Sheet: 'ISM UoM Units'

1

Id

Required

• The identifier for the Unit definition. There is a requirement that this value is unique within the collection of Units 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 "UNIT_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 Unit definition, like "kilograms" and "centimetre squared".

3

Name

{language}

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

5

Description

{language}

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

Symbol

• The symbol associated with the Unit, like "Kg", "MB" and "cm2". This is the value that typically will suffix the associated Attribute value in a user interface.

• If missing the value of Name will be used.

7

Standard

A value referencing the industry standard that defines the Unit.

8

System

• Metric

• US

• Imperial

A value specifying what measure system the Unit belongs to.

9

GroupId

• The name of the group that the Unit belongs to. The value will be used to group the collection of Units in the AVEVA ISM user interface.

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

10

Aspect

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

11

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 Unit 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.

12

SortOrder

- A signed integer value

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

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