Versionen im Vergleich

Schlüssel

  • Diese Zeile wurde hinzugefügt.
  • Diese Zeile wurde entfernt.
  • Formatierung wurde geändert.

...

TitelHinzufügen, Änderung und/oder Löschen einer Produktoption zu einem laufenden Auftrag
Kurzbeschreibung

Folgender Ablauf beschreibt die typischen Interaktionen zwischen Auftraggeber und Leistungserbringer im Anwendungsfall "Hinzufügen, Änderung und/oder Löschen einer Produktoption zu einem laufenden Auftrag". 

Beispiel: Hinzufügen optionalen Serviceleistung für ein Hauptprodukt (Telekom) 

Dabei werden die für diesen Ablauf erforderlichen Auftrags-Status durchlaufen und die für diesen Ablauf relevanten Informationen übermittelt.

Hinweis:

Die Taskresource wird syntaktisch synchron validiert: Pflichtparameter gesetzt etc. (Folge-Zustand Acknowledged)

Danach wurde sie fachlich validiert: PO existiert und im richtigen Zustand (Folge-Zustand InProgress)

Schließlich erfolgt die Aktualisierung der ProductOrder (Folge-Zustand done)

Vorbedingung

Die dazugehörige Product Order muss existieren und kaufmännisch validiert sein, so dass sich der Auftrag mindestens im Status  accepted befindet. (nicht abgebrochen oder beendet)

Die Produktposition muss einen Bezug zum Hauptprodukt haben (ProductOrder ResourceModelProductOrderItem)

Mindestens alle Pflichtfelder für die Meldung eines Montagehinweises sind laut Auftragsmedestruktur Auftrags-/Meldungsstruktur (download) gefüllt.

Ein Hinzufügen, Änderung und/oder Löschen muss erst abgeschlossen sein, bevor eine erneute Aktion gestartet werden kann.

AuslöserAuftraggeber möchte beim Leistungserbringer eine optionale Serviceleistung für eine laufende ProductOrder, durch Erzeugung einer Task Resource vom Typ AmendProductOrder  buchen
Ergebnis

Die Produktposition wurde erfolgreich der ProductOrder hinzugefügt, geändert oder gelöscht.


Ablauf

tmf622/documentation
Stashincludebyfilepath
repoSlugfit-root
branchIdrefs/heads/main
projectKeyTFIT
filepath
Bitbucket file macro
urlhttps://bitbucket.org/fit-api/fit-api/src/main/resourcestmf622/docs/diagramsassets/AmendProductOrder.puml
progLangsyntaxHighlightingplantuml
applicationLinkcbfa78ef-cb5e-30f5-8b3b-ec5f9d824e1d
PlantUML

Beispieldaten

Im Beispiel wird eine optionale Serviceleistung ergänzt

POST AmendProductOrder (1)

Bitbucket file macro
collapsibletrue
urlhttps://bitbucket.org/fit-api/fit-api/src/main/tmf622/examples/amend-product-order-0-create.json
syntaxHighlightingJSON

fachliche FelderDaten API Felder

technisches Event Datum

2022-05-12T08:45:00+02:00EventTime
zu ändernde Order 388a4963-f168-4603-99e8-477200099d91AmendProductOrder/productOrder.id
zu ergänzende optionale Serviceleistung
Aktionscode der AmendActionaddAmendProductOrder/amendProductOrderItem.amendAction
Auftragsposition2AmendProductOrder/amendProductOrderItem/productOrderItem.id
Aktionscode des OrderItemsaddAmendProductOrder/amendProductOrderItem/ProductOrderItem.action
Produktname"Bereitstellung Komfort"AmendProductOrder/amendProductOrderItem/productOrderItem/productOffering.name
Beziehung zum zweiten ProductOrderItem1AmendProductOrder/amendProductOrderItem/ProductOrderItem/productOrderItemRelationship.id
dependsOnAmendProductOrder/amendProductOrderItem/ProductOrderItem/productOrderItemRelationship.relationshipType

Response (2)

Bitbucket file macro
collapsibletrue
urlhttps://bitbucket.org/fit-api/fit-api/src/main/tmf622/examples/amend-product-order-1.json
syntaxHighlightingJSON

AmendProductOrderStateChangeEvent: inProgress (3)

Bitbucket file macro
collapsibletrue
urlhttps://bitbucket.org/fit-api/fit-api/src/main/tmf622/examples/amend-product-order-2-state-change-event-in-progress.json
syntaxHighlightingJSON

fachliche FelderDaten API Felder

technisches Event Datum

2022-05-12T11:30:00+02:00EventTime

Status Wechsel auf inProgress

Status:

Datum/Uhrzeit des Statuswechsels


inProgress

2022-05-11T11:30:00+02:00


AmendProductOrder.state

AmendProductOrder.stateChangeDate

AmendProductOrder erfolgreich

ProductOrderAttributeValueChangeEvent (4)

Bitbucket file macro
collapsibletrue
urlhttps://bitbucket.org/fit-api/fit-api/src/main/tmf622/examples/product-order-2b-attribute-value-change-event-amend.json
syntaxHighlightingJSON

fachliche FelderDaten API Felder

technisches Event Datum

2022-05-12T11:31:00+02:00EventTime
Auftragsposition2ProductOrder/productOrderItem.id
AktionscodeaddProductOrder/ProductOrderItem.action
Produktname"Bereitstellung Komfort"ProductOrder/ProductOrderItem/productOffering.name

AmendProductOrderStateChangeEvent

...

: done (5)

Bitbucket file macro
collapsibletrue
urlhttps://bitbucket.org/fit-api/fit-api/src/main/tmf622/examples/amend-product-order-4a-state-change-event-done.json
syntaxHighlightingJSON

fachliche FelderDaten API Felder

technisches Event Datum

2022-05-12T11:31:10+02:00EventTime

Status Wechsel auf done

Status:

Datum/Uhrzeit des Statuswechsels


done

2022-05-11T11:31:10+02:00


AmendProductOrder.state

AmendProductOrder.stateChangeDate

AmendProductOrder abgelehnt

Bitbucket file macro
collapsibletrue
urlhttps://bitbucket.org/fit-api/fit-api/src/main/tmf622/examples/amend-product-order-4b-state-change-event-rejected.json
syntaxHighlightingJSON