Please ensure Javascript is enabled for purposes of website accessibility
Powered by Zoomin Software. For more details please contactZoomin

AVEVA™ Recipe Management

Work with List Data Types

  • Last UpdatedMay 16, 2024
  • 4 minute read

You use the List Data Types editor to view and manage the Enum Lists and String Lists.

You can update the details such as the name of a List using the Edit option but make sure that the modified name for Enum List or String List is unique. You can delete existing Lists. Deleting a List marks the list as deleted in the database with an asterisk (*). To restore a deleted list data type, you need to re-add the deleted list name with an appended asterisk (*) character. After a successful restore, the asterisk mark (*) disappears.

WARNING: Make sure that you do not delete the List Data Types unless you are sure that the selected List Data Type is not in use. Deleting a list data type invalidates approved Formulas/Recipes that use the List Data Type. It can also lead to failure of future Formula/Recipe assignments. Once deleted, the List Data Types does not appear for selection in the item list. If they are already selected, they will be marked with an asterisk (*).

Enum List

You can add Enumeration list by clicking the Add Enum List button in the List Data Types page.

To add an Enum List

  1. From the main menu, select Configuration > List Data Types to display the List Data Types details page.

  2. Click the Add Enum List button.

  3. Enter the Name and Description.

  4. In the Values tab, click the Add button. A new row appears in the Values grid.

  5. Complete the values fields by providing the following details:

    • String Value: Specify the string value. The default String Value is “ListItem_001”. The maximum length of the String Value is 1024 characters. The String Value cannot be blank. The String value must be unique in the list.

    • Enum: Specify the Enum value. The default Enum value starts with integer 0 and increments by one when you add a new list item.

  6. Click Update to save the Enum List.

To edit a value in the Enum List

  1. From the List Data Types summary page, click the Enum List. The selected Enum List Details page appears.

  2. In the Values tab, click Edit next to the values row you want to change. The existing value appears in an edit mode so you can make changes. The Update and Cancel buttons also appear.

  3. Make the changes to the Enum List value.

  4. Click the Update button to save the changes you make to the Enum List value, or click the Cancel button to undo the changes to the Enum List value.

    To delete a value from the Enum List

    1. From the List Data Types summary page, click the Enum List to edit the value that you want to edit. The selected Enum List Details page appears.

    2. In the Values tab, click Delete next to the values row you want to remove. A confirmation message appears.

    3. Click Yes.

      String List

      You can add a String list by clicking the Add String List button in the List Data Types page.

      To add a String List

      1. From the main menu, select Configuration > List Data Types to display the List Data Types details page.

      2. Click the Add String List button.

      3. Enter the Name and Description.

      4. In the Values tab, click the Add button. A new row appears in the Values grid.

      5. Complete the values fields by providing the following details:

        • String Value: Specify the string value. The default String Value is “ListItem_001”. The maximum length of the String Value can be 1024 characters. The String Value cannot be blank. The String value must be unique in the list.

      6. Click Update to save the String Value.

        To edit a value in the String List

        1. From the List Data Types summary page, click the String List that you want to edit. The selected String List Details page appears.

        2. In the Values tab, click Edit next to the values row you want to change. The existing value appears in an edit mode so you can make changes. The Update and Cancel buttons also appear.

        3. Make the changes to the String List value.

        4. Click the Update button to save the changes you make to the String List value, or click the Cancel button to undo the changes to the String List value.

          To delete a value from the String List

          1. From the List Data Types summary page, click the String List to edit the value that you want to edit. The selected String List Details page appears.

          2. In the Values tab, click Delete next to the values row you want to delete. A confirmation message appears.

          3. Click Yes.

            WARNING: You should delete a String or Enum list item only if you are sure that it is not used anywhere in the system. Deleting a used list item can invalidate your approved Formulas and Recipes. If you do delete an item, it can be restored by re-adding the item (it does not need an asterisk "*" character added to the name).

            Deleting the Lists

            You can use the Delete button to remove an existing List.

            To delete an existing List

            1. From the Summary page, click the List you want to delete. The selected List appears on the details page.

            2. Click the Delete button. A confirmation message appears.

            3. Click Yes. Once deleted, the list does not appear for selection in the item list. The deleted List is marked with an asterisk (*) if already selected in the entities such as Parameter Extensions or Capability Parameters or Equipment Parameters.

              In This Topic
              Related Links
              TitleResults for “How to create a CRG?”Also Available in