Zeige letzte Bearbeiter
1 [[**Plugin-Download**>>url:https://customer.formcycle.eu/index.php/apps/files/?dir=/FORMCYCLE%20-%20Plugins%20Customer/ELSTER%20(fc-plugin-bundle-elster-authenticator)&fileid=25551||rel="noopener noreferrer" target="_blank"]] (erfordert Anmeldung)
2
3 Min. {{formcycle/}}-Version: {{version major="6" minor="6" patch="11"}}{{/version}}. Für Verwendung der Postkorb-Funktionalität ist min. {{formcycle/}}-Version {{version major="7" minor="0" patch="0"/}} & Pluginversion {{version major="2" minor="1" patch="0"/}} nötig.
4
5 {{content/}}
6
7
8 {{figure image="form_cntr_template_de.PNG"}}
9 Formularelementvorlage //ELSTER Accountdaten// für einen Nutzer mit persönlichem Zertifikat.
10 {{/figure}}
11
12 Über das kostenpflichtige //ELSTER Service Plugin// ist es möglich authentifizierte ELSTER-Accountdaten in Formularen zu erfassen. Dies geschieht indem dem Formular ein ELSTER-Login vorgeschaltet wird. Um den ELSTER-Login zu ermöglichen, muss der {{formcycle/}}-Server vorerst bei ELSTER registriert werden. Details hierzu finden Sie im Abschnitt Setup.
13
14 == Setup ==
15
16 Das Plugin kann nur als Mandantplugin installiert werden. Eine Anleitung zur Installation von Plugins finden Sie [[hier>>doc:Formcycle.UserInterface.Client.Plugins.WebHome]]. Nach Installation des Plugins gibt es einen neuen Menüeintrag //ELSTER-Konfiguration// in der Verwaltungsoberfläche. Sollten Sie diesen Menüeintrag nicht sehen, stellen Sie sicher, dass der angemeldete Benutzer die Rollenberechtigung "Externe Benutzer" sowie "ELSTER-Konfiguration" besitzt. Über die ELSTER-Konfigurationsseite kann nun ein neuer ELSTER-Login erstellt werden und der sog. Entity-Descriptor für diesen Login erstellt werden. Diese Schritte sind notwendig um den ELSTER-Login bei ELSTER zu registrieren.
17
18 === ELSTER-Login erstellen ===
19
20 Mit einem Klick auf //ELSTER-Login erstellen// in der Konfigurationsoberfläche kann ein neuer ELSTER-Login erstellt werden. Hierzu sind nun folgende Informationen nötig:
21
22 ==== Allgemeine Informationen ====
23
24 ; Name
25 : Wie soll der ELSTER-Login heißen? Dieser Name wird für den Anmeldebutton im Formular verwendet. (Soll ein alternativer Name verwendet werden, kann dies am ELSTER-Login nach der Erstellung konfiguriert werden)
26 ; Beschreibung
27 : Eine optionale Beschreibung
28
29 ==== Zertifikatsinformationen ====
30
31 Für die Kommunikation mit der ELSTER-Schnittstelle sind Zertifikate für die Verschlüsselung & Signierung der Nachrichten nötig. Sie haben die Möglichkeit bei der Erstellung des ELSTER-Logins einen Zertifikatsspeicher automatisch erstellen zu lassen oder einen Zertifikatsspeicher (einen sog. KeyStore) hochzuladen. Für die automatische Generierung des Zertifikatsspeichers sind folgende Angaben nötig:
32
33 ; Allgemeiner Name (CN)
34 : Der sog. Common name des Zertifikats. Z.B.: ELSTER-Login
35 ; Organisationseinheit (OU)
36 : Bezeichnung der Abteilung, z.B. IT-Abteilung
37 ; Organisationsname (O)
38 : Name des Unternehmens bzw. der Behörde
39 ; Ortsbezeichnung (L)
40 : Stadt oder Ort, in dem das Unternehmen bzw. die Behörde ansässig ist
41 ; Bundesland (ST)
42 : Bundesland, in dem das Unternehmen bzw. die Behörde ansässig ist
43 ; Land (C)
44 : Der aus zwei Buchstaben bestehende Ländercode im ISO-Format desjenigen Landes, in dem das Unternehmen bzw. die Behörde rechtmäßig registriert ist z.B. DE
45
46 Mit diesen Informationen wird bei der Erstellung des ELSTER-Logins ein Zertifikatsspeicher für die Signierung & Verschlüsselung erstellt. Möchten Sie einen eigenen Zertifikatsspeicher verwenden, ist darauf zu achten, dass das darin enthaltene Zertifikat eine Schlüssellönge von 4096 Bit hat und den Algorithmus RSA (SHA-256) verwendet.
47
48 === Entity-Descriptor erstellen ===
49
50 Nachdem der ELSTER-Login erstellt wurde, kann für diesen der Entity-Descriptor erstellt werden. Der Entity-Descriptor enthält Metadaten zum {{formcycle/}}-Server und das Schlüsselmaterial für die Signierung & Verschlüsselung der Kommunikation. Diesen Entity-Descriptor müssen Sie an ELSTER senden, damit der {{formcycle/}}-Server für die Authentifizierungen registriert werden kann.
51 Werden Frontend-Server verwendet, dann muss für jeden Frontend-Server, für den der ELSTER-Login zur Verfügung stehen soll, ein Entity-Descriptor erstellt und bei ELSTER registriert werden.
52
53 {{id name="sec_form_access"/}}
54
55 == Einbindung des ELSTER-Logins in Formularen ==
56
57 Um den ELSTER-Login in Formularen zu aktivieren, muss dieser über die Zugriffseinstellungen des Formulars aktiviert werden. Nachdem dies geschehen ist, werden Nutzer nun beim Aufruf des Formulars nun aufgefordert sich bei ELSTER anzumelden.
58 Zur Darstellung der ELSTER-Accountdaten gibt es eine Formularvorlage im Designer, welche in das Formular gezogen werden kann. Diese Formularvorlage enthält Datenfelder für perönliche sowie Organisationsaccounts. Je nachdem, welcher Nutzer sich angemeldet hat, wird das passende Fieldset dargestellt. Die Formularfelder können nach der Nutzerauthentifizierung nicht mehr geändert werden und haben festgelegte Namen:
59
60 {{table dataTypeAlpha="0" preSort="0-asc"}}
61 |=Formularfeldname|=Bemerkung|=optional|=für Zertifikatstyp
62 |tfDatenkranzTyp|StNr (bei einem Organisationszertifikat) oder IdNr (bei einem persönlichen Zertifikat)|nein|beide
63 |tfPersTyp|NATPERS (Der Inhaber des Steuerkontos ist eine natürliche Person - z.B. ein Einzelunternehmer) oder NNATPERS (nichtnatürliche Person - z.B. eine GmbH)|nein|Organisationszeitifikat
64 |tfTrustLevelIdentifizierung|"SUBSTANZIELL" für alle, die per Brief oder persönlich Identifiziert wurden. "HOCH" für die mit nPA|nein|beide
65 |tfTrustLevelAuthentifizierung|"SUBSTANZIELL" für alle|nein|beide
66 |tfAccountPseudonymId|Pseudonymisierte ELSTERAccountID. Pro ELSTERZertifikat eine eigene ID, auch wenn die ELSTER Zertifikate zu ein und derselben Organisation gehören.|nein|beide
67 |tfDatenuebermittlerPseudonymId|für den jeweiligen ServiceProvider pseudonymisierte ID der Organisation, der der Account angehört|nein|Organisationszeitifikat
68 |tfAntragstellerAdressTyp|INLAND oder AUSLAND|nein|persönliches Zertifikat
69 |tfAntragstellerStrasse|Inland 5-stellig|nein|persönliches Zertifikat
70 |tfAntragstellerHausnummer|Werte 0-9999, mit Zusatz|nein|persönliches Zertifikat
71 |tfAntragstellerPLZ||nein (bei INLAND) ja (bei AUSLAND)|persönliches Zertifikat
72 |tfAntragstellerOrt||ja|persönliches Zertifikat
73 |tfAntragstellerOrtsteil||ja|persönliches Zertifikat
74 |tfAntragstellerErgaenzung|Nicht gesetzt bei Auskunftssperre|ja|persönliches Zertifikat
75 |tfAntragstellerLand|ALPHA-2 Länderkürzel nach ISO 3166-1. DE bei Inlandsadressen. Nicht gesetzt bei Auskunftssperre|nein|persönliches Zertifikat
76 |tfAntragstellerVorname||nein|persönliches Zertifikat
77 |tfAntragstellerName||nein|persönliches Zertifikat
78 |tfAntragstellerGeburtsdatum||nein|persönliches Zertifikat
79 |tfAntragstellerGeburtsname||ja|persönliches Zertifikat
80 |tfAntragstellerGeburtsort||ja|persönliches Zertifikat
81 |tfAntragstellerGeburtsland||ja|persönliches Zertifikat
82 |tfAntragstellerAkademischerGrad||ja|persönliches Zertifikat
83 |tfOrgAdressTyp||nein|Organisationszertifikat
84 |tfOrgStrasse|Inland 5-stellig|nein|Organisationszeitifikat
85 |tfOrgHausnummer|Werte 0-9999, mit Zusatz|nein|Organisationszeitifikat
86 |tfOrgPLZ||nein (bei INLAND) ja (bei AUSLAND)|Organisationszeitifikat
87 |tfOrgOrt||ja|Organisationszeitifikat
88 |tfOrgOrtsteil||ja|Organisationszeitifikat
89 |tfOrgErgaenzung|Nicht gesetzt bei Auskunftssperre|ja|Organisationszeitifikat
90 |tfOrgLand|ALPHA-2 Länderkürzel nach ISO 3166-1. DE bei Inlandsadressen. Nicht gesetzt bei Auskunftssperre|nein|Organisationszeitifikat
91 |tfOrgFirmenname|Der Name der Organisation. Bei NatPers kann dies auch der konkatenierte Vor- und Nachname des Steuerkontoinhabers sein.|nein|Organisationszeitifikat
92 |tfOrgRechtsformText|Für PersTyp NNATPERS|nein|Organisationszertifikat
93 |tfOrgRechtsform|Für PersTyp NNATPERS|nein|Organisationszertifikat
94 |tfOrgTaetigkeitText|Für PersTyp NATPERS|nein|Organisationszertifikat
95 |tfOrgTaetigkeit|Für PersTyp NATPERS|nein|Organisationszertifikat
96 |tfOrgRegisternummer||ja|Organisationszeitifikat
97 |tfOrgRegisterart||ja|Organisationszeitifikat
98 |tfOrgRegistergericht||ja|Organisationszeitifikat
99 |tfOrgGruendungsDatum||ja|Organisationszeitifikat
100 |tfOrgBetriebsbeendigungsdatum||ja|Organisationszeitifikat
101 |tfOrgUStId||ja|Organisationszeitifikat
102 {{/table}}
103
104 === Protokollierung ===
105
106 Für jedes abgesendete Formular, an welchem sich per ELSTER authentifiziert wurde, wird ein Protokolleintrag am Vorgang erstellt. Diese beinhaltet die AccountPseudonym-ID (sowie die DatenübermittlerPseudonym-ID), die ID der SAML-Response, die IssueInstant der SAML-Response und die InResponseTo-ID der SAML-Response.
107
108 Optional kann für jede ELSTER-Anmeldung (ohne Formularabsendung) eine solche Protkollierung aktiviert werden (siehe Konfiguration des Plugins). Dies ist standardmäßig deaktiviert.
109
110 == ELSTER-Postkorb {{version major="2" minor="1" patch="0"/}} ==
111
112 Mit Version //2.1.0// des Plugins ist es möglich Nachrichten an den ELSTER-Postkorb von authentifizierten Nutzern zu senden. Hierfür steht eine neue [[Aktion>>doc:Formcycle.Designer.Workflow.Actions.WebHome]] mit dem Namen //ELSTER Postkorbnachricht// zur Verfügung, welche in den [[Workflow>>doc:Formcycle.Designer.Workflow.WebHome]] integriert werden kann. Derzeit ist es somit möglich PDFs an die Nutzer/Antragsteller zu senden. Der Status einer versendeten Nachricht kann mit der Aktion //ELSTER Postkorbnachricht Status// abgerufen werden.
113
114 === Voraussetzung ===
115
116 Um Nachrichten an den ELSTER-Postkorb von Nutzern/Antragstellern zu senden ist es nötig, dass diese sich an dem Formular authentifizieren. Nachrichten können nur an diese Nutzer gesendet werden. Um den ELSTER-Login in Formularen zu ermöglichen siehe Abschnitt [[Einbindung des ELSTER-Logins in Formularen>>||anchor="sec_form_access"]].
117
118 === Aktion: ELSTER Postkorbnachricht ===
119
120 Mit dieser Aktion können Nachrichten an den ELSTER-Postkorb von authentifizierten Nutzern/Antragstellern gesendet werden. Der Inhalt der Nachricht kann derzeit nur ein PDF sein. Der Empfänger der Nachricht wird über den Status identifiziert, in dem sich der Nutzer/Antragsteller am Formular authentifiziert hat. Die Aktion gibt die ELSTER-Transfer-ID der veresendeten Nachricht im Ergebnis zurück. Diese kann in der Aktion //ELSTER Postkorbnachricht Status// verwendet werden. Folgende Parameter sind für die Konfiguration nötig bzw. optional:
121
122 ; Datenart (Pflicht)
123 : Angabe der Art des Dokuments. Mögliche Werte sind //EPMitteilung//, //EPBescheid// & Gewerbesteuermitteilung//.//
124
125 ; Absender (Pflicht)
126 : Der Absender der Nachricht, z.B. Stadt XYZ.
127
128 ; Betreff (Pflicht)
129 : Bezeichnung der Nachricht.
130
131 ; E-Mail-Adresse (Pflicht bei EPBescheiden)
132 : Notwendig beim Versand von rechtsverbindlichen Bescheiden. Dies ist die E-Mail-Adresse des Empfängers und soltle bei Bescheiden entsprechend im Formular erfasst werden.
133
134 ; Geschätszeichen (Optional)
135 : Für die Zuordnung des Falles zu einem Geschäftsvorgang kann das Geschäftszeichen angegeben werden.
136
137 ; Lieferticket (Optional)
138 : Eindeutige Kennung, um mit diesem Antwort-(Dokument) einen Bezug zu einem vorhergehenden Antrag herzustellen.
139
140 ; Datei (Pflicht)
141 : Nachrichteninhalt in Form einer PDF-Datei.
142
143 ; Empfänger hat sich in diesem Status per ELSTER authentifiziert (Optional)
144 : Durch Angabe des Status wird der Empfänger der Postkorbnachricht bestimmt. Standarmäßig wird die Nachricht an die Person gesendet, die sich beim initialen Aufruf des Formulars per ELSTER authentifiziert hat. Hat sich keine Person zum angegebenen Status per ELSTER authentifiziert, wird diese Aktion fehlschlagen, da der Empfänger nicht ermittelt werden kann. Wird kein Status angegeben, dann wird die Nachricht an den Nutzer gesendet, welcher sich initial am Formular authentifiziert hat.
145
146 ; Testmerker (Optional)
147 : Wenn angegeben, wird die Nachricht als Testnachricht markiert. Mögliche Werte sind 700000001 oder 700000004.
148
149 === Aktion: ELSTER Postkorbnachricht Status ===
150
151 Mit dieser Aktion kann der Status einer bereits mit der Aktion //ELSTER Postkorbnachricht// versendeten Nachricht abgerufen werden. Für diese Aktion ist lediglich die //ELSTER-Transfer-ID// nötig. Diese wird im Ergebnis der Aktion //ELSTER Postkorbnachricht// zurückgegeben und kann im Formular gespeichert werden. Der Status der Nachricht kann folgende Werte haben:
152
153 |=Status|=Beschreibung
154 |IN_BEARBEITUNG|Die Nachricht wird an ELSTER zum Versand an das Postfach übergeben.
155 |UEBERTRAGUNGSFEHLER|Bei der Übertragung an ELSTER ist ein technischer Fehler aufgetreten. In diesem Fall sollte der Versand nochmals versucht werden. Bei wiederholten Fehlern sollte das Anwendungslog kontrolliert werden.
156 |VERSENDET|Die Nachricht wurde erfolgreich an ELSTER übergeben.
157 |EINGESTELLT|Die Nachricht ist im ELSTER-Postfach angekommen, die Benachrichtigung an den Empfänger wurde jedoch noch nicht zugestellt.
158 |DATEN_FEHLERHAFT|Die Daten konnten auf Grund eines Fehlers (z.B. Virenfund) nicht an den Empfänger bereitgestellt werden. In diesem Fall sollte der Bescheid neu aufgebaut und versandt werden.
159 |BEREIT_ZUR_ABHOLUNG|Die Nachricht wurde an den Empfänger bereitgestellt.
160 |VOM_EMPFAENGER_ABGEHOLT|Die Nachricht wurde vom Empfänger abgeholt.
161 |EINGANG_BESTAETIGT|Der Empfänger hat die Abholung bestätigt.
162 |GELOESCHT|Die Nachricht wurde aus dem Postfach gelöscht.
163 |INTERNAL_ERROR|Es kam zu einem internen Fehler.
164 |UNBEKANNT|Die Nachricht konnte nicht im System gefunden werden.
165
166 == Konfiguration des Plugins ==
167
168 In den Plugineinstellungen können Parameter zu Konfiguration angegeben werden:
169
170 {{table dataTypeAlpha="0" preSort="0-asc"}}
171 |=Parameter|=Bemerkung|Standardwert
172 |elster.bundle.param.supported.issuer.ids|Semikolon-separierte Liste der unterstützten Issuer-IDs|[[https://idp.een.elster.de>>https://idp.een.elster.de]];[[https://www.elster.de>>https://www.elster.de]]
173 |elster.bundle.param.protocol.preserve|Ob die angelegten Protokolleinträge löschbar (false) oder nicht löschbar (true) sein sollen|true
174 |elster.bundle.param.protocol.login.callbacks|Gibt an ob für jede Anmeldung bei ELSTER ein Mandantprotokolleintrag erstellt werden soll|false
175 |elster.bundle.param.elster.transfer.client.url|URL zur ELSTER-Transfer-Anwendung. Ist nötig um Nachrichten an den ELSTER-Postkorb zu versenden.|---
176 |elster.bundle.param.inbox.message.test.mode|Gibt an ob Postkorbnachrichten im Testmodus versendet werden. Im Testmodus kann eine konkrete ELSTER-Account-ID angegeben werden, an welche die Postkorbnachricht versendet werden soll.|false
177 {{/table}}
178
179 == Versionshistorie ==
180
181 === 2.1.1 ===
182
183 * Auswahl des Empfänger-Status in der Aktion ELSTER-Postkorbnachricht lässt auch keinen Status zu.
184 * Behebung kleinerer Oberflächenfehler.
185
186 === 2.1.0 ===
187
188 * Neue Workflow-Aktion zum Versenden von Nachrichten an den ELSTER-Postkorb.
189 * Der ELSTER-Login kann auch für Status des neuen Workflow konfiguriert werden.
190
191 === 2.0.1 ===
192
193 * Fehlerbehebung bei der Erstellung/Aktualisierung der Formularvorlage für die ELSTER-Accountdaten in mehreren Mandanten.
194
195 === 2.0.0 {{version major="7" minor="0" patch="0"}}{{/version}} ===
196
197 * Anpassung des Plugins an {{formcycle/}}-Version //7.0.0//
198 * Das Plugin kann nicht im Systemscope installiert werden.
199
200 === 1.0.3 ===
201
202 * Fehlerbehebung bei der Erstellung/Aktualisierung der Formularvorlage für die ELSTER-Accountdaten.
203
204 === 1.0.2 ===
205
206 * Erste öffentliche Version des Plugins. Beinhaltet:
207 ** neue Konfigurationsoberfläche zum Anlegen eines ELSTER-Logins und Erstellung des Entity-Descriptors.
208 ** Formularelementvorlage mit sämtlichen vorbefüllten persönlichen bzw. organisationsbezogenen Formularelementen.
209 * Protokollierung eines ELSTER-Logins nach Absenden eines Formulars.