Contract Unit 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 The units associated with the Contract. Example: 1 Megawatt of electrical energy per hour based on a base load profile. Where the base load profile is defined as the Wholesale Electricity Pool Market base load period from 00:00 hours Monday to 24:00 hours Sunday over the duration of the Contract Quarter. For example: the size (in Megawatt hours) of each contract quarter will vary depending on the number of days and base load hours within the quarter, as follows: A 90 day contract quarter will equate to 2,160 Megawatt hours; A 91 day contract quarter will equate to 2,184 Megawatt hours; A 92 day contract quarter will equate to 2,208 Megawatt hours.	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	ContractUnit/(resolvedAttributes)/ContractUnitId	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	"{6BF3E6B6-3FE2-471F-9DBC-EAD9F392AB42}"	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	"Contract"	string

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

Parameter	Value	Data type	Explanation
localizedDisplayText	languageTag displayText en Contract Unit	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
ContractUnitId	The unique identifier of a contract unit.	ContractUnit
ContractUnitName	The name of a contract unit.	ContractUnit
ContractUnitDescription	The description of a contract unit.	ContractUnit

ContractUnitId

The unique identifier of a contract unit.
First included in: ContractUnit (this entity)

Properties

Name	Value
displayName	Contract Unit ID
description	The unique identifier of a contract unit.
isPrimaryKey	true
dataFormat	int32

Traits

List of traits for the ContractUnitId 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	ContractUnit/(resolvedAttributes)/ContractUnitId	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	"{74A0A86B-7FB6-43B1-BA34-2F3CA85A3E36}"	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 Contract Unit 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 contract unit.	entity	a reference to the constant entity holding the list of localized text

is.dataFormat.integer

ContractUnitName

The name of a contract unit.
First included in: ContractUnit (this entity)

Properties

Name	Value
displayName	Contract Unit Name
description	The name of a contract unit.
dataFormat	string
maximumLength	256
isNullable	true

Traits

List of traits for the ContractUnitName 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	"{9BCFFC4E-4304-4351-8EF4-37A893388EA8}"	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 Contract Unit 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 contract unit.	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.

ContractUnitDescription

The description of a contract unit.
First included in: ContractUnit (this entity)

Properties

Name	Value
displayName	Contract Unit Description
description	The description of a contract unit.
dataFormat	string
maximumLength	2048
isNullable	true

Traits

List of traits for the ContractUnitDescription 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	"{14A97ECA-2B0C-4030-848B-9455D6A99612}"	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 Contract Unit 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 contract unit.	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.