From 1e685c34a2a17f0453492a08d9d217d049546596 Mon Sep 17 00:00:00 2001 From: Marco Holz <marco.holz@fitko.de> Date: Thu, 26 Aug 2021 14:56:35 +0200 Subject: [PATCH] =?UTF-8?q?Einheitliche=20Verwendung=20von=20LeiKa-Schl?= =?UTF-8?q?=C3=BCssel=20vs.=20LeiKa-ID?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit Die mit '99' beginnende Zahlenfolge, die eine Leistung im LeiKa eindeutig referenziert, wird als *LeiKa-Schlüssel* bezeichnet. Zusätzlich gibt es zu jeder Leistung eine LeiKa-intern verwendete *LeiKa-ID*. Die Bezeichnungen wurden im Text entsprechend auf LeiKa-Schlüssel vereinheitlicht. --- docs/details/authentication/scopes-sender.md | 10 +++++----- docs/getting-started/metadata.md | 6 +++--- docs/getting-started/sending/get-destination.mdx | 2 +- docs/glossary.md | 6 +++--- 4 files changed, 12 insertions(+), 12 deletions(-) diff --git a/docs/details/authentication/scopes-sender.md b/docs/details/authentication/scopes-sender.md index 4a3fb5273..333ecc51e 100644 --- a/docs/details/authentication/scopes-sender.md +++ b/docs/details/authentication/scopes-sender.md @@ -28,9 +28,9 @@ Siehe auch: [Gemeindeverzeichnis des Statistischen Bundesamtes](https://www.dest #### Scope: Leistung (innerhalb LeiKa) -- **Typ**: Leistungstyp innerhalb des LeiKa (LeiKa-ID) +- **Typ**: Leistungstyp innerhalb des LeiKa (LeiKa-Schlüssel) - **Beispiel**: `send:service:urn:de:fim:leika:leistung:99108008252000` -- **Erläuterung**: Eine Leistung, die im [Leistungskatalog der öffentlichen Verwaltung](https://leitfaden.ozg-umsetzung.de/display/OZG/2.1+Verwaltungsleistungen+im+Sinne+des+OZG) (LeiKa) verzeichnet ist, wird über ihre LeiKa-ID, vorangestellt mit `urn:de:fim:leika:leistung:` referenziert. +- **Erläuterung**: Eine Leistung, die im [Leistungskatalog der öffentlichen Verwaltung](https://leitfaden.ozg-umsetzung.de/display/OZG/2.1+Verwaltungsleistungen+im+Sinne+des+OZG) (LeiKa) verzeichnet ist, wird über ihren LeiKa-Schüssel, vorangestellt mit `urn:de:fim:leika:leistung:` referenziert. Der LeiKa ist im [FIM-Portal](https://fimportal.de/kataloge#download-leistungen) abrufbar. #### Scope: Leistung (außerhalb LeiKa) @@ -45,7 +45,7 @@ Reine Leistungsscopes werden nicht vergeben sondern sind immer mit einer Region - **Typ**: Kombination aus Leistungstyp und Region - **Beispiel**: `send:region:DE081100000000+send:service:urn:de:fim:leika:leistung:99108008252000` oder `send:region:DE081100000000+send:service:urn:myleistung` -- **Erläuterung**: Eine Kombination aus amtlichem Gemeindeschlüssel und LeiKa-ID. +- **Erläuterung**: Eine Kombination aus amtlichem Gemeindeschlüssel und LeiKa-Schlüssel. Hier erfolgt eine Einschränkung nach beiden angegeben Kriterien (Zugriff nur auf spezifische Leistung in der angegebenen Region). Reine Leistungsscopes werden nicht vergeben sondern sind immer mit einer Region gekoppelt. @@ -108,13 +108,13 @@ send:region:DE081150000000 Um sendende Systeme zur Einreichung bei allen Zustellpunkten mit einer bestimmten Leistung zu berechtigen, ist eine Vergabe von Berechtigungen auf Basis von Leistungs-IDs möglich. Ein Download des Leistungskatalogs mit allen LeiKa-Schlüsseln ist [über das FIM-Portal](https://fimportal.de/kataloge#download-leistungen) möglich. -**Beispiel**: Berechtigung für die LeiKa-Leistung "[Begutachung von abgeschleppten Fahrzeugen](https://fimportal.de/detail/L/99108008252000)" mit LeiKa-ID `99108008252000`: +**Beispiel**: Berechtigung für die LeiKa-Leistung "[Begutachung von abgeschleppten Fahrzeugen](https://fimportal.de/detail/L/99108008252000)" mit LeiKa-Schlüssel `99108008252000`: ``` send:service:urn:de:fim:leika:leistung:99108008252000 ``` -Vor der LeiKa-ID muss also der Präfix `urn:de:fim:leika:leistung:` stehen. +Vor dem LeiKa-Schlüssel muss also der Präfix `urn:de:fim:leika:leistung:` stehen. **Hinweis**: Reine Leistungsscopes werden nicht vergeben sondern sind **immer** mit einer Region gekoppelt. Um ein sendendes System zur Einreichung bei allen existierenden Zustellpunkten unabhängig der Leistung zu berechtigen wird der Schlüssel `send:region:DE` genutzt (siehe nächster Abschnitt). diff --git a/docs/getting-started/metadata.md b/docs/getting-started/metadata.md index a4f3d9967..a14fd20de 100644 --- a/docs/getting-started/metadata.md +++ b/docs/getting-started/metadata.md @@ -144,9 +144,9 @@ die Leistung noch in Rechnung gestellt werden muss oder die Leistung kostenfrei ## Verwaltungsleistung (`publicServiceType`) -Beschreibung der Art der Verwaltungsleistung. Eine Verwaltungsleistung sollte immer mit einer LeiKa-Id beschrieben -werden (siehe [Leistungskatalog im FIM-Portal](https://fimportal.de/kataloge#download-leistungen)). Ist für die gegebene Verwaltungsleistung keine LeiKa-Id vorhanden, kann die Verwaltungsleistung übergangsweise -über die Angabe einer anderen Leistungs-ID in Form einer eindeutigen URN beschrieben werden. Auf diese Option sollte allerdings nach Möglichkeit verzichtet werden. +Beschreibung der Art der Verwaltungsleistung. Eine Verwaltungsleistung sollte immer mit einem LeiKa-Schlüssel beschrieben werden (siehe [Leistungskatalog im FIM-Portal](https://fimportal.de/kataloge#download-leistungen)). +Ist für die gegebene Verwaltungsleistung kein LeiKa-Schlüssel vorhanden, kann die Verwaltungsleistung übergangsweise über die Angabe einer anderen Leistungs-ID in Form einer eindeutigen URN beschrieben werden. +Auf diese Option sollte allerdings nach Möglichkeit verzichtet werden. ```json { diff --git a/docs/getting-started/sending/get-destination.mdx b/docs/getting-started/sending/get-destination.mdx index c5375a1f5..a60ee0b7c 100644 --- a/docs/getting-started/sending/get-destination.mdx +++ b/docs/getting-started/sending/get-destination.mdx @@ -15,7 +15,7 @@ Um eine Einreichung an die fachlich korrekte Stelle sicherzustellen und die tech Um an einen Zustellpunkt eine Einreichung korrekt zu übermitteln, ist es notwendig, die im Zustellpunkt hinterlegten technischen Parameter für die Einreichung zu ermitteln. Diese Informationen sind: - Die Verwaltungsleistungen (`services`), die über diesen Zustellpunkt abgebildet werden, bestehend aus: - - einem Identifikator der Verwaltungsleitung (`identifier`): Typischerweise entspricht dieser einer LeiKa-ID (siehe [Leistungskatalog im FIM-Portal](https://fimportal.de/kataloge#download-leistungen)). + - einem Identifikator der Verwaltungsleitung (`identifier`): Typischerweise entspricht dieser einem LeiKa-Schlüssel (siehe [Leistungskatalog im FIM-Portal](https://fimportal.de/kataloge#download-leistungen)). - einer Liste an zulässigen Fachdatenschemata (`submissionSchemas`): Hiermit legt das empfangende System fest, welchem Schema die übergebenen Fachdatensätze entsprechen müssen. Welches der angebenen Schemata verwendet werden muss, bestimmt das sendende System aus dem eigenen fachlichen Kontext heraus. Wenn bspw. ein Antrag für einen Schwerbehindertenausweis gestellt wird, muss der Fachdatensatz aus den dort hinterlegten Schemata gemäß dem dortigen Schema für den Schwerbehindertausweis (bspw. ein FIM/XFall Schema) entsprechen. - einer Liste an Regionen (`regions`), für die die Verwaltungsleistung angeboten wird. - Der öffentliche Verschlüsselungsschlüssel (`encryptionKid` und `publicKeys`): Empfangende Systeme veröffentlichen in Form eines JSON Web Key Sets einen oder mehrere Public Keys für die Verschlüsselung der Einreichung. Welcher Public Key zum aktuellen Zeitpunkt für die Verschlüsselung genutzt werden muss, wird über den Parameter `kid` mitgeteilt. diff --git a/docs/glossary.md b/docs/glossary.md index 154f2aa04..7674f6e78 100644 --- a/docs/glossary.md +++ b/docs/glossary.md @@ -19,10 +19,10 @@ hide_table_of_contents: true | Ereignisprotokoll (event log) | Der Zustelldienst bündelt alle einem Object zugeordneten Ereignisse in einem Ereignisprotokoll. | | Fachdatensatz (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 verwendete Fachschema steht im Metadatensatz. Siehe auch: Artikel [Fachschemarefenzen auf Fachstandards und Rahmenwerke abbilden](details/schema-reference) | -| FIM | Föderales Informationsmanagement, bestehend aus den Bausteinen *FIM Leistungen* (siehe *LeiKa-ID*), FIM Datenfelder (siehe *Fachschema*) und FIM Prozesse (Prozessabbildungen zu einer Leistungserbringung). Weiterführende Informationen finden sich im [FIM-Portal](https://fimportal.de/) | +| FIM | Föderales Informationsmanagement, bestehend aus den Bausteinen *FIM Leistungen* (siehe *LeiKa-Schlüssel*), FIM Datenfelder (siehe *Fachschema*) und FIM Prozesse (Prozessabbildungen zu einer Leistungserbringung). Weiterführende Informationen finden sich im [FIM-Portal](https://fimportal.de/) | | Kommunikationskanal (communication channel) | Beschreibt einen Kommunikationskanal, um zwischen der zuständigen Stelle und dem Autor der Einreichung (bspw. dem Verwaltungskund:in) zu 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 (AS4)</li> <li>Elster Transfer des einheitlichen Unternehmenskontos</li> <li>Postfachplus (OSCI) des einheitlichen Unternehmenskontos</li> </ul>Eine zuständige Stelle kommuniziert über die Destination, welche Kommunikationskanäle unterstützt werden und der Autor der Einreichung legt fest, welche Kommunikationskanäle er sich hierfür wünscht. Für die Adressierung des Autors werden alle für den Kommunikationskanal notwendigen Verbindungs- und Adressparameter (einschließlich ggf. notwendiger Schlüssel/Zertifikate) im Metadatensatz mitgeliefert.| -| LeiKa-ID | ID aus dem **Lei**stungs**ka**talog der öffentlichen Verwaltung, siehe *Leistungs-ID* | -| Leistungs-ID | Eindeutigen ID des Typs einer Verwaltungsleistung. Eine Identifikation des Leistungtypen erfolgt z.B. über eine Leika-ID (z.B. `99010003001006`) bzw. der zugehörigen eindeutigen URN (z.B. `urn:de:fim:leika:leistung:99010003001006`) | +| LeiKa-Schlüssel | ID aus dem **Lei**stungs**ka**talog der öffentlichen Verwaltung. Manchmal wird zur Abgrenzung zwischen dem *LeiKa-Schlüssel* (beginnt immer mit `99`) und der LeiKa-intern verwendeten *LeiKa-ID* unterschieden. Siehe auch: *Leistungs-ID* | +| Leistungs-ID | Eindeutigen ID des Typs einer Verwaltungsleistung. Eine Identifikation des Leistungtypen erfolgt z.B. über einen Leika-Schlüssel (z.B. `99010003001006`) bzw. der zugehörigen eindeutigen URN (z.B. `urn:de:fim:leika:leistung:99010003001006`) | | Metadatensatz (metadata) | Ein Metadatensatz beschreibt: <ul> <li>Fachunabhängige Metadaten der Einreichung: Authentifizierung des Autors einer Einreichung oder Berichts (bspw. über einen eID-Laufzettel, Identifikation Report, Informationen über Signaturnutzung einschließlich Angabe des Signaturformats und ggf. separater Signaturdateien.), Ergebnisse eines Bezahlvorgangs oder digitale Verbindungs- und Adressparameter für die Verfahrensinformationen (falls vom Verwaltungskund:in gewünscht).</li> <li>Strukturbeschreibung der Einreichung: Art der Leistung oder Einreichungsbestandteile.</li> </ul> | | Onlineservice | Ein Onlineservice kann entweder von einer Behörde, einem Unternehmen oder einer zivilgesesellschaftlichen Organisation betrieben wird. Er interagiert in der Art mit FIT-Connect, dass er Anträge im Namen bzw. Auftrag eines Endnutzers verschlüsselt übermittelt. | | Self-Service-Portal | Das Self-Service-Portal ist Teil des Autorisierungsdienst und ermöglicht es, Accounts/Berechtigungen für die Anbindung von Onlinediensten und Fachverfahren/virtuellen Poststellen anzulegen. | -- GitLab