Dela via


Party Ancestry 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 ancestry(s) identified by or for the Individual.

The data on ancestry represent self-classification by people according to the ancestry group(s) with which they most closely identify.

Ancestry refers to a person's ethnic origin or descent, "roots," or heritage or the place of birth of the person or the person's parents or ancestors before their arrival in the United States.

Some ethnic identities, such as "Egyptian" or "Polish" can be traced to geographic areas outside the United States, while other ethnicities such as "Pennsylvania Dutch" or "Cajun" evolved in the United States.

The intent of ancestry is not to measure the degree of attachment the respondent had to a particular ethnicity. For example, a response of "Irish" might reflect total involvement in an "Irish" community or only a memory of ancestors several generations removed from the individual.

Normally, 'multiple responses' are assigned to a single code: "French Canadian," "Greek Cypriote," and "Black Dutch"

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"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"{0E7A17DD-A950-4AB3-A1CE-835B1A3E4908}"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
enParty Ancestry
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
PartyId The unique identifier of a Party. PartyAncestry
AncestryId The unique identifier of an Ancestry. PartyAncestry
PartyAncestryNote Notes, comments or additional information regarding the Individual's ancestry. PartyAncestry

PartyId

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

Properties

NameValue
displayNameParty ID
descriptionThe unique identifier of a Party.
isPrimaryKeytrue
dataFormatint64

Traits

List of traits for the PartyId 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.identifiedBy
Names a specific identity attribute to use with an entity.

ParameterValueData typeExplanation
attributePartyAncestry/(resolvedAttributes)/PartyIdattribute

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
IndividualParty.cdm.json/IndividualPartyPartyId
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
enParty 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 Party.
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"{345EE973-63FF-47F0-8C42-F539FFB23070}"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
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.

AncestryId

The unique identifier of an Ancestry.
First included in: PartyAncestry (this entity)

Properties

NameValue
displayNameAncestry ID
descriptionThe unique identifier of an Ancestry.
isPrimaryKeytrue
dataFormatint32

Traits

List of traits for the AncestryId attribute are listed here.

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

ParameterValueData typeExplanation
attributePartyAncestry/(resolvedAttributes)/AncestryIdattribute

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
Ancestry.cdm.json/AncestryAncestryId
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
enAncestry 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 Ancestry.
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"{0F713135-71A4-46C6-AA81-A2341BB14019}"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

PartyAncestryNote

Notes, comments or additional information regarding the Individual's ancestry.
First included in: PartyAncestry (this entity)

Properties

NameValue
displayNameParty Ancestry Note
descriptionNotes, comments or additional information regarding the Individual's ancestry.
dataFormatstring
maximumLength2048
isNullabletrue

Traits

List of traits for the PartyAncestryNote 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"{A4E372CE-62B0-49EA-AB53-25888CDF6A75}"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
enParty Ancestry 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
enNotes, comments or additional information regarding the Individual's ancestry.
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.