Survey in ESG data model
Traits
Traits for this entity are listed below.
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 | Survey/(resolvedAttributes)/SurveyId | 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 | "{103685C9-C4E8-4F1F-94A5-5F2B951E3001}" | 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 | "Customer Service & Contact 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 |
---|---|---|
SurveyId | The unique identifier of a Survey. | Sustainability/esg-data-model/Survey |
SurveyStartDate | The "period" start date of the Survey. | Sustainability/esg-data-model/Survey |
SurveyEndDate | The "period" end date of the Survey. | Sustainability/esg-data-model/Survey |
SurveyName | The name of the Survey. | Sustainability/esg-data-model/Survey |
SurveyDescription | The description of the Survey.This would also be a good place to describe the objectives to be addressed by the Survey and detail measurement parameters that apply to the Survey. | Sustainability/esg-data-model/Survey |
SurveyNote | A comment, note or description regarding the Survey, | Sustainability/esg-data-model/Survey |
SurveyTypeId | The unique identifier of a Survey Type. | Sustainability/esg-data-model/Survey |
SurveyId
The unique identifier of a Survey. First included in: Sustainability/esg-data-model/Survey (this entity)
Properties
Name | Value |
---|---|
displayName | Survey ID |
description | The unique identifier of a Survey. |
isPrimaryKey | true |
dataFormat | int32 |
Traits
List of traits for the SurveyId attribute are listed below.
is.dataFormat.integer
is.identifiedBy
names a specific identity attribute to use with an entity
Parameter | Value | Data type | Explanation |
---|---|---|---|
attribute | Survey/(resolvedAttributes)/SurveyId | 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 | "{2B345B13-B7B4-420F-8A92-ADC7E6C17327}" | 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
SurveyStartDate
The "period" start date of the Survey. First included in: Sustainability/esg-data-model/Survey (this entity)
Properties
Name | Value |
---|---|
displayName | Survey Start Date |
description | The "period" start date of the Survey. |
dataFormat | date |
isNullable | true |
Traits
List of traits for the SurveyStartDate attribute are listed below.
is.dataFormat.date
means.measurement.date
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 | "{028AAB6D-3CFD-4757-8EBB-A3D2349769DE}" | 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.date
SurveyEndDate
The "period" end date of the Survey. First included in: Sustainability/esg-data-model/Survey (this entity)
Properties
Name | Value |
---|---|
displayName | Survey End Date |
description | The "period" end date of the Survey. |
dataFormat | date |
isNullable | true |
Traits
List of traits for the SurveyEndDate attribute are listed below.
is.dataFormat.date
means.measurement.date
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 | "{1400C0B4-3EBC-41BE-B9D6-FA4BBD3FA191}" | 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.date
SurveyName
The name of the Survey. First included in: Sustainability/esg-data-model/Survey (this entity)
Properties
Name | Value |
---|---|
displayName | Survey Name |
description | The name of the Survey. |
dataFormat | string |
maximumLength | 256 |
isNullable | true |
Traits
List of traits for the SurveyName attribute are listed below.
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 | "{0235A597-F882-4125-9C5D-455D55AAD23D}" | 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.
SurveyDescription
The description of the Survey.
This would also be a good place to describe the objectives to be addressed by the Survey and detail measurement parameters that apply to the Survey. First included in: Sustainability/esg-data-model/Survey (this entity)
Properties
Name | Value |
---|---|
displayName | Survey Description |
description | The description of the Survey.
This would also be a good place to describe the objectives to be addressed by the Survey and detail measurement parameters that apply to the Survey. |
dataFormat | string |
maximumLength | 2048 |
isNullable | true |
Traits
List of traits for the SurveyDescription attribute are listed below.
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 | "{5F9FB91C-7BC2-4A79-B0E5-FDF2ECDA27D8}" | 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.
SurveyNote
A comment, note or description regarding the Survey,
First included in: Sustainability/esg-data-model/Survey (this entity)
Properties
Name | Value |
---|---|
displayName | Survey Note |
description | A comment, note or description regarding the Survey, |
dataFormat | string |
maximumLength | 2048 |
isNullable | true |
Traits
List of traits for the SurveyNote attribute are listed below.
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 | "{0EAF8048-6E01-4D1E-B68F-BF1A95FE5C3C}" | 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.
SurveyTypeId
The unique identifier of a Survey Type. First included in: Sustainability/esg-data-model/Survey (this entity)
Properties
Name | Value |
---|---|
displayName | Survey Type ID |
description | The unique identifier of a Survey Type. |
dataFormat | int32 |
isNullable | true |
Traits
List of traits for the SurveyTypeId attribute are listed below.
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 | "{06FF6415-2204-4D2D-856C-7A668A172CBF}" | 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