[NB] START_AUFH_ZUK_ZUORDNUNG
Marktrolle NB · Formatversion 202610 · BO4E-Schema 1.7.8
Master data
Exactly one of the following 2 check identifiers is permitted under this topic — which one is decided by the event process.
| Prüfi | Scope | Use case | Regulatory determination | Communication |
|---|---|---|---|---|
| PI_44038 | UTILMD_GAS | Information notification on the cancellation of a future assignment | GeLi Gas 2.0 | NB → LF (future LF) |
| PI_55038 | UTILMD | Revocation of a future assignment | GPKE part 2 | NB → LFZ |
The master data of the 2 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 | 44038 | 55038 | Condition |
|---|---|---|---|---|---|
| stammdaten | — | object | May | May | — |
| BILANZIERUNG [ ] | — | object[] | May | — | — |
| bilanzierungsende00010 | Exclusive end of balancing | string (date-time) | May | — | — |
| MARKTLOKATION [ ] * | — | object[] | Must | May | — |
| marktlokationsId *00020 | Identification number of a market location at which energy is either consumed or generated | string | Must | May | — |
| NETZNUTZUNGSVERTRAG [ ] | — | object[] | May | May | — |
| vertragsbeginn00030 | Specifies when the contract begins. | string (date-time) | May | May | — |
| TRANCHE [ ] | — | object[] | — | May | — |
| tranchenId00040 | tranchenId | string | — | May | — |
Chain of this trigger
The event triggers the message.
| Message | Responses | Write call after the response |
|---|---|---|
| 44038 | — | — |
| 55038 | — | — |
This event triggers steps in these role views:
| Process | Party involved | Rulebook | Division |
|---|---|---|---|
| Start of supply | NB | GPKE part 2 | Electricity |
| End of supply from NB to LF | NB | GPKE part 2 | Electricity |
| Start of supply | NB | GeLi Gas 2.0 | Gas |
Transaction data
The interchange envelope of the message. Mandatory fields must be set on the trigger call.
| Field | Type | Mandatory | Description |
|---|---|---|---|
| sparte | Enum Sparte | yes | Contains information about the division Values: STROM, GAS, FERNWAERME, NAHWAERME, WASSER, ABWASSER |
| transaktionsgrund | string | yes | The transaction reason describes the business transaction for the category in more detail / UTILMD STS+7++###+ZW4+E03 |
| transaktionsgrundergaenzung | string | yes | Supplement to the transaction reason / UTILMD STS+7++E01+###+E03 |
| vertragsbeginn | string (date-time) | yes | Contract start date / DTM+92 |
pruefidentifikator | — | no | Determined dynamically in the event process (decision basis: sparte). A value supplied by the sender is ignored. Check identifiers possible in the topic — 44038, 55038. Possible values: 44038, 55038 |
| 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_AUFH_ZUK_ZUORDNUNG. 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_AUFH_ZUK_ZUORDNUNG | 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.