Transportprofil konsistent definieren

XBAU-138
  • K1.1-E3
Geprüft
Do., 11.08.2022 - 15:05
Fertig
Mi., 31.03.2021 - 14:23
priority-icon High
  • Kernmodul

Die Definition der Übermittlung von Primärdokumenten ist nicht konsistent:

Es muss einheitlich gesagt werden, wie die Mechanismen externe Verlinkung (Element referenzPrimaerdokument) und externer Anhang (Element dateinameAnhang) ticken und was in den Elementen stehen muss. 

N.B.: Die Angaben im OSCI-Transportprofil sind Mechanismen nur für externer Anhang. 

 

Es sollte außerdem die (externe) Anhang-Lösung in XFamilie berücksichtigt werden (z.B. Version 0.2.0 vom 20.01.2021), die zu XTA und OSCI entsprechende Anleitung gibt:

  • XTA: Übertragung der Fachnachricht im Element message, Übertragung des Primärdokuments im Element attachment
  • OSCI: als Attachment im selben Inhaltsdatencontainer wie die Fachnachricht (also neben der Fachnachricht)
  • jeweils ist eine ID des Primärdokuments zu vergeben und einzutragen:
    • in der Fachnachricht
      • in XFamilie Element documentid
      • in XBau bisher so nicht vorhanden, evtl. ist aber Element referenzPrimaerdokument geeignet
    • im XTA-Container: message/@id
    • OSCI-Container: Ref.-ID

 

Definition laut Spezifikation XBau 2.2

referenzPrimaerdokument

  • Hier ist der Link auf das Primärdokument in einem Quellsystem einzutragen, der die Anlage (Primärdokument) identifiziert bzw. als Ressource verfügbar macht. Die Verlinkung auf ein Quellsystem entspricht der Architektur einer externen Verlinkung.

dateinameAnhang:

  • Hier ist der Name der Datei (Primärdokument) einzutragen, als die die Bauvorlage als Anlage zum Antrag übermittelt wird. Das Dokument wird hierbei als externer Anhang außerhalb der Nachricht in einem Archiv übertragen.

Kommentare

Antragsteller ist Hr. Schlüter, Dataport. 

Antrag vom 12.02.2021

Anmerkung zu Kollaborationsplattformen.

Bei Plattformen, die die Zusammenarbeit verschiedener Akteure in einem Projekt ermöglichen, ist es denkbar, dass Dateien (= Primärdokumente) in einen geschützten Bereich auf dieser Plattform hochgeladen und den Akteuren dort über einen Link zur Verfügung gestellt werden können.

In dem Fall wäre die Externe Verlinkung die Methode, die anzuwenden ist.

Textstelle "schärfen"

In der Beschreibung der XTA-Transportstruktur ist der Satz zu den Primärdokumeten zu weich formuliert. Er sollte ersetzt werden durch:

Primärdokumente und Anhänge zu der Fachnachricht müssen als einzelne Instanzen des Elements Attachment in demselben ContentContainer übertragen werden.

Drei Gegenstände im XBau-Kernmodul waren konsistent zu gestalten:

  1. Abschnitt II.1 Primärdokumente
  2. Datentyp AnlageBauvorlage
  3. Anhang OSCI-Transportprofil

ad (1) - Der Abschitt II.1 Primärdokumente der Spezifikation XBau-Kernmodul wurde angepasst und die beiden Mechanismen Anhang und Verlinkung für die Übermittlung von Primärdokumenten beschrieben.

Regelungsthema: Wie funktionieren die beiden Mechanismen zur Übertragung von Bauvorlagen, die der Standard XBau vorsieht? (heißen jetzt Anhang bzw. Verlinkung; werden von diesen XBau-Elementen im Datentyp AnlageBauvorlage unterstützt; gilt für alle Transporttechnologien: wie z.B. XTA, OSCI, REST, E-Mail und Brieftaube)

ad (2) - Der Datentyp AnlageBauvorlage wurde konsistent damit überarbeitet, seine relevanten Elemente heißen jetzt:  

um den Mechanismus Anhang zu unterstützen:
die Elemente dokumentid und dateiname (Bezeichnungen identisch in XFamilie)

um den Mechanismus Verlinkung zu unterstützen:
das Element uriVerlinkung

ad (3) - Die Regelungen zum OSCI-Transportprofil aus der Handlungsanweisung (zu XBau 2.2) wurden in den Anhang IV.C OSCI-Transportprofil der Spezifikation XBau-Kernmodul übertragen. Die Gliederung und einige Formulierungen wurden dabei redaktionell überarbeitet, so dass beide Abschnitte (zu XTA-WS und zu OSCI-Transport 1.2) verständlicher sind. 

Regelungsthema: Wie ist die XBau-Fachnachricht mit ihren Anhängen in den Strukturen der Transportnachrichten von XTA bzw. OSCI-Transport unterzubringen? (gilt für XBau-Fachnachrichten mit und ohne Anhänge; falls Anhänge da sind, sind diese auf diese Weise anzuordnen und im XTA- bzw. OSCI-Transportcontainer zu referenzieren)

Die Versionshistorie wurde angepasst.

In der Beschreibung der XTA-Transportstruktur wurde der Satz zu den Primärdokumeten sinngemäß entsprechend formuliert.

Lautet jetzt: 

Soweit Bauvorlagen oder sonstige Primärdokumente als Anhänge zu übertragen sind, muss pro Primärdokument ein Element Attachment in demselben ContentContainer instantiiert werden.

Bemerkung zu Kollaborationsplattformen: Der Mechanismus der (externen) Verlinkung, der dafür vorgesehen ist, bleibt erhalten. 

QS durch Hr. S. / Dataport am 26.05.2021

auf Seite 7 sollte das Wort Anhang durch Attachment ergänzt werden, da dies besser zu den Transportprofilen passt. Das Wort „lokaler“ führt nur zur Verwirrung bei und sollte entfallen.

Der IT-Planungsratsbeschluss schreibt XTA 2.1.1 und OSCI-Transport vor. Es gibt nichts zum Thema zip-Archive. Daher sollte alles mit Zip-Archive entfallen.

 

  1. Anhang: Sie werden als lokaler Anhang (Attachment) übermittelt:

II.1.1 Anhang

Bei diesem Mechanismus werden die Primärdokumente als Anhänge mit der XBau-XML-Nachricht

(XBau-Fachnachricht) zusammengelegt und -gemeinsam als Bündel übertragen (-innerhalb eines

gemeinsamen Containers übertragen, z.B. innerhalb eines zip-Archivs oder innerhalb eines XTA ContentContainers-)-.

 

Auf Seite 8 muss folgender Block komplett entfallen:

Die Abbildung zeigt einen Zip-Container, der eine XBau-Fachnachricht neben einer Reihe von Primärdokumenten

enthält. In die Fachnachricht sind Verweise (ID und Dateiname) auf die im Container liegenden

Primärdokumente eingetragen.

Abbildung II.1.1. Primärdokumente als Anhang zur XBau-Fachnachricht

mit Grafik

 

Seite 21: Sicherheitshalber sollte hier klargestellt werden, dass bei Rückweisungen nur das Fach-XML ohne Attachments eingebettet wird.

nachricht xs:base64Binary 1

Dieses Element bildet die zurückgewiesene Fachnachricht-Nachricht ohne Attachments im Binärformat ab.

 

Seite 49

Die Bauvorlage wird entweder als Anhang (Attachment) zur XBau-Fachnachricht übermittelt (Metadaten dokumentid

und dateiname).

 

Ich frage mich warum der Dateiname die Anz. 1 hat, wäre hier nicht 0..1 besser?

 

Seite 84

Dieser Klammerzusatz sollte gestrichen werden, da der IT-Planungsratsbeschluss XTA-WS 2.1.1 empfiehlt:

(vorzugsweise XTA-WS 2.1.1, gilt aber genauso für andere Versionen).

 

Die QS-Ergebnisse wurden eingearbeitet.

Vgl. Eintrag im verlinkten CR 137.

Mail Dataport vom 17.09.2021:

Wir haben erfreut zur Kenntnis genommen, dass unsere wesentlichen Anmerkungen 
vom 26.05 berücksichtigt worden sind.
Als Kleinigkeit hätten wir den Wunsch, dass analog zu II.1.2 Verlinkung, 
wo steht dass die Verlinkungen eindeutig sein müssen 
(„Die Verlinkungen müssen ihr Ziel eindeutig bezeichnen.“), 
dies auch noch mal bei II.1.1 Anhang verdeutlicht wird.
z.B. „Syntaxregeln für die ID …“ in „Syntaxregeln für die eindeutige ID …“. ändern. 

zu tun:

Änderung in der Spezifikation Kernmodul im Abschnitt II.1.1 Anhang einfügen, so dass auch für den Verweis aus den Metadatein auf die Attachments klar ist, dass das eine eindeutige Zuordnung sein muss. Auch im Abschnitt zur Abbildung II.1.1 entsprechend verdeutlichen. 

Wurde korekt umgesetzt durch VN