Wiki-Quellcode von Autista
Version 4.1 von MACH ProForms GmbH am 26.04.2021
Zeige letzte Bearbeiter
author | version | line-number | content |
---|---|---|---|
1 | ## Auswahl des Inhalts-Schema | ||
2 | |||
3 | Ab der Version 4.33.0 wird die Inhaltsnachricht im xPersonenstandsformat an Autista übergeben. | ||
4 | Für einen selbstgebauten Assistenten heißt, dies dass je Urkundenart ein Mapping vorgenommen werden muss. | ||
5 | |||
6 | Damit der Formularserver unabhängig von der Art der Einreichung (siehe unten) weiß welches Mapping-Schema bei der Übergabe an Autista verwendet werden soll, benötigt er ein Feld namens "mappingSchemaFilter". | ||
7 | |||
8 | Über das Feld "mappingSchemaFilter" wird definiert, welche Mapping-Schema für die Inhaltsnachricht verwendet werden soll. | ||
9 | |||
10 | Dabei kommen im Verlagsassistent die folgenden Werte zum Einsatz | ||
11 | |||
12 | - portal2StA.Geburt.081030#@#1.7.5 für Geburtsurkunden | ||
13 | - portal2StA.Ehe.082030#@#1.7.5 für Eheurkunden | ||
14 | - portal2StA.LP.083030#@#1.7.5 für Lebenspartnerschaftsurkunden | ||
15 | - portal2StA.Sterbefall.084030#@#1.7.5 für Sterbefallurkunden | ||
16 | |||
17 | Sollten Sie die Schema-Dateien unter einem anderen Namen und Version hochgeladen haben, so sind die Werte von oben entsprechend zu ersetzen. Als Trennzeichen zwischen Schema-Namen und Schema-Version ist immer #@# zu verwenden. | ||
18 | |||
19 | Das Feld "mappingSchemaFilter" wird aus einer Konfigurationsliste gezogen, welche von uns (Form-Solutions) gepflegt wird! | ||
20 | Falls eigenständige Anpassungen an der Liste vorgenommen werden und sich daraus Fehler ergeben, sind die daraus entstehenden Kosten selbst zu tragen! | ||
21 | Damit die richtigen Daten aus der Konfigurationsliste gezogen werden, benötigen wir von Ihnen folgende Informationen: | ||
22 | - Mandantennummer | ||
23 | - Mandantenbezeichnung | ||
24 | - die eingesetzte Versionsnummer von Autista und xPersonenstand | ||
25 | - Standesamtsnummer | ||
26 | |||
27 | ## Konfiguration der Autista Push-Variante auf Seiten des Form-Solutions Formularservers | ||
28 | |||
29 | Das Autista Push System steht ab Version 4.22.0 des Formularservers zur Verfügung. | ||
30 | |||
31 | Bei Verwendung der Push-Variante werden die Inhaltsdaten, beim Einreichen des Assistenten, an einen Webservice verschickt. | ||
32 | Für einen erfolgreichen Versand ist es notwendig, dass die Inhaltsdaten zunächst in ein XML (nach xSta Standard) gemappt werden. | ||
33 | Anschließend wird dieses XML als Inhalt einer Webservice-Nachricht (nach XTA Standard) an die Autista-Webservice-Schnittstelle des Empfängers verschickt. | ||
34 | |||
35 | Die Dokumentation zur Konfiguration sowie Veröffentlichung des Assistenten finden Sie [hier](https://wiki.form-solutions.de/wiki/docwiki/view/Main/09_Schnittstellen/01_Fachschnittstellen/02_Autista/) | ||
36 | |||
37 | ___ | ||
38 | |||
39 | ## Konfiguration der Autista Pull-Variante auf Seiten des Form-Solutions Formularservers | ||
40 | |||
41 | Das Autista Pull System steht ab Version 4.22.0 des Formularservers zur Verfügung. | ||
42 | |||
43 | ### 1) Konfiguration des Apache Reverse Proxy | ||
44 | |||
45 | Der Apache Reverse Proxy muss folgendermaßen konfiguriert werden (siehe vhost-ofs.conf, im Unterverzeichnis customerArea/httpd.conf.d): | ||
46 | |||
47 | ### 1.1) Konfiguration der ProxyPass Einträge | ||
48 | |||
49 | Falls die folgenden ProxyPass Einträge nicht vorhanden sind, so müssen diese hinzugefügt werden (falls auf dem System bereits Autista in der Version 1 eingesetzt wurde, so sollte diese Einträge bereits vorhanden sein): | ||
50 | |||
51 | ``` | ||
52 | ProxyPass /autista-webservice http://servername:8080/autista-webservice | ||
53 | ProxyPassReverse /autista-webservice http://servername:8080/autista-webservice | ||
54 | ``` | ||
55 | |||
56 | Der Servername muss durch Ihre konkrete Domain ersetzt werden. | ||
57 | |||
58 | ### 1.2) Konfiguration der Zertifikatsweiterleitung | ||
59 | |||
60 | Für die korrekte Weiterleitung von Client Zertifikaten an den Wildfly Applikationsserver müssen die nachfolgenden Einträge hinzugefügt werden: | ||
61 | Diese Einstellungen sollten im `<IfModule ssl_module>` Block stehen, am besten direkt nach den Server-Zertifikatseinstellungen ("SSLCertificate*File") | ||
62 | |||
63 | ``` | ||
64 | ## pass SSL client certificates to wildfly (required for Autista Webservice) | ||
65 | <Location /autista-webservice > | ||
66 | SSLVerifyClient optional_no_ca | ||
67 | |||
68 | RequestHeader set SSL_CLIENT_CERT "" | ||
69 | RequestHeader set SSL_CLIENT_VERIFY "" | ||
70 | RequestHeader set SSL_CLIENT_S_DN "" | ||
71 | RequestHeader set SSL_CLIENT_I_DN "" | ||
72 | RequestHeader set SSL_SERVER_S_DN_OU "" | ||
73 | RequestHeader set SSL_CLIENT_CERT "%{SSL_CLIENT_CERT}s" | ||
74 | RequestHeader set SSL_CLIENT_VERIFY "%{SSL_CLIENT_VERIFY}s" | ||
75 | RequestHeader set SSL_CLIENT_S_DN "%{SSL_CLIENT_S_DN}s" | ||
76 | RequestHeader set SSL_CLIENT_I_DN "%{SSL_CLIENT_I_DN}s" | ||
77 | RequestHeader set SSL_SERVER_S_DN_OU "%{SSL_SERVER_S_DN_OU}s" | ||
78 | |||
79 | ProxyPass http://wildfly:8080/autista-webservice | ||
80 | ProxyPassReverse http://wildfly:8080/autista-webservice | ||
81 | </Location> | ||
82 | ``` | ||
83 | |||
84 | ### 2) Konfiguration der Mandanten (Kundenbereich) | ||
85 | |||
86 | Die folgenden Konfigurationen müssen zum jetzigen Zeitpunkt manuell durch Manipulation auf Datenbankebene vorgenommen werden. | ||
87 | |||
88 | #### 2.1) Konfiguration des Client | ||
89 | |||
90 | Damit Ausfülldaten über den Autista Webservice abgeholt werden können, muss für jedes abholende Autista System (Autista Backend) das verwendete Client-Zertifikat oder alternativ die Remote-IP je Mandant hinterlegt werden. | ||
91 | |||
92 | Wird ein und dasselbe Client-Zertifikat oder Remote-IP bei mehreren Mandanten hinterlegt, so kann das zugehörige Autista System die Ausfülldaten für all diese Mandanten abholen. | ||
93 | |||
94 | Client Zertifikate und Remote-IP werden momentan direkt durch manuelle Änderungen an der Datenbank im System hinterlegt. | ||
95 | Der entsprechende Datenbankname lautet "fsadministrationCenter" und die Collection wird als "apiKey" bezeichnet. | ||
96 | |||
97 | #### 2.2) Einrichten mit Client-Zertifikat | ||
98 | |||
99 | Ein Eintrag in der apiKey Collection muss die Attribute "certificate" und "certificateSha1Fingerprint" enthalten. | ||
100 | `certificate` enthält das base-64-codiert (.pem) Zertifikat (zu beachten ist, dass Zeilenumbrüche durch `\n` ersetzt werden müssen). | ||
101 | `certificateSha1Fingerprint` enthält den SHA-1 Fingerabdruck des Zertifikats. | ||
102 | |||
103 | Zum Anlegen eines entsprechenden Eintrages in der apiKey Tabelle muss wie folgt aussehen (der Zertifikat-Eintrag ist gekürzt): | ||
104 | |||
105 | ``` | ||
106 | use fsadministrationCenter | ||
107 | ``` | ||
108 | |||
109 | ``` | ||
110 | db.apiKey.save({ | ||
111 | "_id" : "CMS_Key...", | ||
112 | "_class" : "de.formsolutions.administrationcenter.model.entities.ApiKey", | ||
113 | "organizationId" : "22222222-2222", | ||
114 | "validUntil" : ISODate("2020-06-14T13:16:27.626Z"), | ||
115 | "createdAt" : ISODate("2017-06-14T13:16:27.626Z"), | ||
116 | "description" : "Test Key", | ||
117 | "certificate" : "-----BEGIN CERTIFICATE-----\nMIIDxzCCAq+gAwIBAgIEGdOgVzANBgkqhkiG9w0BAQsFADCBkzELMAkGA1UEBhMC\n___BEISPIELEINTRAG_GEKÜRZT___\nZ1UA5Z7b0EYYTOY=\n-----END CERTIFICATE-----", | ||
118 | "certificateSha1Fingerprint" : "dfa4139224337185428ebf8d7d4eeed93a6f0000" | ||
119 | }); | ||
120 | ``` | ||
121 | |||
122 | #### 2.2) Konfiguration des Clients mit Remote-IP | ||
123 | |||
124 | Sollte es mit der zertifikatsbasierten Abholung Probleme geben, gibt es alternativ noch die Möglichkeit die Abholung via Remote-IP abzusichern. Dazu muss der API-Key wie folgt angelegt werden: | ||
125 | |||
126 | ``` | ||
127 | use fsadministrationCenter | ||
128 | ``` | ||
129 | |||
130 | ``` | ||
131 | db.apiKey.save({ | ||
132 | |||
133 | "_id" : "CMS_Key...", | ||
134 | "_class" : "de.formsolutions.administrationcenter.model.entities.ApiKey", | ||
135 | "organizationId" : "22222222-2222", | ||
136 | "validUntil" : ISODate("2020-06-14T13:16:27.626Z"), | ||
137 | "createdAt" : ISODate("2017-06-14T13:16:27.626Z"), | ||
138 | "description" : "Test Key", | ||
139 | "remoteIp" : "<IP-Adresse>" | ||
140 | }); | ||
141 | ``` | ||
142 | |||
143 | Die entsprechende Remote-IP-Adresse können Sie aus dem access-Log des Formularservers ermitteln. | ||
144 | |||
145 | #### 2.2) Konfiguration von Standesamtzuweisungen | ||
146 | |||
147 | Welche Standesämter zu einem Mandanten gehören, wird in der Mandantenkonfiguration hinterlegt. Diese Konfiguration enthält eine Menge von Modulkonfigurationen und eine davon (de.formsolutions.administrationcenter.organization.OrganizationAutistaConfiguration) enthält die Standesamtnummern eines Mandanten. | ||
148 | Diese befindet sich in der Datenbank `administrationCenter` und hier in der Collection `organizationConfiguration`. | ||
149 | Diese Modulkonfiguration hat ein Attribut `civilRegistryOfficeIds`, welches eine Liste von Standesamtnummern enthält. | ||
150 | |||
151 | Ein Beispieleintrag in der Mandantenkonfiguration für den Mandanten "12345678-1234" würde wie folgt aussehen: | ||
152 | |||
153 | ``` | ||
154 | { | ||
155 | "_id" : "12345678-1234", | ||
156 | "_class" : "de.formsolutions.administrationcenter.organization.OrganizationConfiguration", | ||
157 | "moduleConfigurations" : [ | ||
158 | ... GEKÜRZTER_EINTRAG ... | ||
159 | { | ||
160 | "civilRegistryOfficeIds" : [ | ||
161 | "05362020" | ||
162 | ], | ||
163 | "_class" : "de.formsolutions.administrationcenter.organization.OrganizationAutistaConfiguration" | ||
164 | } | ||
165 | |||
166 | ] | ||
167 | } | ||
168 | ``` | ||
169 | |||
170 | Beispiele für das Anlegen der Struktur | ||
171 | |||
172 | ``` | ||
173 | use administrationCenter | ||
174 | ``` | ||
175 | |||
176 | Sofern für den Mandanten bereits eine Modulkonfiguration wie z.B. Payment vorliegt können Sie den Eintrag wie folgt hinzufügen: | ||
177 | |||
178 | ``` | ||
179 | db.organizationConfiguration.update({"_id" : "organizationid"}, {$push: {"moduleConfigurations" : {"civilRegistryOfficeIds" : ["standesamtsnummer"], "_class" : "de.formsolutions.administrationcenter.organization.OrganizationAutistaConfiguration"}}}) | ||
180 | ``` | ||
181 | |||
182 | Sollte noch keine Modulkonfiguration für den Mandanten vorhanden sein, bitte wie folgt vorgehen: | ||
183 | |||
184 | ``` | ||
185 | db.organizationConfiguration.insert({ | ||
186 | "_id" : "organiazationID", | ||
187 | "_class" : "de.formsolutions.administrationcenter.organization.OrganizationConfiguration", | ||
188 | "moduleConfigurations" : [ | ||
189 | { | ||
190 | "civilRegistryOfficeIds" : [ | ||
191 | "standesamtsnummer" | ||
192 | ], | ||
193 | "_class" : "de.formsolutions.administrationcenter.organization.OrganizationAutistaConfiguration" | ||
194 | } | ||
195 | |||
196 | ] | ||
197 | }) | ||
198 | ``` | ||
199 | |||
200 | In beiden Fällen sind die Werte für `_id` und `civilRegistryOfficeIds`durch die entsprechenden Werte Kundennummer und Standesamtsnummer zu ersetzen. |