Do Not Contact Registry in ESG data model

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 ESG Data Model entities are derived. en A Registry containing a list of phone numbers, email addresses or addresses that do not wish to be contacted.	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	DoNotContactRegistry/(resolvedAttributes)/DoNotContactRegistryId	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	"{0B9DED85-0BB7-4C56-B2B6-375BD1FD6897}"	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 Do Not Contact Registry	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
DoNotContactRegistryId	The unique identifier of an Do Not Contact Registry.	Sustainability/esg-data-model/DoNotContactRegistry
DoNotContactRegistryName	The name of the Do Not Contact Registry.	Sustainability/esg-data-model/DoNotContactRegistry
DoNotContactRegistryDescription	The description of the Do Not Contact Registry.	Sustainability/esg-data-model/DoNotContactRegistry
DoNotContactWebsite	The website used for collecting Do Not Contact information.	Sustainability/esg-data-model/DoNotContactRegistry
DoNotContactRegistryTypeId	The unique identifier of a Do Not Contact Registry Type.	Sustainability/esg-data-model/DoNotContactRegistry
RegulatoryPartyId	The unique identifier of a Party.	Sustainability/esg-data-model/DoNotContactRegistry
DoNotContactRegistryNote	A note, comment, or more information regarding the Do Not Contact Registry.	Sustainability/esg-data-model/DoNotContactRegistry

DoNotContactRegistryId

The unique identifier of an Do Not Contact Registry. First included in: Sustainability/esg-data-model/DoNotContactRegistry (this entity)

Properties

Name	Value
displayName	Do Not Contact Registry ID
description	The unique identifier of an Do Not Contact Registry.
isPrimaryKey	true
dataFormat	int32

Traits

List of traits for the DoNotContactRegistryId 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	DoNotContactRegistry/(resolvedAttributes)/DoNotContactRegistryId	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	"{6918798F-EAF5-4BE7-BE96-7BE9BBB8EF47}"	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 Do Not Contact Registry 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 an Do Not Contact Registry.	entity	a reference to the constant entity holding the list of localized text

is.dataFormat.integer

DoNotContactRegistryName

The name of the Do Not Contact Registry. First included in: Sustainability/esg-data-model/DoNotContactRegistry (this entity)

Properties

Name	Value
displayName	Do Not Contact Registry Name
description	The name of the Do Not Contact Registry.
dataFormat	string
maximumLength	256
isNullable	true

Traits

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

Parameter	Value	Data type	Explanation
identifier	"{1D072023-24D1-462E-97A7-78A4DE7C40D9}"	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 Do Not Contact Registry 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 the Do Not Contact Registry.	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.

DoNotContactRegistryDescription

The description of the Do Not Contact Registry. First included in: Sustainability/esg-data-model/DoNotContactRegistry (this entity)

Properties

Name	Value
displayName	Do Not Contact Registry Description
description	The description of the Do Not Contact Registry.
dataFormat	string
maximumLength	2048
isNullable	true

Traits

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

Parameter	Value	Data type	Explanation
identifier	"{2419D380-A772-458C-90E6-C41756BC60FE}"	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 Do Not Contact Registry 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 the Do Not Contact Registry.	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.

DoNotContactWebsite

The website used for collecting Do Not Contact information. First included in: Sustainability/esg-data-model/DoNotContactRegistry (this entity)

Properties

Name	Value
displayName	Do Not Contact Website
description	The website used for collecting Do Not Contact information.
dataFormat	string
maximumLength	2083
isNullable	true

Traits

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

Parameter	Value	Data type	Explanation
identifier	"{51FC55F2-A3E7-44A8-BF74-82C9FA2C2F86}"	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 Do Not Contact Website	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 website used for collecting Do Not Contact information.	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	"2083"	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.

DoNotContactRegistryTypeId

The unique identifier of a Do Not Contact Registry Type. First included in: Sustainability/esg-data-model/DoNotContactRegistry (this entity)

Properties

Name	Value
displayName	Do Not Contact Registry Type ID
description	The unique identifier of a Do Not Contact Registry Type.
dataFormat	int32
isNullable	true

Traits

List of traits for the DoNotContactRegistryTypeId 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 Do Not Contact Registry 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 Do Not Contact Registry Type.	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	entityReference attributeReference DoNotContactRegistryType.cdm.json/DoNotContactRegistryType DoNotContactRegistryTypeId	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	"{357D97EE-CD7D-4001-8CB6-836D49224C2B}"	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

RegulatoryPartyId

The unique identifier of a Party. First included in: Sustainability/esg-data-model/DoNotContactRegistry (this entity)

Properties

Name	Value
displayName	Regulatory Party ID
description	The unique identifier of a Party.
dataFormat	int64
isNullable	true

Traits

List of traits for the RegulatoryPartyId 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.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 Regulatory Party 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 Party.	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	entityReference attributeReference Party.cdm.json/Party PartyId	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	"{1257F70B-32E5-4B6F-996C-1289967FC84C}"	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
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.

DoNotContactRegistryNote

A note, comment, or more information regarding the Do Not Contact Registry. First included in: Sustainability/esg-data-model/DoNotContactRegistry (this entity)

Properties

Name	Value
displayName	Do Not Contact Registry Note
description	A note, comment, or more information regarding the Do Not Contact Registry.
dataFormat	string
maximumLength	2048
isNullable	true

Traits

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

Parameter	Value	Data type	Explanation
identifier	"{032A71F4-85CF-453C-9DDC-6714BB9B5240}"	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 Do Not Contact Registry Note	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 A note, comment, or more information regarding the Do Not Contact Registry.	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.