...
| Titel | Zwischenmeldung zur Auftragsrealisierung versenden |
|---|
| Kurzbeschreibung | Folgender Ablauf beschreibt die typischen API- Interaktionen zwischen Auftraggeber und Leistungserbringer im Anwendungsfall "Zwischenmeldung zur Auftragsrealisierung versendenAuftragsrealisierung versenden". Mit diesem Anwendungsfall stellt der Leistungserbringer dem Auftraggeber , Informationen zur Auftragsrealisierung bereit. Insbesondere können Informationen über Folge-Aufträge zum Leistungserbringer mitgeben werdenmitgegeben werden. Dabei werden die für diesen Ablauf erforderlichen Auftrags-Status durchlaufen und die für diesen Ablauf relevanten Informationen übermittelt. |
|---|
| Vorbedingung | Der Auftrag befindet sich mindestens in der Realisierungtechnischen Validierung und somit im Status "accepted". |
|---|
| Auslöser | Es stehen Informationen zur Auftragsrealisierung bereit. |
|---|
| Ergebnis | Die Zwischenmeldung zur Auftragsrealisierung wurde versendet |
|---|
Ablauf
| Img |
|---|
src | | Bitbucket file macro |
|---|
| url | https://www.plantuml.com/plantuml/png/VP2zJa9148NxVOe9bHJ4I651OV17Em89nCfcxjtZPPAzisHsLkJjtQ0nqZZj-RwJaraMP_Cwfi3LizQnWuKkVz93FS4elvFYI4aKuT10wUN0wjGH5vgiBS94XqcWxpkRMwG4eztgvNO-lx0E-QnjBCVQ-zbkQg0cjcXsHzs2DkljZluIz-ucNNMySgfutBCEUFw0-jKqQ7QGoR3t1Jt1QCEdb3bI4OtNKfmQTaHioPlIZ6vcUb7ToenxXpLK-aBvbuGeiJltUupguPzvAqaedlLdawZ3HaHXnmgby81fM49ZU_4N |
|---|
|
| Codeblock |
|---|
|
@startuml
autonumber
box Buyer of new line
participant b as "Ordering"
box Seller TMF622
participant po as "ProductOrder"
po -> b: POST ProductOrderAttributeValueChangeEvent()
note right: Der Payload sind/ist entweder \n - 1-n ProductOrderCharacteristics oder \n - ein attachemnt
po -> b: POST ProductOrderMilestoneEvent(intermediateMessage)
@enduml |
Beispiel für den Payload einer ZWM-LE aus der S/PRI:
| Codeblock |
|---|
|
ProduktGruppe=FTTH-2.0-L3-BSA; NGA=DTAG; Geschaeftsfall=NEU; extAuftragsnummer=APO***8 |
Abbildung in FIT:
| Codeblock |
|---|
|
ProductOrder.productOrderCharacteristic =
- aggregatorProductOffering
- aggregatorNGA
- aggregatorOrderAction
- aggregatorOrderId
|
...
ProductOrderAttributeValueChange (Aggregator)
| Stashincludebyfilepath |
|---|
| repoSlug | fit-root |
|---|
| branchId | refs/heads/main |
|---|
| projectKey | TFIT |
|---|
| filepath | tmf622/examples/ftth-no-optsbitbucket.org/fit-api/fit-api/src/main/tmf622/assets/SendMilestoneEvent.puml |
|---|
| syntaxHighlighting | PlantUML |
|---|
|
Beispieldaten
POST ProductOrderAttributeValueChangeEvent (Aggregator) (1)
| Bitbucket file macro |
|---|
| collapsible | true |
|---|
| url | https://bitbucket.org/fit-api/fit-api/src/main/tmf622/examples/product-order-4d-attribute-value-change-event-aggregator.json |
|---|
| showLineNumberssyntaxHighlighting | true |
|---|
| progLang | plain |
|---|
| collapsible | true |
|---|
| applicationLink | cbfa78ef-cb5e-30f5-8b3b-ec5f9d824e1d |
|---|
| JSON |
|
| ProductOrderAttributeValueChange (setzen von AuftragsmanagmentAuftragsdaten für Aggregator) |
Eventdate| Felder | Daten | API Feld |
| technisches EventDatum | 2022-05-25T10:32:00 | eventTime |
| Produktgruppe | FTTH-2.0-L3-BSA | productOrder/productOrderCharacteristicadditionalOrderData.value productOrder/productOrderCharacteristicadditionalOrderData.name = "aggregatorProductOffering" |
| NGA | DTAG | productOrder/productOrderCharacteristic.value additionalOrderData productOrder/productOrderCharacteristicadditionalOrderData.name = "aggregatorNGA" |
| Geschäftsfall | NEU | productOrder/productOrderCharacteristicadditionalOrderData.value productOrder/productOrderCharacteristicadditionalOrderData.name= "aggregatorOrderAction" |
| externeAuftragsnummer | AP0***8 | productOrder/productOrderCharacteristicadditionalOrderData.value productOrder/productOrderCharacteristicadditionalOrderData.name= "aggregatorOrderId" |
...
POST ProductOrderMilestoneEvent(intermediateMessage) (2)
| Bitbucket file macro |
|---|
| collapsible | true |
|---|
| url | https://bitbucket.org/fit-api/fit-api/src/main/tmf622/examples/product-order-4e- |
|---|
|
...
| milestone-event-intermediate.json |
|
...
...
...
ProductOrderMilestoneEvent
|
...
...
| ProductOrderProcessingMessageEvent (setzen von Auftragsmanagment) |
| proccesingMessageType | intermediateMessage |
proccesingMessageDate| Daten | API Feld |
| Typ des Product Order Milestone Events | intermediateMessage | name |
| Datum und Uhrzeit des Milestones | 2022-05-25T10:33:00 | proccesingMessageReason | proccesingMessageTypeTextmilestoneDate |
| Meldecode des Milestones | 0073 | milestoneMessage.code |
| Meldungstext des Milestones | Information zum Auftrag. | milestoneMessage.text |
