Location Type 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 means of categorizing locations based on common characteristics or functions. Ex: Mail-To Ship-To Account Statements-To Documentation Mail-To Legal Documentation-To Home Office Current Position INDIVIDUAL Personal Residence Vacation Residence Employment Location LEGAL ENTITY Business Office Branch Office Primary Office Headquarters Headquarters Mail-To Headquarters Ship-To Purchasing Department Sales Office Marketing Support Manufacturer Facility Operations Warehouse Maintenance Facility Supplier Agent STRUCTURE Airport Port Warehouse Facility School Police Station Hospital Dock Train Station Storage Tank Aquifer Property Well Oil Depot	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	LocationType/(resolvedAttributes)/LocationTypeId	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	"{0471CB56-3FEF-4C04-AF5B-297E50A93452}"	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	"Geography"	string

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

Parameter	Value	Data type	Explanation
localizedDisplayText	languageTag displayText en Location Type	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
LocationTypeId	The unique identifier of a Location Type.	Sustainability/esg-data-model/LocationType
LocationTypeName	The name of a Location Type.	Sustainability/esg-data-model/LocationType
LocationTypeDescription	The description of a Location Type.	Sustainability/esg-data-model/LocationType

LocationTypeId

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

Properties

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

Traits

List of traits for the LocationTypeId 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	LocationType/(resolvedAttributes)/LocationTypeId	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	"{0A1A0FDF-EF09-4543-8B9D-6C5CBC2F6481}"	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 Location 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 Location Type.	entity	a reference to the constant entity holding the list of localized text

is.dataFormat.integer

LocationTypeName

The name of a Location Type. First included in: Sustainability/esg-data-model/LocationType (this entity)

Properties

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

Traits

List of traits for the LocationTypeName 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	"{1E7266F4-B667-4367-B95C-06395D416B31}"	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 Location Type 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 Location Type.	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.

LocationTypeDescription

The description of a Location Type. First included in: Sustainability/esg-data-model/LocationType (this entity)

Properties

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

Traits

List of traits for the LocationTypeDescription 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	"{3E177BEE-C952-4F23-B36E-DB2271B386B0}"	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 Location Type 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 Location Type.	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.