Leitfaden zur Integration von Online-Diensten aus Brandenburg

Owned by Christina Dozenko (Unlicensed)
Last updated: Oct 16, 2024 by Felix Nold
6 min read

Inhaltsverzeichnis Integrationsleitfaden

1. Nachnutzung anmelden

2. Basisdaten hinterlegen

3. Voraussetzung für Fachverfahrensanbindung erfüllen

4. Antragsstrecken auf Webseite einbinden

4.1. Einbindung via Web Component

4.1.1. HTML-Code Beispiel Einbindung “at-erwerbstaetigkeit” mit Attributen und Kategorisierung von Codeteilen

Zur Übersicht des Integrationsleitfadens

Nachfolgend finden Sie eine Vorlage für einen vollumfänglich konfigurierten HTML-Code sowie eine Detaillierung der Anpassungsoptionen am Beispiel der dezentralen Antragsstrecke “Aufenthaltstitel zur Erwerbstätigkeit“. dd

Wir empfehlen die Web Component Einbindung durch die Ansprechpersonen vornehmen zu lassen, die bei Ihnen im Haus für die Pflege der Webseite zuständig sind.

Kategorien zur Anpassung des Codes

Kategorien zur Anpassung des Codes

Farbe

Bedeutung

Rot

Code muss für die korrekte Funktionsweise der Web Component 1:1 übernommen werden.

Gelb

Code muss aus fachlichen Gründen übernommen werden, kann aber textuell (nicht die HTML-Attribute) angepasst werden.

Grün

Code ist optional und die Einbindung der Web Component. Es wird jedoch auf Grund von Nutzerfreundlichkeit und einer einheitlichen Darstellung der Web Component empfohlen diesen zu verwenden.

Türkis

Code muss dienstspezifisch angepasst werden.

Grau

Code muss mandantenspezifisch angepasst werden.

Violett

Attribute, welche zusätzliche Funktionen für die Antragsstrecke bereitstellen. Diese können bei Bedarf hinzugefügt werden, um z.B. das Nutzerkonto anzubieten.

HTML-Code Beispiel Aufenthaltstitel zur Erwerbstätigkeit mit Attributen

HTML-Code Beispiel Aufenthaltstitel zur Erwerbstätigkeit mit Attributen

<html lang="de">       

        <head>

            <meta charset="UTF-8">

            <meta name="viewport" content="width=device-width, initial-scale=1.0">

            <title>Antrag für einen Aufenthaltstitel zur Erwerbstätigkeit</title>

            <link rel="stylesheet" href="https://api.service-digitale-verwaltung.de/embed/themes/tf-blue.css">

            <script src="https://api.service-digitale-verwaltung.de/embed/polyfill/polyfill.js"></script>

        </head>

        <body style="margin-top: 4rem;">

            <noscript>

                Für die Verwendung dieses Dienstes ist JavaScript erforderlich.

                Bitte aktivieren Sie diese Funktion in Ihren Browsereinstellungen oder verwenden Sie einen anderen Web-Browser mit aktiviertem JavaScript.

            </noscript>

                <at-erwerbstaetigkeit ags="12345678" language-selection hide-login="false" plz-check hide-page-nav="false" page-nav-position="left" excluded-languages="ru" page-nav-position =“left“></at-erwerbstaetigkeit>               

                <script src="https://api.service-digitale-verwaltung.de/embed/at-erwerbstaetigkeit/at-erwerbstaetigkeit.js" charset="UTF-8"></script>

                                  

        </body>

    </html>

 

4.2. Einbindung Nutzerkonto

4.2.1. Verwendung des Rückkanals

4.3. Einbindung PLZ-Check zur Zuständigkeitsprüfung

4.4. Einbindung ePayment

4.5. Einbindung Sprachauswahl

Zur Übersicht des Integrationsleitfadens

Bei Bedarf Sprachauswahl zum Antragsbeginn aktivieren.

Antragsstrecke

Status der Entwicklung

Verfügbare Sprachen

Sprachen in Planung

Antragsstrecke

Status der Entwicklung

Verfügbare Sprachen

Sprachen in Planung

Aufenthaltstitel zur Erwerbstätigkeit

Zur Nachnutzung verfügbar

Deutsch, Englisch, Russisch, Serbisch, Türkisch, Französisch, Spanisch

Ukrainisch, Arabisch

Antrag für eine Aufenthaltserlaubnis aus familiären Gründen

Zur Nachnutzung verfügbar

Deutsch, Englisch, Russisch, Serbisch, Türkisch, Französisch, Spanisch

Ukrainisch, Arabisch

Aufenthaltserlaubnis zum Zweck der Ausbildung

Zur Nachnutzung verfügbar

Deutsch, Englisch, Russisch, Serbisch, Türkisch, Französisch, Spanisch

Ukrainisch, Arabisch

Änderung von aufenthaltsrechtlichen Nebenbestimmungen

Zur Nachnutzung verfügbar

Deutsch, Englisch, Russisch, Serbisch, Türkisch, Französisch, Spanisch

Ukrainisch, Arabisch

Aufenthaltsgewährung zum vorübergehenden Schutz für Vertriebenen aus der Ukraine (§24 Aufenthaltsgesetz)

Zur Nachnutzung verfügbar

Deutsch, Englisch, Ukrainisch, Russisch

Vorerst finalisiert

Niederlassungserlaubnis

Zur Nachnutzung verfügbar

Deutsch, Englisch, Russisch, Serbisch, Türkisch, Französisch, Spanisch

Ukrainisch, Arabisch

Aufenthalt von EU- und EWR-Bürgern sowie deren Familien (Freizügigkeitsberechtigte)

Zur Nachnutzung verfügbar

Deutsch, Englisch, Russisch, Serbisch, Türkisch

Französisch, Spanisch (voraussichtlich ab Q3 verfügbar)

Ukrainisch, Arabisch,

Bündelungskomponente

Zur Nachnutzung verfügbar

Deutsch, Englisch, Ukrainisch, Russisch, Serbisch, Türkisch, , Französisch, Spanisch

Arabisch,

Beantragung des beschleunigten Fachkräfteverfahrens

Zur Nachnutzung verfügbar

Deutsch, Englisch, Russisch, Serbisch, Türkisch, , Französisch, Spanisch

Ukrainisch, Arabisch

Beschäftigungserlaubnis und Ausbildungsduldung für Inhaber von Aufenthaltsgestattungen und Duldungen

Zur Nachnutzung verfügbar

Deutsch, Englisch, Russisch, Serbisch, Türkisch, , Französisch, Spanisch

Ukrainisch, Arabisch

4.6. Einbindung Bündelungskomponente

4.6.1. HTML-Code Beispiel Einbindung “at-buendelungskomponente” mit Attributen und Kategorisierung von Codeteilen

Kategorien der Anpassungsmöglichkeiten im HTML-Code

Kategorien der Anpassungsmöglichkeiten im HTML-Code

Farbe

Bedeutung

Rot

Code muss für die korrekte Funktionsweise der Web Component 1:1 übernommen werden.

Grün

Code ist optional und die Einbindung der Web Component. Es wird jedoch auf Grund von Nutzerfreundlichkeit und einer einheitlichen Darstellung der Web Component empfohlen diesen zu verwenden.

Grau

Code muss mandantenspezifisch angepasst werden.

Türkis

Attribute, welche zusätzliche Funktionen für die Antragsstrecke bereitstellen. Diese können bei Bedarf hinzugefügt werden, um z.B. ein Nutzerkonto auszublenden oder die Antragsstrecken in unterschiedlichen Sprachen zur Verfügung stellen.

Gelb

Code muss aus fachlichen Gründen übernommen werden, kann aber textuell (nicht die HTML-Attribute) angepasst werden.

(Text in Klammern)

Kommentar, zur Einordnung des Attributs in der aktuellen Umsetzung. Dieser Text muss in der Einbindung des Codes gelöscht werden.

HTML-Code Beispiel mit Attributen

HTML-Code Beispiel mit Attributen

<html lang="de">

    <head>

        <meta charset="UTF-8">

        <meta name="viewport" content="width=device-width, initial-scale=1.0">

        <link rel="stylesheet" href="https://api.service-digitale-verwaltung.de/embed/themes/tf-blue.css">

        <script src="https://api.service-digitale-verwaltung.de/embed/polyfill/polyfill.js"></script>

    </head>

    <body style="margin-top: 4rem;">

        <aw-buendelungskomponente

            hide-services="at-nebenbestimmungen" (kommaseparierte Liste der Antragskürzel erlaubt - diesen Kommentar bei der Einbindung bitte löschen)

            hide-login-services="at-ausbildung" (kommaseparierte Liste der Antragskürzel erlaubt- diesen Kommentar bei der Einbindung bitte löschen)

            ags="12345678"

            add-services="at-germany-for-ukraine" (kommaseparierte Liste der Antragskürzel erlaubt - diesen Kommentar bei der Einbindung bitte löschen)

            page-nav-position-services="at-ausbildung:right" (kommaseparierte Liste der Antragskürzel mit Angabe der Navigationsausrichtung erlaubt - diesen Kommentar bei der Einbindung bitte löschen)

            language-selection-services="at-ausbildung,at-erwerbstaetigkeit,at-familiennachzug" (kommaseparierte Liste der Antragskürzel erlaubt - diesen Kommentar bei der Einbindung bitte löschen)

            plz-check-services="at-ausbildung,at-erwerbstaetigkeit,at-familiennachzug,at-nebenbestimmungen" (kommaseparierte Liste der Antragskürzel erlaubt - diesen Kommentar bei der Einbindung bitte löschen)

        ></aw-buendelungskomponente>

        <script src="https://api.service-digitale-verwaltung.de/embed/aw-buendelungskomponente/aw-buendelungskomponente.js" charset="UTF-8"></script>

    </body>

</html>

 

Erklärvideo “HTML-Code für Bündelungskomponente”

 

 

4.6.2. Direkte Verlinkung einer Antragsstrecke innerhalb der Bündelungskomponente

4.7. Änderungshinweise zu Antragsstrecken

5. Antragsstrecken im OZG Service Management Tool individualisieren

5.1. Zugangsdaten & Anmeldung für OZG Service Management Tool

5.2. Produktiv- und Testumgebung

5.3. Einstellungen - Postleitzahlen

5.4. Individualisierung der Texte

5.4.1. Erläuterungen zur Textbearbeitung im OZG Service Management

5.4.1.1. Freigeschaltete Texte im OZG Service Management Tool

5.4.1.2. “Speichern” im OZG Service Management Tool

5.4.1.3. Eingaben auf den Default-Wert zurücksetzen

5.4.1.4. Felder im Online-Dienst ausblenden

5.4.1.5. Weitere “Sprachen” hinzufügen

5.4.1.6. Textsuche im OZG Service Management Tool

5.4.1.7. Filterfunktion im OZG Service Management Tool

5.5. Terminmanagementsystem integrieren

5.6. Metriken

5.7. Nachweisuploads als verpflichtend einstellen

6. Antragsstrecken und Nachrichtenzustellung testen

7. Informationen zum Datenschutz

8. Go Live und Kommunikationsmaterialien

9. Erklärung zur Barrierefreiheit

10. Support