Role 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 specific role that a Party may perform. Example: INDIVIDUAL Employee Contractor Dependent Shareholder Spouse Customer Bill-To Customer Ship-To Customer Machine Operator Master Planner Scheduler Inventory Clerk ORGANIZATION Employer Distributor Association Legal Entity Customer Government Organization Security Trading Organization Vendor	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	Role/(resolvedAttributes)/RoleId	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	"{F858FA1E-7960-48B6-BE23-21B98ED90627}"	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	languageTag displayText en Role	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
RoleId	The unique identifier of a Role.	Role
RoleName	The name of a Role.	Role
RoleDescription	The description of a Role.	Role
RoleTypeId	The unique identifier of a Role Type.	Role

RoleId

The unique identifier of a Role.
First included in: Role (this entity)

Properties

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

Traits

List of traits for the RoleId 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	Role/(resolvedAttributes)/RoleId	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	"{23E2707F-BCEF-42C4-A4C9-8BDCE4D70C0B}"	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 Role 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 Role.	entity	a reference to the constant entity holding the list of localized text

is.dataFormat.integer

RoleName

The name of a Role.
First included in: Role (this entity)

Properties

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

Traits

List of traits for the RoleName 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	"{07D83435-BCD7-4590-9D89-BA0EE42ECADD}"	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 Role 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 Role.	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.

RoleDescription

The description of a Role.
First included in: Role (this entity)

Properties

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

Traits

List of traits for the RoleDescription 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	"{C8C6F0A7-5493-4914-BB8C-7EF864347733}"	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 Role 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 Role.	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.

RoleTypeId

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

Properties

Name	Value
displayName	Role Type ID
description	The unique identifier of a Role Type.
dataFormat	int32
isNullable	true

Traits

List of traits for the RoleTypeId 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 Role 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 Role Type.	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 RoleType.cdm.json/RoleType RoleTypeId	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	"{82717BD7-D72E-4863-85EB-86FC181F10F6}"	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