Skip to content
Snippets Groups Projects
Commit e3f9ce3d authored by Michael Haidner's avatar Michael Haidner
Browse files

new_514_Rueckkanal_processStandards_dokumentieren(planning#514)

parent c9695ddf
No related branches found
No related tags found
1 merge request!257new_514_Rueckkanal_processStandards_dokumentieren(planning#514)
# Fachschemareferenzen auf Fachstandards und Rahmenwerke abbilden
Im Folgenden wird aufgezeigt, wie Fachschemareferenzen für Fachdatensätze auf bestehende Fachstandards und Rahmenwerke abgebildet werden. Aktuell
werden folgende Fachstandards und Rahmenwerke beschrieben:
- FIM Übertragungsschemata für Anträge auf Basis von FIM Datenfeldern
- XÖV Nachrichten auf Basis von XÖV-konformen Fachstandards
:::note Aufnahme weiterer Fachstandards und Rahmenwerke
Soll ein anderer Fachstandard mit der FIT-Connect Submission API übermittelt werden, können wir gerne die Beschreibung dieser Schemareferenz hier aufnehmen, um diese Informationen einem breiteren Nutzerkreis zugänglich zu machen.
Hierzu bitte einfach ein Issue [hier](https://docs.fitko.de/feedback) aufmachen und gerne schon einen konkreten Vorschlag zuliefern.
:::
## Aufbau Fachschemareferenz
Eine Fachschemareferenz besteht aus zwei Angaben.
- Die `schemaUri` referenziert das zu verwendende Fachschema.
- Der `mimeType` gibt den Datentyp (JSON oder XML) der Fachdaten vor.
Bitte beachten Sie, dass manche Fachschema nur JSON oder XML als Datentyp zulassen.
## FIM Fachschemareferenz
Um ein FIM Fachschema eindeutig zu referenzieren, sind folgende Angaben notwendig:
- **ID** des Stammdatenschemas mit kleinem "s" ("s00000000009" im Beispiel)
- **Version** des Stammdatenschemas ("1.0.0" im Beispiel)
- **Art** des Schemas (JSON- oder XML-Schema)
Für ein JSON-Schema wird die `schemaUri` wie folgt gebildet:
`https://schema.fitko.de/fim/{ID}_{Version}.schema.json`
Für ein XML-Schema wird die `schemaUri` wie folgt gebildet:
`urn:xoev-de:xfall:standard:fim-{ID}_{Version}`
### Beispiel für eine FIM Fachschemareferenz
JSON Schema:
```json
{
"schemaUri": "https://schema.fitko.de/fim/s00000096_1.0.schema.json",
"mimeType": "application/json"
}
```
XML Schema:
```json
{
"schemaUri": "urn:xoev-de:xfall:standard:fim-s00000092_1.0",
"mimeType": "application/xml"
}
```
## XÖV Fachschemareferenz
Ein XÖV Fachschema wird über folgende Angaben referenziert:
- **Kennung** (ID) des Fachschemas ("urn:xoev-de:bmk:standard:xbau" im Beispiel)
- **Version** des Fachschemas ("2.2" im Beispiel)
- Verwendete **Nachricht** aus dem Fachschema ("baugenehmigung.antrag.0200" im Beispiel)
Beispiel: `urn:xoev-de:bmk:standard:xbau_2.2#baugenehmigung.antrag.0200`
Die `schemaUri` wird wie folgt gebildet:
`{Kennung}_{Version}#{Nachricht}`
### Beispiel für eine XÖV Fachschemareferenz
```json
{
"schemaUri": "urn:xoev-de:bmk:standard:xbau_2.2#baugenehmigung.antrag.0200",
"mimeType": "application/xml"
}
```
# Fachdaten
Die eigentlichen Fachdaten (Antragsdaten) werden bei der Nutzung von FIT-Connect immer maschinenlesbar übermittelt und folgen einem definierten Schema, das Inhalte und Struktur der übermittelten Daten definiert.
:::caution Hinweis
Das Thema der Fachdaten hinsichtlich ihres Aufbaus und Verwendung wird hier in Zukunft beschrieben.
Daher ist der Artikel aktuell noch in Bearbeitung.
:::
Die folgende Dokumentation erläutert die Unterschiede zwischen einem Fachdatenschema und einem Prozessstandard (Datenaustauschstandard).
Zudem beschreibt die Dokumentation, wie Sie in FIT-Connect ein Fachdatenschema und einen Prozessstandard referenzieren.
Weitere Informationen zur Validierung eines Fachdatensatzes finden sich im Artikel [Schemavalidierung](../schema-validation.mdx).
Eine Erläuterung der Fachschemareferenzen für die gängigsten Fachstandards der Verwaltung findet sich im Artikel [Fachschemarefenzen auf Fachstandards und Rahmenwerke abbilden](/details/schema-reference.md).
## Unterscheidung Fachdatenschema / Prozessstandard
### Fachdatenschema
Ein Fachdatenschema legt fest, welche Daten und Datentypen (Datenformate) in einer einzelnen Nachricht (in einem Antrag) eines sendenden Systems an einen Zustellpunkt zu verwenden sind.
### Prozessstandard
Ein Prozessstandard (oder Datenaustauschstandard) beschreibt einen komplexen Prozess,
der nicht nur aus einer Nachricht (in einem bestimmten Datenformat) eines sendenden Systems an einen Zustellpunkt besteht. <br/>
Ein Prozessstandard besteht vielmehr aus einer Nachricht eines sendenden Systems (Senders) an einen Zustellpunkt und einer Antwort auf diese Nachricht
durch den Zustellpunkt, gefolgt unter Umständen von weiteren Nachrichten des Senders an diesen Zustellpunkt und weiteren Antworten darauf. <br/>
Ein solcher Prozessstandard mit mehreren Nachrichten und Antworten (jeweils in einem bestimmten Datenformat/Schema) ist zum Beispiel der Standard XBau.
## Referenzen auf Fachdatenschemata und Prozessstandards in FIT-Connect
FIT-Connect nutzt Referenzen (Verweise) auf ein Fachdatenschema oder einen Prozessstandard (Datenaustauschstandard) an den folgenden Stellen:
- **Konfiguration eines Zustellpunktes eines empfangenden Systems** <br/>
In der Konfiguration eines Zustellpunkt ist hinterlegt, welche Schemata (Datenformate) dieser Zustellpunkt für die zu sendenden Fachdaten anbietet,
d.&nbsp;h. welche Datenformate der zugehörige Empfänger (Subscriber) lesen und verarbeiten kann. <br/>
Sendende Systeme (Sender) können die Konfiguration eines Zustellpunktes über die FIT-Connect Routing API erfragen. <br/>
Die Referenzen auf die unterstützten Fachdatenschema finden sich im JSON-Object, das der Aufruf der Routing-API "/routes" zurück liefert, zum Beispiel der folgende API-Aufruf: https://routing-api-testing.fit-connect.fitko.dev/v1/routes?ars=064350014014&leikaKey=99123456760610. <br/>
Die Referenzen sind im JSON-Object im "routes"-Array unter `destinationParameters.submissionSchemas` eingetragen. <br/>
Weitere Informationen hierzu finden sich im Artikel [Zustellpunkt ermitteln](../../sending/get-destination.mdx).
- **Metadaten einer Einreichung eines sendenden Systems** <br/>
In den Metadaten einer Einreichung (eines Antrags) gibt die Referenz zu einem Fachdatenschema an, in welchem Datenformat (in welchem Schema) der Sender die Fachdaten übertragen hat. <br/>
Im Metadatensatz wird die Referenz auf das verwendete Fachdatenschema eingetragen unter `contentStructure.data.submissionSchema`. <br/>
Weitere Informationen zur Hinterlegung der Referenz auf das verwendete Fachschema finden sich [in der Dokumentaion des Metadatensatzes](../../metadata/overview.mdx).
## Unterstütze Rahmenwerke und Standards
Aktuell wird die Verwendung von Fachdatenschemata und Prozessstandards auf Basis folgender Rahmenwerke beschrieben:
- Fachdatenschemata für Anträge auf Basis von FIM-Datenfelder
- Fachdatenschemata und Prozessstandards auf Basis von XÖV-konformen Fachstandards
:::note Aufnahme weiterer Fachstandards und Rahmenwerke
Möchten Sie einen anderen Fachstandard gemeinsam mit FIT-Connect nutzen, dann können wir gerne die Beschreibung weiterer Fachschemareferenzen hier aufnehmen, um diese Informationen einem breiteren Nutzer:innenkreis zugänglich zu machen.
Hierzu bitte einfach [in inserem öffentlichen Issue-Tracker](https://docs.fitko.de/feedback) ein Issue aufmachen.
Wir freuen uns sehr, wenn Sie uns bereits einen konkreten Vorschlag zuliefern.
:::
## Aufbau einer Referenz
Eine Fachschemareferenz besteht aus zwei Angaben:
- Die `schemaUri` referenziert das zu verwendende Fachschema.
- Der `mimeType` gibt den Datentyp (JSON oder XML) der Fachdaten an.
:::note Hinweis
Manche Fachschemata lassen nur JSON oder XML als Datentyp zu.
:::
### FIM-Fachschemareferenz
Um ein FIM-Fachschema zu referenzieren, sind folgende Angaben notwendig:
- **ID** des Stammdatenschemas mit kleinem `s` (`s00000096` im folgenden [Beispiel](#FIM-Fachschemareferenz) mit dem Datentyp JSON)
- **Version** des Stammdatenschemas (`1.0` im Beispiel)
- **Art** des Schemas (JSON- oder XML-Schema)
Für ein Schema mit dem Datentyp JSON wird die `schemaUri` wie folgt gebildet: <br/>
`https://schema.fitko.de/fim/{ID}_{Version}.schema.json`
Für ein Schema mit dem Datentyp XML wird die `schemaUri` wie folgt gebildet: <br/>
`urn:xoev-de:xfall:standard:fim-{ID}_{Version}`
#### Beispiel für eine FIM-Fachschemareferenz {#FIM-Fachschemareferenz}
JSON:
```json
{
"schemaUri": "https://schema.fitko.de/fim/s00000096_1.0.schema.json",
"mimeType": "application/json"
}
```
XML:
```json
{
"schemaUri": "urn:xoev-de:xfall:standard:fim-s00000092_1.0",
"mimeType": "application/xml"
}
```
### XÖV-Fachschemareferenz
Ein XÖV-Fachschema wird über folgende Angaben referenziert:
- **Kennung** (ID) des Fachschemas (`urn:xoev-de:bmk:standard:xbau` im folgenden [Beispiel](#XOEV-Fachschemareferenz))
- **Version** des Fachschemas (`2.2` im Beispiel)
- Verwendete **Nachricht** aus dem Fachschema (`baugenehmigung.antrag.0200` im Beispiel)
Die `schemaUri` wird wie folgt gebildet:
`{Kennung}_{Version}#{Nachricht}`
#### Beispiel für eine XÖV-Fachschemareferenz {#XOEV-Fachschemareferenz}
```json
{
"schemaUri": "urn:xoev-de:bmk:standard:xbau_2.2#baugenehmigung.antrag.0200",
"mimeType": "application/xml"
}
```
### Referenz auf einen XÖV-Prozessstandard
Ein XÖV-Prozessstandard wird über folgende Angaben referenziert:
- **Kennung** (ID) des Prozessstandards (`urn:xoev-de:bmk:standard:xbau` im folgenden [Beispiel](#XOEV-Prozessstandard))
- **Version** des Prozessstandards (`2.3` im Beispiel)
Die `processStandards` werden wie folgt gebildet:
`{Kennung}_{Version}`
#### Beispiel für eine Referenz zu einem XÖV-Prozessstandard {#XOEV-Prozessstandard}
```json
"processStandards": [
"urn:xoev-de:bmk:standard:xbau_2.3"
]
```
## FIT-Connect als Rückkanal
Wenn ein Empfänger (Subscriber) die Option anbietet, FIT-Connect als Rückkanal zu nutzen (Subscriber antwortet über FIT-Connect), dann muss der zugehörige Zustellpunkt dafür auch die von ihm unterstützten Prozessstandards in seiner Konfiguration definieren (z.B. XBau).
Wenn ein Onlinedienst (Sender) FIT-Connect als Rückkanal nutzen will (Antworten über FIT-Connect vom Subscriber), dann muss der Sender in den Metadaten angeben, welches Metadatenschema der Zustellpunkt für die Antwort (Reply) nutzen muss.
Das folgende Beispiel zeigt einen Auszug aus den Metadaten eines Senders: Der Sender weist den Empfänger an, XBAU 2.3 als Prozessstandard für die Antwort (Reply) zu nutzen:
```json
{
...
"processStandards": [
"urn:xoev-de:bmk:standard:xbau_2.3"
]
}
```
......@@ -97,4 +97,4 @@ Es wird für sendende Systeme empfohlen, auf den Versand eigener proprietärer A
## Meine Software übermittelt oder empfängt nach Standard XYZ Fachdatensätze, wie kann ich das jeweils genutzte Fachschema korrekt referenzieren?
Eine Erläuterung der Fachschemareferenzen für die gängigsten Fachstandards der Verwaltung findet sich im Artikel [Fachschemarefenzen auf Fachstandards und Rahmenwerke abbilden](/details/schema-reference.md).
Eine Erläuterung der Fachschemareferenzen für die gängigsten Fachstandards der Verwaltung findet sich im Artikel [Fachdaten](data.mdx).
......@@ -15,6 +15,7 @@ hide_table_of_contents: true
| API-Client | Ein technisches System, dass auf die FIT-Connect-Schnittstellen zugreift. Dieser Begriff kann verwendet werden, wenn eine Unterscheidung zwischen Fachverfahren, virtueller Poststelle, Onlineservice oder Endgerät der antragstellenden Person nicht nötig ist. |
| API-Gateway | Das API-Gateway ist eine technische Komponente, die OAuth-Tokens prüft und nicht oder falsch authentifizierte Anfragen ablehnt. Ein Zugriff auf die Schnittstelle des Zustelldienstes erfolgt immer über das API-Gateway. |
| Autorisierungsdienst | Der Autorisierungsdienst / OAuth-Dienst stellt via Client-Credentials-Flow OAuth-Tokens an API-Clients aus, mit denen diese sich anschließend gegenüber den FIT-Connect-Schnittstellen (d.h. gegenüber dem API-Gateway) authentifizieren können. |
| Datenaustauschstandard | siehe *Prozessstandard* |
| Destination | siehe *Zustellpunkt (`destination`)* |
| Destination-ID (`destinationId`) | Die Destination-ID ist eine vom *Zustelldienst* vergebene ID für einen *Zustellpunkt*. Sie wird von Betreiber:innen empfangender Systeme im Self-Service-Portal angelegt und dient der eindeutigen Adressierung des empfangenden Systems der zuständigen Fachbehörde im jeweiligen Antragskontext auf Basis eines *Leistungsschlüssels* und eines geographischen Merkmals (z.B. ARS oder PLZ). Sendende Systeme (z.B. Online-Antragsdienste) können die Destination-ID über die Routing API oder über bilaterale Absprachen mit den Betreiber:innen empfangender Systeme ermitteln (siehe Artikel [Zustellpunkt ermitteln](sending/get-destination.mdx)). |
| Einreichung (`submission`) | Eine Einreichung bei einer zuständigen Stelle kann ein Antrag (bspw. ein Antrag nach dem Onlinezugangsgesetz), ein Bericht (bspw. Statistikmeldung eines Unternehmens) oder eine sonstige Einreichung für die Initiierung eines Bearbeitungsvorgangs in einem Verwaltungsverfahren sein. Eine Einreichung besteht mindestens aus einem Metadatensatz und optional einem Fachdatensatz und / oder einem oder mehreren Anlagen. Eine Einreichung besitzt immer eine systemübergreifend eindeutige ID (`submissionId`). Diese ID wird für jeden Einreichungsvorgang durch den Zustelldienst vergeben. |
......@@ -23,7 +24,7 @@ hide_table_of_contents: true
| Ereignis (event) | Ein in Form eines [Security Event Token](https://datatracker.ietf.org/doc/html/rfc8417) aufgezeichnetes Ereignis zu einer Einreichung oder einem Einreichungsvorgang. Dies kann z.B. das Absenden einer Einreichung sein. |
| Ereignisprotokoll (event log) | Der Zustelldienst bündelt alle einer Einreichung oder einem Einreichungsvorgang zugeordneten Ereignisse in einem Ereignisprotokoll. |
| Fachdatensatz (data, auch: submission data) | Ist ein strukturierter Fachdatensatz im Rahmen der Einreichung. Kann JSON, XML oder ein anderes in verwaltungseigenen Datenstandards genutztes Datenformat sein. |
| Fachschemareferenz (submission schema) | Das referenzierte Fachschema aus FIM oder XÖV. Eine Liste der möglichen Fachschemata wird im Zustellpunkt angegeben. Das für eine Einreichung verwendete Fachschema steht im Metadatensatz. Siehe auch: Artikel [Fachschemarefenzen auf Fachstandards und Rahmenwerke abbilden](details/schema-reference.md) |
| Fachschemareferenz (submission schema) | Das referenzierte Fachschema aus FIM oder XÖV. Eine Liste der möglichen Fachschemata wird im Zustellpunkt angegeben. Das für eine Einreichung verwendete Fachschema steht im Metadatensatz. Siehe auch: Artikel [Fachdaten](getting-started/submission/data.mdx) |
| FIM | Föderales Informationsmanagement, bestehend aus den Bausteinen *FIM Leistungen* (siehe *Leistungsschlüssel*), FIM Datenfelder (siehe *Fachschema*) und FIM Prozesse (Prozessabbildungen zu einer Leistungserbringung). Weiterführende Informationen finden sich im [FIM-Portal](https://fimportal.de/) |
| Gebiet (area) | Eine räumlich abgegrenzte Fläche, z.B. ein Postleitzahlenbereich, ein Naturschutzgebiet oder eine Region im Sinne des Amtlichen Regionalschlüssels (siehe *Region*). |
| Kommunikationskanal (communication channel) | Beschreibt einen Kommunikationskanal, um zwischen der zuständigen Fachbehörde und der Verwaltungskund:in digital zu kommunizieren. Kommunikationskanäle können sein: <ul> <li>E-Mail</li> <li>De-Mail</li> <li>FIT-Connect Rückkanal</li> <li>Interoperable Postfächer (FINK)</li> <li>Elster-Transfer des einheitlichen Unternehmenskontos</li> </ul>Eine zuständige Fachbehörde kommuniziert über den Zustellpunkt, welche Kommunikationskanäle unterstützt werden und die Verwaltungskund:in legt fest, welche Kommunikationskanäle genutzt werden sollen. Für die Adressierung der Verwaltungskund:in werden alle für den Kommunikationskanal notwendigen Verbindungs- und Adressierungsparameter (einschließlich ggf. notwendiger Schlüssel/Zertifikate) im Metadatensatz übertragen. |
......@@ -33,6 +34,7 @@ hide_table_of_contents: true
| Region (region) | Eine verwaltungspolitische Region (Gebietskörperschaften) im Sinne des Amtlichen Regionalschlüssels (ARS). Regionen werden in FIT-Connect durch Angabe eines ARS mit vorangestelltem Präfix `DE` identifiziert. Z.B. `DE081150045045`. Siehe auch: *Gebiet* |
| Onlinedienst/Onlineservice (online service) | Ein Onlineservice kann entweder von einer Behörde, einem Unternehmen oder einer zivilgesesellschaftlichen Organisation betrieben werden. Er interagiert in der Art mit FIT-Connect, dass er Anträge im Namen bzw. Auftrag eines Endnutzers verschlüsselt übermittelt. |
| OAuth-Dienst | Der Autorisierungsdienst / OAuth-Dienst stellt Access-Tokens an API-Clients aus, mit denen diese sich anschließend gegenüber dem Zustelldienst (Submission API) authorisieren können. Zugänge für API-Clients können über das Self-Service-Portal konfiguriert werden. |
| Prozessstandard | Ein Prozessstandard (oder Datenaustauschstandard) beschreibt einen komplexen Prozess, der aus einer Nachricht eines sendenden Systems (Senders) an einen Zustellpunkt und einer Antwort auf diese Nachricht besteht, gefolgt unter Umständen von weiteren Nachrichten des Senders an diesen Zustellpunkt und weiteren Antworten darauf. Ein solcher Prozessstandard mit mehreren Nachrichten und Antworten (jeweils in einem bestimmten Datenformat/Schema) ist zum Beispiel der Standard XBau. |
| Self-Service-Portal | Das Self-Service-Portal ermöglicht es, Accounts/Berechtigungen für die Anbindung von API-Clients anzulegen und Zustellpunkte für empfangende Systeme zu konfigurieren. Siehe Artikel [Accountregistrierung und Client-Verwaltung](getting-started/account.mdx) sowie [Zustellpunkt anlegen](receiving/destination.mdx). |
| Sendendes System (`sender`) | Das technische System, das eine Einreichung über die Submission API vornimmt (z.&nbsp;B. Online-Antragsservice oder Unternehmenssystem). Dies ist in der Regel ein Online-Antragsservice (spezialisiertes Webportal für eine bestimmte Fachlichkeit), das Endgerät der Antragsteller:in oder auch ein Verwaltungsportal, das typischerweise mehrere Fachlichkeiten / Antragstypen unterstützt. Perspektivisch wären hier auch andere API-Clients denkbar, z.&nbsp;B. spezialisierte Anwendungen zur Antragseinreichung ohne Webinterface oder Fachverfahren der Verwaltung, über die beim Behördengang durch eine Sachbearbeiter:in stellvertretend für die Antragsteller:in eine Einreichung eingereicht wird. |
| Submission-Host (`submissionHost`) | Technischer Bezeichner für die Host-Adresse des für eine bestimmte *Destination-ID* zuständigen Zustelldienstes. |
......
......@@ -23,7 +23,7 @@ Ein Tutorial, das den Versand von Einreichungen erläutert, finden Sie [hier](..
Das Tutorial oben bezieht sich auf die folgenden Seiten in der Dokumentation:
- [Accountregistrierung und Client-Verwaltung](../getting-started/account.mdx)
- [Zustellpunkt anlegen](./destination.mdx)
- [Fachschemareferenzen auf Fachstandards und Rahmenwerke abbilden](../details/schema-reference.md)
- [Fachdaten](../getting-started/submission/data.mdx)
## Einreichungen abrufen
......
......@@ -129,7 +129,6 @@ module.exports = {
'details/crypto',
'details/jwk-creation',
'details/destination-management',
'details/schema-reference',
{
type: 'category',
label: 'Authentifizierung',
......
import React from 'react';
import {Redirect} from '@docusaurus/router';
export default function query_status() {
return (
<p>
<Redirect to="../../getting-started/submission/data" />
</p>
);
}
0% Loading or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment