...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
Inhaltsverzeichnis Leitfaden
| Warning |
|---|
Achtung! Sie befinden sich im veralteten Integrationsleitfaden des EfA-Onlinedienstes “Einbürgerung.” Den aktuellen und neu bereitgestellten Integrationsleitfaden haben wir Ihnen unter diesem Link zur Verfügung gestellt. |
| Table of Contents |
|---|
| Panel | ||||||||
|---|---|---|---|---|---|---|---|---|
| ||||||||
Hinweis: Bitte beachten Sie, dass Sie für alle vorgenommenen textlichen Änderungen selbst verantwortlich sind. Sollten die vorgenommene Änderungen hinfällig oder nicht mehr aktuell sein, sind sie auch dafür verantwortlich dies wieder anzupassen. Wir empfehlen Ihnen, sich eine Übersicht anzulegen, aus der ersichtlich wird, welche Änderungen Sie vorgenommen haben und diese zu dokumentieren. Dies dient auch dazu, die Standardtexte zur Verügung zu haben, sollten diese wieder benötigt werden. Beachten Sie außerdem, dass dieser Leitfaden vom Aufenthaltsitel adaptiert wurde und es in wenigen Fällen dazu kommen kann, dass in diesem Leitfaden noch davon die Rede ist - dies bitten wir zu ignorieren. Das technische Vorgehen ist in jedem Fall einheitlich. |
1. Antragsstrecken im OZG Service Management Tool individualisieren
| Info |
|---|
Das OZG Service Management Tool ist die Management-Oberfläche und das Bearbeitungstool für die Online- und EfA-Dienste der AKDB. Dort finden Sie einen Bereich für Ihre Kommune und können Metriken zu den Aufrufen Ihrer Dienste einsehen, Postleitzahlen hinterlegen sowie die Texte anpassen. Das nachfolgende Erklärvideo dient als Unterstützung für die Arbeit im OZG Service Management Tool. |
“Erklärvideo OZG Service Management Tool”
...
1.1 Zugangsdaten & Anmeldung für OZG Service Management Tool
- Prüfung, ob die angegebenen fachlichen und technischen Ansprechpartner/innen zwei Einladungs-E-Mails für das OZG Service Management Tool erhalten haben.
- Anmeldung beim OZG Service Management Tool.
| Info |
|---|
Die angegebenen fachlichen und technischen Ansprechpartner/innen erhalten nach der Einrichtung des Mandanten zwei E-Mails mit jeweils einem Einladungslink für die PRE- und für die PRO-Umgebung des OZG Service Management Tool. Hierbei handelt es sich um die fachlichen und technischen Ansprechpartner/innen, die zuvor im Self-Service-Ticket angegeben wurden. |
| Panel | ||||||||
|---|---|---|---|---|---|---|---|---|
| ||||||||
Hinweis: Die Einladungslinks laufen nach 72 Stunden ab. Aus Gründen der Revisionssicherheit können die Einladungslink für das OZG Service Management Tool nicht an Funktionspostfächer gesendet werden. Dieser Umstand schließt nicht aus, dass für die allgemeine Kommunikation Funktionspostfächer im Sinne einer technischen oder fachlichen Ansprechperson verwendet werden können. Für die erfolgreiche Einrichtung des Online-Dienstes muss jedoch mindestens eine technische oder fachliche Ansprechperson angegeben werden. Hierfür sind die Angaben Vorname, Nachname sowie eine personalisierte E-Mail-Adresse notwendig. Bitte beachten Sie bei der Anmeldung, dass bei der Eingabe “Benutzername bzw. E-Mail-Adresse” lediglich Kleinbuchstaben verwendet werden können. Es bestehen keine spezifischen Passwortkriterien. Um eine Fehlermeldung bei der Aktivierung zu vermeiden, sollte der Einladungslink nicht über den Internet Explorer, sondern über einen der folgenden Webbrowser geöffnet werden: Google Chrome, Firefox, Safari, Microsoft Edge, Opera. ⚠️ Falls Sie keine Zugangsdaten erhalten haben, der Einladungslink abgelaufen ist oder weitere Personen Zugriff erhalten sollen, senden Sie bitte eine E-Mail an rollout-dv@akdb.de oder reichen ein online Ticket mit Ihrem Anliegen ein. |
...
1.2. Produktiv- und Testumgebung
| Info |
|---|
Grundsätzlich gibt es für Ihre Dienste eine Test-Umgebung (PRE) und eine produktive Umgebung (PRO). Für beide Umgebungen gibt es eigenständige Oberflächen im OZG Service Management. Die Zugriffsrechte sind pro Umgebung definiert. Test-Umgebung (PRE) Die Verwendung der Test-Umgebung (PRE) ist optional und vor allem für den Test der Web Component Einbindung sowie für die Weiterentwicklungen der Online-Dienste gedacht. Bitte beachten Sie, dass Sie auf der Test-Umgebung (PRE) nicht die Zustellung der Antragsdaten in Ihr Fachverfahren testen können. Produktive Umgebung (PRO) Die produktive Umgebung (PRO) kann direkt für die Integration der Online-Dienste in die Webseite Ihrer Kommune bzw. Behörde verwendet werden. Auf der produktiven Umgebung (PRO) können Sie die Zustellung der Antragsdaten in Ihr Fachverfahren testen. |
| Panel | ||||||||
|---|---|---|---|---|---|---|---|---|
| ||||||||
Hinweis: Bitte beachten Sie, dass die zu individualisierenden Texte im OZG Service Management Tool auf der produktiven Umgebung (PRO) verpflichtend anzupassen sind. Auf der Test-Umgebung (PRE) können diese Anpassungen optional vorgenommen werden. Anpassungen, die auf der Test-Umgebung (PRE) bzw. auf der produktiven Umgebung von Ihnen vorgenommen wurden, können nicht automatisch auf die jeweils andere Umgebung übernommen werden, da die beiden Umgebungen (PRE, PRO) eigenständig sind. Für eine zeitsparende Einbindung der Antragsstrecken empfehlen wir lediglich die Einbindung auf der produktiven Umgebung (PRO) vorzunehmen. |
1.3. Einstellungen - Postleitzahlen
| Panel | ||||||||
|---|---|---|---|---|---|---|---|---|
| ||||||||
Anleitung: Wenn der PLZ-Check zur Zuständigkeitsprüfung aktiviert ist, können unter “Einstellungen” in dem Reiter “Postleitzahlen” die gültigen Postleitzahlen Ihres Zuständigkeitsbereichs hinterlegt werden. Hinweis: Die konfigurierten Postleitzahlen werden ausschließlich für die Web Component Einbindung verwendet, über die der Dienst mit dem entsprechenden Amtlichen Gemeindeschlüssel (AGS) eingebunden ist. Für den Online-Dienst „Aufenthaltstitel, Aufenthaltskarten & aufenthaltsrelevante Bescheinigungen“ müssen keine Angaben zu Standesämtern im OZG Service Management Tool hinterlegt werden. |
...
1.4. Individualisierung der Texte
- Zwingend zu individualisierende Texte auf der PRO-Umgebung unter “variables” anpassen.
- Attribute “plz_check_hint” und “plz_check_success” anpassen, wenn der PLZ-Check aktiviert wurde.
| Panel | ||||||||
|---|---|---|---|---|---|---|---|---|
| ||||||||
Anleitung: Sämtliche Texte im Online-Dienst können über das OZG Service Management Tool individualisiert werden. Durch Auswählen der Ellipse (“drei Punkte“) bei der entsprechenden Antragsstrecke öffnet sich ein Reiter, unter dem Sie “Texte bearbeiten“ auswählen können. |
...
| Panel | ||||||||
|---|---|---|---|---|---|---|---|---|
| ||||||||
Hinweis: Einige Textstellen müssen zwingend auf der PRO-Umgebung (Produktivsystem) angepasst werden. Diese sind in der Gruppe „variables“ als Platzhalter für Sie gebündelt. |
...
| Panel | ||||||||
|---|---|---|---|---|---|---|---|---|
| ||||||||
Hinweis: Sollte der PLZ-Check aktiviert sein, sind auch zwingend in der Gruppe “html” die Attribute
zu individualisieren. Bei der Individualisierung des Attributes „plz_check_success“ muss der Platzhalter „XY“ durch den Namen der antragsbearbeitenden Behörde ersetzt werden. Dieser Text wird den Antragsstellenden angezeigt, wenn die eingegebene Postleitzahl in den Zuständigkeitsbereich der jeweiligen Behörde fällt. Eine ausführliche Erklärung zur Aktivierung des PLZ-Checks können Sie einige Schritt vorher aus 4.3 Einbindung PLZ-Check zur Zuständigkeitsprüfung entnehmen. |
| Info |
|---|
Jedem Textbereich der Antragsseiten ist im OZG Service Management Tool eine eindeutige Variable (ein Schlüssel) zugeordnet. Die folgende Abbildungen zeigen die Textbereiche in den Antragsstrecken mit den dazugehörigen Variablen im, die im OZG Service Management zwingend anzupassen sind: |
| Panel | ||
|---|---|---|
| ||
Beispiel: Folgendem Textbereich “Die Einbürgerungsbehörde XY ist für Ihr Anliegen zuständig. Sie können Ihr Anliegen nun online einreichen! Klicken Sie dazu auf “Jetzt starten”. ist den eindeutigen Variablen plz_check_hint und plz_check_successzugeordnet. |
1.4.1. Erläuterungen zur Textbearbeitung im OZG Service Management
| Panel | ||||||||
|---|---|---|---|---|---|---|---|---|
| ||||||||
Hinweis: Den nachfolgenden Erläuterungen können Sie weitere Informationen zu der Textbearbeitung im OZG Service Management Tool entnehmen:
|
1.4.1.1. Freigeschaltete Texte im OZG Service Management Tool
| Panel | ||||||||
|---|---|---|---|---|---|---|---|---|
| ||||||||
Anleitung: In der linken Navigationsleiste sind alle zur Bearbeitung freigeschalteten Texte hinter entsprechenden Schlüsseln/ Variablen aufgelistet. Zur Übersicht sind, die von Ihnen zwingend zu individualisierenden Stellen in der Gruppe “variables“ als Platzhalter gebündelt. Dort können Sie die Platzhalter zu Ihrer Kommune (Orts- und Behördenbezeichnungen, Gebührenangaben, Kontaktdaten etc.) bearbeiten und speichern. |
...
1.4.1.2. “Speichern” im OZG Service Management Tool
| Panel | ||||||||
|---|---|---|---|---|---|---|---|---|
| ||||||||
Anleitung: Aus der linken Navigationsleiste kann das gewünschte Objekt ausgewählt und der Text im Eingabefeld rechts angepasst werden. Die Eingaben werden erst durch Klicken auf „Speichern“ hinterlegt. Wird die Eingabe nicht durch „Speichern“ bestätigt, gehen die Änderungen verloren. Wenn Sie ein Objekt bearbeitet und gespeichert haben, wird es in der Navigationsleiste mit blauer Schrift markiert. Hinweis: Falls die Änderungen ggf. trotz Speicherung nicht sichtbar sind, empfehlen wir Ihnen als ersten Schritt den Cache und die Cookies des verwendeten Browsers zu löschen. Für eine schnelle Prüfung empfehlen wir Ihnen Ihre Web Component Einbindung in einem neuen Browser (z.B. Firefox, Google Chrome, Edge) zu öffnen und Ihre vorgenommenen und gespeicherten Textanpassungen erneut zu prüfen. |
...
1.4.1.3. Eingaben auf den Default-Wert zurücksetzen
| Panel | ||||||||
|---|---|---|---|---|---|---|---|---|
| ||||||||
Anleitung: Eingaben können über das Menü rechts neben dem Eingabefeld (“drei Punkte“) auf den Default-Wert (Voreinstellung) zurückgesetzt werden. Auch das Zurücksetzen muss mit “Speichern” bestätigt werden. |
...
1.4.1.4. Felder im Online-Dienst ausblenden
| Panel | ||||||||
|---|---|---|---|---|---|---|---|---|
| ||||||||
Anleitung: Einige Felder (z. B. Hinweisboxen) können über den Regler “Sichtbar“ aus dem Dienst ausgeblendet werden. Hierfür muss der aktive Regler („blau“) auf “Versteckt“ („grau“) gesetzt und die Änderung mit “Speichern“ bestätigt werden. Sofern die Funktion für das jeweilige Feld verfügbar ist, befindet sich der Regler rechts neben der Menü-Leiste. |
...
1.4.1.5. Weitere “Sprachen” hinzufügen
| Panel | ||||||||
|---|---|---|---|---|---|---|---|---|
| ||||||||
Anleitung: Grundsätzlich ist es möglich, über „Sprache hinzufügen“ weitere Sprachen hinzuzufügen. Hierfür ist es notwendig, alle Texte in der neuen Sprache zu hinterlegen. |
...
1.4.1.6. Textsuche im OZG Service Management Tool
| Panel | ||||||||
|---|---|---|---|---|---|---|---|---|
| ||||||||
Anleitung: Um einzelne Textstellen im OZG Service Management Tool zu finden, gibt es eine Suchfunktion, die nach allen Texten, die den Suchbegriff enthalten, filtert und die Ergebnisse in der linken Navigationsleiste anzeigt. Für die einfacher Textsuche, wird empfohlen die ersten Textbausteine des Abschnitts ohne Abschneiden von Wörtern oder Buchstaben zu kopieren. Anschließend sind die kopierten Textstellen bei der entsprechenden Antragsstrecke in das Suchfeld bei der Textbearbeitung im OZG Service Management Tool einzufügen, um die Suche durchzuführen. |
...
1.4.1.7. Filterfunktion im OZG Service Management Tool
| Panel | ||||||||
|---|---|---|---|---|---|---|---|---|
| ||||||||
Anleitung: Links neben der Suchfunktion gibt es eine Filterfunktion, mit der ausgewählt werden kann, welche Objekte in der Navigationsleiste angezeigt werden. Hier können entweder alle Textbausteine oder nur benutzerdefinierte Objekte angezeigt werden. Bei der Auswahl „benutzerdefiniert“, werden in der Navigationsleiste nur die bereits bearbeiteten Texte (blau markiert) angezeigt. Dies ermöglicht einen schnellen Überblick über die bereits angepassten Passagen. |
...
1.5. Informationsblatt zur Datenverarbeitung verlinken
- Informationsblatt zur Datenverarbeitung individualisieren und zu Beginn der entsprechenden Antragsstrecke im Online-Dienst verlinken.
| Info |
|---|
Das Informationsblatt zur Datenverarbeitung dient dazu, die Informationspflichten gemäß Art. 13 DSGVO zu erfüllen. Die Vorlage des Informationsblatts und weitere Informationen finden Sie in dem Kapitel “7. Datenschutzpflichten erfüllen”. |
| Panel | ||||||||
|---|---|---|---|---|---|---|---|---|
| ||||||||
Anleitung:
|
...
1.6. Terminmanagementsystem integrieren
| Panel | ||||||||
|---|---|---|---|---|---|---|---|---|
| ||||||||
Anleitung: Über das OZG Service Management Tool können Sie einen Link zu Ihrem Terminmanagementsystem hinterlegen. Im Bereich der Textbearbeitung finden Sie links in der Navigationsleiste unter "variables" das Element "terminplanung_link". Hier können Sie den Link zu dem Terminmanagementsystem Ihrer Behörde hinterlegen und mit “Speichern” bestätigen. Diese Anpassung ist für alle im Dienst verwendeten Sprachen in den jeweiligen Feldern (z.B. en) zu tätigen. Nur wenn Sie den Link an der beschriebenen Stelle im OZG Service Management Tool hinterlegt haben, wird den Antragsstellenden ein Button “Terminplanung” unter der Versandbestätigung im Online-Dienst angezeigt. Über eine Klick auf diesen Button gelangen die Antragsstellenden auf den hinterlegten Link zum Terminmanagementsystem Ihrer Behörde. |
...
1.7. Metriken
| Info |
|---|
Für alle eingesetzten Antragsstrecken Die grafische Darstellung auf der Startseite Ihrer Gebietskörperschaft im OZG Service Management Tool veranschaulicht die Nutzung des Online-Dienstes und zeigt die Anzahl der gestarteten Anträge („start“), erfolgreich gestellten Anträge („success“), abgebrochenen Antragstellungen (“timeout”) sowie der fehlgeschlagenen Übermittlungen von Anträgen (“error”) für alle eingesetzten Antragsstrecken insgesamt. Das Timeout setzt dabei nach 30-minütiger Inaktivität des Nutzenden ein und löscht den aktuellen Bearbeitungsstand. Die hier aufgeführten Metriken beziehen sich lediglich auf die Verarbeitung der Anträge auf dem OZG Service Management. Da die Anträge über weitere Kommunikationsteilnehmende wie z.B. dem landesspezifischen OSCI- Intermediär geroutet werden, können diese Zahlen von der Anzahl der bei der Behörde eingegangenen Anträge abweichen. Ferner werden lediglich die Aufrufe der Dienste gezählt und keine personenbezogene Daten gespeichert. Standardmäßig wird die Darstellung der letzten 30 Tage angezeigt. Rechts oberhalb der Grafik kann die gewünschte Zeitspanne gewählt werden. |
...
| Panel | ||||||||
|---|---|---|---|---|---|---|---|---|
| ||||||||
Hinweis: Weiterführende Informationen finden Sie unter: Leitfaden zur Integration von Online-Diensten aus Brandenburg - Jira Service Management (atlassian.net) |