Descriptive text on custom types

'Custom types cannot by default display a description or label in connection with the record number, unlike cases for example, which can be displayed by a number of meta data such as Case ID, Case number, Case title, Case handler and/or Case type.

When referring to a record made in a custom type, only the record ID is by default displayed in widgets and in drop-down lists in fields. Displaying custom type records by ID only makes quick identification of which custom type record users are currently working on or looking at difficult.

Adding descriptive text to a custom type

You can manually add a description to the custom type ID which will be displayed when users look-up a custom type field value in a drop-down list or when users analyze custom type data displayed in dashboard widgets.

The descriptive text of a custom type is retrieved from the value of a specially designated custom type text field. Only text fields can be used as descriptions of custom types and only one text field can be used as the description. If you select more than one text field to be used as the description of the custom type, only the last selected text field will be applied.

To add a descriptive label to a custom type

1. In WorkZone Configurator > Global > Custom types, select the custom type you want to add a descriptive label to.
2. For an existing custom type text field:
   1. In the custom type field list, select the custom type text field you want to use as the description of the custom type and select Edit to open a form where you can edit the custom type text field.
   2. In the form, select the Use as entity description parameter
   3. Click Save to save your changes and exit the form.
3. Creating a new custom type text field:
   1. In the custom type field list, click Create to open the Create custom type field form
   2. In the Create custom type field form:
   3. In the Name field, enter a unique name
   4. In the Label by default, enter a user-friendly label to the custom type text field.
   5. (Optional) In the Label (da-DK) field, enter a user-friendly label of the custom type text field that is displayed when Danish is selected as the WorkZone display language.
   6. (Optional) In the Label (de-DE) field, enter a user-friendly label of the custom type text field that is displayed when German is selected as the WorkZone display language.
   7. (Optional) In the Label (en-GB) field, enter a user-friendly label of the custom type text field that is displayed when English is selected as the WorkZone display language.
   8. In the Type of field, select Text.
   9. Select the Use as entity description parameter to use values in this custom type text field as the descriptive text for the custom type field.
   10. Click Save to save your changes and exit the form.

To add a dashboard widget that displays the custom type ID and the description

Prerequisite:

• A main custom type that contains a custom type text field used as the custom type description and a secondary custom type.
• A saved custom type search for the secondary custom type.

To add a dashboard widget for a customtype

1. In the dashboard, click Personalize to open the Dashboard configuration form and drag the saved custom type search for the secondary custom type into the dashboard as a widget.
2. Place and re-size the widget in the dashboard if necessary.
3. Change the widget type to a Bar chart and in the Group by field, select to group the secondary custom type by the main custom type.
4. Select the Display legend check box and click Apply to save your changes and close the form.
5. In the Dashboard configuration form, click Save to save your changes and close the form.