minimumObjectModelVersion
Minimum version of the object model required to fully understand the data schema used.
Parameter
Value
Data type
Explanation
versionNumber
"1.2.3"
string
is.IDM.modelVersion
Semantic version number of the IDM.
Parameter
Value
Data type
Explanation
versionNumber
"2.0.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 more identification values.
Parameter
Value
Data type
Explanation
identifier
"{CDB34DD3-65D9-44AC-8F6A-1C3A1E972040}"
string
The 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.
Parameter
Value
Data type
Explanation
name
"Document Management"
string
is.localized.displayedAs
Holds the list of language specific display text for an object.
Parameter
Value
Data type
Explanation
localizedDisplayText
languageTag
displayText
en
Document Purpose
entity
a 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.
The unique identifier of a Document.
First included in: Sustainability/esg-data-model/DocumentPurpose (this entity)
Properties
Name
Value
displayName
Document ID
description
The unique identifier of a Document.
isPrimaryKey
true
dataFormat
int64
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
is.linkedEntity.identifier
Marks the attributes 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.
a 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.
Parameter
Value
Data type
Explanation
localizedDisplayText
languageTag
displayText
en
Document ID
entity
a 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.
Parameter
Value
Data type
Explanation
localizedDisplayText
languageTag
displayText
en
The unique identifier of a Document.
entity
a 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 more identification values.
Parameter
Value
Data type
Explanation
identifier
"{1969BF9C-42ED-4B51-9EE7-FA501DEC6899}"
string
The 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.
is.linkedEntity.identifier
Marks the attributes 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.
a 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.
Parameter
Value
Data type
Explanation
localizedDisplayText
languageTag
displayText
en
Document Purpose Priority ID
entity
a 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.
Parameter
Value
Data type
Explanation
localizedDisplayText
languageTag
displayText
en
The unique identifier of a Document Purpose Priority.
entity
a 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 more identification values.
Parameter
Value
Data type
Explanation
identifier
"{08B0BE89-FFEB-48E0-B6DB-24D3F4752004}"
string
The 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.linkedEntity.identifier
Marks the attributes 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.
a 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.
Parameter
Value
Data type
Explanation
localizedDisplayText
languageTag
displayText
en
Document Purpose Type ID
entity
a 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.
Parameter
Value
Data type
Explanation
localizedDisplayText
languageTag
displayText
en
The unique identifier of a Document Purpose Type.
entity
a 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 more identification values.
Parameter
Value
Data type
Explanation
identifier
"{C3A71831-DAA3-4541-A070-D39936D8BAE0}"
string
The identifier for the schema object. There's no uniqueness guarantee enforced by CDM. It's a contract between reader and writer of the schema.
The period start timestamp associated with the document security.
First included in: Sustainability/esg-data-model/DocumentPurpose (this entity)
Properties
Name
Value
displayName
Period Start Timestamp
description
The period start timestamp associated with the document security.
isPrimaryKey
true
dataFormat
dateTime
Traits
List of traits for the PeriodStartTimestamp 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
has.schemaObjectIdentifier
The schema object has an identifier, which is a string, specified as the parameter of the trait. It allows writers to define more identification values.
Parameter
Value
Data type
Explanation
identifier
"{51E2F02C-4E29-4810-9A58-6152A85E995D}"
string
The 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.
Parameter
Value
Data type
Explanation
localizedDisplayText
languageTag
displayText
en
Period Start Timestamp
entity
a 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.
Parameter
Value
Data type
Explanation
localizedDisplayText
languageTag
displayText
en
The period start timestamp associated with the document security.
entity
a reference to the constant entity holding the list of localized text
The period end timestamp associated with the document security.
First included in: Sustainability/esg-data-model/DocumentPurpose (this entity)
Properties
Name
Value
displayName
Period End Timestamp
description
The period end timestamp associated with the document security.
dataFormat
dateTime
isNullable
true
Traits
List of traits for the PeriodEndTimestamp 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 more identification values.
Parameter
Value
Data type
Explanation
identifier
"{F3D1EDF4-549D-44F9-A795-6A9F0DF94542}"
string
The 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.
Parameter
Value
Data type
Explanation
localizedDisplayText
languageTag
displayText
en
Period End Timestamp
entity
a 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.
Parameter
Value
Data type
Explanation
localizedDisplayText
languageTag
displayText
en
The period end timestamp associated with the document security.
entity
a reference to the constant entity holding the list of localized text
A note, comment, or more information regarding the document purpose.
First included in: Sustainability/esg-data-model/DocumentPurpose (this entity)
Properties
Name
Value
displayName
Document Purpose Note
description
A note, comment, or more information regarding the document purpose.
dataFormat
string
maximumLength
2048
isNullable
true
Traits
List of traits for the DocumentPurposeNote 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, and 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 more identification values.
Parameter
Value
Data type
Explanation
identifier
"{AD97BED2-1EBE-40E2-9010-6E9C8F56ACB2}"
string
The 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.
Parameter
Value
Data type
Explanation
localizedDisplayText
languageTag
displayText
en
Document Purpose Note
entity
a 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.
Parameter
Value
Data type
Explanation
localizedDisplayText
languageTag
displayText
en
A note, comment, or more information regarding the document purpose.
entity
a reference to the constant entity holding the list of localized text
is.constrained
maximum length or value constraints
Parameter
Value
Data type
Explanation
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, and Array of Byte is a Binary Object.