Delivery 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

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 Industry Data Model entities are derived. en A location where a commodity may be delivered. The reference point for delivery will differ depending on the type of commodity being acquired or sold. For gas the delivery location is typically a hub on a pipeline, for electricity the delivery location is typically a node on the electric grid. This location may be an internally defined delivery location that is specific to the organization's network or a common delivery location (or reference location) that is used throughout the industry. Example: Henry Hub for gas, Cushing for WTI.	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	DeliveryLocation/(resolvedAttributes)/DeliveryLocationId	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	"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.

Parameter	Value	Data type	Explanation
identifier	"{3A1CFC7B-366F-423C-B455-8421F307AAD8}"	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	"Product"	string

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

Parameter	Value	Data type	Explanation
localizedDisplayText	languageTag displayText en Delivery Location	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
DeliveryLocationId	The unique identifier of a Delivery Location.	DeliveryLocation
DeliveryLocationName	The name of the Delivery Location.	DeliveryLocation
DeliveryLocationDescription	The description of the Delivery Location.	DeliveryLocation
DeliveryLocationTypeId	The unique identifier of a Delivery Location Type.	DeliveryLocation
HubId	The unique identifier of a Hub (Australia).	DeliveryLocation
PipelineZoneId	The unique identifier of a Pipeline.	DeliveryLocation
RegionalReferenceNodeId	The unique identifier of a regional reference node.	DeliveryLocation
LocationId	The unique identifier of a Location.	DeliveryLocation
PipelineId	The unique identifier of a Pipeline.	DeliveryLocation

DeliveryLocationId

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

Properties

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

Traits

List of traits for the DeliveryLocationId 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	DeliveryLocation/(resolvedAttributes)/DeliveryLocationId	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 other identification values.

Parameter	Value	Data type	Explanation
identifier	"{EB887362-CC75-45BB-9566-E0EC6DC36B39}"	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 Delivery Location 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 Delivery Location.	entity	a reference to the constant entity holding the list of localized text

is.dataFormat.integer

DeliveryLocationName

The name of the Delivery Location.
First included in: DeliveryLocation (this entity)

Properties

Name	Value
displayName	Delivery Location Name
description	The name of the Delivery Location.
dataFormat	string
maximumLength	256
isNullable	true

Traits

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

Parameter	Value	Data type	Explanation
identifier	"{E4551D83-4237-4FA5-81E3-BFFBFAAB1C49}"	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 Delivery Location 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 the Delivery Location.	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. Array of Byte is a Binary Object.

DeliveryLocationDescription

The description of the Delivery Location.
First included in: DeliveryLocation (this entity)

Properties

Name	Value
displayName	Delivery Location Description
description	The description of the Delivery Location.
dataFormat	string
maximumLength	2048
isNullable	true

Traits

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

Parameter	Value	Data type	Explanation
identifier	"{D58FAF46-5D84-4B3E-8FA1-C4DE066E4133}"	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 Delivery Location 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 the Delivery Location.	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. Array of Byte is a Binary Object.

DeliveryLocationTypeId

The unique identifier of a Delivery Location Type.
First included in: DeliveryLocation (this entity)

Properties

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

Traits

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

Parameter	Value	Data type	Explanation
localizedDisplayText	languageTag displayText en Delivery 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 Delivery Location Type.	entity	a 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.

Parameter	Value	Data type	Explanation
entityReferences	entityReference attributeReference DeliveryLocationType.cdm.json/DeliveryLocationType DeliveryLocationTypeId	entity	a 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.

Parameter	Value	Data type	Explanation
identifier	"{2DD6D082-DEE4-47C7-BA8B-D78552A35071}"	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.dataFormat.integer

HubId

The unique identifier of a Hub (Australia).
First included in: DeliveryLocation (this entity)

Properties

Name	Value
displayName	Hub ID
description	The unique identifier of a Hub (Australia).
dataFormat	int32
isNullable	true

Traits

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

Parameter	Value	Data type	Explanation
identifier	"{ED17251D-4490-4D63-8AC8-ACD1C6DD615E}"	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 Hub 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 Hub (Australia).	entity	a reference to the constant entity holding the list of localized text

is.dataFormat.integer

PipelineZoneId

The unique identifier of a Pipeline.
First included in: DeliveryLocation (this entity)

Properties

Name	Value
displayName	Pipeline Zone ID
description	The unique identifier of a Pipeline.
dataFormat	int32
isNullable	true

Traits

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

Parameter	Value	Data type	Explanation
identifier	"{F9B05DD9-FB73-4946-98A0-DB7B34F399ED}"	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 Pipeline Zone 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 Pipeline.	entity	a reference to the constant entity holding the list of localized text

is.dataFormat.integer

RegionalReferenceNodeId

The unique identifier of a regional reference node.
First included in: DeliveryLocation (this entity)

Properties

Name	Value
displayName	Regional Reference Node ID
description	The unique identifier of a regional reference node.
dataFormat	int32
isNullable	true

Traits

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

Parameter	Value	Data type	Explanation
identifier	"{4498B97A-B4AE-483C-B84D-94079DE6F60C}"	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 Regional Reference Node 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 regional reference node.	entity	a reference to the constant entity holding the list of localized text

is.dataFormat.integer

LocationId

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

Properties

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

Traits

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

Parameter	Value	Data type	Explanation
localizedDisplayText	languageTag displayText en Location 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.	entity	a 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.

Parameter	Value	Data type	Explanation
entityReferences	entityReference attributeReference Location.cdm.json/Location LocationId	entity	a 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.

Parameter	Value	Data type	Explanation
identifier	"{4DA4E174-3C87-471F-930A-54AD8CF6777D}"	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.dataFormat.integer

PipelineId

The unique identifier of a Pipeline.
First included in: DeliveryLocation (this entity)

Properties

Name	Value
displayName	Pipeline ID
description	The unique identifier of a Pipeline.
dataFormat	int64
isNullable	true

Traits

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

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.

Parameter	Value	Data type	Explanation
identifier	"{7122FE86-D462-42E0-A5C7-FE8BDF05DDF0}"	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 Pipeline 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 Pipeline.	entity	a reference to the constant entity holding the list of localized text

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.