Who is this article for?

Users who are responsible for Metadata Type management.

Equipment Administrator(EQADM) permissions are required.

Against any equipment model, you can associate additional fields for logging information within the record for assets/equipment of that model. A few examples for this may include Vehicle Registration, Number, Colour, Training Required, etc. This article will show you how to administer metadata types on the system.

1. Accessing Metadata Types
2. Creating Metadata Types
   • Dropdown and Radio Button Data Types
   • Integer and Decimal Data Types
   • Text and Multiline Data Types
   • Date Data Type
   • Yes/No Data Type
3. Amending Metadata Types

1. Accessing Metadata Types

To access Metadata Types:

1. Navigate to Equipment Manager.
2. Select Administration.
3. Switch to the "Metadata Types" tab.

2. Creating Metadata Types

To create a new Metadata Type:

1. Click the New Metadata Type icon to the right of the Metadata Types header bar.
   A blank Metadata Type Details screen will be displayed.

2. Complete the mandatory details: Title, Label.
3. Select the Data Type.
   Text, Integer, or Decimal Metadata Types may be simple fields or offer choice from a table of values. These are presented as either a dropdown box or as a radio button selection.
4. Define an optional Tooltip.
   This will be displayed when the associated display screen Label has the cursor placed over it.
5. If the Owner is set to User, they can be selected from the set of Users in the dropdown box.
   Alternatively, you can open the user list by clicking the Select Owner icon to the right of the dropdown box.

6. If the Owner is set to the Group, they can be selected from the set of Groups in the dropdown box.
   Alternatively, you can open the group list by clicking the Select Owner icon to the right of the dropdown box.

7. Tick Active to make the Type available for selection.
   Leaving it unticked removes the Metadata Type from further selection in Equipment Models.
8. Click Save.
   This will expand the screen to reveal the additional, metadata-specific fields.

Dropdown and Radio Button Data Types

When Drop Down or Radio Button is selected, the Metadata Type Details screen will expand to reveal the Value section.

To add a new row, click the Add New Value icon.

Values entered in each row added must match the data type selected.

You can use the arrows to sequence the supplied items. This dictates the order in which they will be presented in the Dropdown or Radio Button.

To delete a field, click the Delete Value icon to the right of its row.

Integer and Decimal Data Types

When Integer and Decimal Data Types is selected, additional fields for the optional declaration of Minimum, Maximum and Default will be displayed.

Minimum Number and Maximum Number fields can be used to validate the input value supplied when the record is saved.

Default field can be used to populate the value into all records using the associated Metadata Type.

In both Integer and Decimal Metadata Types, negative numbers may be used.

Text and Multiline Data Types

When Text and Multiline Data Types is selected, additional fields for the optional declaration of Minimum Length and/or Maximum Length of characters (cannot exceed 9999), and an optional Default field will be displayed.

A fourth Text option is available - Multiline. This allows for the provision of paragraphs of information. This has no default field. For Multiline Data Types, ensure that you set both the Minimum and Maximum Length.

Date Data Type

When Date Data Type is selected, fields for Minimum Offset, Maximum Offset, and Default values will be displayed.

These values are expressed in terms of offset in Days or Months from the date of record creation. The Default is an offset, which must be between the Minimum Offset and Maximum Offset values (if provided).

The date range has a limit of plus 834 years and minus 84 years.

Yes/No Data Type

When Yes/No is selected, a Boolean field option will be displayed.

This allows the Default value to be set to Yes, No, or No Default (allowing the User to select a value of their choice).

3. Amending Metadata Types

To amend an existing Metadata Type:

1. Click anywhere in the record row.
   The Metadata Type details screen will be presented.

2. Alter any field that is not greyed out.
3. Untick Active to remove the Type from being available for selection.
   Where an association has already been made it remains in place.
4. Click the Save icon to the right of the Metadata Type details header bar.
   The following overlaid confirmation message will be displayed:

5. Click OK to continue.

Making changes to an active Metadata Type?
Any changes made to Metadata Types will be reflected in all Issues - closed or active - that have the Metadata Type associated with them.