[LF] START_UEBERM_DEFINITION
Marktrolle LF · Formatversion 202610 · BO4E-Schema 1.7.8
Master data
Exactly one of the following 3 check identifiers is permitted under this topic — which one is decided by the event process.
| Prüfi | Scope | Use case | Regulatory determination | Communication |
|---|---|---|---|---|
| PI_25005 | UTILTS | Transmission of a rolled-out metering time period definition | GPKE part 3 | NB → LF |
| PI_25008 | UTILTS | Transmission of a rolled-out switching time definition | GPKE part 3 | NB → LF |
| PI_25009 | UTILTS | Transmission of a rolled-out power curve definition | GPKE part 3 | NB → LF |
The master data of the 3 check identifiers in one structure — one column per check identifier, as in the application handbook. A value in the column means that the field belongs to this check identifier: Must where its specification requires it, otherwise May. An empty cell means »not part of it«, not »unknown«. The first one is preselected; the bar above the table adds the others.
| Structure (BO4E) | Description | Format | 25005 | 25008 | 25009 | Condition |
|---|---|---|---|---|---|---|
| stammdaten | — | object | May | May | May | — |
| ZAEHLZEITDEFINITION [ ] * | — | object[] | Must | — | — | — |
| beginndatum *00010 | The inclusive point in time from which the metering time period definitions are rolled out | string (date-time) | Must | — | — | — |
| code *00020 | Metering time period definition | string | Must | — | — | — |
| endedatum00030 | The exclusive point in time up to which the metering time period definitions are rolled out | string (date-time) | May | — | — | — |
| version *00040 | Version of the metering time period definition as a date | string (date-time) | Must | — | — | — |
| zaehlzeiten [ ] * | — | object[] | Must | — | — | — |
| aenderungszeitpunkt *00050 | aenderungszeitpunkt | string (date-time) | Must | — | — | — |
| haeufigkeit00060 | Frequency of transmission | Enum HaeufigkeitZaehlzeit | May | — | — | — |
EINMALIG | — | — | May | — | — | — |
JAEHRLICH | — | — | May | — | — | — |
| register *00070 | register | string | Must | — | — | — |
| SCHALTZEITDEFINITION [ ] * | — | object[] | — | Must | — | — |
| beginndatum *00080 | beginndatum | string (date-time) | — | Must | — | — |
| code *00090 | code | string | — | Must | — | — |
| endedatum00100 | endedatum | string (date-time) | — | May | — | — |
| version *00110 | version | string (date-time) | — | Must | — | — |
| schaltzeiten [ ] * | — | object[] | — | Must | — | — |
| aenderungszeitpunkt *00120 | aenderungszeitpunkt | string (date-time) | — | Must | — | — |
| haeufigkeit00130 | HaeufigkeitSchaltzeit | Enum HaeufigkeitSchaltzeit | — | May | — | — |
EINMALIG | — | — | — | May | — | — |
JAEHRLICH | — | — | — | May | — | — |
| schalthandlung *00140 | Switching operation | Enum Schalthandlung | — | Must | — | — |
LEISTUNG_AN | — | — | — | Must | — | — |
LEISTUNG_AUS | — | — | — | Must | — | — |
| LEISTUNGSKURVENDEFINITION [ ] * | — | object[] | — | — | Must | — |
| beginndatum *00150 | beginndatum | string (date-time) | — | — | Must | — |
| code *00160 | code | string | — | — | Must | — |
| endedatum00170 | endedatum | string (date-time) | — | — | May | — |
| version *00180 | version | string (date-time) | — | — | Must | — |
| leistungskurven [ ] * | — | object[] | — | — | Must | — |
| aenderungszeitpunkt *00190 | Time of change | string (date-time) | — | — | Must | — |
| haeufigkeit00200 | HaeufigkeitLeistungskurve | Enum HaeufigkeitLeistungskurve | — | — | May | — |
EINMALIG | — | — | — | — | May | — |
JAEHRLICH | — | — | — | — | May | — |
| schwellwert * | — | object | — | — | Must | — |
| obererSchwellwert *00210 | obererSchwellwert | number (float) | — | — | Must | — |
Chain of this trigger
The event triggers the message.
| Message | Responses | Write call after the response |
|---|---|---|
| 25005 | — | — |
| 25008 | — | — |
| 25009 | — | — |
This event triggers a step in this role view:
| Process | Party involved | Rulebook | Division |
|---|---|---|---|
| Transmission of a definition of the LF by the LF | LF | GPKE part 3 | Electricity |
Transaction data
The interchange envelope of the message. Mandatory fields must be set on the trigger call.
| Field | Type | Mandatory | Description |
|---|---|---|---|
| anfrageReferenz | string | yes | Application number / RFF+AGI |
| kategorie | string | yes | Qualifier from the beginning of the EDIFACT message / BGM |
| sparte | Enum Sparte | yes | Contains information about the division Values: STROM, GAS, FERNWAERME, NAHWAERME, WASSER, ABWASSER |
pruefidentifikator | — | no | Determined dynamically in the event process (decision basis: kategorie). A value supplied by the sender is ignored. Check identifiers possible in the topic — 25005, 25008, 25009. Possible values: 25005, 25008, 25009 |
| absender › rollencodenummer | string | no | Specifies the code value of the market role. |
| empfaenger › rollencodenummer | string | no | Specifies the code value of the market role. |
Additional data
eventname is fixed to START_UEBERM_DEFINITION. This value stays German in the English version as well, because Camunda correlates on it.
| Field | Type | Mandatory | Description |
|---|---|---|---|
prozessId | string | yes | — |
eventname | const START_UEBERM_DEFINITION | yes | — |
Response
The trigger assigns its own businessKey. The MACO APP adopts neither the businessKey nor the prozessId of the calling system as the identifier of the process instance. The businessKey of the response is created when the process starts and is new. The body of this call carries no businessKey field; there is thus no place where a key of your own could be passed in. The prozessId passed in (a mandatory field of this call) remains the document number of the backend: it comes back in zusatzdaten.prozessId of the callbacks — mandatory there only for MaloIdent (03002/03003), otherwise optional.
201 — Success. Success message for the process data API call.
| Field | Type | Mandatory | Description |
|---|---|---|---|
businessKey | string (uuid) | yes | Unique identifier of the business process |
message | string | yes | Message with details of the triggered event — example from the source: received event XXXXXXXXXXXX with id at 2024-08-08T12:58:22Z and started process with businessKey 4c7170ed-3518-41ee-8582-39ab65b00107 |
400 — Error. Error message for the process data API call.
| Field | Type | Mandatory | Description |
|---|---|---|---|
errorCode | string | no | Error identifier — example from the source: 400 |
message | string | no | Technical message — example from the source: Validation Failed |
Which body the callbacks updateProcessData and createProcessData send is measured against the NiFi flow of the MACO APP: {stammdaten, transaktionsdaten, zusatzdaten} without an interchange envelope, the businessKey inside zusatzdaten. This is not measured against a recorded call, and not for MaloIdent (03002/03003).
What distinguishes businessKey, prozessId and targetBusinessKey is explained on Keys and assignment.