Identification Component 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 |
| 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 | IdentificationComponent/(resolvedAttributes)/IdentificationComponentId | 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 | "{C1CA0789-0271-41BF-8C58-2F078344F91A}" | 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 | "Party" | 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 |
|---|---|---|
| IdentificationId | The unique identifier of the identification. | IdentificationComponent |
| IdentificationComponentId | The unique identifier of the Identification Component. | IdentificationComponent |
| IdentificationComponentInstalledTimestamp | The timestamp the badge component was installed in the identification. | IdentificationComponent |
| IdentificationComponentRemovedTimestamp | The timestamp the badge component was removed from the identification. | IdentificationComponent |
| IdentificationComponentNote | A note, comment or additional information regarding the identification component. | IdentificationComponent |
| IdentificationComponentTypeId | The unique identifier of an Identification Component Type. | IdentificationComponent |
| IrTagId | The unique identifier of an IR Tag.The transmitter/receiver pair or transceiver plus the information storage mechanism attached to the object is referred to as the tag, transponder, electronic label, code plate and various other terms. Although transponder is technically the most accurate, the most common term and the one preferred by the Automatic Identification Manufacturers is tag. | IdentificationComponent |
| RfidTagId | The unique identifier of a RFID Tag.The transmitter/receiver pair or transceiver plus the information storage mechanism attached to the object is referred to as the tag, transponder, electronic label, code plate and various other terms. Although transponder is technically the most accurate, the most common term and the one preferred by the Automatic Identification Manufacturers is tag. | IdentificationComponent |
| BarCodeId | The unique identifier of a Bar Code. | IdentificationComponent |
| RadiationDetectionDeviceId | The unique identifier of a Radiation Detection Device. | IdentificationComponent |
| PhotographId | The unique identifier of a photograph. | IdentificationComponent |
IdentificationId
The unique identifier of the identification.
First included in: IdentificationComponent (this entity)
Properties
| Name | Value |
|---|---|
| displayName | Identification ID |
| description | The unique identifier of the identification. |
| isPrimaryKey | true |
| dataFormat | int32 |
Traits
List of traits for the IdentificationId 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 | IdentificationComponent/(resolvedAttributes)/IdentificationId | attribute |
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 |
| entity | 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 |
| 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 |
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 | "{985E18C8-E53C-4EEF-86EC-8ACB433D907D}" | 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
IdentificationComponentId
The unique identifier of the Identification Component.
First included in: IdentificationComponent (this entity)
Properties
| Name | Value |
|---|---|
| displayName | Identification Component ID |
| description | The unique identifier of the Identification Component. |
| isPrimaryKey | true |
| dataFormat | int64 |
Traits
List of traits for the IdentificationComponentId 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 | IdentificationComponent/(resolvedAttributes)/IdentificationComponentId | 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 | "{1B24BA39-303F-422A-8B8A-F361D1281181}" | 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.
IdentificationComponentInstalledTimestamp
The timestamp the badge component was installed in the identification.
First included in: IdentificationComponent (this entity)
Properties
| Name | Value |
|---|---|
| displayName | Identification Component Installed Timestamp |
| description | The timestamp the badge component was installed in the identification. |
| dataFormat | dateTime |
| isNullable | true |
Traits
List of traits for the IdentificationComponentInstalledTimestamp attribute are listed here.
is.dataFormat.date
means.measurement.date
is.dataFormat.time
means.measurement.time
has.schemaObjectIdentifier
The schema object has an identifier, which is a string, specified as the parameter of the trait. It allows writers to define other identification values.
| Parameter | Value | Data type | Explanation |
|---|---|---|---|
| identifier | "{9AAD90B4-41F7-418F-AE6E-3A36EB30772A}" | 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
IdentificationComponentRemovedTimestamp
The timestamp the badge component was removed from the identification.
First included in: IdentificationComponent (this entity)
Properties
| Name | Value |
|---|---|
| displayName | Identification Component Removed Timestamp |
| description | The timestamp the badge component was removed from the identification. |
| dataFormat | dateTime |
| isNullable | true |
Traits
List of traits for the IdentificationComponentRemovedTimestamp attribute are listed here.
is.dataFormat.date
means.measurement.date
is.dataFormat.time
means.measurement.time
has.schemaObjectIdentifier
The schema object has an identifier, which is a string, specified as the parameter of the trait. It allows writers to define other identification values.
| Parameter | Value | Data type | Explanation |
|---|---|---|---|
| identifier | "{49D8EF3D-2754-4258-8484-5111008E5E2B}" | 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
IdentificationComponentNote
A note, comment or additional information regarding the identification component.
First included in: IdentificationComponent (this entity)
Properties
| Name | Value |
|---|---|
| displayName | Identification Component Note |
| description | A note, comment or additional information regarding the identification component. |
| dataFormat | string |
| maximumLength | 2048 |
| isNullable | true |
Traits
List of traits for the IdentificationComponentNote 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 | "{25437B87-1F64-4B9D-BD37-2EAF310D8E92}" | 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. Array of Byte is a Binary Object.
IdentificationComponentTypeId
The unique identifier of an Identification Component Type.
First included in: IdentificationComponent (this entity)
Properties
| Name | Value |
|---|---|
| displayName | Identification Component Type ID |
| description | The unique identifier of an Identification Component Type. |
| dataFormat | int32 |
| isNullable | true |
Traits
List of traits for the IdentificationComponentTypeId 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 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 |
| 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 | "{66D0B6AD-1F7F-4434-B99D-05951566F26E}" | 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
IrTagId
The unique identifier of an IR Tag.
The transmitter/receiver pair or transceiver plus the information storage mechanism attached to the object is referred to as the tag, transponder, electronic label, code plate and various other terms.
Although transponder is technically the most accurate, the most common term and the one preferred by the Automatic Identification Manufacturers is tag.
First included in: IdentificationComponent (this entity)
Properties
| Name | Value |
|---|---|
| displayName | IR Tag ID |
| description | The unique identifier of an IR Tag.
The transmitter/receiver pair or transceiver plus the information storage mechanism attached to the object is referred to as the tag, transponder, electronic label, code plate and various other terms. Although transponder is technically the most accurate, the most common term and the one preferred by the Automatic Identification Manufacturers is tag. |
| dataFormat | int32 |
| isNullable | true |
Traits
List of traits for the IrTagId 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 other identification values.
| Parameter | Value | Data type | Explanation |
|---|---|---|---|
| identifier | "{776B1B66-7313-44A2-A47C-69CCD85C66D5}" | 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
RfidTagId
The unique identifier of a RFID Tag.
The transmitter/receiver pair or transceiver plus the information storage mechanism attached to the object is referred to as the tag, transponder, electronic label, code plate and various other terms.
Although transponder is technically the most accurate, the most common term and the one preferred by the Automatic Identification Manufacturers is tag.
First included in: IdentificationComponent (this entity)
Properties
| Name | Value |
|---|---|
| displayName | RFID Tag ID |
| description | The unique identifier of a RFID Tag.
The transmitter/receiver pair or transceiver plus the information storage mechanism attached to the object is referred to as the tag, transponder, electronic label, code plate and various other terms. Although transponder is technically the most accurate, the most common term and the one preferred by the Automatic Identification Manufacturers is tag. |
| dataFormat | int32 |
| isNullable | true |
Traits
List of traits for the RfidTagId 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 other identification values.
| Parameter | Value | Data type | Explanation |
|---|---|---|---|
| identifier | "{12D72B3C-3982-4F9D-9AA6-1267D57834E9}" | 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
BarCodeId
The unique identifier of a Bar Code.
First included in: IdentificationComponent (this entity)
Properties
| Name | Value |
|---|---|
| displayName | Bar Code ID |
| description | The unique identifier of a Bar Code. |
| dataFormat | int32 |
| isNullable | true |
Traits
List of traits for the BarCodeId 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 other identification values.
| Parameter | Value | Data type | Explanation |
|---|---|---|---|
| identifier | "{247A62A6-1534-4E0E-8140-7DC8851B7053}" | 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
RadiationDetectionDeviceId
The unique identifier of a Radiation Detection Device.
First included in: IdentificationComponent (this entity)
Properties
| Name | Value |
|---|---|
| displayName | Radiation Detection Device ID |
| description | The unique identifier of a Radiation Detection Device. |
| dataFormat | int32 |
| isNullable | true |
Traits
List of traits for the RadiationDetectionDeviceId 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 other identification values.
| Parameter | Value | Data type | Explanation |
|---|---|---|---|
| identifier | "{5397038B-EC78-49D4-9211-7F5170F92F2E}" | 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
PhotographId
The unique identifier of a photograph.
First included in: IdentificationComponent (this entity)
Properties
| Name | Value |
|---|---|
| displayName | Photograph ID |
| description | The unique identifier of a photograph. |
| dataFormat | int32 |
| isNullable | true |
Traits
List of traits for the PhotographId 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 other identification values.
| Parameter | Value | Data type | Explanation |
|---|---|---|---|
| identifier | "{82612211-18E5-4754-8BD2-249A9473F362}" | 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