Household Role 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 role played by a household member.

Ex:

  • Caregiver
  • Income producer
  • Dependent child
  • Dependent adult
  • Biological sibling
  • Biological parent
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
attributeHouseholdRole/(resolvedAttributes)/HouseholdRoleIdattribute

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"{16C22ECD-ED81-4020-BEE2-0C6BC32FBC46}"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
enHousehold Role
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
HouseholdRoleId The unique identifier of a Household Role. Sustainability/esg-data-model/HouseholdRole
HouseholdRoleName The name of a Household Role. Sustainability/esg-data-model/HouseholdRole
HouseholdRoleDescription The description of a Household Role. Sustainability/esg-data-model/HouseholdRole

HouseholdRoleId

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

Properties

NameValue
displayNameHousehold Role ID
descriptionThe unique identifier of a Household Role.
isPrimaryKeytrue
dataFormatint32

Traits

List of traits for the HouseholdRoleId attribute are listed here.

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

ParameterValueData typeExplanation
attributeHouseholdRole/(resolvedAttributes)/HouseholdRoleIdattribute

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"{12C51784-CCBC-437B-BABA-441E6E87ED1A}"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
enHousehold Role 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 Household Role.
entitya reference to the constant entity holding the list of localized text

is.dataFormat.integer

HouseholdRoleName

The name of a Household Role. First included in: Sustainability/esg-data-model/HouseholdRole (this entity)

Properties

NameValue
displayNameHousehold Role Name
descriptionThe name of a Household Role.
dataFormatstring
maximumLength256
isNullabletrue

Traits

List of traits for the HouseholdRoleName 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"{0E309E69-BA79-4F9A-9DAE-A28EEDBCA4CE}"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
enHousehold Role Name
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 name of a Household Role.
entitya reference to the constant entity holding the list of localized text

is.constrained
maximum length or value constraints

ParameterValueData typeExplanation
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.

HouseholdRoleDescription

The description of a Household Role. First included in: Sustainability/esg-data-model/HouseholdRole (this entity)

Properties

NameValue
displayNameHousehold Role Description
descriptionThe description of a Household Role.
dataFormatstring
maximumLength2048
isNullabletrue

Traits

List of traits for the HouseholdRoleDescription 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"{92712FC8-0C74-4460-B05E-6C65DD26F9AC}"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
enHousehold Role Description
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 description of a Household Role.
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.