Sheet: 'ISM N&N Templates'

1

Id

Required

• The identifier for the Naming Template definition. There is a requirement that this value is unique within the collection of Naming Templates 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 "TPL_xxxx" , where "xxxx" indicates the role/purpose of the Naming Template.

• 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 Naming Template definition, like "Pipe Naming Rule" and "Main Tag Naming Rule".

3

Name

{language}

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

5

Description

{language}

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

Applicable For

• Allocation

• Validation

• Specifies the applicability of the Naming Template.

• If naming rules are introduced, for example, a Brown Field asset, it is very likely that there are existing object names not conforming to the naming standard being introduced. It is typically not practical to rename these existing objects. Naming templates applicable for Validation only can then be used to validate the names of existing objects, while naming templates applicable for Allocation can be used when allocating names to new objects.

• It is possible to specify more than one value, in which case the values need to be separated by a single space character.

7

Regular Expression

- A valid regular expression syntax

• Specifies a regular expression reflecting the entire name structure represented by the Naming Template.

• If specified, the Naming template should not have any Sheet: 'ISM N&N Elements'.

• A Naming Template having a regular expression will be applicable for Validation only.

8

Aspect

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

9

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 Naming Template 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.

10

SortOrder

- A signed integer value

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

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