Sheet: 'ISM Enumerations'

1

Id

Required

• An Enumeration is a List with Items, and potentially sub-Items. The rows in this sheet therefore either represent a List, or they represent an Item belonging to a list.

• If the value provided do not contain a "|" (pipe), the entire value is considered a List identifier. There is a requirement that List identifiers are unique within the collection of Enumeration Lists in the target Class Library model

• Even though it is not an absolute requirement, it is recommended that List identifier values do not contain white space characters

• It is strongly recommended, when a Class Library evolves over time, to never change the value of any identifiers

• If the value provided consists of multiple segments delimited by "|" (pipe), the first segment is considered the List identifier, while the successive segments is considered Item identifiers, optionally sub-Item identifiers.

• An Enumeration List can typically be used as a ValidationRule for an Attribute; to constrain what values will be accepted for the corresponding attribute. An information authoring application consuming the Class Library might choose to render the List as a drop-down list in the user interface. When a user makes a selection in this list, it is typically the identifier value for the corresponding Item that is considered the data value. Therefore the notation, and the rules, for Item identifiers are different from other identifier values in the Class Library. So instead of using a notation like "ITEM_nnn", you should specify the data value that the item represents. For example, a List that represents possible "Cooling Types" might have Items with identifiers like "AIR", "WATER".

2

Name

A human readable name for the List or Item definition

3

Name

{language}

• A human readable name for the List or Item definition, in a specific language

• The value for {language} is composed as {languageCode}-{countryCode} (see the Sheets and Column Headers for AVEVA ISM Intrinsic Definitions)

• This column can be repeated as many times as required, each with a different value for {language}

4

Description

An arbitrary description of the purpose/role of the List or Item

5

Description

{language}

• An arbitrary description of the purpose/role of the List or Item, in a specific language

• The value for {language} is composed as {languageCode}-{countryCode} (see the Sheets and Column Headers for AVEVA ISM Intrinsic Definitions)

• This column can be repeated as many times as required, each with a different value for {language}

6

Aspect

Annotating a List or Item with an aspect is a way to associate the List or Item with a specific semantic definition. Application logic will look for these aspects, and apply associated processing rules. Definition of available aspect values is outside the scope of this document

7

Obsolete

• true

• false

When evolving a Class Library over time, removing previously existing definitions might cause issues with consuming software systems (for example, they might not support deleting a List or Item that is in use for existing data). Obsoleting deprecated definitions might therefore be a less intrusive approach. How, or whether, obsoleting is supported might vary across consuming software though

8

SortOrder

- A signed integer value

Decides on the order in which List and Items are presented in the AVEVA ISM user interface

Lists or Items not having a value specified for this property will be ordered as if they have the highest SortOrder value