Compartir a través de


Related Business Metric 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

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 Industry Data Model entities are derived.
enThe relationship between two Business Metrics during the associated period.
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
attributeRelatedBusinessMetric/(resolvedAttributes)/RelatedBusinessMetricPeriodStartTimestampattribute

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"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.

ParameterValueData typeExplanation
identifier"{C8861F84-DA9D-479B-9023-29D4B214E67C}"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"Business Metrics"string

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

ParameterValueData typeExplanation
localizedDisplayText
languageTagdisplayText
enRelated Business Metric
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
BusinessMetricId The unique identifier of a business metric. RelatedBusinessMetric
RelatedBusinessMetricId The unique identifier of a business metric. RelatedBusinessMetric
BusinessMetricRelationshipTypeId The unique identifier of a Business Metric Relationship Type. RelatedBusinessMetric
RelatedBusinessMetricPeriodStartTimestamp The period starting timestamp that the Related Business Metric is defined or identified. RelatedBusinessMetric
RelatedBusinessMetricPeriodEndTimestamp The period ending timestamp that the Related Business Metric is defined or identified. RelatedBusinessMetric
BusinessMetricRelationshipNote A note, comment or additional information regarding the Related Business Metric. RelatedBusinessMetric

BusinessMetricId

The unique identifier of a business metric.
First included in: RelatedBusinessMetric (this entity)

Properties

NameValue
displayNameBusiness Metric ID
descriptionThe unique identifier of a business metric.
isPrimaryKeytrue
dataFormatint32

Traits

List of traits for the BusinessMetricId attribute are listed here.

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

ParameterValueData typeExplanation
attributeRelatedBusinessMetric/(resolvedAttributes)/BusinessMetricIdattribute

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.

ParameterValueData typeExplanation
entityReferences
entityReferenceattributeReference
BusinessMetric.cdm.json/BusinessMetricBusinessMetricId
entitya 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.

ParameterValueData typeExplanation
localizedDisplayText
languageTagdisplayText
enBusiness Metric 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 a business metric.
entitya 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.

ParameterValueData typeExplanation
identifier"{03910D82-5FAF-4AAE-9139-D0701567594E}"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.dataFormat.integer

RelatedBusinessMetricId

The unique identifier of a business metric.
First included in: RelatedBusinessMetric (this entity)

Properties

NameValue
displayNameRelated Business Metric ID
descriptionThe unique identifier of a business metric.
isPrimaryKeytrue
dataFormatint32

Traits

List of traits for the RelatedBusinessMetricId attribute are listed here.

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

ParameterValueData typeExplanation
attributeRelatedBusinessMetric/(resolvedAttributes)/RelatedBusinessMetricIdattribute

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.

ParameterValueData typeExplanation
entityReferences
entityReferenceattributeReference
BusinessMetric.cdm.json/BusinessMetricBusinessMetricId
entitya 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.

ParameterValueData typeExplanation
localizedDisplayText
languageTagdisplayText
enRelated Business Metric 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 a business metric.
entitya 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.

ParameterValueData typeExplanation
identifier"{A33DFE3A-7915-4821-9609-4CF720FEC1EE}"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.dataFormat.integer

BusinessMetricRelationshipTypeId

The unique identifier of a Business Metric Relationship Type.
First included in: RelatedBusinessMetric (this entity)

Properties

NameValue
displayNameBusiness Metric Relationship Type ID
descriptionThe unique identifier of a Business Metric Relationship Type.
isPrimaryKeytrue
dataFormatint32

Traits

List of traits for the BusinessMetricRelationshipTypeId attribute are listed here.

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

ParameterValueData typeExplanation
attributeRelatedBusinessMetric/(resolvedAttributes)/BusinessMetricRelationshipTypeIdattribute

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.

ParameterValueData typeExplanation
entityReferences
entityReferenceattributeReference
BusinessMetricRelationshipType.cdm.json/BusinessMetricRelationshipTypeBusinessMetricRelationshipTypeId
entitya 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.

ParameterValueData typeExplanation
localizedDisplayText
languageTagdisplayText
enBusiness Metric Relationship Type 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 a Business Metric Relationship Type.
entitya 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.

ParameterValueData typeExplanation
identifier"{2BF55793-046E-46E0-88A2-919C3E111D49}"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.dataFormat.integer

RelatedBusinessMetricPeriodStartTimestamp

The period starting timestamp that the Related Business Metric is defined or identified.
First included in: RelatedBusinessMetric (this entity)

Properties

NameValue
displayNameRelated Business Metric Period Start Timestamp
descriptionThe period starting timestamp that the Related Business Metric is defined or identified.
isPrimaryKeytrue
dataFormatdateTime

Traits

List of traits for the RelatedBusinessMetricPeriodStartTimestamp attribute are listed here.

is.dataFormat.date
means.measurement.date
is.dataFormat.time
means.measurement.time
is.identifiedBy
Names a specific identity attribute to use with an entity.

ParameterValueData typeExplanation
attributeRelatedBusinessMetric/(resolvedAttributes)/RelatedBusinessMetricPeriodStartTimestampattribute

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.

ParameterValueData typeExplanation
identifier"{51C6882E-D0E1-4087-A6B0-6D02900B6125}"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
enRelated Business Metric Period Start Timestamp
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 period starting timestamp that the Related Business Metric is defined or identified.
entitya reference to the constant entity holding the list of localized text

is.dataFormat.time
is.dataFormat.date

RelatedBusinessMetricPeriodEndTimestamp

The period ending timestamp that the Related Business Metric is defined or identified.
First included in: RelatedBusinessMetric (this entity)

Properties

NameValue
displayNameRelated Business Metric Period End Timestamp
descriptionThe period ending timestamp that the Related Business Metric is defined or identified.
dataFormatdateTime
isNullabletrue

Traits

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

ParameterValueData typeExplanation
identifier"{31B11CE8-C715-42AD-A7D7-8DC06A9BF328}"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
enRelated Business Metric Period End Timestamp
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 period ending timestamp that the Related Business Metric is defined or identified.
entitya reference to the constant entity holding the list of localized text

is.dataFormat.time
is.dataFormat.date

BusinessMetricRelationshipNote

A note, comment or additional information regarding the Related Business Metric.
First included in: RelatedBusinessMetric (this entity)

Properties

NameValue
displayNameBusiness Metric Relationship Note
descriptionA note, comment or additional information regarding the Related Business Metric.
dataFormatstring
maximumLength2048
isNullabletrue

Traits

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

ParameterValueData typeExplanation
identifier"{B6AC175A-A2B1-455E-AEF0-1DB791B2E8E0}"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
enBusiness Metric Relationship Note
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
enA note, comment or additional information regarding the Related Business Metric.
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. Array of Byte is a Binary Object.