Do Not Mail Registry Location in ESG data model

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 ESG Data Model entities are derived.
enA location that is restricted by the Do Not Call Registry.
entitya reference to the constant entity holding the list of localized text

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

ParameterValueData typeExplanation
identifier"{026AFBA6-652B-4B71-9ED5-51E5100A70C6}"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"Party"string

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

ParameterValueData typeExplanation
localizedDisplayText
languageTagdisplayText
enDo Not Mail Registry Location
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
DoNotContactRegistryId The unique identifier of an Do Not Contact Registry. Sustainability/esg-data-model/DoNotMailRegistryLocation
LocationId The unique identifier of a Location. Sustainability/esg-data-model/DoNotMailRegistryLocation
DoNotMailRegistryLocationNote A note, comment, or more information regarding the Do Not Contact Registry Location. Sustainability/esg-data-model/DoNotMailRegistryLocation

DoNotContactRegistryId

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

Properties

NameValue
displayNameDo Not Contact Registry ID
descriptionThe unique identifier of an Do Not Contact Registry.
isPrimaryKeytrue
dataFormatint32

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

ParameterValueData typeExplanation
attributeDoNotMailRegistryLocation/(resolvedAttributes)/DoNotContactRegistryIdattribute

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.

ParameterValueData typeExplanation
entityReferences
entityReferenceattributeReference
DoNotContactRegistry.cdm.json/DoNotContactRegistryDoNotContactRegistryId
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
enDo Not Contact Registry 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 an Do Not Contact Registry.
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 more identification values.

ParameterValueData typeExplanation
identifier"{134CC64E-BE27-4F24-98BE-2041F0B30FBC}"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

LocationId

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

Properties

NameValue
displayNameLocation ID
descriptionThe unique identifier of a Location.
isPrimaryKeytrue
dataFormatint32

Traits

List of traits for the LocationId attribute are listed here.

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

ParameterValueData typeExplanation
attributeDoNotMailRegistryLocation/(resolvedAttributes)/LocationIdattribute

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.

ParameterValueData typeExplanation
entityReferences
entityReferenceattributeReference
Location.cdm.json/LocationLocationId
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
enLocation 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 Location.
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 more identification values.

ParameterValueData typeExplanation
identifier"{53F19854-3A0B-495B-B4DC-D10A0A0008C3}"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

DoNotMailRegistryLocationNote

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

Properties

NameValue
displayNameDo Not Mail Registry Location Note
descriptionA note, comment, or more information regarding the Do Not Contact Registry Location.
dataFormatstring
maximumLength2048
isNullabletrue

Traits

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

ParameterValueData typeExplanation
identifier"{0F368C7B-5A62-46FD-8D05-CC73820F7969}"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
enDo Not Mail Registry Location 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 more information regarding the Do Not Contact Registry Location.
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, and Array of Byte is a Binary Object.