Identification Form in ESG data model

Traits

Traits for this entity are listed here.

is.CDM.entityVersion

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

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

ParameterValueData typeExplanation
localizedDisplayText
languageTagdisplayText
enBase entity from which all ESG Data Model entities are derived.
enThe form of identification.

Ex:

  • Card
  • Paper Wristband
  • PVC Wristband
  • FOB
  • Lanyard
  • Jewelry
  • Intangible (Identification Number issued but no physical form)
entitya reference to the constant entity holding the list of localized text

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

ParameterValueData typeExplanation
attributeIdentificationForm/(resolvedAttributes)/IdentificationFormIdattribute

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

ParameterValueData typeExplanation
versionNumber"1.2.3"string

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

ParameterValueData typeExplanation
versionNumber"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.

ParameterValueData typeExplanation
identifier"{46B0FA8A-BF34-427A-992D-67CE29B4F352}"stringThe identifier for the schema object. There's no uniqueness guarantee enforced by CDM. It's a contract between reader and writer of the schema.

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

ParameterValueData typeExplanation
name"Party"string

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

ParameterValueData typeExplanation
localizedDisplayText
languageTagdisplayText
enIdentification Form
entitya reference to the constant entity holding the list of localized text

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

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

Attributes

Name Description First Included in Instance
IdentificationFormId The unique identifier of an Identification Form. Sustainability/esg-data-model/IdentificationForm
IdentificationFormName The name of an Identification Form. Sustainability/esg-data-model/IdentificationForm
IdentificationFormDescription The description of an Identification Form. Sustainability/esg-data-model/IdentificationForm

IdentificationFormId

The unique identifier of an Identification Form. First included in: Sustainability/esg-data-model/IdentificationForm (this entity)

Properties

NameValue
displayNameIdentification Form ID
descriptionThe unique identifier of an Identification Form.
isPrimaryKeytrue
dataFormatint32

Traits

List of traits for the IdentificationFormId attribute are listed here.

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

ParameterValueData typeExplanation
attributeIdentificationForm/(resolvedAttributes)/IdentificationFormIdattribute

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.

ParameterValueData typeExplanation
identifier"{5EDC8DFD-9CC5-4C85-868B-B08553EFF87A}"stringThe identifier for the schema object. There's no uniqueness guarantee enforced by CDM. It's a contract between reader and writer of the schema.

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

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

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

ParameterValueData typeExplanation
localizedDisplayText
languageTagdisplayText
enThe unique identifier of an Identification Form.
entitya reference to the constant entity holding the list of localized text

is.dataFormat.integer

IdentificationFormName

The name of an Identification Form. First included in: Sustainability/esg-data-model/IdentificationForm (this entity)

Properties

NameValue
displayNameIdentification Form Name
descriptionThe name of an Identification Form.
dataFormatstring
maximumLength256
isNullabletrue

Traits

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

ParameterValueData typeExplanation
identifier"{44F051A5-2E31-4120-B365-FFF871C617A1}"stringThe identifier for the schema object. There's no uniqueness guarantee enforced by CDM. It's a contract between reader and writer of the schema.

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

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

ParameterValueData typeExplanation
localizedDisplayText
languageTagdisplayText
enIdentification Form Name
entitya reference to the constant entity holding the list of localized text

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

ParameterValueData typeExplanation
localizedDisplayText
languageTagdisplayText
enThe name of an Identification Form.
entitya reference to the constant entity holding the list of localized text

is.constrained
maximum length or value constraints

ParameterValueData typeExplanation
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.

IdentificationFormDescription

The description of an Identification Form. First included in: Sustainability/esg-data-model/IdentificationForm (this entity)

Properties

NameValue
displayNameIdentification Form Description
descriptionThe description of an Identification Form.
dataFormatstring
maximumLength2048
isNullabletrue

Traits

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

ParameterValueData typeExplanation
identifier"{18E894AE-E78D-4FA8-B542-4F85E3C857D6}"stringThe identifier for the schema object. There's no uniqueness guarantee enforced by CDM. It's a contract between reader and writer of the schema.

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

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

ParameterValueData typeExplanation
localizedDisplayText
languageTagdisplayText
enIdentification Form Description
entitya reference to the constant entity holding the list of localized text

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

ParameterValueData typeExplanation
localizedDisplayText
languageTagdisplayText
enThe description of an Identification Form.
entitya reference to the constant entity holding the list of localized text

is.constrained
maximum length or value constraints

ParameterValueData typeExplanation
maximumLength"2048"integer

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