Dela via


Location 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.
enA location is a physical point that can be defined as a single latitude / longitude. A location can be used to describe:

  • the address of a physical structure
  • the location of a business or service
  • the location of a component
  • the delivery location for a shipment or mail
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
attributeLocation/(resolvedAttributes)/LocationIdattribute

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"{0D496F51-E1B6-4A2A-9C94-03D3E1A2257C}"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"Geography"string

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

ParameterValueData typeExplanation
localizedDisplayText
languageTagdisplayText
enLocation
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
LocationId The unique identifier of a Location. Location
LocationName The name of a location. Location
LocationDescription The description of a location. Location
LocationAddressLine1 The 'street' component of a location. Includes street name, apartment, suite number or PO Box. Location
LocationAddressLine2 The 'street' component of a location. Includes street name, apartment, suite number or PO Box. Location
LocationCity The 'city' component of a location. Location
LocationStateId The unique identifier of the State = State Code.A two-digit FIPS code assigned by the NIST to identify each State and statistically equivalent entity. The NIST assigns the codes based on the alphabetic sequence of State names (Puerto Rico and the Outlying Areas appear at the end); it documents these codes in a FIPS publication (FIPS PUB 5). Also, a two-digit code assigned by the Census Bureau to identify each State within its census geographic division (Puerto Rico and the Outlying Areas appear at the end). Location
LocationZipCode The unique identifier of a Zip Code. Location
LocationNote Notes, comments or additional information about the location. The note could be used to describe access to the location as well as any hazardous conditions that might exist at the location. Location
LocationLatitude The location north or south in reference to the equator, which is designated at zero (0) degrees. Parallel lines that circle the globe both north and south of the equator. Latitude is often measured in degrees, minutes, seconds (ddd mm ss), but other formats are also commonly used: gps coordinate (ddd mm.mmmm), decimal degrees (ddd.dddd). Location
LocationLongitude The location east or west in reference to the Prime Meridian, which is designated as zero (0) degrees longitude. The distance between lines of longitude are greater at the equator and smaller at the higher latitudes, intersecting at the earth's North and South Poles. Time zones are correlated to longitude.Longitude is often measured in degrees, minutes, seconds (ddd mm ss), but other formats are also commonly used: gps coordinate (ddd mm.mmmm), decimal degrees (ddd.dddd). Location
LocationDatum Latitude and longitude are based on a datum. A datum is a reference point, surface or axis against which measurements are made.Different datums can be used for determining the latitude and longitude. If different datums are used the latitude and longitude for a single point (location) may be different.WGS 84 is a datum that is used on most GPS equipment. Location
LocationElevation The distance above sea level of this location at ground level. Location
LocationElevationUnitOfMeasureId The unique identifier of a Unit Of Measure. Location
GlobalLocationNumber The Global Location Number (GLN) is a simple tool used to uniquely identify locations. It can be used to identify physical locations such as a warehouse, legal entities, or a function / department within a legal entity. The GLN is part of the GS1 system of standards. Location
TimezoneId The unique identifier of a timezone. Location
DaylightSavingsTimeObservedIndicator Indicates whether daylight savings time (DST) is observed at this location. Location
CountryId The unique identifier of the Country. Location
CountrySubdivisionId The unique identifier of the Country Subdivision. Location

LocationId

The unique identifier of a Location.
First included in: Location (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
attributeLocation/(resolvedAttributes)/LocationIdattribute

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"{12240DD7-7094-4F77-A4D4-4E9735FB4AE6}"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
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

is.dataFormat.integer

LocationName

The name of a location.
First included in: Location (this entity)

Properties

NameValue
displayNameLocation Name
descriptionThe name of a location.
dataFormatstring
maximumLength256
isNullabletrue

Traits

List of traits for the LocationName 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"{0BA1CCFA-7E5E-462C-9347-531E4DC19CDB}"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
enLocation 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 location.
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. Array of Byte is a Binary Object.

LocationDescription

The description of a location.
First included in: Location (this entity)

Properties

NameValue
displayNameLocation Description
descriptionThe description of a location.
dataFormatstring
maximumLength2048
isNullabletrue

Traits

List of traits for the LocationDescription 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"{0F3E0CC1-1AD0-4CC3-B50F-8FBDE6324C97}"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
enLocation 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 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. Array of Byte is a Binary Object.

LocationAddressLine1

The 'street' component of a location. Includes street name, apartment, suite number or PO Box.
First included in: Location (this entity)

Properties

NameValue
displayNameLocation Address Line 1
descriptionThe 'street' component of a location. Includes street name, apartment, suite number or PO Box.
dataFormatstring
maximumLength512
isNullabletrue

Traits

List of traits for the LocationAddressLine1 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"{0274E35C-0863-4B82-B321-0B361858DC34}"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
enLocation Address Line 1
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 'street' component of a location. Includes street name, apartment, suite number or PO Box.
entitya reference to the constant entity holding the list of localized text

is.constrained
Maximum length or value constraints.

ParameterValueData typeExplanation
maximumLength"512"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.

LocationAddressLine2

The 'street' component of a location. Includes street name, apartment, suite number or PO Box.
First included in: Location (this entity)

Properties

NameValue
displayNameLocation Address Line 2
descriptionThe 'street' component of a location. Includes street name, apartment, suite number or PO Box.
dataFormatstring
maximumLength512
isNullabletrue

Traits

List of traits for the LocationAddressLine2 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"{06926CE3-FEB0-4A50-B98B-A327C0AACB1A}"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
enLocation Address Line 2
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 'street' component of a location. Includes street name, apartment, suite number or PO Box.
entitya reference to the constant entity holding the list of localized text

is.constrained
Maximum length or value constraints.

ParameterValueData typeExplanation
maximumLength"512"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.

LocationCity

The 'city' component of a location.
First included in: Location (this entity)

Properties

NameValue
displayNameLocation City
descriptionThe 'city' component of a location.
dataFormatstring
maximumLength256
isNullabletrue

Traits

List of traits for the LocationCity 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"{1167C4DA-1F25-4ED0-B9D1-7E1E70C33E72}"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
enLocation City
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 'city' component of a location.
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. Array of Byte is a Binary Object.

LocationStateId

The unique identifier of the State = State Code.

A two-digit FIPS code assigned by the NIST to identify each State and statistically equivalent entity. The NIST assigns the codes based on the alphabetic sequence of State names (Puerto Rico and the Outlying Areas appear at the end); it documents these codes in a FIPS publication (FIPS PUB 5). Also, a two-digit code assigned by the Census Bureau to identify each State within its census geographic division (Puerto Rico and the Outlying Areas appear at the end).
First included in: Location (this entity)

Properties

NameValue
displayNameLocation State ID
descriptionThe unique identifier of the State = State Code.

A two-digit FIPS code assigned by the NIST to identify each State and statistically equivalent entity. The NIST assigns the codes based on the alphabetic sequence of State names (Puerto Rico and the Outlying Areas appear at the end); it documents these codes in a FIPS publication (FIPS PUB 5). Also, a two-digit code assigned by the Census Bureau to identify each State within its census geographic division (Puerto Rico and the Outlying Areas appear at the end).

dataFormatint32
isNullabletrue

Traits

List of traits for the LocationStateId attribute are listed here.

is.dataFormat.integer
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"{26C3D3AF-C4ED-40A7-97D6-493646F520FB}"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
enLocation State 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 the State = State Code.

A two-digit FIPS code assigned by the NIST to identify each State and statistically equivalent entity. The NIST assigns the codes based on the alphabetic sequence of State names (Puerto Rico and the Outlying Areas appear at the end); it documents these codes in a FIPS publication (FIPS PUB 5). Also, a two-digit code assigned by the Census Bureau to identify each State within its census geographic division (Puerto Rico and the Outlying Areas appear at the end).

entitya reference to the constant entity holding the list of localized text

is.dataFormat.integer

LocationZipCode

The unique identifier of a Zip Code.
First included in: Location (this entity)

Properties

NameValue
displayNameLocation Zip Code
descriptionThe unique identifier of a Zip Code.
dataFormatdecimal
isNullabletrue

Traits

List of traits for the LocationZipCode attribute are listed here.

is.dataFormat.numeric.shaped
for setting the exact precision and scale of numeric values

ParameterValueData typeExplanation
precision"11"integerthe total number of significant digits
scale"0"integerthe number of digits to the right of the decimal place

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"{07DF8296-8922-4E7F-8202-33DF1975E0DE}"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
enLocation Zip Code
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 Zip Code.
entitya reference to the constant entity holding the list of localized text

is.dataFormat.numeric.shaped
for setting the exact precision and scale of numeric values

LocationNote

Notes, comments or additional information about the location. The note could be used to describe access to the location as well as any hazardous conditions that might exist at the location.
First included in: Location (this entity)

Properties

NameValue
displayNameLocation Note
descriptionNotes, comments or additional information about the location. The note could be used to describe access to the location as well as any hazardous conditions that might exist at the location.
dataFormatstring
maximumLength2048
isNullabletrue

Traits

List of traits for the LocationNote 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"{059FCA45-F3FB-4D00-8066-71580CA94802}"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
enLocation 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 about the location. The note could be used to describe access to the location as well as any hazardous conditions that might exist at the 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. Array of Byte is a Binary Object.

LocationLatitude

The location north or south in reference to the equator, which is designated at zero (0) degrees. Parallel lines that circle the globe both north and south of the equator.

Latitude is often measured in degrees, minutes, seconds (ddd mm ss), but other formats are also commonly used: gps coordinate (ddd mm.mmmm), decimal degrees (ddd.dddd).
First included in: Location (this entity)

Properties

NameValue
displayNameLocation Latitude
descriptionThe location north or south in reference to the equator, which is designated at zero (0) degrees. Parallel lines that circle the globe both north and south of the equator.

Latitude is often measured in degrees, minutes, seconds (ddd mm ss), but other formats are also commonly used: gps coordinate (ddd mm.mmmm), decimal degrees (ddd.dddd).

dataFormatdecimal
isNullabletrue

Traits

List of traits for the LocationLatitude attribute are listed here.

is.dataFormat.numeric.shaped
for setting the exact precision and scale of numeric values

ParameterValueData typeExplanation
precision"10"integerthe total number of significant digits
scale"7"integerthe number of digits to the right of the decimal place

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"{26623700-2004-49B7-8F4C-470C04DE8C55}"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
enLocation Latitude
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 location north or south in reference to the equator, which is designated at zero (0) degrees. Parallel lines that circle the globe both north and south of the equator.

Latitude is often measured in degrees, minutes, seconds (ddd mm ss), but other formats are also commonly used: gps coordinate (ddd mm.mmmm), decimal degrees (ddd.dddd).

entitya reference to the constant entity holding the list of localized text

is.dataFormat.numeric.shaped
for setting the exact precision and scale of numeric values

LocationLongitude

The location east or west in reference to the Prime Meridian, which is designated as zero (0) degrees longitude. The distance between lines of longitude are greater at the equator and smaller at the higher latitudes, intersecting at the earth's North and South Poles. Time zones are correlated to longitude.

Longitude is often measured in degrees, minutes, seconds (ddd mm ss), but other formats are also commonly used: gps coordinate (ddd mm.mmmm), decimal degrees (ddd.dddd).
First included in: Location (this entity)

Properties

NameValue
displayNameLocation Longitude
descriptionThe location east or west in reference to the Prime Meridian, which is designated as zero (0) degrees longitude. The distance between lines of longitude are greater at the equator and smaller at the higher latitudes, intersecting at the earth's North and South Poles. Time zones are correlated to longitude.

Longitude is often measured in degrees, minutes, seconds (ddd mm ss), but other formats are also commonly used: gps coordinate (ddd mm.mmmm), decimal degrees (ddd.dddd).

dataFormatdecimal
isNullabletrue

Traits

List of traits for the LocationLongitude attribute are listed here.

is.dataFormat.numeric.shaped
for setting the exact precision and scale of numeric values

ParameterValueData typeExplanation
precision"10"integerthe total number of significant digits
scale"7"integerthe number of digits to the right of the decimal place

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"{0BBB53B7-7855-499A-9269-317D73940F1A}"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
enLocation Longitude
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 location east or west in reference to the Prime Meridian, which is designated as zero (0) degrees longitude. The distance between lines of longitude are greater at the equator and smaller at the higher latitudes, intersecting at the earth's North and South Poles. Time zones are correlated to longitude.

Longitude is often measured in degrees, minutes, seconds (ddd mm ss), but other formats are also commonly used: gps coordinate (ddd mm.mmmm), decimal degrees (ddd.dddd).

entitya reference to the constant entity holding the list of localized text

is.dataFormat.numeric.shaped
for setting the exact precision and scale of numeric values

LocationDatum

Latitude and longitude are based on a datum. A datum is a reference point, surface or axis against which measurements are made.

Different datums can be used for determining the latitude and longitude. If different datums are used the latitude and longitude for a single point (location) may be different.

WGS 84 is a datum that is used on most GPS equipment.
First included in: Location (this entity)

Properties

NameValue
displayNameLocation Datum
descriptionLatitude and longitude are based on a datum. A datum is a reference point, surface or axis against which measurements are made.

Different datums can be used for determining the latitude and longitude. If different datums are used the latitude and longitude for a single point (location) may be different.

WGS 84 is a datum that is used on most GPS equipment.

dataFormatstring
maximumLength5
isNullabletrue

Traits

List of traits for the LocationDatum 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"{02B5389A-5373-4BC9-B683-DAD889E9A94B}"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
enLocation Datum
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
enLatitude and longitude are based on a datum. A datum is a reference point, surface or axis against which measurements are made.

Different datums can be used for determining the latitude and longitude. If different datums are used the latitude and longitude for a single point (location) may be different.

WGS 84 is a datum that is used on most GPS equipment.

entitya reference to the constant entity holding the list of localized text

is.constrained
Maximum length or value constraints.

ParameterValueData typeExplanation
maximumLength"5"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.

LocationElevation

The distance above sea level of this location at ground level.
First included in: Location (this entity)

Properties

NameValue
displayNameLocation Elevation
descriptionThe distance above sea level of this location at ground level.
dataFormatdecimal
isNullabletrue

Traits

List of traits for the LocationElevation attribute are listed here.

is.dataFormat.numeric.shaped
for setting the exact precision and scale of numeric values

ParameterValueData typeExplanation
precision"18"integerthe total number of significant digits
scale"8"integerthe number of digits to the right of the decimal place

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"{03634C73-7D30-4686-A65B-AEA1FE39B2AE}"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
enLocation Elevation
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 distance above sea level of this location at ground level.
entitya reference to the constant entity holding the list of localized text

is.dataFormat.numeric.shaped
for setting the exact precision and scale of numeric values

LocationElevationUnitOfMeasureId

The unique identifier of a Unit Of Measure.
First included in: Location (this entity)

Properties

NameValue
displayNameLocation Elevation Unit Of Measure ID
descriptionThe unique identifier of a Unit Of Measure.
dataFormatint32
isNullabletrue

Traits

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

ParameterValueData typeExplanation
localizedDisplayText
languageTagdisplayText
enLocation Elevation Unit Of Measure 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 Unit Of Measure.
entitya reference to the constant entity holding the list of localized text

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
UnitOfMeasure.cdm.json/UnitOfMeasureUnitOfMeasureId
entitya 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 other identification values.

ParameterValueData typeExplanation
identifier"{0F98AFB8-8E24-483E-B66E-64387D9AD218}"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

GlobalLocationNumber

The Global Location Number (GLN) is a simple tool used to uniquely identify locations. It can be used to identify physical locations such as a warehouse, legal entities, or a function / department within a legal entity. The GLN is part of the GS1 system of standards.
First included in: Location (this entity)

Properties

NameValue
displayNameGlobal Location Number (GLN)
descriptionThe Global Location Number (GLN) is a simple tool used to uniquely identify locations. It can be used to identify physical locations such as a warehouse, legal entities, or a function / department within a legal entity. The GLN is part of the GS1 system of standards.
dataFormatdecimal
isNullabletrue

Traits

List of traits for the GlobalLocationNumber attribute are listed here.

is.dataFormat.numeric.shaped
for setting the exact precision and scale of numeric values

ParameterValueData typeExplanation
precision"13"integerthe total number of significant digits
scale"0"integerthe number of digits to the right of the decimal place

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"{0A2474D2-167B-47AA-A43D-701EB8443497}"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
enGlobal Location Number (GLN)
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 Global Location Number (GLN) is a simple tool used to uniquely identify locations. It can be used to identify physical locations such as a warehouse, legal entities, or a function / department within a legal entity. The GLN is part of the GS1 system of standards.
entitya reference to the constant entity holding the list of localized text

is.dataFormat.numeric.shaped
for setting the exact precision and scale of numeric values

TimezoneId

The unique identifier of a timezone.
First included in: Location (this entity)

Properties

NameValue
displayNameTimezone ID
descriptionThe unique identifier of a timezone.
dataFormatint32
isNullabletrue

Traits

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

ParameterValueData typeExplanation
localizedDisplayText
languageTagdisplayText
enTimezone 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 timezone.
entitya reference to the constant entity holding the list of localized text

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
Timezone.cdm.json/TimezoneTimezoneId
entitya 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 other identification values.

ParameterValueData typeExplanation
identifier"{17BF69EF-1C79-47A2-8A9D-AA29F4CACFC0}"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

DaylightSavingsTimeObservedIndicator

Indicates whether daylight savings time (DST) is observed at this location.
First included in: Location (this entity)

Properties

NameValue
displayNameDaylight Savings Time Observed Indicator
descriptionIndicates whether daylight savings time (DST) is observed at this location.
dataFormatboolean
isNullabletrue

Traits

List of traits for the DaylightSavingsTimeObservedIndicator attribute are listed here.

is.dataFormat.boolean
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"{02BF04E1-1DE9-4A4A-94EB-90AC5B600378}"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
enDaylight Savings Time Observed Indicator
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
enIndicates whether daylight savings time (DST) is observed at this location.
entitya reference to the constant entity holding the list of localized text

is.dataFormat.boolean

CountryId

The unique identifier of the Country.
First included in: Location (this entity)

Properties

NameValue
displayNameCountry ID
descriptionThe unique identifier of the Country.
dataFormatint32
isNullabletrue

Traits

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

ParameterValueData typeExplanation
localizedDisplayText
languageTagdisplayText
enCountry 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 the Country.
entitya reference to the constant entity holding the list of localized text

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
Country.cdm.json/CountryCountryId
entitya 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 other identification values.

ParameterValueData typeExplanation
identifier"{1E178BF3-F12C-4807-986A-40DE6077035B}"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

CountrySubdivisionId

The unique identifier of the Country Subdivision.
First included in: Location (this entity)

Properties

NameValue
displayNameCountry Subdivision ID
descriptionThe unique identifier of the Country Subdivision.
dataFormatint32
isNullabletrue

Traits

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

ParameterValueData typeExplanation
localizedDisplayText
languageTagdisplayText
enCountry Subdivision 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 the Country Subdivision.
entitya reference to the constant entity holding the list of localized text

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
CountrySubdivision.cdm.json/CountrySubdivisionCountrySubdivisionId
entitya 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 other identification values.

ParameterValueData typeExplanation
identifier"{04B858A7-0D12-4377-BDC2-CB4E7A28AAE5}"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