Skip to content
Snippets Groups Projects

515_NEW_Rueckkanal_Dokumentation_ueber_die_Verwendung(planning#515, planning#115)

Compare and Show latest version
6 files
+ 46
86
Compare changes
  • Side-by-side
  • Inline
Files
6
@@ -67,19 +67,21 @@ Dieser Zustellpunkt (und das nachgelagerte Fachverfahren) bietet sendenden Syste
@@ -67,19 +67,21 @@ Dieser Zustellpunkt (und das nachgelagerte Fachverfahren) bietet sendenden Syste
Gibt es keine Einträge zu `replyChannels`,
Gibt es keine Einträge zu `replyChannels`,
dann stellt das nachgelagerte Fachverfahren Antworten zu Einreichungen auf dem Postweg zu.
dann stellt das nachgelagerte Fachverfahren Antworten zu Einreichungen auf dem Postweg zu.
## Rückkanäle E-Mail, De-Mail und Elster
## Rückkanäle E-Mail, Elster und FIT-Connect
### Erforderliche Einträge in den Metadaten {#eintraege_metadaten}
### Erforderliche Einträge in den Metadaten {#eintraege_metadaten}
Im [Beispiel oben](#KonfigZustellpunkt) für die Konfiguration eines Zustellpunkts
Im [Beispiel oben](#KonfigZustellpunkt) für die Konfiguration eines Zustellpunkts
sind als mögliche Rückkanäle Elster, E-Mail und FIT-Connect eingetragen,
sind als mögliche Rückkanäle E-Mail, Elster und FIT-Connect eingetragen,
somit können Sender einen dieser Rückkanäle für ihre Einreichungen auswählen. <br/>
somit können Sender einen dieser Rückkanäle für ihre Einreichungen auswählen.
Wenn ein Sender für eine Einreichung E-Mail, De-Mail oder Elster auswählen will,
 
#### Einen Rückkanal eintragen
 
Wenn ein Sender für eine Einreichung E-Mail, Elster oder FIT-Connect auswählen will,
dann muss er dies dem adressierten Fachverfahren mitteilen,
dann muss er dies dem adressierten Fachverfahren mitteilen,
indem er einen Eintrag in den Metadaten zu der Einreichung unter "replyChannel" einfügt. <br/>
indem er einen Eintrag in die Metadaten zu der Einreichung unter "replyChannel" einfügt. <br/>
Sie dürfen nur einen Rückkanal eintragen.
Es darf nur ein Rückkanal eingetragen werden.
### Einträge für E-Mail
### Eintrag für E-Mail
Das folgende Beispiel für die Metadaten einer Einreichung zeigt den Eintrag für E-Mail als Rückkanal:
Das folgende Beispiel für die Metadaten einer Einreichung zeigt den Eintrag für E-Mail als Rückkanal:
@@ -115,43 +117,7 @@ Das folgende Beispiel für die Metadaten einer Einreichung zeigt den Eintrag fü
@@ -115,43 +117,7 @@ Das folgende Beispiel für die Metadaten einer Einreichung zeigt den Eintrag fü
}
}
```
```
### Einträge für De-Mail
### Eintrag für Elster
Das folgende Beispiel für die Metadaten einer Einreichung zeigt den Eintrag für De-Mail als Rückkanal:
```json
{
"$schema": "https://schema.fitko.de/fit-connect/metadata/1.0.0/metadata.schema.json",
"authenticationInformation": [
{
...
}
],
"contentStructure": {
"data": {
...
},
"attachments": [
...
]
},
"paymentInformation": {
...
},
"publicServiceType": {
...
},
"replyChannel": {
"deMail": {
"address": "example@example.de-mail.de"
}
}
...
}
```
### Einträge für Elster
Das folgende Beispiel für die Metadaten einer Einreichung zeigt den Eintrag für Elster als Rückkanal:
Das folgende Beispiel für die Metadaten einer Einreichung zeigt den Eintrag für Elster als Rückkanal:
@@ -186,7 +152,7 @@ Das folgende Beispiel für die Metadaten einer Einreichung zeigt den Eintrag fü
@@ -186,7 +152,7 @@ Das folgende Beispiel für die Metadaten einer Einreichung zeigt den Eintrag fü
}
}
```
```
### Einträge für FIT-Connect
### Eintrag für FIT-Connect
Dieses Beispiel zeigt einen Auszug aus den Metadaten einer weiteren Einreichung; hier ist als Rückkanal `fitConnect` unter `replyChannel` eingetragen.
Dieses Beispiel zeigt einen Auszug aus den Metadaten einer weiteren Einreichung; hier ist als Rückkanal `fitConnect` unter `replyChannel` eingetragen.
```json
```json
@@ -238,7 +204,7 @@ Im [Beispiel oben](#KonfigZustellpunkt) für die Konfiguration eines Zustellpunk
@@ -238,7 +204,7 @@ Im [Beispiel oben](#KonfigZustellpunkt) für die Konfiguration eines Zustellpunk
In diesem Beispiel können Sender also auch die bidirektionale Kommunikation über FIT-Connect wählen (siehe die folgenden Absätze).
In diesem Beispiel können Sender also auch die bidirektionale Kommunikation über FIT-Connect wählen (siehe die folgenden Absätze).
### Bidirektionale Kommunikation über FIT-Connect
### Bidirektionale Kommunikation über FIT-Connect
Bei bidirektionaler Kommunikation können ein Fachverfahren und ein Sender (Onlinedienst oder ein anderes Softwareprogramm) Nachrichten austauschen.
Bei bidirektionaler Kommunikation können ein Fachverfahren und ein Sender (Onlinedienst) Nachrichten austauschen.
Bidirektionale Kommunikation ist nur über FIT-Connect möglich,
Bidirektionale Kommunikation ist nur über FIT-Connect möglich,
nicht aber bei anderen Rückkanälen wie Elster oder E-Mail. <br/>
nicht aber bei anderen Rückkanälen wie Elster oder E-Mail. <br/>
@@ -254,44 +220,12 @@ wertet sie programmtechnisch aus und reagiert darauf,
@@ -254,44 +220,12 @@ wertet sie programmtechnisch aus und reagiert darauf,
indem es zum Beispiel eine weitere Nachricht an das empfangende System sendet,
indem es zum Beispiel eine weitere Nachricht an das empfangende System sendet,
das dann wiederum darauf antworten kann.
das dann wiederum darauf antworten kann.
### Erforderliche Einstellungen für bidirektionale Kommunikation {#einstellungen_bidirektionale_kommunikation}
## Erforderliche Einstellungen für bidirektionale Kommunikation {#einstellungen_bidirektionale_kommunikation}
Soll ein Fachverfahren bei einer Einreichung die bidirektionale Kommunikation verwenden,
dann sind die folgenden Angaben für diese Einreichung erforderlich:
- Der Sender muss beim Erstellen einer Einreichung dem Fachverfahren mitteilen,
dass die bidirektioale Kommunikation verwendet werden soll
(siehe [Erstellen einer Einreichung](#erstellen_einreichung)).
- Der Sender muss beim Versenden dieser Einreichung dem Fachverfahren in den Metadaten mitteilen,
welcher Prozessstandard und welcher Verschlüsselungsschlüssel bei der Antwort verwendet werden sollen
(siehe [Einträge in den Metadaten](#MetadatenFitConnect)).
### Erstellen einer Einreichung {#erstellen_einreichung}
Soll bei einer Einreichung die bidirektionale Kommunikation verwendet werden,
dann muss der Sender (Onlinedienst) beim Aufruf des Endpunkts
<ApiLink api="submission-api" to="/submissions" withMethod="post"/> (beim Erstellen der Einreichung)
ein JSON-Objekt übergeben,
in dem die Eigenschaft "bidirectional" auf den Wert "true" gesetzt ist.
Das folgende Beispiel zeigt diese Einstellung:
```json
{
"destinationId": "879ee109-a690-4db8-ab32-424284184d7d",
"announcedAttachments": [
"879ee109-a690-4db8-ab32-424284184d7d",
"2046f9f1-dc89-4440-9c24-c76a8f40d668"
],
...
"bidirectional": true
}
```
### Einträge in den Metadaten {#MetadatenFitConnect}
### Einträge in den Metadaten {#MetadatenFitConnect}
Soll bei einer Einreichung die bidirektionale Kommunikation verwendet werden,
Soll bei einer Einreichung die bidirektionale Kommunikation verwendet werden,
dann muss zudem in den Metadaten zu dieser Einreichung unter "replyChannel" ein Objekt zu "fitConnect" eingetragen sein,
dann muss in den Metadaten zu dieser Einreichung unter "replyChannel" ein Objekt "fitConnect" eingetragen sein,
das den Prozessstandard bezeichnet sowie ferner Angaben zum Verschlüsselungsschlüssel für die Antwort des Fachverfahrens enthält. <br/>
das den Prozessstandard bezeichnet sowie ferner Angaben zum Verschlüsselungsschlüssel für die Antwort des Fachverfahrens enthält. <br/>
Im folgenden Beispiel wünscht sich der Sender (Onlinedienst), dass das Facherfahren FIT-Connect als Rückkanal verwendet. <br/>
Im folgenden Beispiel wünscht sich der Sender (Onlinedienst), dass das Facherfahren FIT-Connect als Rückkanal verwendet. <br/>
Zudem soll der Prozessstandard "XBAU 2.3" genutzt werden. <br/>
Zudem soll der Prozessstandard "XBAU 2.3" genutzt werden. <br/>
Loading