Document Type 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

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	languageTag displayText en Base entity from which all Industry Data Model entities are derived. en A categorization of document(s) based on common function, application or usage. Example: Account Statement Account Application Credit Review Credit Increase Request Credit Increase Authorization Account Suspension Notice Deposit Account Agreement Landlord Agreement Refund Credit Memo RFI RFP Order PO Invoice Building Permit Construction Permit Regulatory Operating Permit Complaint letter Marketing correspondence Non-disclosure Agreement Employment Contract Permanent Resident Care Social Security Card Cost justification Pricing Maintenance plan User Manual Engineering Specification Functional Design Audit Request Auditor Report Letter of Credit Performance Bond Power of Attorney Audit Request Auditor Report Letter of Credit Performance Bond Power of Attorney Regulatory Engineering Specification User Manual Functional Design Pricing where: Development agreement (DA) One of the range of agreements between governments and petroleum-resource developers is the DA or one of its variants - the Development and Fiscal Agreement (DFA) or the Development and Production Sharing Agreement (DPSA). Enabling agreement Provides the general terms and conditions for the purchase, sale, or exchange of LNG, pipeline gas and electricity, but does not list specific contract details. Environmental-impact assessment (EIA) An assessment of the impact of an industrial installation or activity on the surrounding environment, conducted before work on that activity has commenced. The original baseline study, a key part of this process, describes the original conditions. Financial-guarantee contract A contract that requires the issuer to make specified payments to reimburse the holder for a loss it incurs because a specified debtor fails to make payment when due in accordance with the original or modified terms of a debt instrument. Forward contract A commitment to buy (long) or sell (short) an underlying asset at a specified date at a price (known as the exercise or forward price) specified at the origination of the contract. Futures Contracts to buy or sell a commodity, such as gas, for a given price on a given date. Gas futures can usually be traded on a major exchange, such as NYMEX or ICE. Heads of agreement (HOA) A preliminary agreement covering the outline terms for the sale and purchase of LNG or natural gas. See Sales and purchase agreement (SPA) Long-term gas contract A supply contract in the physical market covering natural gas deliveries. Operational balancing agreements (OBAs) Agreements between pipelines and parties at delivery or receipt points, whereby the parties agree to specified procedures for balancing discrepancies between the nominated levels of service and the actual quantities. Operational-flow orders (OFOs) Orders that are issued by a pipeline to protect the operational integrity of the line. Production-sharing contract (PSC) Contract between a government and a company, granting the company a contractual right to explore and produce hydrocarbons in a specified area in enabling the company to recover its costs and a certain profit. Sales and purchase agreement (SPA) A definitive contract between a seller and buyer for the sale and purchase of a quantity of natural gas or LNG for delivery during a specified period at a specified price. See Annual delivery programme (ADP) and Heads of agreement (HOA). Transportation contract Contract setting forth the terms and conditions applicable to natural gas or electricity transportation services. Enabling agreement: provides the general terms and conditions for the purchase, sale, or exchange of LNG, pipeline gas and electricity, but does not list specific contract details. Heads of agreement (HOA): a preliminary agreement covering the outline terms for the sale and purchase of LNG or natural gas. See Sales and purchase agreement (SPA). Operational balancing agreements (OBAs): agreements between pipelines and parties at delivery or receipt points, whereby the parties agree to specified procedures for balancing discrepancies between the nominated levels of service and the actual quantities. Sales and purchase agreement (SPA): a definitive contract between a seller and buyer for the sale and purchase of a quantity of natural gas or LNG for delivery during a specified	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	DocumentType/(resolvedAttributes)/DocumentTypeId	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	"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.

Parameter	Value	Data type	Explanation
identifier	"{026218DC-C65A-4979-A616-12096EEBAD11}"	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 Type	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
DocumentTypeId	The unique identifier of a Document Type.	DocumentType
DocumentTypeName	The name of a Document Type.	DocumentType
DocumentTypeDescription	The description of a Document Type.	DocumentType
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.	DocumentType
DocumentTypeRetentionPeriod	The length of time that a document of a particular document type must be kept from the date that it was completed.	DocumentType
DocumentTypeRetentionPeriodUomId	The unique identifier of a Unit Of Measure.	DocumentType
DocumentTypeRetentionPeriodNote	A note, comment or additional information regarding the document type retention period.	DocumentType

DocumentTypeId

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

Properties

Name	Value
displayName	Document Type ID
description	The unique identifier of a Document Type.
isPrimaryKey	true
dataFormat	int32

Traits

List of traits for the DocumentTypeId attribute are listed here.

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

Parameter	Value	Data type	Explanation
attribute	DocumentType/(resolvedAttributes)/DocumentTypeId	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 other identification values.

Parameter	Value	Data type	Explanation
identifier	"{039D2DFB-71A5-4624-8E33-A0120B1A5EE4}"	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 Document 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 Type.	entity	a reference to the constant entity holding the list of localized text

is.dataFormat.integer

DocumentTypeName

The name of a Document Type.
First included in: DocumentType (this entity)

Properties

Name	Value
displayName	Document Type Name
description	The name of a Document Type.
dataFormat	string
maximumLength	256
isNullable	true

Traits

List of traits for the DocumentTypeName 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.

Parameter	Value	Data type	Explanation
identifier	"{01466378-BE73-4B20-A6D2-A59843BB7C74}"	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 Type Name	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 name of a Document Type.	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. Array of Byte is a Binary Object.

DocumentTypeDescription

The description of a Document Type.
First included in: DocumentType (this entity)

Properties

Name	Value
displayName	Document Type Description
description	The description of a Document Type.
dataFormat	string
maximumLength	2048
isNullable	true

Traits

List of traits for the DocumentTypeDescription 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.

Parameter	Value	Data type	Explanation
identifier	"{16F92E7D-0395-4A96-8BBA-04FC41D00557}"	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 Type Description	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 description of a Document Type.	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. 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: DocumentType (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. 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.

Parameter	Value	Data type	Explanation
identifier	"{1E39BF98-3D21-444C-B87F-F4950831E935}"	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 Global Document Type Identifier (GDTI)	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 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.	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. Array of Byte is a Binary Object.

DocumentTypeRetentionPeriod

The length of time that a document of a particular document type must be kept from the date that it was completed.
First included in: DocumentType (this entity)

Properties

Name	Value
displayName	Document Type Retention Period
description	The length of time that a document of a particular document type must be kept from the date that it was completed.
dataFormat	decimal
isNullable	true

Traits

List of traits for the DocumentTypeRetentionPeriod attribute are listed here.

is.dataFormat.numeric.shaped
for setting the exact precision and scale of numeric values

Parameter	Value	Data type	Explanation
precision	"3"	integer	the total number of significant digits
scale	"0"	integer	the number of digits to the right of the decimal place

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.

Parameter	Value	Data type	Explanation
identifier	"{0DF847E8-0047-40DC-ADBF-34F5771E496B}"	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 Type Retention Period	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 length of time that a document of a particular document type must be kept from the date that it was completed.	entity	a reference to the constant entity holding the list of localized text

is.dataFormat.numeric.shaped
for setting the exact precision and scale of numeric values

DocumentTypeRetentionPeriodUomId

The unique identifier of a Unit Of Measure.
First included in: DocumentType (this entity)

Properties

Name	Value
displayName	Document Type Retention Period UOM ID
description	The unique identifier of a Unit Of Measure.
dataFormat	int32
isNullable	true

Traits

List of traits for the DocumentTypeRetentionPeriodUomId 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	languageTag displayText en Document Type Retention Period UOM 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 Unit Of Measure.	entity	a reference to the constant entity holding the list of localized text

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.

Parameter	Value	Data type	Explanation
entityReferences	entityReference attributeReference UnitOfMeasure.cdm.json/UnitOfMeasure UnitOfMeasureId	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 other identification values.

Parameter	Value	Data type	Explanation
identifier	"{4C65C9EB-9F73-4909-A395-AFA5BBCAEECB}"	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

DocumentTypeRetentionPeriodNote

A note, comment or additional information regarding the document type retention period.
First included in: DocumentType (this entity)

Properties

Name	Value
displayName	Document Type Retention Period Note
description	A note, comment or additional information regarding the document type retention period.
dataFormat	string
maximumLength	2048
isNullable	true

Traits

List of traits for the DocumentTypeRetentionPeriodNote 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.

Parameter	Value	Data type	Explanation
identifier	"{0B0F826D-8061-4E49-BC23-F930B2803B78}"	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 Type Retention Period 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 additional information regarding the document type retention period.	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. Array of Byte is a Binary Object.