XTA 2 - Interoperabilitätsstandard zur Einbindung von IT-Fachapplikationen in eine Infrastruktur für Nachrichtenübermittlung
XTA 2
xta2
urn:xoev-de:kosit:standard:xta2
XTA ist ein vom IT-Planungsrat empfohlener Interoperabilitätsstandard. XTA (XÖV Transport Adapter) definiert einen Webservice für die Anbindung von IT-Fachapplikationen an eine technische Infrastruktur für Nachrichtenübermittlung (Transportverfahren). Diese Webservice-Definition (genannt XTA-Webservice) ist für alle Fachlichkeiten einsetzbar. Außerdem bietet XTA Definitionen für Struktur und Semantik von "Service Profilen" an. Mittels eines instanziierten "XTA Service Profils" formuliert eine Fachlichkeit die durch sie geforderten Service Qualitäten für die Nachrichten- und Datenübermittlung dieser Fachlichkeit.
2.2
1.5.1
2.1
3.0.1
18.0 SP6
MagicDraw
Struktur für die Attribute/Eigenschaften einer Nachricht in der MessageBox.
Eindeutige ID der Nachricht.
Bezug zu weiteren Nachrichten anhand von deren MessageIDs.
Ursprung der Nachricht (als Endpoint Reference).
Geschäftsszenario der Nachricht für Zuordnung bzw gefilterten Abruf durch den Leser.
Größe der Nachricht in Kilobytes als positiver Integer.
Verfallsdatum der Nachricht, welches - falls angegeben - den Wert des Elements ObsoleteAfter aus dem SOAP-Header der zugrundeliegenden OSCI1.2-Nachricht enthält.
Zeitpunkt der Zustellung der Nachricht, welcher - falls angegeben - den Wert des Elements Delivery aus dem SOAP-Header der zugrundeliegenden OSCI1.2-Nachricht enthält.
Zeitpunkt des ersten Abrufs der Nachricht, welcher - falls angegeben - den Wert des Elements InitialFetch aus dem SOAP-Header der zugrundeliegenden OSCI1.2-Nachricht enthält.
Nachricht zum Schließen eines Abhol-Auftrags nach dem Abruf von Nachrichten durch den Leser, bzw. den Abbruch eines iterativen Nachrichtenabrufes (z.B. durch die WS-Methoden getMessage oder getStatusList).
MessageID der letzten, vom Leser erhaltenen Nachricht als Bestätigung über den Erhalt. Sobald der erfolgreiche Abruf durch den Leser signalisiert wird, setzt der Empfänger/MsgBox den Zeitstempel Receiption im MessageMetaData-Header der Nachricht auf seine Systemzeit.
Die Ressourcenkennung (Iterator) der vorangegangenen MsgBoxResponse zur Zuordnung zum ursprünglichen Abhol-Auftrag (MsgBoxFetchRequest bzw. MsgBoxStatusListRequest).
Diese Struktur konkretisiert die Abfrage von Nachrichten aus der MessageBox des Lesers.
Der Leser kann über ein NMTOKEN zwischen verschiedenen Formen der Zustellung wählen: Envelope: Der vollständige s12:Envelope-Container der gewählten Nachricht wird als Nutzlast der SOAP-Nachricht mitgeliefert. Variante ist die Voreinstellung. Header: Der SOAP-Header der Nachricht wird als Nutzlast der Antwort zugestellt. Body: Nur die Nutzlast der ursprünglichen SOAP-Nachricht wird als Nutzlast der Antwort zugestellt. Wird dieses Attribut nicht angegeben, ist Body der Default-Wert.
Struktur für die Abfrage noch nicht erhaltener Nachrichten einer Ergebnismenge in einer MessageBox.
MessageID der letzten, vom Leser erhaltenen Nachricht als Bestätigung über den Erhalt. Falls das Header-Elemente osci:Reception im SOAP-Header-Block MsgTimeStamps der zugrundeliegenden OSCI 1.2-Nachricht fehlt oder genullt ist, ist hier die Systemzeit einzutragen und in den SOAP-Header-Block in der MessageBox zu übertragen.
Die Ressourcenkennung (Iterator) des vorangegangenen MsgBoxResponse zur Zuordnung zum ursprünglichen Abhol-Auftrag (MsgBoxFetchRequest bzw. MsgBoxStatusListRequest). Die ID kann an andere Leser weitergereicht werden, falls mehrere Leser auf die Nachrichten zugreifen wollen.
Diese Struktur ermöglicht die Selektion der durch den Leser angeforderten Nachrichten oder Status-Listen.
Betreff der Nachricht (informatorisch)
Diese Struktur enthält die Nutzlast einer Antwort auf MessageBox-Anfragen (MsgBoxFetchRequest und MsgBoxStatusListRequest).
Dieses Element ist zu befüllen, falls keine Nachrichten in der MessageBox zur Verfügung stehen. Hier sind URI-Werte gemäß folgender Systematik einzutragen: Keine Treffer für Filterkriterien: http://www.osci.eu/ws/2008/05/transport/ MsgBox/reasons/NoMatch Fehlerhafte Such- bzw. Filterkriterien:http://www.osci.eu/ws/2008/05/transport/ MsgBox/reasons/SearchArgsInvalid Request-ID nicht bekannt oder verfügbar: http://www.osci.eu/ws/2008/05/common/urn/ MsgBox/reasons/RequestIdInvalid Weiterer spezifischer Grund: beliebige, vereinbarte weitere URI. Dieser Parameter kann nicht verwendet werden, wenn osci:ItemsPending verwendet wird.
Anzahl der nach der Antwort verbliebenen Nachrichten, ist beim letzten Inkrement einer Ergebnismenge auf Null zu setzen. Dieser Parameter kann nicht verwendet werden, wenn osci:NoMessageAvailable verwendet wird.
Die Ressourcenkennung (Iterator) für Nachrichten zur Abfrage von Nachrichten und Status-Listen aus der MessageBox. Diese Ressourcenkennung muss vom Abfragenden für die Abfrage weiterer Nachrichten oder Status-Listen sowie das Beenden der Abfrage genutzt werden.
Struktur für die Parameter einer Abfrage von Nachrichten-Statusinformationen aus einer MessageBox. Hinweis: Im XTA-Kontext ist für das Attribut ListForm der Wert MessageMetaData anzugeben.
Dieses Element erlaubt dem Leser, zu spezifizieren, ob die angeforderte Status-Liste Nachrichtenattribute (siehe MsgAttributes) oder Nachrichten-Metadaten (siehe MessageMetaData) enthalten soll.
Vom Leser vorgebene maximale Anzahl an Nachrichten, die beim Aufruf der Methode getStatusList zurückgeliefert werden sollen. Der Empfänger ist ungeachtet dessen verpflichtet, die vollständige Liste der Ergebnisse vorzuhalten und diese bei nachfolgenden Anfragen mit Bezug auf diese Statusliste bereitzustellen. Diese Obergrenze kann durch den Empfänger auf Ebene der Postfach-Instanz selbstständig auf jeden Wert größer null beschränkt werden.
Parameter für die Auswahl/Filterung von Nachrichten oder Listen in einer MessageBox.
Liste der ausuwählenden Nachrichten anhand deren WS-Adressing MessageID. Das Setzen dieses Selektionskriteriums setzt ggf. andere Kriterien außer Kraft.
Liste der auszuwählenden Nachrichten anhand deren RelatesTo-Eigenschaft, z.B. Vorgängernachrichten.
Untergrenze für den Eingangszeitpunkt der auszuwählenden Nachrichten. Wenn dieses Element gesetzt ist, werden nur MessageIDs und Metadaten von Nachrichten geliefert, die nach diesem Zeitpunkt empfangen wurden.
Obergrenze für den Eingangszeitpunkt der auszuwählenden Nachrichten.Wenn dieses Element gesetzt ist, werden nur MessageIDs und Metadaten von Nachrichten geliefert, die vor diesem Zeitpunkt empfangen wurden.
Dieses Element ist eine Vorkehrung für die Festlegung weiterer Suchkriterien, zum Beispiel XPath-basierte Abfragen auf Basis des Transportauftrags oder Token zur Teilnehmererkennung.
Über diesen Wahrheitswert legt der Leser fest, ob nur neue Nachrichten in die Auswahl mit einbezogen werden sollen. Beim Fehlen dieses Attributs wird davon ausgegangen, dass nur neue Nachrichten (ohne Zeitstempel InititalFetch) ausgewählt werden sollen.
Struktur für die Inhaltsdaten einer Antwortnachricht beim Aufruf der Methode getStatusList. Abhängig vom Attribut ListForm der beantworteten Anfrage werden hier entweder Nachrichten-Attribute (MsgAttributes) oder den Transportauftrag (MessageMetaData) der ausgewählten Nachrichten übertragen.
Liste der Nachrichten-Attribute der ausgewählten Nachrichten (als Antwort auf Anfragen mit ListForm MsgAttributes ).
Liste der Transportaufträge der ausgewählten Nachrichten (als Antwort auf Anfragen mit ListFormMessageMetaData ).
Geschäftsszenario der Nachricht für Zuordnung bzw gefilterten Abruf durch den Leser. Die Identifikation von Geschäftszenarien erfolgt über eine von der KoSIT herausgegebene Codeliste, welche XTA-kompatible Fachkontexte enthält. Die Codeliste ist im XRepository unter der URN urn:de:xta:codeliste:business.scenario verfügbar. Für lokale Geschäftskontexte können Kommunikationspartner auch eigene Codelisten definieren und an dieser Stelle einbinden.
Gemäß WS-Adressing ist hier der Wahrheitswert true zu setzen.
Element des Typs MsgBoxCloseRequestType.
Element des Typs MsgBoxFetchRequestType.
Element des Typs MsgBoxGetNextRequestType.
Element des Typs MsgBoxResponseType.
Element des Typs MsgBoxStatusListRequestType.
Element des Typs MsgSelectorType.
Element des Typs MsgStatusListType.
Element des Typs TypeOfBusinessScenarioType.