Sheet: 'ISM Life Cycle Types'

1

Id

Required

- A positive integer value

• The identifier for the Life Cycle Type definition. There is a requirement that this value is unique within the collection of Life Cycle Types 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 "LCT_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 Life Cycle Type definition.

3

Name

{language}

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

5

Description

{language}

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

• A value describing what concept the Life Cycle Type is intended for. Valid values are:

  • Functional: The Life Cycle Type is intended for Functional classes

  • Document: Then Life Cycle Type is intended for Document classes

7

Maturity Levels

A comma separated list of Permissible Maturity Levels for the Life Cycle Type.

8

Aspect

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

10

SortOrder

- A signed integer value

• Decides on the order in which Life Cycle Types are presented in the AVEVA ISM user interface.

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