Sheet: 'ISM Attributes'

1

Id

Required

• The identifier for the Attribute definition. There is a requirement that this value is unique within the collection of attributes 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 "ATT_nnnn"

• 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 Attribute definition

3

Name

{language}

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

5

Description

{language}

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

Presence

• Not Applicable

• Optional

• Preferred

• Required

Dictates the requirements for a value being provided for the Attribute when a data object is provided. For example, when data is loaded by AVEVA Gatekeeper, the constraint dictated by this property will be enforced for all instances of the target Attribute

7

Presence

{maturity}

• Specifies the Presence requirement for the attribute when a data object has a maturity of {maturity}. The value for {maturity} should correspond to the identifier of a Maturity Level definition

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

8

Discipline

The discipline "owning" the Attribute

9

Discipline

{maturity}

• The discipline "owning" the Attribute when a data object has a maturity of {maturity}. The value for {maturity} should correspond to the identifier of a Maturity Level definition

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

10

GroupId

• The name of the group that the Attribute belongs to

• Groups are created automatically, based on the values provided in this column

• An Enumeration@aspect="Enumerations.AttributeGroups" will be created automatically, and populated with the values supplied in this column

11

MinOccurs

- A positive integer value

Specifies the minimum number of values that has to be provided for the Attribute when an instance of a class is provided. For example, when data is loaded by AVEVA Gatekeeper, the constraint dictated by this property will be enforced for all instances of the target Attribute

12

MaxOccurs

- A positive integer value >= Min Occurs, or

"unbounded"

Specifies the maximum number of values that can to be provided for the Attribute when an instance of a class is provided. For example, when data is loaded by AVEVA Gatekeeper, the constraint dictated by this property will be enforced for all instances of the target Attribute

13

UomClassId

- {UoMClass @id}

• Specifies the identifier of a Unit Of Measure class

• Supplying a value for this column will force UomRequired=true and the DataType=Decimal

• When UomRequired=true there will be a requirement for providing a UoM with instance values for the Attribute. When editing instance values such Attributes in a UI a drop-down list of applicable Unit Of Measure Classes and/or Units Of Measures will be provided

14

UomRequired

• true

• false

• When "true" there will be a requirement for providing a UoM with instance values for the Attribute. When editing instance values such Attributes in a UI a drop- down list of applicable Unit Of Measure Classes and/or Units Of Measures will be provided

• When "true" will force DataType=Decimal

15

Validation Type

• Enumeration

• Regular Expression

• ValueRange Inclusive

• Association

• Specifies a constraint for how instance values for the Attribute should be validated

• Column ValidationRule (see below) should then contain

16

Validation Rule

• Specifies the rule corresponding to what has been specified for column ValidationType (see above):

  • Enumeration: the identifier for a corresponding Enumeration list defined elsewhere in the Class Library. When the instance values for the Attribute is edited in a UI, the list of valid values will be provided as a drop-down list

  • RegularExpression: A Regular Expression syntax constraining what values will be accepted for the corresponding Attribute

  • ValueRangeInclusive: Two numeric values, separated by comma. The first value sets the lower bound, and the second value sets the upper bound for values supplied for the Attribute

  • Association: The validation rule Association indicates that the corresponding attribute value represents the identifier of another object of a given class. The rule syntax is: {concept}:{classId}[|{classId}|…|{classId}] {concept} can be one of the following values:

    • Functional

    • Physical

    • Document

    • General

      {classId} is an identifier of a class of {concept}. The square brackets in the syntax example above is indicating that you optionally can specify more than one {classId}. You should not include the square brackets in actual syntax.

17

Concept

• Functional

• Document

• A value describing what concept(s) the Attribute is intended for. Valid values are:

  • Functional: The Attribute is intended for Functional classes

  • Document: Then Attribute is intended for Document classes

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

18

DataType

• String

• Boolean

• Integer

• Decimal

• Dictates what data type the Attribute value has to conform to

• If a value is provided for column UomClassId, or UomRequired (see above), the data type will be set to Decimal, independent of what is specified in this column

19

Size

• An expression specifying size restriction for the value of the Attribute. Interpretation of the expression is dependent on the consuming application, but the following notation is recommended, depending on the DataType of the Attribute:

  • String: A positive integer value expressing the maximum number of characters that the corresponding Attribute value can hold

  • Integer: A positive integer value expressing the maximum number of digits that the corresponding Attribute value can hold

  • Decimal: Two positive integer values, separated by comma, expressing maximum number of digits for the integer part and the fractional part of the decimal number that the corresponding Attribute value can hold

20

Aspect

Annotating an Attribute with an aspect is a way to associate the Attribute 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 Attribute 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 Attributes are presented in the AVEVA ISM user interface

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

• Consuming software systems might also utilise this information to decide on in which order Attribute values are to be presented