Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.
Include Page
Einleitung
Einleitung

Inhaltsverzeichnis Integrationsleitfaden

Table of Contents
minLevel1
maxLevel7
stylenone

1. Nachnutzung anmelden

Include Page
1. Nachnutzung anmelden
1. Nachnutzung anmelden

2. Basisdaten hinterlegen

Include Page
2. Basisdaten hinterlegen
2. Basisdaten hinterlegen

3. Voraussetzung für Fachverfahrensanbindung erfüllen

Include Page
3. Voraussetzung für Fachverfahrensanbindung erfüllen
3. Voraussetzung für Fachverfahrensanbindung erfüllen

4. Antragsstrecken auf Webseite einbinden

Include Page
4. Antragsstrecken auf Webseite einbinden
4. Antragsstrecken auf Webseite einbinden

4.1. Einbindung via Web Component

Include Page
4.1. Einzeleinbindungen der Antragsstrecken via Web Component
4.1. Einzeleinbindungen der Antragsstrecken via Web Component

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

Panel
bgColor#E6FCFF

Zur Übersicht des Integrationsleitfadens

Info

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

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 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

Include Page
4.2. Einbindung Nutzerkonto
4.2. Einbindung Nutzerkonto

4.2.1. Verwendung des Rückkanals

Include Page
4.2.1. Verwendung des Rückkanals
4.2.1. Verwendung des Rückkanals

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

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

4.4. Einbindung ePayment

Include Page
4.4. Einbindung ePayment
4.4. Einbindung ePayment

4.5. Einbindung Sprachauswahl

Panel
bgColor#E6FCFF

Zur Übersicht des Integrationsleitfadens

  •  Bei Bedarf Sprachauswahl zum Antragsbeginn aktivieren.
Panel
panelIconId1f4cb
panelIcon:clipboard:
panelIconText📋
bgColor#ABF5D1

Anleitung:

Die Sprachauswahl kann zum Antragsbeginn gemäß dertechnischen Anleitung aktiviert oder deaktiviert werden. Zu verwenden ist das Attributlanguage-selection“. Weitere Informationen zu der Spracheinstellung finden Sie hier.

⚠️ Über das Attribut “excluded-languages” kann die angezeigte Sprachauswahl in den Antragsstrecken eingeschränkt werden und somit einzelne Übersetzungen der Antragsoberfläche deaktiviert werden. Folgendes Beispiel veranschaulicht die Entfernung der Übersetzungen in die russische und türkische Sprache für die Antragsstrecke „Aufenthaltstitel zur Erwerbstätigkeit“:

<at-erwerbstaetigkeit excluded-languages="ru, tr" />

Die in den Anführungszeichen des Codes genannten Sprachkürzel lauten wie folgt:

  • de = Deutsch

  • en = Englisch

  • ru = Russisch

  • tr = Türkisch

  • sr = Serbisch

  • es = Spanisch

  • fr = Französisch

  • uk = Ukrainisch (nur für Antragsstrecke „at-germany4ukraine“ vorhanden)

Diese Codezeile kann entweder zentral in der Bündelungskomponente oder je Antragsstrecke im HTML-Code der Web-Component eingebaut werden.

Das Deaktivieren von einzelnen Sprachen kann lediglich über das Attribut “excluded-languages” im HTML-Code gesteuert werden. Auch wenn Sie die angezeigten Übersetzungen der einzelnen Texte im OZG Service Management löschen, erscheinen die jeweiligen Übersetzungen in dem Online-Dienst mit der entsprechenden Sprachauswahl.

Panel
panelIconIdatlassian-info
panelIcon:info:
panelIconText:info:
bgColor#DEEBFF

Die Antragsstrecken stehen in deutscher Sprache standardisiert zur Verfügung. Der nachfolgenden Tabelle können Sie entnehmen, welche weiteren Übersetzungen für die separaten Antragsstrecken bereits bestehen bzw. welche Übersetzungen aktuell in Entwicklung sind.

Im OZG Service Management können Sie über die Einstellungen unter dem Reiter „Texte Bearbeiten” für die einzelnen Antragselemente selbst weitere Sprachen hinzufügen. Hierfür ist es notwendig, alle Texte über „Sprache hinzufügen“ in der gewählten Sprache zu hinterlegen.

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ährungzum 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

In Konzeption Zur Nachnutzung verfügbar

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

Ukrainisch, Arabisch

Panel
panelIconIdatlassian-light_bulb_on
panelIcon:light_bulb_on:
panelIconText:light_bulb_on:
bgColor#FFBDAD

Hinweis: Die zur Verfügung stehenden Antragsstrecken sind in deutscher Sprache und auf Grundlage des lateinischen Alphabets entwickelt worden. Die in den Antragsstrecken bereitgestellten Beschreibungs- und Hilfetexte in deutscher und verschiedenen weiteren Sprachen basieren hierbei, trotz Übersetzung und der Verwendung des kyrillischen Alphabets, weiterhin auf der deutschen Antragsstrecke unter Verwendung des lateinischen Alphabets.
Die Anträge gehen, trotz der beliebigen Sprachauswahl der Antragsstellenden für die Beschreibungs- und Hilfetexte der Antragsstrecke, in deutscher Sprache und der Verwendung des lateinischen Alphabets in den zu befüllenden Feldern im Fachverfahren ein. Dies gilt für alle Antragsstrecken.

4.6. Einbindung Bündelungskomponente

Include Page
4.6. Einbindung Bündelungskomponente
4.6. Einbindung Bündelungskomponente

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

Panel
bgColor#E6FCFF

Zur Übersicht des Integrationsleitfadens

Info

Nachfolgend finden Sie ein Beispiel für einen vollumfänglich konfigurierten HTML-Code sowie eine Detaillierung der Anpassungsoptionen für die Einbindung der “Bündelungskomponente”.
Eine vollständige Anleitung mit weiteren Konfigurationsmöglichkeiten und aktuellen Änderungen finden Sie in dieser Anleitung.

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 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>

Info

Als zusätzliche Unterstützung wird anhand des gezeigten HTML-Code Beispiels die Einbindung in dem nachfolgenden Erklärvideo noch einmal detaillierter beschrieben.

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

Video_4_Bündelungskomponente_Untertitel.mp4

4.6.2. Direkte Verlinkung einer Antragsstrecke innerhalb der Bündelungskomponente

Include Page
4.6.2. Erstellung von Deeplinks der Bündelungskomponente zur Eintragung in Landesportalen
4.6.2. Erstellung von Deeplinks der Bündelungskomponente zur Eintragung in Landesportalen

4.7. Änderungshinweise zu Antragsstrecken

Include Page
4.7. Änderungshinweise zu Antragsstrecken
4.7. Änderungshinweise zu Antragsstrecken

5. Antragsstrecken im OZG Service Management Tool individualisieren

Include Page
5. Antragsstrecken im OZG Service Management Tool individualisieren
5. Antragsstrecken im OZG Service Management Tool individualisieren

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

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

5.2. Produktiv- und Testumgebung

Include Page
5.2. Produktiv- und Testumgebung
5.2. Produktiv- und Testumgebung

5.3. Einstellungen - Postleitzahlen

Include Page
5.3. Einstellungen - Postleitzahlen
5.3. Einstellungen - Postleitzahlen

5.4. Individualisierung der Texte

Include Page
5.4. Individualisierung der Texte
5.4. Individualisierung der Texte

5.4.1. Erläuterungen zur Textbearbeitung im OZG Service Management

Include Page
5.4.1. Erläuterungen zur Textbearbeitung im OZG Service Management
5.4.1. Erläuterungen zur Textbearbeitung im OZG Service Management

5.4.1.1. Freigeschaltete Texte im OZG Service Management Tool

Include Page
5.4.1.1. Freigeschaltete Texte im OZG Service Management Tool
5.4.1.1. Freigeschaltete Texte im OZG Service Management Tool

5.4.1.2. “Speichern” im OZG Service Management Tool

Include Page
5.4.1.2. “Speichern” 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

Include Page
5.4.1.3. Eingaben auf den Default-Wert zurücksetzen
5.4.1.3. Eingaben auf den Default-Wert zurücksetzen

5.4.1.4. Felder im Online-Dienst ausblenden

Include Page
5.4.1.4. Felder im Online-Dienst ausblenden
5.4.1.4. Felder im Online-Dienst ausblenden

5.4.1.5. Weitere “Sprachen” hinzufügen

Include Page
5.4.1.5. Weitere “Sprachen” hinzufügen
5.4.1.5. Weitere “Sprachen” hinzufügen

5.4.1.6. Textsuche im OZG Service Management Tool

Include Page
5.4.1.6. Textsuche im OZG Service Management Tool
5.4.1.6. Textsuche im OZG Service Management Tool

5.4.1.7. Filterfunktion im OZG Service Management Tool

Include Page
5.4.1.7. Filterfunktion im OZG Service Management Tool
5.4.1.7. Filterfunktion im OZG Service Management Tool

5.4.1.8. Textvariablen für den Rückkanal

Include Page5.4.1.8. Textvariablen für den Rückkanal5.4.1.8. Textvariablen für den Rückkanal

5.5. Informationsblatt zur Datenverarbeitung verlinken

Include Page
5.5. Informationsblatt zur Datenverarbeitung verlinken

5.5.

Informationsblatt zur Datenverarbeitung verlinken5.6.

Terminmanagementsystem integrieren

Include Page
5.6. Terminmanagementsystem integrieren
5.6. Terminmanagementsystem integrieren

5.

7

6. Metriken

Include Page
5.7. Metriken
5.7. Metriken

5.

8

7. Nachweisuploads als verpflichtend einstellen

Include Page
5.8. Nachweisuploads als verpflichtend einstellen
5.8. Nachweisuploads als verpflichtend einstellen

6. Antragsstrecken und Nachrichtenzustellung testen

Include Page
6. Antragsstrecken und Nachrichtenzustellung testen
6. Antragsstrecken und Nachrichtenzustellung testen

7. Informationen zum Datenschutz

Info

Mit Inkrafttreten des Gesetzes zur Änderung des Onlinezugangsgesetzes - OZGÄndG („OZG 2.0“) wurde eine zentrale, datenschutzrechtliche Verantwortung der den Onlinedienst betreibenden Behörde normiert (§ 8a Abs. 4 OZG n.F.).

Aufgrund dieser gesetzlichen Änderung ist eine Unterzeichnung einer datenschutzrechtlichen Vereinbarung zur Auftragsverarbeitung durch die jeweils einzelnen (kommunalen) Behörden nicht mehr notwendig.

→ Das Ministerium des Innern und für Kommunales Brandenburg übernimmt als betreibende Behörde ab sofort für den EfA-Onlinedienst „Aufenthalt Digital“ die zentrale datenschutzrechtliche Verantwortung!


8. Go Live und Kommunikationsmaterialien

Include Page
8. Go Live und Kommunikationsmaterialien
8. Go Live und Kommunikationsmaterialien

9. Erklärung zur Barrierefreiheit

Include Page
9. Erklärung zur Barrierefreiheit
9. Erklärung zur Barrierefreiheit

10. Support

Include Page
10. Support
10. Support