Sheet: 'ISM N&N Elements'

1

Id

Required

• The identifier for the Element definition. There is a requirement that this value is unique within the collection of Elements in the target Class Library model.

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

• To avoid identifier naming conflicts in applications implementing the Class Library it is recommended that all identifiers, across all concepts, are unique within a Class Library. This can easily be achieved by using a naming convention, such as "ELEM_xxxx", where "xxxx" indicates the role/purpose of the Element.

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

2

Name

A human readable name for the Element definition.

3

Name

{language}

• A human readable name for the Element 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 Element.

5

Description

{language}

• An arbitrary description of the purpose/role of the Element, 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

Source

• When composing an object name (for example, a Tag name), the value for each of the Elements constituting the name is typically picked from an Attribute of the object. Source specifies either the Id or the Aspect of that source Attribute.

• If the value is enclosed in curly braces, Source is referring to the Aspect of the source Attribute.

• If the value is not enclosed in curly braces, the Attribute is located by Id, or Aspect, in that order of priority.

7

Mandatory

• true

• false

• When composing an object name, some of the Elements might be considered optional. For example, if the corresponding Attribute do not contain a value.

• This indicator specifies whether the Element is mandatory.

8

HideOn EmptyValue

• true

• false

• This value dictates how the Element should appear in the composed name when the corresponding Attribute value is empty.

• If true, the Element, including any Prefix or Suffix will be excluded from the composed name.

9

MaxNumber OfCharacters

- A positive integer value

This value dictates the maximum number of characters in the value represented by the Element.

10

MinNumber OfCharacters

- A positive integer value

• This value dictates the minimum number of characters in the value represented by the Element.

• If the value provided contains less than this number of characters, the value will be padded by PaddingCharacter. The padding will be left or right, depending on the data type of the associated Attribute (see Source).

11

Padding Character

- A single character

Specifies the character to use when padding the Element value (see MinNumberOfCharacters).

12

Prefix

- One or more characters

• Specifies a character sequence to prefix the Element value when composing an object name.

• Typically either Prefix or Suffix is used for an Element, but rarely both on the same Element.

13

Suffix

- One or more characters

• Specifies a character sequence to suffix the Element value when composing an object name.

• Typically either Prefix or Suffix is used for an Element, but rarely both on the same Element.

14

Temporary Value

Specifies a value to use as a replacement when the associated Attribute (see Source) is empty.

15

FixedValue

• Specifies a fixed value to use for the Element.

• If a value is specified for this property, Source should be empty.

16

Regular Expression

- A valid regular expression syntax

• Specifies a regular expression to be used when validating the Element in an object name.

• The expression specified will be used in composing a holistic regular expression for the entire object name, and should therefore not contain any positional anchoring instructions.

• If a value is specified for this property, Source should be empty.

• If a Sheet: 'ISM N&N Templates' contains one or more Elements having a regular expression, the template will be applicable for validation of exiting object names only. Such a type of templates will not be applicable for allocating new object names.

17

SequenceId

Example:

FUNCTIONAL

DOCUMENT

• An object name typically contains at least one Element representing a running sequence number.

• To avoid sequence number conflicts across object types. For example, for Tags and Documents it is recommended to use a distinct SequenceId for each target object type.

• This value specifies the sequence id to use when providing sequence numbers for new object names.

20

Aspect

Annotating an Element with an aspect is a way to associate the Element 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.

21

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 an Element that is in use for existing data). Obsoleting deprecated definitions might therefore be a less intrusive approach. How, or whether, obsoleting is implemented might vary across consuming software though.

22

SortOrder

- A signed integer value

• Decides on the order in which Elements are presented in the AVEVA ISM user interface.

• Elements not having a value specified for this property will be ordered as if they have the highest SortOrder value.