About List Data Types

You can define custom list types such as String List, Enum List or can define Dynamic List data types using APIs in AVEVA Recipe Management. These data types help you to define custom Target and Actual values for various entities.

Lists can be of the following types:

• Enumeration list

• String list

• Dynamic list

  NOTE: Dynamic Lists are special forms of String lists and are not editable by the UI. They are only available in special installations and are beyond the scope of the general User Guide.

The Lists are not versioned entities and are available for selection while adding new entities or updating existing entities such as Capability, Equipment, Formula below the built-in system data types.

When you click List Data Types from the sub menu, the Summary page appears. By default, the Summary page appears in the Tile view format. The tiles contain the following information about existing lists:

• Name

• Type

• Number of values (In the case of the Dynamic List data type, the number of values is not available)

The total number of lists appears at the bottom of the screen unless you have used filters to limit the List Data Types shown. If you apply a filter to view the List Data Types, the filter icon appears at the bottom of the screen. For more information, see Filtering.

You can click the Grid View icon to show the Summary page in tabular or Grid view format.

You can click any of the tiles (Tile View) or click View (Grid View) on the Summary page to navigate to the List Data Types detail page. The List Data Types detail page provides the following details:

• Name and description of the list

• Type of List data type

• Information icon: Tooltip for the list

• Values tab

• Basic Filter

  NOTE: In the case of Dynamic Lists, the Values tab and the Filter options are not available, and the URL of the Dynamic list appears in the Read-only mode on the Details page. The Dynamic Lists Details page also shows the information tooltip.

You can add, edit, or delete a list (Enumeration or String) only if you have the necessary permission to access the List Data Types menu.

You cannot add a custom list name with the same name as default data types available in the application (String, Boolean, Integer, or Double).

You cannot add a Dynamic list using the List Data Type editor. You can add/update/delete a Dynamic list through API only. It is available in the user interface but cannot be edited or deleted. The URL for a Dynamic list is visible as a read-only field in details area. Also, you cannot add any list items to a Dynamic list.

An enum list value contains an integer value and a string value; a String list value contains only a string. Make sure that the Enum list or String list values that you created are unique.

In the Application Object (IDE), the List data type appears in the Data Type column where the List type (EnumList or StringList) is appended to an existing list.