Skip to content
Snippets Groups Projects
Commit d720e54b authored by Marco Holz's avatar Marco Holz
Browse files

Move routing configuration infos to separate page

parent c5d1946d
No related branches found
No related tags found
1 merge request!240Move routing configuration infos to separate page
Hide whitespace changes
Inline Side-by-side
Showing
with 95 additions and 83 deletions
docs/organisation-tasks/routing.mdx 0 → 100644
+ 70
− 0
View file @ d720e54b
---
title: Antragsrouting konfigurieren
---
import useBaseUrl from '@docusaurus/useBaseUrl';
Beim Anlegen eines Zustellpunktes werden die technischen Parameter des Fachverfahrens (zum Beispiel die FIM-Leistungsschlüssel der unterstützen Leistungen) durch FIT-Connect automatisch an das Deutsche Verwaltungsdiensteverzeichnis (DVDV) übertragen.
Darüber hinaus müssen maschinenlesbare Zuständigkeiten im Portalverbund hinterlegt werden.
FIT-Connect stellt zu diesem Zweck signierten Adressierungsinformationen bereit, die in einem FIM Bundes- oder Landesredaktionssystem hinterlegt werden müssen.
Onlinedienste können diese Informationen nach erfolgreicher Konfiguration im Redakionssystemen über den FIT-Connect Routingdienst abrufen.
## Signierte Adressierungsinformationen
Das Self-Service-Portal (SSP) stellt Informationen über Zustellpunkte in signierter Form zur Verfügung.
Die signierten Adressierungsinformationen (`destinationSignature`) eines Zustellpunktes sind im Self-Service-Portal auf der Übersichtsseite zu den Zustellpunkten hinterlegt.
Das folgende Bild zeigt die Übersichtseite:
<div class="center">
<img width="800" alt="Button in der Zustellpunkt-Übersichtsliste"
src={useBaseUrl('/images/ssp/destination-overview-export-address-information.png')}/>
</div>
Lassen Sie sich eine Kopie der signierten Adressierungsinformationen aushändigen. Diese Daten werden im nächsten Schritt benötigt.
## Adressierungsinformationen in Redaktionssysteme hinterlegen
Fügen Sie die Adressierungsinformationen in das FIM-Redaktionssystem Ihrer Behörde bzw. ihres Bundeslandes ein.
Das Einpflegen der Informationen ist abhängig vom verwendeten Redaktionssystem.
Im Folgenden werden die konkreten Schritte zur Pflege der Adressierungsinformationen für verschiedene Redakionssysteme beschrieben.
### Infodienste (Systeme) der Linie6Plus (BB, HE, MV, NI, RP, SH, SL, ST, TH)
#### Einleitung/Allgemeines
Zur Steuerung von Antragsinformationen der Plattform FIT-Connect bzw. um die signierten Adressierungsinformationen eines Zustellpunktes auszugegeben, müssen die signierten Adressierungsinformationen (`destinationSignatur`, im Folgenden `FIT-Connect destinationSignatur` genannt) verwendet werden.
Dafür wird die teilweise eingeführte Destination-ID entfallen, da die FIT-Connect `destinationSignatur` bereits die Destination-ID enthält.
Diese lässt sich in den Infodiensten pflegen; Voraussetzung und Ablauf sind im folgenden Abschnitt beschrieben.
#### Anlage eines Zustellkanals für die FIT-Connect destinationSignatur
Für die Pflege der FIT-Connect destinationSignatur in den Infodiensten wird ein neuer Zustellkanal benötigt.
Dieser kann nach Beauftragung durch die jeweiligen Länder der Linie6Plus durch den Support (support@teleport.de) zentral in den Infodiensten für die benötigte Datenpflege implementiert werden.
Da die FIT-Connect destinationSignatur einen eindeutigen Zustellpunkt definiert, muss sie an der Organisationseinheit als zuständige Stelle für definierte Verwaltungsleistungen verortet sein.
In dem Modul `Organisationseinheit` -> `Einstellung Kontakt/Verkehr`, kann die FIT-Connect destinationSignatur als neues Kontaktsystem für die Organisationseinheit angegeben werden.
Dementsprechend darf in den Infodiensten nicht nur der Wert Destination-ID hinterlegt werden, sondern dort müssen ebenfalls die signierten Adressierungsinformationen aus Schritt 1 hinterlegt werden können.
Dies ist durch das Anlegen der FIT-Connect destinationSignatur möglich, da diese den Wert ebenfalls enthält.
Konkret wird das (neue) Kontaktsystem wie folgt benannt: "FIT-Connect (destinationSignatur)" mit der Kurzbezeichnung "FITCONNECTDESTSIGNATURE".
#### Pflege der FIT-Connect destinationSignatur in den Infodiensten
Die Redakteure der Kommunen und der zentralen Landesredaktion pflegen die FIT-Connect destinationSignatur an der Organisationseinheit dezentral.
In dem Modul `Organisationseinheit` -> `Einstellung Kontakt/Verkehr` kann der Redakteur ein Kontaktsystem hinzufügen.
Hierbei steht ihm als Option das Kontaktsystem "FIT-Connect (destinationSignatur)" als Auswahloption zur Verfügung.
Im Feld `Kennung` hinterlegt der Redakteur die FIT-Connect destinationSignatur der Organisationseinheit.
Für bestimmte Anwendungsfälle besteht aber auch die Möglichkeit die FIT-Connect destinationSignatur mehrfach zu hinterlegen.
### Weitere Redaktionssysteme
Wir streben an, für alle in Deutschland gängigen Systeme ein entsprechendes Pflegekonzept bereitzustellen.
Hierzu freuen wir uns über Bedarfsmeldungen, um besser abschätzen zu können, für welche Systeme ein Pflegekonzept prioritär benötigt wird.
Teilen Sie uns auch gerne mit, wenn Ihnen ein hier noch nicht aufgeführtes Pflegekonzept bekannt ist.
## Exkurs: Technischer Hintergrund
Der Routingdienst von FIT-Connect stellt Informationen über Fachverfahren zur Verfügung, zum Beispiel die online beantragbaren Leistungen eines Fachverfahrens.
Diese Informationen stammen aus den folgenden Quellen:
- Deutsches Verwaltungsdiensteverzeichnis (DVDV): Nach dem Anlegen eines Zustellpunktes sendet FIT-Connect technische Parameter des zuständigen Fachverfahrens an das DVDV. Das DVDV reicht diese Informationen an den FIT-Connect Routingdienst weiter (siehe folgendes Bild, linker Zweig).
- [Onlinegateway des Portalverbunds (PVOG)](https://servicesuche.bund.de/): Das Onlinegateway des Portalverbunds wird von den Redakionssystemen des Bundes und der Länder gespeist. Das PVOG sendet Zuständigkeitsinformationen zu den online beantragbaren Leistungen der Fachverfahren an den FIT-Connect Routingdienst (siehe folgendes Bild, rechter Zweig).
<div class="center">
<img width="550" alt="FIT-Connect Routing-Architektur"
src={useBaseUrl('/images/routing/routing-architecture-overview.png')}/>
</div>
docs/organisation-tasks/subscriber.mdx
+ 4
− 68
View file @ d720e54b
---
title: Fachverfahren registrieren
---
import useBaseUrl from '@docusaurus/useBaseUrl';
import Tabs from '@theme/Tabs'
import TabItem from '@theme/TabItem'
# Fachverfahren registrieren
......@@ -32,79 +29,18 @@ Was dabei zu beachten ist, das ist nachfolgend unter [Punkt 3](#3-zustellpunkt-u
4. Adressierungsinformationen in Redaktionssysteme einfügen <br/>
Das Self-Service-Portal stellt die im Schritt 3 eingetragenen Informationen in signierter Form zur Verfügung. <br/>
Fügen Sie diese signierten Adressierungsinformationen in das Redaktionssystem Ihrer Behörde ein. <br/>
Was dabei zu beachten ist, das ist nachfolgend unter [Punkt 4](#4-adressierungsinformationen-in-redaktionssysteme-einf%C3%BCgen) beschrieben.
Was dabei zu beachten ist, das ist nachfolgend unter [Punkt 4](#routing) beschrieben.
### 1. Beantragen Sie bei der FITKO einen Zugang zum Produktivsystem für FIT-Connect
Die rechtlichen Vertreter:innen eines Fachverfahrens, die FIT-Connect für ihre Fachverfahren nutzen wollen, müssen den Nutzungsbedingungen der FITKO zustimmen. <br/>
Die FITKO legt anschließend für das Fachverfahren einen Account für FITKO-GitLab an, sodass Sie auf dem Self-Service-Portal der Produktivumgebung Daten pflegen können (oder ein von Ihnen beauftragter Mitarbeiter oder Dienstleister pflegt die Daten).
### 2. Beantragen Sie Zertifikate der Verwaltungs-PKI.
Wie Sie Zertifikate beantragen, das ist [hier](./certificates#zertifikate-der-verwaltungs-pki-beantragen) beschrieben.
Wie Sie Zertifikate beantragen, das ist [hier](./certificates.mdx#zertifikate-der-verwaltungs-pki-beantragen) beschrieben.
### 3. Zustellpunkt und API-Client anlegen
Beauftragen Sie Administrator:innen Ihrer Behörde (oder Dienstleister) damit, einen Zustellpunkt und einen API-Client des Typs "Subscriber" anzulegen. Hierfür benötigen die Administrator:innen die Zertifikate, die Sie im Schritt 2 erhalten haben. <br/>
Das Anlegen von Zustellpunkten und API-Clients im Self-Service-Portal ist [hier](../getting-started/account) beschrieben. <br/>
#### Onlinedienste erhalten Informationen zu Fachverfahren
Nach dem Anlegen eines Zustellpunktes überträgt das Self-Service-Portal die eingetragenen Informationen zu den Leistungen eines Fachverfahrens (zum Beispiel die Leika-Schlüssel) an das Deutsche Verwaltungsdiensteverzeichnis (DVDV), und Onlinedienste rufen diese Informationen vom DVDV ab, über den Routingdienst von FIT-Connect.
#### Signierte Adressierungsinformationen
Die signierten Adressierungsinformationen (`destinationSignature`) eines Zustellpunktes sind im Self-Service-Portal auf der Übersichtsseite zu den Zustellpunkten hinterlegt. Das folgende Bid zeigt die Übersichtseite. <br/>
<br/>
<div class="center">
<img width="800" alt="Button in der Zustellpunkt-Übersichtsliste"
src={useBaseUrl('/images/ssp/destination-overview-export-address-information.png')}/>
</div>
Lassen Sie sich eine Kopie der signierten Adressierungsinformationen aushändigen. Diese Daten werden im Schritt [4. Adressierungsinformationen in Redaktionssysteme einfügen](#4-adressierungsinformationen-in-redaktionssysteme-einf%C3%BCgen) benötigt. <br/>
#### Routingdienst
Der Routingdienst von FIT-Connect stellt Informationen über Fachverfahren zur Verfügung, zum Beispiel die online beantragbaren Leistungen eines Fachverfahrens.
Diese Informationen stammen aus den folgenden Quellen:
- Deutsches Verwaltungsdiensteverzeichnis (DVDV) <br/>
Nach dem Anlegen eines Zustellpunktes sendet das Self-Service-Portal der FITKO Informationen zu den online beantragbaren Leistungen zum DVDV, und das DVDV reicht diese Informationen an den Routing-Dienst von FIT-Connect weiter (siehe folgendes Bild, linker Zweig).
- Onlinegateway des Portalverbunds [PVOG](https://servicesuche.bund.de/) <br/>
Das Onlinegateway des Portalverbunds wird von den Redakionssystemen des Bundes und der Länder gespeist. <br/>
Das PVOG sendet Informationen zu den online beantragbaren Leistungen der Fachverfahren an den Routingdienst von FIT-Connect (siehe folgendes Bild, rechter Zweig).
<div class="center">
<img width="550" alt="FIT-Connect Routing-Architektur"
src={useBaseUrl('/images/routing/routing-architecture-overview.png')}/>
</div>
### 4. Adressierungsinformationen in Redaktionssysteme einfügen{#Redaktionssysteme}
Das Self-Service-Portal (SSP) stellt Informationen über Zustellpunkte in signierter Form zur Verfügung. <br/>
Wie Sie diese Informationen aus dem SSP kopieren, das ist [hier](#signierte-adressierungsinformationen) beschrieben.
Fügen Sie die Adressierungsinformationen in das Redaktionssystem Ihrer Behörde ein. <br/>
Das Einpflegen der Informationen ist abhängig vom verwendeten Redaktionssystem:
#### Infodienste (Systeme) der Linie6Plus (BB, HE, MV, NI, RP, SH, SL, ST, TH)
##### Einleitung/Allgemeines
Zur Steuerung von Antragsinformationen der Plattform FIT-Connect bzw. um die signierten Adressierungsinformationen eines Zustellpunktes (Destination) auszugegeben, muss die in Schritt 1 abgerufene „destinationSignatur“ (im Folgenden „FIT-Connect destinationSignatur“ genannt) verwendet werden.
Dafür wird die teilweise eingeführte Destination-ID entfallen, da die FIT-Connect destinationSignatur bereits die Destination-ID enthält.
Diese lässt sich in den Infodiensten pflegen; Voraussetzung und Ablauf sind im folgenden Abschnitt beschrieben.
##### Anlage eines Zustellkanals für die FIT-Connect destinationSignatur
Für die Pflege der FIT-Connect destinationSignatur in den Infodiensten wird ein neuer Zustellkanal benötigt.
Dieser kann nach Beauftragung durch die jeweiligen Länder der Linie6Plus durch den Support (support@teleport.de) zentral in den Infodiensten für die benötigte Datenpflege implementiert werden.
Da die FIT-Connect destinationSignatur einen eindeutigen Zustellpunkt definiert, muss sie an der Organisationseinheit als zuständige Stelle für definierte Verwaltungsleistungen verortet sein.
In dem Modul `Organisationseinheit` -> `Einstellung Kontakt/Verkehr`, kann die FIT-Connect destinationSignatur als neues Kontaktsystem für die Organisationseinheit angegeben werden.
Dementsprechend darf in den Infodiensten nicht nur der Wert Destination-ID hinterlegt werden, sondern dort müssen ebenfalls die signierten Adressierungsinformationen aus Schritt 1 hinterlegt werden können.
Dies ist durch das Anlegen der FIT-Connect destinationSignatur möglich, da diese den Wert ebenfalls enthält.
Konkret wird das (neue) Kontaktsystem wie folgt benannt: „FIT-Connect (destinationSignatur)“ mit der Kurzbezeichnung "FITCONNECTDESTSIGNATURE".
##### Pflege der FIT-Connect destinationSignatur in den Infodiensten
Die Redakteure der Kommunen und der zentralen Landesredaktion pflegen die FIT-Connect destinationSignatur an der Organisationseinheit dezentral.
In dem Modul `Organisationseinheit` -> `Einstellung Kontakt/Verkehr` kann der Redakteur ein Kontaktsystem hinzufügen.
Hierbei steht ihm als Option das Kontaktsystem „FIT-Connect (destinationSignatur)“ als Auswahloption zur Verfügung.
Im Feld `Kennung` hinterlegt der Redakteur die FIT-Connect destinationSignatur der Organisationseinheit.
Für bestimmte Anwendungsfälle besteht aber auch die Möglichkeit die FIT-Connect destinationSignatur mehrfach zu hinterlegen.
#### Weitere Redaktionssysteme
Wir streben an, für alle in Deutschland gängigen Systeme ein entsprechendes Pflegekonzept bereitzustellen.
Hierzu freuen wir uns über Bedarfsmeldungen, um besser abschätzen zu können, für welche Systeme ein Pflegekonzept prioritär benötigt wird.
Teilen Sie uns auch gerne mit, wenn Ihnen ein hier noch nicht aufgeführtes Pflegekonzept bekannt ist.
### 4. Konfiguration des Antragsroutings in FIM-Redaktionssystemen {#routing}
Damit das Fachverfahren Ihrer Behörde über die FIT-Connect Routingarchitektur auffindbar ist, müssen die von FIT-Connect bereitgestellten signierten Adressierungsinformationen zunächst im jeweiligen FIM Bundes- oder Landesredaktionssystem hinterlegt werden. Weitere Informationen dazu finden Sie [hier](./routing.mdx)
docs/receiving/destination.mdx
+ 1
− 1
View file @ d720e54b
......@@ -98,7 +98,7 @@ Anschließend kann der Zustellpunkt entweder über das Self-Service-Portal oder
:::
:::caution Hinweis
Um einen [Zustellpunkt mithilfe der Routing-API](../sending/get-destination.mdx) zu finden, müssen die Adressierungsinformationen in einem Redaktionssystem hinterlegt sein. Weitere Informationen hierzu finden sich im Artikel [Konfiguration des Antragsroutings](../organisation-tasks/subscriber.mdx#Redaktionssysteme).
Um einen [Zustellpunkt mithilfe der Routing-API](../sending/get-destination.mdx) zu finden, müssen die Adressierungsinformationen in einem Redaktionssystem hinterlegt sein. Weitere Informationen hierzu finden sich im Artikel [Antragsrouting konfigurieren](../organisation-tasks/routing.mdx).
:::
## Zugriff auf Zustellpunkte einrichten
......
docs/sending/get-destination.mdx
+ 8
− 3
View file @ d720e54b
......@@ -10,14 +10,19 @@ import TabItem from '@theme/TabItem'
Um eine Einreichung an die fachlich korrekte Stelle sicherzustellen und die technischen Parameter des richtigen Zustellpunkts zu ermitteln, muss die `destinationId` der zuständigen Stelle und die Adresse des zuständigen Zustelldienstes ermittelt werden.
:::tip Hinweis
:::info Hinweis
Die über das Self-Service-Portal erstellten Zustellpunkte sind in der Testumgebung nicht automatisch über die Routing-API auffindbar.
Dieses Feature ist als zukünftige Erweiterung geplant.
Für eine Auffindbarkeit der Zustellpunkte über die Routing-API ist in der Testumgebung derzeit eine manuelle Pflege in der Demo-Umgebung des Portalverbund Onlinegateway (PVOG) notwendig.
:::
:::tip Tipp
Sofern eine Destination-ID bereits bekannt ist, können die in einem Zustellpunkt hinterlegten technischen Parameter alternativ auch über den Endpunkt <ApiLink api="submission-api" to="/v1/destinations/{destinationId}" /> der Submission API des zuständigen Zustelldienstes [abgerufen werden (siehe unten)](#submissionapi).
:::
Die Konfiguration des Antragsroutings in der produktiven Umgebung ist bereits jetzt möglich. Die [in den Landesredaktionen konfigurierten Zustellpunkte](../organisation-tasks/subscriber.mdx#Redaktionssysteme) sind in der Produktivumgebung über die Routing-API abrufbar.
:::info Hinweis
Der Abruf von Routing-Informationen über die Routing-API ist in der produktiven Umgebung bereits jetzt möglich.
Hierzu müssen die Zuständigkeitsinformationen zuvor [in den Landesredaktionen konfiguriert werden](../organisation-tasks/routing.mdx).
:::
Die Ermittlung der `destinationId` und die Ermittlung der technischen Parameter über die Routing-API erfolgt über einen GET-Request auf den Endpunkt <ApiLink api="routing-api" to="/routes" /> des FIT-Connect Routingdienstes.
......@@ -615,4 +620,4 @@ $ curl \
}
```
</TabItem>
</Tabs>
\ No newline at end of file
</Tabs>
sidebar.js
+ 7
− 6
View file @ d720e54b
......@@ -21,12 +21,13 @@ module.exports = {
collapsed: true,
items: [
'organisation-tasks/subscriber',
'organisation-tasks/certificates',
'organisation-tasks/certificates',
'organisation-tasks/routing',
],
},
'organisation-tasks/sender',
},
'organisation-tasks/sender',
],
},
},
{
type: 'category',
label: 'Infos für Entwickler:innen',
......@@ -52,7 +53,7 @@ module.exports = {
'sending/get-destination',
'sending/metadata',
'sending/encrypt',
'sending/attachments',
'sending/attachments',
'sending/submit',
'sending/accept-reject',
]
......@@ -81,7 +82,7 @@ module.exports = {
'getting-started/event-log/set-creation',
'getting-started/event-log/set-validation',
]
},
},
'getting-started/notifications-and-deletion-deadlines',
'getting-started/schema-validation',
'getting-started/encryption',
......
src/pages/docs/getting-started/first-steps.js
+ 1
− 1
View file @ d720e54b
......@@ -8,4 +8,4 @@ export default function get_started() {
</p>
);
}
\ No newline at end of file
}
src/pages/docs/getting-started/receiving/destination.js
+ 1
− 1
View file @ d720e54b
......@@ -8,4 +8,4 @@ export default function destination() {
</p>
);
}
\ No newline at end of file
}
src/pages/docs/responsibilities/get-destination.js
+ 1
− 1
View file @ d720e54b
......@@ -8,4 +8,4 @@ export default function publish_destination() {
</p>
);
}
\ No newline at end of file
}
src/pages/docs/responsibilities/routing.js
+ 2
− 2
View file @ d720e54b
......@@ -4,8 +4,8 @@ import {Redirect} from '@docusaurus/router';
export default function routing() {
return (
<p>
<Redirect to="../../../docs/organisation-tasks/subscriber#Redaktionssysteme" />
<Redirect to="../../../docs/organisation-tasks/routing" />
</p>
);
}
\ No newline at end of file
}
0% or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment