Document in ESG data model
Traits
Traits for this entity are listed here.
is.CDM.entityVersion
Parameter | Value | Data type | Explanation |
---|---|---|---|
versionNumber | "4.3" | string | semantic version number of the entity |
is.localized.describedAs
Holds the list of language specific descriptive text for an object.
Parameter | Value | Data type | Explanation | ||||||
---|---|---|---|---|---|---|---|---|---|
localizedDisplayText |
| entity | a reference to the constant entity holding the list of localized text |
is.identifiedBy
names a specific identity attribute to use with an entity
Parameter | Value | Data type | Explanation |
---|---|---|---|
attribute | Document/(resolvedAttributes)/DocumentId | attribute |
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 | "{22B69F7E-CB29-490F-AB49-AE63672B469D}" | 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 |
| 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.
Parameter | Value | Data type | Explanation |
---|---|---|---|
level | "resolved" | string | Possible values: logical, composition, resolved |
Attributes
Name | Description | First Included in Instance |
---|---|---|
DocumentId | The unique identifier of a Document. | Sustainability/esg-data-model/Document |
DocumentName | The name of the Document. | Sustainability/esg-data-model/Document |
DocumentDescription | The description of the Document. | Sustainability/esg-data-model/Document |
GlobalDocumentTypeIdentifier | The Global Document Type Identifier (GDTI) is part of the GS1 system of standards. It's used to identify a document by type or specifically as required. | Sustainability/esg-data-model/Document |
DocumentScopeStatement | The scope of the document. | Sustainability/esg-data-model/Document |
DocumentRevisionNumber | The revision number of the associated document. | Sustainability/esg-data-model/Document |
DocumentCreatedTimestamp | The timestamp that the Document was created. | Sustainability/esg-data-model/Document |
DocumentCompletedTimestamp | The timestamp that the document was completed. | Sustainability/esg-data-model/Document |
DocumentFiledTimestamp | The timestamp that the document was filed. | Sustainability/esg-data-model/Document |
DocumentFirstPublishedTimestamp | The timestamp that the document was first published. | Sustainability/esg-data-model/Document |
DocumentMinimumRetentionTimestamp | The timestamp that a document must be retained until. This is typically the earliest timestamp that a document can be deleted and in many cases the timestamp that the document should be deleted. | Sustainability/esg-data-model/Document |
DocumentCopyrightTimestamp | The document copyright timestamp. | Sustainability/esg-data-model/Document |
DocumentDeletedTimestamp | The timestamp that the Document was deleted. Once a document is deleted all data associated with the document, attributes of the document (including Document Image) and related entities may be deleted. | Sustainability/esg-data-model/Document |
DocumentImage | The image or text of the document (scanned). | Sustainability/esg-data-model/Document |
DocumentText | The text of the document. | Sustainability/esg-data-model/Document |
DocumentNote | A note, comment, or more information regarding the Document. | Sustainability/esg-data-model/Document |
NumberOfPages | The number of document pages. | Sustainability/esg-data-model/Document |
PageSize | The size of the document pages. | Sustainability/esg-data-model/Document |
DocumentUrl | The URL at which the document is located. | Sustainability/esg-data-model/Document |
IsoLanguageId | The unique identifier of an ISO Language. | Sustainability/esg-data-model/Document |
DeliveryMethodId | The unique identifier of a document delivery method. | Sustainability/esg-data-model/Document |
DocumentFormatTypeId | The unique identifier of a document format type. | Sustainability/esg-data-model/Document |
DocumentTypeId | The unique identifier of a Document Type. | Sustainability/esg-data-model/Document |
MediaTypeId | The unique identifier of a Media Type. | Sustainability/esg-data-model/Document |
CountryId | The unique identifier of the Country. | Sustainability/esg-data-model/Document |
StateId | The unique identifier of a State. | Sustainability/esg-data-model/Document |
IdentificationId | The unique identifier of the identification. | Sustainability/esg-data-model/Document |
DocumentVersion | The identifier that is used to identify this version of the activity definition when it is referenced in a specification, model, design or instance. This is an arbitrary value managed by the activity definition author and is not expected to be globally unique. For example, it might be a timestamp (yyyymmdd.hhmmsss) if a managed version is not available. There's also no expectation that versions can be placed in a lexicographical sequence. To provide a version consistent with the Decision Support Service specification, use the format Major.Minor.Revision. Note that a version is required for non-experimental active assets. | Sustainability/esg-data-model/Document |
DocumentId
The unique identifier of a Document. First included in: Sustainability/esg-data-model/Document (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
Parameter | Value | Data type | Explanation |
---|---|---|---|
attribute | Document/(resolvedAttributes)/DocumentId | attribute |
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 | "{01881F46-7F19-4632-9D58-40EF72A33662}" | 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 |
| 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 |
| entity | a reference to the constant entity holding the list of localized text |
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.
DocumentName
The name of the Document. First included in: Sustainability/esg-data-model/Document (this entity)
Properties
Name | Value |
---|---|
displayName | Document Name |
description | The name of the Document. |
dataFormat | string |
maximumLength | 256 |
isNullable | true |
Traits
List of traits for the DocumentName 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 | "{025F6E5B-B75D-4E06-B3F8-7FDA0FAF7A91}" | 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 |
| 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 |
| 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 | "256" | 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.
DocumentDescription
The description of the Document. First included in: Sustainability/esg-data-model/Document (this entity)
Properties
Name | Value |
---|---|
displayName | Document Description |
description | The description of the Document. |
dataFormat | string |
maximumLength | 2048 |
isNullable | true |
Traits
List of traits for the DocumentDescription 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 | "{0226D022-C8B1-48AA-9945-27DEF11DF2BF}" | 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 |
| 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 |
| 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.
GlobalDocumentTypeIdentifier
The Global Document Type Identifier (GDTI) is part of the GS1 system of standards. It's used to identify a document by type or specifically as required. First included in: Sustainability/esg-data-model/Document (this entity)
Properties
Name | Value |
---|---|
displayName | Global Document Type Identifier (GDTI) |
description | The Global Document Type Identifier (GDTI) is part of the GS1 system of standards. It's used to identify a document by type or specifically as required. |
dataFormat | string |
maximumLength | 30 |
isNullable | true |
Traits
List of traits for the GlobalDocumentTypeIdentifier 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 | "{1A96D6C0-C53B-492F-8A25-41764E15A988}" | 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 |
| 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 |
| 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 | "30" | 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.
DocumentScopeStatement
The scope of the document. First included in: Sustainability/esg-data-model/Document (this entity)
Properties
Name | Value |
---|---|
displayName | Document Scope Statement |
description | The scope of the document. |
dataFormat | string |
maximumLength | 2048 |
isNullable | true |
Traits
List of traits for the DocumentScopeStatement 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 | "{00C2621C-919D-4109-9462-D0E87A3672B8}" | 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 |
| 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 |
| 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.
DocumentRevisionNumber
The revision number of the associated document. First included in: Sustainability/esg-data-model/Document (this entity)
Properties
Name | Value |
---|---|
displayName | Document Revision Number |
description | The revision number of the associated document. |
dataFormat | int32 |
isNullable | true |
Traits
List of traits for the DocumentRevisionNumber attribute are listed here.
is.dataFormat.integer
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 | "{04EF3ABA-137B-44C2-AE44-C1C92AA8672E}" | 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 |
| 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 |
| entity | a reference to the constant entity holding the list of localized text |
is.dataFormat.integer
DocumentCreatedTimestamp
The timestamp that the Document was created. First included in: Sustainability/esg-data-model/Document (this entity)
Properties
Name | Value |
---|---|
displayName | Document Created Timestamp |
description | The timestamp that the Document was created. |
dataFormat | dateTime |
isNullable | true |
Traits
List of traits for the DocumentCreatedTimestamp 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 | "{0B06B6A9-1FF2-4DC4-998E-D68B46DA5CDE}" | 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 |
| 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 |
| entity | a reference to the constant entity holding the list of localized text |
is.dataFormat.time
is.dataFormat.date
DocumentCompletedTimestamp
The timestamp that the document was completed. First included in: Sustainability/esg-data-model/Document (this entity)
Properties
Name | Value |
---|---|
displayName | Document Completed Timestamp |
description | The timestamp that the document was completed. |
dataFormat | dateTime |
isNullable | true |
Traits
List of traits for the DocumentCompletedTimestamp 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 | "{0384E412-878C-423F-A257-C8873DBDB3B1}" | 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 |
| 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 |
| entity | a reference to the constant entity holding the list of localized text |
is.dataFormat.time
is.dataFormat.date
DocumentFiledTimestamp
The timestamp that the document was filed. First included in: Sustainability/esg-data-model/Document (this entity)
Properties
Name | Value |
---|---|
displayName | Document Filed Timestamp |
description | The timestamp that the document was filed. |
dataFormat | dateTime |
isNullable | true |
Traits
List of traits for the DocumentFiledTimestamp 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 | "{3F2CA3E0-72A9-44D1-9D54-880F29118F67}" | 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 |
| 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 |
| entity | a reference to the constant entity holding the list of localized text |
is.dataFormat.time
is.dataFormat.date
DocumentFirstPublishedTimestamp
The timestamp that the document was first published. First included in: Sustainability/esg-data-model/Document (this entity)
Properties
Name | Value |
---|---|
displayName | Document First Published Timestamp |
description | The timestamp that the document was first published. |
dataFormat | dateTime |
isNullable | true |
Traits
List of traits for the DocumentFirstPublishedTimestamp 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 | "{028E5533-9FF8-4E86-B1ED-259DDE05C8FF}" | 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 |
| 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 |
| entity | a reference to the constant entity holding the list of localized text |
is.dataFormat.time
is.dataFormat.date
DocumentMinimumRetentionTimestamp
The timestamp that a document must be retained until. This is typically the earliest timestamp that a document can be deleted and in many cases the timestamp that the document should be deleted. First included in: Sustainability/esg-data-model/Document (this entity)
Properties
Name | Value |
---|---|
displayName | Document Minimum Retention Timestamp |
description | The timestamp that a document must be retained until. This is typically the earliest timestamp that a document can be deleted and in many cases the timestamp that the document should be deleted. |
dataFormat | dateTime |
isNullable | true |
Traits
List of traits for the DocumentMinimumRetentionTimestamp 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 | "{06568B09-E7ED-424F-BF61-AB346D5FC1D6}" | 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 |
| 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 |
| entity | a reference to the constant entity holding the list of localized text |
is.dataFormat.time
is.dataFormat.date
DocumentCopyrightTimestamp
The document copyright timestamp. First included in: Sustainability/esg-data-model/Document (this entity)
Properties
Name | Value |
---|---|
displayName | Document Copyright Timestamp |
description | The document copyright timestamp. |
dataFormat | dateTime |
isNullable | true |
Traits
List of traits for the DocumentCopyrightTimestamp 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 | "{07B81F49-42A8-4F70-940F-3E5B4818AA05}" | 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 |
| 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 |
| entity | a reference to the constant entity holding the list of localized text |
is.dataFormat.time
is.dataFormat.date
DocumentDeletedTimestamp
The timestamp that the Document was deleted. Once a document is deleted all data associated with the document, attributes of the document (including Document Image) and related entities may be deleted. First included in: Sustainability/esg-data-model/Document (this entity)
Properties
Name | Value |
---|---|
displayName | Document Deleted Timestamp |
description | The timestamp that the Document was deleted. Once a document is deleted all data associated with the document, attributes of the document (including Document Image) and related entities may be deleted. |
dataFormat | dateTime |
isNullable | true |
Traits
List of traits for the DocumentDeletedTimestamp 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 | "{0BD04025-D8F9-4857-B32C-A3A8DB842CF0}" | 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 |
| 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 |
| entity | a reference to the constant entity holding the list of localized text |
is.dataFormat.time
is.dataFormat.date
DocumentImage
The image or text of the document (scanned). First included in: Sustainability/esg-data-model/Document (this entity)
Properties
Name | Value |
---|---|
displayName | Document Image |
description | The image or text of the document (scanned). |
dataFormat | binary |
isNullable | true |
Traits
List of traits for the DocumentImage attribute are listed here.
is.dataFormat.byte
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 | "{0A8FBE27-2C2C-4678-9790-7FBE76A0291F}" | 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 |
| 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 |
| entity | a reference to the constant entity holding the list of localized text |
is.dataFormat.byte
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.
DocumentText
The text of the document. First included in: Sustainability/esg-data-model/Document (this entity)
Properties
Name | Value |
---|---|
displayName | Document Text |
description | The text of the document. |
dataFormat | string |
maximumLength | 2048 |
isNullable | true |
Traits
List of traits for the DocumentText 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 | "{04AE512E-F9F3-4A5A-A5E1-4A916EE66020}" | 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 |
| 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 |
| 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.
DocumentNote
A note, comment, or more information regarding the Document. First included in: Sustainability/esg-data-model/Document (this entity)
Properties
Name | Value |
---|---|
displayName | Document Note |
description | A note, comment, or more information regarding the Document. |
dataFormat | string |
maximumLength | 2048 |
isNullable | true |
Traits
List of traits for the DocumentNote 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 | "{000F7730-B3D3-40F2-950C-E1207ABDCC83}" | 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 |
| 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 |
| 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.
NumberOfPages
The number of document pages. First included in: Sustainability/esg-data-model/Document (this entity)
Properties
Name | Value |
---|---|
displayName | Number Of Pages |
description | The number of document pages. |
dataFormat | int32 |
isNullable | true |
Traits
List of traits for the NumberOfPages attribute are listed here.
is.dataFormat.integer
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 | "{21C4C9D7-A058-4154-BB11-C7EE6E5329B2}" | 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 |
| 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 |
| entity | a reference to the constant entity holding the list of localized text |
is.dataFormat.integer
PageSize
The size of the document pages. First included in: Sustainability/esg-data-model/Document (this entity)
Properties
Name | Value |
---|---|
displayName | Page Size |
description | The size of the document pages. |
dataFormat | string |
maximumLength | 2048 |
isNullable | true |
Traits
List of traits for the PageSize 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 | "{0F8957C3-6A83-482D-A2F3-3B77277AD622}" | 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 |
| 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 |
| 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.
DocumentUrl
The URL at which the document is located. First included in: Sustainability/esg-data-model/Document (this entity)
Properties
Name | Value |
---|---|
displayName | Document URL |
description | The URL at which the document is located. |
dataFormat | string |
maximumLength | 2083 |
isNullable | true |
Traits
List of traits for the DocumentUrl 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 | "{07EBF8CF-FF6B-43E1-A6F2-0E75A84BB163}" | 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 |
| 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 |
| 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 | "2083" | 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.
IsoLanguageId
The unique identifier of an ISO Language. First included in: Sustainability/esg-data-model/Document (this entity)
Properties
Name | Value |
---|---|
displayName | ISO Language ID |
description | The unique identifier of an ISO Language. |
dataFormat | int32 |
isNullable | true |
Traits
List of traits for the IsoLanguageId attribute are listed here.
is.dataFormat.integer
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 |
| 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 |
| entity | a reference to the constant entity holding the list of localized text |
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.
Parameter | Value | Data type | Explanation | ||||
---|---|---|---|---|---|---|---|
entityReferences |
| entity | a reference to the constant entity holding the list of entity references |
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 | "{15FCB4F5-1428-4E93-8EC5-1D73C0C01A6D}" | 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
DeliveryMethodId
The unique identifier of a document delivery method. First included in: Sustainability/esg-data-model/Document (this entity)
Properties
Name | Value |
---|---|
displayName | Delivery Method ID |
description | The unique identifier of a document delivery method. |
dataFormat | int32 |
isNullable | true |
Traits
List of traits for the DeliveryMethodId attribute are listed here.
is.dataFormat.integer
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 | "{20997A7C-F742-465D-8340-AA2B5666D6C7}" | 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 |
| 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 |
| entity | a reference to the constant entity holding the list of localized text |
is.dataFormat.integer
DocumentFormatTypeId
The unique identifier of a document format type. First included in: Sustainability/esg-data-model/Document (this entity)
Properties
Name | Value |
---|---|
displayName | Document Format Type ID |
description | The unique identifier of a document format type. |
dataFormat | int32 |
isNullable | true |
Traits
List of traits for the DocumentFormatTypeId attribute are listed here.
is.dataFormat.integer
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 | "{05E0AA02-9E4B-4276-9B87-118AC6FCF984}" | 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 |
| 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 |
| entity | a reference to the constant entity holding the list of localized text |
is.dataFormat.integer
DocumentTypeId
The unique identifier of a Document Type. First included in: Sustainability/esg-data-model/Document (this entity)
Properties
Name | Value |
---|---|
displayName | Document Type ID |
description | The unique identifier of a Document Type. |
dataFormat | int32 |
isNullable | true |
Traits
List of traits for the DocumentTypeId attribute are listed here.
is.dataFormat.integer
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 |
| 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 |
| entity | a reference to the constant entity holding the list of localized text |
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.
Parameter | Value | Data type | Explanation | ||||
---|---|---|---|---|---|---|---|
entityReferences |
| entity | a reference to the constant entity holding the list of entity references |
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 | "{1602E928-0802-41D9-ADB9-291D2CD5A2DA}" | 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
MediaTypeId
The unique identifier of a Media Type. First included in: Sustainability/esg-data-model/Document (this entity)
Properties
Name | Value |
---|---|
displayName | Media Type ID |
description | The unique identifier of a Media Type. |
dataFormat | int32 |
isNullable | true |
Traits
List of traits for the MediaTypeId attribute are listed here.
is.dataFormat.integer
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 | "{0BE9D16F-5D96-4147-A127-AD4B4503C877}" | 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 |
| 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 |
| entity | a reference to the constant entity holding the list of localized text |
is.dataFormat.integer
CountryId
The unique identifier of the Country. First included in: Sustainability/esg-data-model/Document (this entity)
Properties
Name | Value |
---|---|
displayName | Country ID |
description | The unique identifier of the Country. |
dataFormat | int32 |
isNullable | true |
Traits
List of traits for the CountryId attribute are listed here.
is.dataFormat.integer
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 |
| 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 |
| entity | a reference to the constant entity holding the list of localized text |
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.
Parameter | Value | Data type | Explanation | ||||
---|---|---|---|---|---|---|---|
entityReferences |
| entity | a reference to the constant entity holding the list of entity references |
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 | "{0611A9A8-C941-4D88-9D7C-B113CB1F7E98}" | 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
StateId
The unique identifier of a State. First included in: Sustainability/esg-data-model/Document (this entity)
Properties
Name | Value |
---|---|
displayName | State ID |
description | The unique identifier of a State. |
dataFormat | int32 |
isNullable | true |
Traits
List of traits for the StateId attribute are listed here.
is.dataFormat.integer
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 | "{019AFD54-8E2B-434D-940C-B73D96F9D5B0}" | 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 |
| 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 |
| entity | a reference to the constant entity holding the list of localized text |
is.dataFormat.integer
IdentificationId
The unique identifier of the identification. First included in: Sustainability/esg-data-model/Document (this entity)
Properties
Name | Value |
---|---|
displayName | Identification ID |
description | The unique identifier of the identification. |
dataFormat | int32 |
isNullable | true |
Traits
List of traits for the IdentificationId attribute are listed here.
is.dataFormat.integer
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 |
| 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 |
| entity | a reference to the constant entity holding the list of localized text |
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.
Parameter | Value | Data type | Explanation | ||||
---|---|---|---|---|---|---|---|
entityReferences |
| entity | a reference to the constant entity holding the list of entity references |
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 | "{238D5E01-A15C-40E7-84F9-C6FA675EB0DA}" | 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
DocumentVersion
The identifier that is used to identify this version of the activity definition when it is referenced in a specification, model, design or instance. This is an arbitrary value managed by the activity definition author and is not expected to be globally unique. For example, it might be a timestamp (yyyymmdd.hhmmsss) if a managed version is not available. There's also no expectation that versions can be placed in a lexicographical sequence. To provide a version consistent with the Decision Support Service specification, use the format Major.Minor.Revision. Note that a version is required for non-experimental active assets. First included in: Sustainability/esg-data-model/Document (this entity)
Properties
Name | Value |
---|---|
displayName | Document Version |
description | The identifier that is used to identify this version of the activity definition when it is referenced in a specification, model, design or instance. This is an arbitrary value managed by the activity definition author and is not expected to be globally unique. For example, it might be a timestamp (yyyymmdd.hhmmsss) if a managed version is not available. There's also no expectation that versions can be placed in a lexicographical sequence. To provide a version consistent with the Decision Support Service specification, use the format Major.Minor.Revision. Note that a version is required for non-experimental active assets. |
dataFormat | string |
maximumLength | 2048 |
isNullable | true |
Traits
List of traits for the DocumentVersion 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 | "{02F69F78-F1D7-4A06-804C-0435256CB7B5}" | 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 |
| 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 |
| 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.