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
"{3EEFC58B-2703-428D-A837-F01CDA02C9CF}"
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
"Sustainability"
string
is.localized.displayedAs
Holds the list of language specific display text for an object.
Parameter
Value
Data type
Explanation
localizedDisplayText
languageTag
displayText
en
Party Customer Group Water Metric
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.
The unique identifier of a Party.
First included in: PartyCustomerGroupWaterMetric (this entity)
Properties
Name
Value
displayName
Party ID
description
The unique identifier of a Party.
isPrimaryKey
true
dataFormat
int64
Traits
List of traits for the PartyId 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.
is.identifiedBy
Names a specific identity attribute to use with an entity.
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.
a reference to the constant entity holding the list of entity references
is.localized.displayedAs
Holds the list of language specific display text for an object.
Parameter
Value
Data type
Explanation
localizedDisplayText
languageTag
displayText
en
Party 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 Party.
entity
a reference to the constant entity holding the list of localized text
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
"{E1F5B0A7-9B32-4CDD-86DC-1B045C1CEF9D}"
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 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.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.
a reference to the constant entity holding the list of entity references
is.localized.displayedAs
Holds the list of language specific display text for an object.
Parameter
Value
Data type
Explanation
localizedDisplayText
languageTag
displayText
en
Customer Group 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 Customer Group.
entity
a reference to the constant entity holding the list of localized text
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
"{E7439DE6-6CB4-412C-B388-10AC91A9B477}"
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.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.
a reference to the constant entity holding the list of entity references
is.localized.displayedAs
Holds the list of language specific display text for an object.
Parameter
Value
Data type
Explanation
localizedDisplayText
languageTag
displayText
en
Water 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 water type.
entity
a reference to the constant entity holding the list of localized text
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
"{D03EC2CD-9DD4-4D0E-A19C-49C3BF92FBE0}"
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.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.
a reference to the constant entity holding the list of entity references
is.localized.displayedAs
Holds the list of language specific display text for an object.
Parameter
Value
Data type
Explanation
localizedDisplayText
languageTag
displayText
en
Water Metric 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 water type.
entity
a reference to the constant entity holding the list of localized text
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
"{03AEA847-900B-4971-A357-7B2CE5240057}"
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.
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
"{3B45E265-5B56-48E3-A284-B944CD3AF766}"
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
Party Customer Group Water Metric Period Start Date
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 period start date of the Party Customer Group Water Metric.
entity
a reference to the constant entity holding the list of localized text
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
"{626F29F2-9C6C-4A16-8725-5521749562E8}"
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
Party Customer Group Water Metric Period End Date
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 period end date Party Customer Group Water Metric.
entity
a reference to the constant entity holding the list of localized text
The total units of Party Customer Group Water Metric.
First included in: PartyCustomerGroupWaterMetric (this entity)
Properties
Name
Value
displayName
Party Customer Group Water Metric Units
description
The total units of Party Customer Group Water Metric.
dataFormat
int32
isNullable
true
Traits
List of traits for the PartyCustomerGroupWaterMetricUnits 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
"{00CD43B1-2032-4851-821B-7E6EA9954A99}"
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
Party Customer Group Water Metric Units
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 total units of Party Customer Group Water Metric.
entity
a reference to the constant entity holding the list of localized text
The unique identifier of a Unit Of Measure.
First included in: PartyCustomerGroupWaterMetric (this entity)
Properties
Name
Value
displayName
Unit Of Measure ID
description
The unique identifier of a Unit Of Measure.
dataFormat
int32
isNullable
true
Traits
List of traits for the UnitOfMeasureId 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
Unit Of Measure 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 Unit Of Measure.
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.
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
"{9F9F0438-0F85-4D0D-8B03-5EEC495EBD5E}"
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.
The total amount charged to the customer.
First included in: PartyCustomerGroupWaterMetric (this entity)
Properties
Name
Value
displayName
Party Customer Group Water Metric Revenue Amount
description
The total amount charged to the customer.
dataFormat
decimal
isNullable
true
Traits
List of traits for the PartyCustomerGroupWaterMetricRevenueAmount attribute are listed here.
is.dataFormat.numeric.shaped
for setting the exact precision and scale of numeric values
Parameter
Value
Data type
Explanation
precision
"18"
integer
the total number of significant digits
scale
"2"
integer
the 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.
Parameter
Value
Data type
Explanation
identifier
"{01DE5739-410D-4054-B8FE-CA4441355EF8}"
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
Party Customer Group Water Metric Revenue Amount
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 total amount charged to the customer.
entity
a 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
The cost of providing this to the customer.
First included in: PartyCustomerGroupWaterMetric (this entity)
Properties
Name
Value
displayName
Party Customer Group Water Metric Cost Amount
description
The cost of providing this to the customer.
dataFormat
decimal
isNullable
true
Traits
List of traits for the PartyCustomerGroupWaterMetricCostAmount attribute are listed here.
is.dataFormat.numeric.shaped
for setting the exact precision and scale of numeric values
Parameter
Value
Data type
Explanation
precision
"18"
integer
the total number of significant digits
scale
"2"
integer
the 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.
Parameter
Value
Data type
Explanation
identifier
"{71870C86-5455-4B6B-A276-A7662A19419E}"
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
Party Customer Group Water Metric Cost Amount
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 cost of providing this to the customer.
entity
a 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
The ISO 4217 currency code.
First included in: PartyCustomerGroupWaterMetric (this entity)
Properties
Name
Value
displayName
ISO Currency Code
description
The ISO 4217 currency code.
dataFormat
string
maximumLength
3
isNullable
true
Traits
List of traits for the IsoCurrencyCode 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.
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
ISO Currency Code
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 ISO 4217 currency code.
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
"3"
integer
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.
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
"{0DEBD49B-33E3-44B1-B71D-74E065D2146B}"
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.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.
A note, comment or additional information regarding the Party Water Metric.
First included in: PartyCustomerGroupWaterMetric (this entity)
Properties
Name
Value
displayName
Party Customer Group Water Metric Note
description
A note, comment or additional information regarding the Party Water Metric.
dataFormat
string
maximumLength
2048
isNullable
true
Traits
List of traits for the PartyCustomerGroupWaterMetricNote 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
"{00850355-C1A6-4123-BF83-72B04F5BC8F5}"
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
Party Customer Group Water Metric Note
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
A note, comment or additional information regarding the Party Water Metric.
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.