Dela via


Standard Version Document in ESG data model

Base entity from which all Industry Data Model entities are derived.

Traits

Traits for this entity are listed here.

is.CDM.entityVersion

ParameterValueData typeExplanation
versionNumber"4.3"stringsemantic version number of the entity

is.localized.describedAs
Holds the list of language specific descriptive text for an object.

ParameterValueData typeExplanation
localizedDisplayText
languageTagdisplayText
enBase entity from which all Industry Data Model entities are derived.
enA document that applies to a standard version.
entitya reference to the constant entity holding the list of localized text

is.identifiedBy
Names a specific identity attribute to use with an entity.

ParameterValueData typeExplanation
attributeStandardVersionDocument/(resolvedAttributes)/StandardVersionDocumentPeriodStartTimestampattribute

minimumObjectModelVersion
Minimum version of the object model required to fully understand the data schema used.

ParameterValueData typeExplanation
versionNumber"1.2.3"string

is.IDM.modelVersion
Semantic version number of the IDM.

ParameterValueData typeExplanation
versionNumber"1.6.0"string

has.schemaObjectIdentifier
The schema object has an identifier, which is a string, specified as the parameter of the trait. It allows writers to define other identification values.

ParameterValueData typeExplanation
identifier"{2155307C-C076-4584-87A4-4A96BC53C9AD}"stringThe identifier for the schema object. There's no uniqueness guarantee enforced by CDM. It's a contract between reader and writer of the schema.

is.nativeTo.businessArea
The name of the business area from which the entity originates.

ParameterValueData typeExplanation
name"Business Management"string

is.localized.displayedAs
Holds the list of language specific display text for an object.

ParameterValueData typeExplanation
localizedDisplayText
languageTagdisplayText
enStandard Version Document
entitya reference to the constant entity holding the list of localized text

has.entitySchemaAbstractionLevel
A level of abstraction assigned to an Entity schema. Logical schema descriptions use complex dataTypes, inheritance, and entities as attributes. Resolved descriptions contain none of those things, only final trait and attribute sets are shown. A composition schema manipulates, guides or restates parts of logical schemas to produce one resolved schema.

ParameterValueData typeExplanation
level"resolved"stringPossible values: logical, composition, resolved

Attributes

Name Description First Included in Instance
StandardId The unique identifier of a Standard. StandardVersionDocument
DocumentId The unique identifier of a Document. StandardVersionDocument
StandardVersionDocumentPeriodStartTimestamp The period start timestamp associated with the Standard Version Document. StandardVersionDocument
StandardVersionId The unique identifier of a Standard Version. StandardVersionDocument
StandardVersionDocumentPeriodEndTimestamp The period end timestamp associated with the Standard Version Document. StandardVersionDocument
StandardVersionDocumentNote Notes, comments or additional information regarding the associated Standard Version Document. StandardVersionDocument

StandardId

The unique identifier of a Standard.
First included in: StandardVersionDocument (this entity)

Properties

NameValue
displayNameStandard ID
descriptionThe unique identifier of a Standard.
isPrimaryKeytrue
dataFormatint32

Traits

List of traits for the StandardId attribute are listed here.

is.dataFormat.integer
is.identifiedBy
Names a specific identity attribute to use with an entity.

ParameterValueData typeExplanation
attributeStandardVersionDocument/(resolvedAttributes)/StandardIdattribute

is.linkedEntity.identifier
Marks the attribute(s) that hold foreign key references to a linked (used as an attribute) entity. This attribute is added to the resolved entity to enumerate the referenced entities.

ParameterValueData typeExplanation
entityReferences
entityReferenceattributeReference
StandardVersion.cdm.json/StandardVersionStandardId
entitya reference to the constant entity holding the list of entity references

is.localized.displayedAs
Holds the list of language specific display text for an object.

ParameterValueData typeExplanation
localizedDisplayText
languageTagdisplayText
enStandard ID
entitya reference to the constant entity holding the list of localized text

is.localized.describedAs
Holds the list of language specific descriptive text for an object.

ParameterValueData typeExplanation
localizedDisplayText
languageTagdisplayText
enThe unique identifier of a Standard.
entitya reference to the constant entity holding the list of localized text

has.schemaObjectIdentifier
The schema object has an identifier, which is a string, specified as the parameter of the trait. It allows writers to define other identification values.

ParameterValueData typeExplanation
identifier"{01A1428A-277C-42DC-8E2A-4D14DD6B422D}"stringThe identifier for the schema object. There's no uniqueness guarantee enforced by CDM. It's a contract between reader and writer of the schema.

is.dataFormat.integer

DocumentId

The unique identifier of a Document.
First included in: StandardVersionDocument (this entity)

Properties

NameValue
displayNameDocument ID
descriptionThe unique identifier of a Document.
isPrimaryKeytrue
dataFormatint64

Traits

List of traits for the DocumentId attribute are listed here.

is.dataFormat.integer
is.dataFormat.big
Indicates an atomic but multi-unit version of a fundamental type such as a multi byte encoded character, a double precision float, a long integer.

is.identifiedBy
Names a specific identity attribute to use with an entity.

ParameterValueData typeExplanation
attributeStandardVersionDocument/(resolvedAttributes)/DocumentIdattribute

is.linkedEntity.identifier
Marks the attribute(s) that hold foreign key references to a linked (used as an attribute) entity. This attribute is added to the resolved entity to enumerate the referenced entities.

ParameterValueData typeExplanation
entityReferences
entityReferenceattributeReference
Document.cdm.json/DocumentDocumentId
entitya reference to the constant entity holding the list of entity references

is.localized.displayedAs
Holds the list of language specific display text for an object.

ParameterValueData typeExplanation
localizedDisplayText
languageTagdisplayText
enDocument ID
entitya reference to the constant entity holding the list of localized text

is.localized.describedAs
Holds the list of language specific descriptive text for an object.

ParameterValueData typeExplanation
localizedDisplayText
languageTagdisplayText
enThe unique identifier of a Document.
entitya reference to the constant entity holding the list of localized text

has.schemaObjectIdentifier
The schema object has an identifier, which is a string, specified as the parameter of the trait. It allows writers to define other identification values.

ParameterValueData typeExplanation
identifier"{1DF39393-5B53-48FE-9D80-7D3D2B72AD9E}"stringThe identifier for the schema object. There's no uniqueness guarantee enforced by CDM. It's a contract between reader and writer of the schema.

is.dataFormat.integer
is.dataFormat.big
Indicates an atomic but multi-unit version of a fundamental type such as a multi byte encoded character, a double precision float, a long integer.

StandardVersionDocumentPeriodStartTimestamp

The period start timestamp associated with the Standard Version Document.
First included in: StandardVersionDocument (this entity)

Properties

NameValue
displayNameStandard Version Document Period Start Timestamp
descriptionThe period start timestamp associated with the Standard Version Document.
isPrimaryKeytrue
dataFormatdateTime

Traits

List of traits for the StandardVersionDocumentPeriodStartTimestamp attribute are listed here.

is.dataFormat.date
means.measurement.date
is.dataFormat.time
means.measurement.time
is.identifiedBy
Names a specific identity attribute to use with an entity.

ParameterValueData typeExplanation
attributeStandardVersionDocument/(resolvedAttributes)/StandardVersionDocumentPeriodStartTimestampattribute

has.schemaObjectIdentifier
The schema object has an identifier, which is a string, specified as the parameter of the trait. It allows writers to define other identification values.

ParameterValueData typeExplanation
identifier"{4F73AC0A-8DAD-4B98-906A-992E4AD740B0}"stringThe identifier for the schema object. There's no uniqueness guarantee enforced by CDM. It's a contract between reader and writer of the schema.

is.localized.displayedAs
Holds the list of language specific display text for an object.

ParameterValueData typeExplanation
localizedDisplayText
languageTagdisplayText
enStandard Version Document Period Start Timestamp
entitya reference to the constant entity holding the list of localized text

is.localized.describedAs
Holds the list of language specific descriptive text for an object.

ParameterValueData typeExplanation
localizedDisplayText
languageTagdisplayText
enThe period start timestamp associated with the Standard Version Document.
entitya reference to the constant entity holding the list of localized text

is.dataFormat.time
is.dataFormat.date

StandardVersionId

The unique identifier of a Standard Version.
First included in: StandardVersionDocument (this entity)

Properties

NameValue
displayNameStandard Version ID
descriptionThe unique identifier of a Standard Version.
isPrimaryKeytrue
dataFormatint32

Traits

List of traits for the StandardVersionId attribute are listed here.

is.dataFormat.integer
is.identifiedBy
Names a specific identity attribute to use with an entity.

ParameterValueData typeExplanation
attributeStandardVersionDocument/(resolvedAttributes)/StandardVersionIdattribute

is.linkedEntity.identifier
Marks the attribute(s) that hold foreign key references to a linked (used as an attribute) entity. This attribute is added to the resolved entity to enumerate the referenced entities.

ParameterValueData typeExplanation
entityReferences
entityReferenceattributeReference
StandardVersion.cdm.json/StandardVersionStandardVersionId
entitya reference to the constant entity holding the list of entity references

is.localized.displayedAs
Holds the list of language specific display text for an object.

ParameterValueData typeExplanation
localizedDisplayText
languageTagdisplayText
enStandard Version ID
entitya reference to the constant entity holding the list of localized text

is.localized.describedAs
Holds the list of language specific descriptive text for an object.

ParameterValueData typeExplanation
localizedDisplayText
languageTagdisplayText
enThe unique identifier of a Standard Version.
entitya reference to the constant entity holding the list of localized text

has.schemaObjectIdentifier
The schema object has an identifier, which is a string, specified as the parameter of the trait. It allows writers to define other identification values.

ParameterValueData typeExplanation
identifier"{359BCA14-8142-4A2D-832B-A1252D918A4C}"stringThe identifier for the schema object. There's no uniqueness guarantee enforced by CDM. It's a contract between reader and writer of the schema.

is.dataFormat.integer

StandardVersionDocumentPeriodEndTimestamp

The period end timestamp associated with the Standard Version Document.
First included in: StandardVersionDocument (this entity)

Properties

NameValue
displayNameStandard Version Document Period End Timestamp
descriptionThe period end timestamp associated with the Standard Version Document.
dataFormatdateTime
isNullabletrue

Traits

List of traits for the StandardVersionDocumentPeriodEndTimestamp attribute are listed here.

is.dataFormat.date
means.measurement.date
is.dataFormat.time
means.measurement.time
has.schemaObjectIdentifier
The schema object has an identifier, which is a string, specified as the parameter of the trait. It allows writers to define other identification values.

ParameterValueData typeExplanation
identifier"{3592CC58-6431-4497-A734-020D5579978C}"stringThe identifier for the schema object. There's no uniqueness guarantee enforced by CDM. It's a contract between reader and writer of the schema.

is.nullable
The attribute value can be set to NULL.

is.localized.displayedAs
Holds the list of language specific display text for an object.

ParameterValueData typeExplanation
localizedDisplayText
languageTagdisplayText
enStandard Version Document Period End Timestamp
entitya reference to the constant entity holding the list of localized text

is.localized.describedAs
Holds the list of language specific descriptive text for an object.

ParameterValueData typeExplanation
localizedDisplayText
languageTagdisplayText
enThe period end timestamp associated with the Standard Version Document.
entitya reference to the constant entity holding the list of localized text

is.dataFormat.time
is.dataFormat.date

StandardVersionDocumentNote

Notes, comments or additional information regarding the associated Standard Version Document.
First included in: StandardVersionDocument (this entity)

Properties

NameValue
displayNameStandard Version Document Note
descriptionNotes, comments or additional information regarding the associated Standard Version Document.
dataFormatstring
maximumLength2048
isNullabletrue

Traits

List of traits for the StandardVersionDocumentNote attribute are listed here.

is.dataFormat.character
is.dataFormat.big
Indicates an atomic but multi-unit version of a fundamental type such as a multi byte encoded character, a double precision float, a long integer.

is.dataFormat.array
Indicates a contiguous sequence of fundamental units that should be taken as a whole and considered one value. Array of Character is a String. Array of Byte is a Binary Object.

has.schemaObjectIdentifier
The schema object has an identifier, which is a string, specified as the parameter of the trait. It allows writers to define other identification values.

ParameterValueData typeExplanation
identifier"{16C9037F-AF57-4187-8507-B4151C670AD0}"stringThe identifier for the schema object. There's no uniqueness guarantee enforced by CDM. It's a contract between reader and writer of the schema.

is.nullable
The attribute value can be set to NULL.

is.localized.displayedAs
Holds the list of language specific display text for an object.

ParameterValueData typeExplanation
localizedDisplayText
languageTagdisplayText
enStandard Version Document Note
entitya reference to the constant entity holding the list of localized text

is.localized.describedAs
Holds the list of language specific descriptive text for an object.

ParameterValueData typeExplanation
localizedDisplayText
languageTagdisplayText
enNotes, comments or additional information regarding the associated Standard Version Document.
entitya reference to the constant entity holding the list of localized text

is.constrained
Maximum length or value constraints.

ParameterValueData typeExplanation
maximumLength"2048"integer

is.dataFormat.character
is.dataFormat.array
Indicates a contiguous sequence of fundamental units that should be taken as a whole and considered one value. Array of Character is a String. Array of Byte is a Binary Object.