Sheet: 'ISM Taxonomies'

1

Id

Required

• Taxonomy is a hierarchical structure consisting of the Taxonomy itself, with a collection of Nodes, which themselves can have collection of Nodes, and so on. The rows in this sheet therefore either represent a Taxonomy, or they represent a Node.

• If the value provided do not contain a "|" (pipe), the entire value is considered a Taxonomy identifier. There is a requirement that Taxonomy identifiers are unique within the collection of Taxonomies 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 Taxonomy identifier, while the successive segments is considered Node identifiers, in a hierarchy as deep as you like.

2

Name

A human readable name for the Taxonomy or Node definition

3

Name

{language}

• A human readable name for the Taxonomy or Node 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 Taxonomy or Node

5

Description

{language}

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

Concept

• Functional

• Document

• Physical

• General

• This column is applicable only when the row represents a Taxonomy (see Id above)

• A value describing what concept the Taxonomy is intended for. Valid values are:

  • Functional: The Taxonomy is intended for organising Functional classes

  • Document: The Taxonomy is intended for organising Document classes

  • Physical: The Taxonomy is intended for organising Physical classes

  • General: The Taxonomy is intended for organising General classes

7

ClassIds

• This column is applicable only of the row represents a Node (see Id above)

• A comma separated list of Functional- or Document Class identifiers to be associated with the target Node.

• The identifiers will be resolved according to Concept

8

Aspect

Annotating a Taxonomy or Node with an aspect is a way to associate the Taxonomy or Node 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 (e.g. they might not support deleting a Taxonomy or Node 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 Taxonomy or Node are presented in the AVEVA ISM user interface

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