General
General
This chapter contains message implementation guides regarding classes used in all Elhub messages, ie. Header and Process class.
Header
The header class is included in ALL messages.
Class diagram
Element | Lvl | Definition | Description | Card | Max | Content | XML element |
|---|---|---|---|---|---|---|---|
Header | 1 | Header class | 1..1 | Header | |||
Identification | 2 | Unique identification of the business document | Universal Unique Identifiers (UUID) must be used. Ref. Identification of messages | 1..1 | A36 | UUID | Identification |
Document Type | 2 | Type of document being sent | Code depending on message being sent | 1..1 | A3 | DocumentType | |
listAgency Identifier | 2 | Attribute to the DocumentType | Identification of the agency maintaining the code list for document types | 1..1 | A3 | listAgencyIdentifier | |
Creation | 2 | Date and time of creation of the business document by the sender. | For additional information ref. DateTime elements. | 1..1 | YYYY-MM-DDTHH:MM:SSZ or YYYY-MM-DDTHH:MM:SS[+-][HH:MM] | Creation | |
| Request Positive Acknowledgement | 2 | Indicator to trigger a Positive Acknowledgement to be returned to the physical sender of the message. Applies to incoming messages only. | To be used in market process, masterdata messages and some query messages:
Not applicable for RequestDataFromElhub and RequestUpfrontMeteringPointCharacteristics because the result of the queries is regarded as a positive acknowledgement. Not applicable for BRS-NO-317. Not applicable for polling messages (PollForData and the Acknowledgement message). | 0..1 | boolean | true/false | RequestPositiveAcknowledgement |
Physical Sender Energy Party | 2 | Physical Sender Energy Party Complex Type | 1..1 | PhysicalSenderEnergyParty | |||
Identification | 3 | Unique identification of the physical sender of the document | All parties are identified by using Global Location Number (GLN). | 1..1 | A13 | Physical Sender ID | Identification |
schemeAgency Identifier | 3 | Attribute to the Physical Sender Identification element | Identification of the agency issuing the identifier used as physical sender identification | 1..1 | A1 | 9 | schemeAgencyIdentifier |
| Juridical Sender Energy Party | 2 | Juridical Sender Energy Party Complex Type | 1..1 | JuridicalSenderEnergyParty | |||
Identification | 3 | Unique identification of the juridical sender of the document | All parties are identified by using Global Location Number (GLN). | 1..1 | A13 | Juridical Sender ID | Identification |
schemeAgency Identifier | 3 | Attribute to the Juridical Sender Identification element | Identification of the agency issuing the identifier used as juridical sender identification | 1..1 | A1 | 9 | schemeAgencyIdentifier |
Juridical Recipient Energy Party | 2 | Juridical Recipient Energy Party Complex Type | 1..1 | JuridicalRecipientEnergyParty | |||
Identification | 3 | Unique identification of the recipient of the document | All parties are identified by using Global Location Number (GLN). | 1..1 | A13 | Juridical Recipient ID | Identification |
schemeAgency Identifier | 3 | Attribute to the Recipient Identification element | Identification of the agency issuing the identifier used as juridical recipient | 1..1 | A1 | 9 | schemeAgencyIdentifier |
Process
The process energy context class is included in ALL messages.
Class diagram
Element | Lvl | Definition | Description | Card | Max | Content | XML element |
|---|---|---|---|---|---|---|---|
ProcessEnergy Context | 1 | Process Energy Context Class | 1..1 | ProcessEnergyContext | |||
Energy Business Process | 2 | The nature of the process that the document is directed at. | Ref. Elhub BRS identifications for a complete overview and description of the business processes used by Elhub | 1..1 | A10 | EnergyBusinessProcess | |
listAgencyIdentifier | 2 | Attribute to the Energy Business Process | Identification of the agency maintaining the code list for energy business processes | 1..1 | A2 | 89 | listAgencyIdentifier |
Energy Business Process Role | 2 | The business role of the market party sending or receiving the market message | Ref. Roles and domains for a complete overview and description of the business process roles. | 1..1 | A3 | EnergyBusinessProcessRole | |
listAgencyIdentifier | 2 | Attribute to the Energy Business Process Role | Identification of the agency maintaining the code list for energy business process roles | 1..1 | A2 | 6 or 89 | listAgencyIdentifier |
Energy Industry Classification | 2 | Classification of industry | 23 Electricity supply industry | 1..1 | A2 | 23 | EnergyIndustryClassification |