Änderungen von Dokument Autista

Zuletzt geändert von MACH ProForms GmbH am 02.07.2024

Von 13.1 nach 14.1

Von Version 1.1

bearbeitet von MACH ProForms GmbH
am 08.10.2020

Änderungskommentar: Es gibt keinen Kommentar für diese Version

Auf Version 13.1

bearbeitet von MACH ProForms GmbH
am 17.01.2022

Änderungskommentar: Es gibt keinen Kommentar für diese Version

Rohform
Im Layout

Zusammenfassung

Seiteneigenschaften (1 geändert, 0 hinzugefügt, 0 gelöscht)
Anhänge (0 geändert, 1 hinzugefügt, 0 gelöscht)
- ApiKeyAnlegen_Stammdaten.jpg

Details

Seiteneigenschaften

Inhalt

@@ -1,25 +1,22 @@
--# Auswahl des Inhalts-Schema
++## Auswahl des Inhalts-Schema
++
  Ab der Version 4.33.0 wird die Inhaltsnachricht im xPersonenstandsformat an Autista übergeben.
  Für einen selbstgebauten Assistenten heißt, dies dass je Urkundenart ein Mapping vorgenommen werden muss.
--Damit der Formularserver unabhängig von der Art der Einreichung (siehe unten) weiss welches Mapping-Schema
--bei der Übergabe an Autista verwendet werden soll, benötigt er ein Feld namens mappingSchemaFilter.
++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".
--Über das Feld mappingSchemaFilter wird definiert, welche Mapping-Schema für die Inhaltsnachricht verwendet werden soll.
++Über das Feld "mappingSchemaFilter" wird definiert, welche Mapping-Schema für die Inhaltsnachricht verwendet werden soll.
  Dabei kommen im Verlagsassistent die folgenden Werte zum Einsatz
--//Formatierung noch schauen wegen Aufzählung
--portal2StA.Geburt.081030#@#1.7.4 für Geburtsurkunden
--portal2StA.Ehe.082030#@#1.7.4 für Eheurukunden
--portal2StA.Geburt.081030#@#1.7.4 für Geburtsurkunden
--portal2StA.LP.083030#@#1.7.4 für Lebenspartnerschaftsurkunden
--portal2StA.Sterbefall.084030#@#1.7.4 für Sterbefallurkunden
++- portal2StA.Geburt.081030#@#1.7.5 für Geburtsurkunden
++- portal2StA.Ehe.082030#@#1.7.5 für Eheurkunden
++- portal2StA.LP.083030#@#1.7.5 für Lebenspartnerschaftsurkunden
++- portal2StA.Sterbefall.084030#@#1.7.5 für Sterbefallurkunden
--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.
++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.
--Das Feld mappingSchemaFilter wird aus einer Konfigurationsliste gezogen, welche von uns (Form-Solutions) gepflegt wird!
++Das Feld "mappingSchemaFilter" wird aus einer Konfigurationsliste gezogen, welche von uns (Form-Solutions) gepflegt wird!
  Falls eigenständige Anpassungen an der Liste vorgenommen werden und sich daraus Fehler ergeben, sind die daraus entstehenden Kosten selbst zu tragen!
  Damit die richtigen Daten aus der Konfigurationsliste gezogen werden, benötigen wir von Ihnen folgende Informationen:
  - Mandantennummer
@@ -27,27 +27,27 @@
  - die eingesetzte Versionsnummer von Autista und xPersonenstand
  - Standesamtsnummer
--# Konfiguration der Autista Push-Variante auf Seiten des Form-Solutions Formularservers.
++## Konfiguration der Autista Push-Variante auf Seiten des Form-Solutions Formularservers
  Das Autista Push System steht ab Version 4.22.0 des Formularservers zur Verfügung.
  Bei Verwendung der Push-Variante werden die Inhaltsdaten, beim Einreichen des Assistenten, an einen Webservice verschickt.
  Für einen erfolgreichen Versand ist es notwendig, dass die Inhaltsdaten zunächst in ein XML (nach xSta Standard) gemappt werden.
--Anschließend wird dieses XML als Inhalt einer WebService-Nachricht (nach XTA Standard) an die Autista-Webservice-Schnittstelle des Empfängers verschickt.
++Anschließend wird dieses XML als Inhalt einer Webservice-Nachricht (nach XTA Standard) an die Autista-Webservice-Schnittstelle des Empfängers verschickt.
--Die Dokumentation zur Konfiguration sowie Veröffentlichung des Assistenten finden Sie [hier](https://wiki.form-solutions.de/wiki/docwiki/view/Main/12_Anbindungen/02_Autista)
++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/)
  ___
--# Konfiguration der Autista Pull-Variante auf Seiten des Form-Solutions Formularservers
++## Konfiguration der Autista Pull-Variante auf Seiten des Form-Solutions Formularservers
  Das Autista Pull System steht ab Version 4.22.0 des Formularservers zur Verfügung.
--## 1) Konfiguration des Apache Reverse Proxy
++### 1) Konfiguration des Apache Reverse Proxy
  Der Apache Reverse Proxy muss folgendermaßen konfiguriert werden (siehe vhost-ofs.conf, im Unterverzeichnis customerArea/httpd.conf.d):
--## 1.1) Konfiguration der ProxyPass Einträge
++### 1.1) Konfiguration der ProxyPass Einträge
  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):
@@ -58,90 +58,54 @@
  Der Servername muss durch Ihre konkrete Domain ersetzt werden.
--## 1.2) Konfiguration der Zertifikatsweiterleitung
++### 1.2) Konfiguration der Zertifikatsweiterleitung
  Für die korrekte Weiterleitung von Client Zertifikaten an den Wildfly Applikationsserver müssen die nachfolgenden Einträge hinzugefügt werden:
  Diese Einstellungen sollten im `<IfModule ssl_module>` Block stehen, am besten direkt nach den Server-Zertifikatseinstellungen ("SSLCertificate*File")
  ```
--# pass SSL client certificates to wildfly (required for Autista Webservice)
--SSLVerifyClient optional_no_ca
--
--RequestHeader set SSL_CLIENT_CERT ""
--RequestHeader set SSL_CLIENT_VERIFY ""
--RequestHeader set SSL_CLIENT_S_DN ""
--RequestHeader set SSL_CLIENT_I_DN ""
--RequestHeader set SSL_SERVER_S_DN_OU ""
--RequestHeader set SSL_CLIENT_CERT "%{SSL_CLIENT_CERT}s"
--RequestHeader set SSL_CLIENT_VERIFY "%{SSL_CLIENT_VERIFY}s"
--RequestHeader set SSL_CLIENT_S_DN "%{SSL_CLIENT_S_DN}s"
--RequestHeader set SSL_CLIENT_I_DN "%{SSL_CLIENT_I_DN}s"
--RequestHeader set SSL_SERVER_S_DN_OU "%{SSL_SERVER_S_DN_OU}s"
++## pass SSL client certificates to wildfly (required for Autista Webservice)
++<Location /autista-webservice >
++    SSLVerifyClient optional_no_ca
++
++    RequestHeader set SSL_CLIENT_CERT ""
++    RequestHeader set SSL_CLIENT_VERIFY ""
++    RequestHeader set SSL_CLIENT_S_DN ""
++    RequestHeader set SSL_CLIENT_I_DN ""
++    RequestHeader set SSL_SERVER_S_DN_OU ""
++    RequestHeader set SSL_CLIENT_CERT "%{SSL_CLIENT_CERT}s"
++    RequestHeader set SSL_CLIENT_VERIFY "%{SSL_CLIENT_VERIFY}s"
++    RequestHeader set SSL_CLIENT_S_DN "%{SSL_CLIENT_S_DN}s"
++    RequestHeader set SSL_CLIENT_I_DN "%{SSL_CLIENT_I_DN}s"
++    RequestHeader set SSL_SERVER_S_DN_OU "%{SSL_SERVER_S_DN_OU}s"
++
++    ProxyPass http://wildfly:8080/autista-webservice
++    ProxyPassReverse http://wildfly:8080/autista-webservice
++  </Location>
  ```
--## 2) Konfiguration der Mandanten (Kundenbereich)
++### 2) Konfiguration der Mandanten (Kundenbereich)
--Die folgenden Konfigurationen müssen zum jetzigen Zeitpunkt manuell durch Manipulation auf Datenbankebene vorgenommen werden.
++Die Konfiguration per DB-Eintrag ist mit der im Folgenden beschriebenen Funktionalität obsolet.
--### 2.1) Konfiguration des Client
--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.
++#### 2.1) Konfiguration des Clients
--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.
++Damit die 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. Diese Konfiguration kann unter "Einstellungen/Server-Administration/API-Keys" durch die Verwendung eines API-Keys durchgeführt werden. 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.
--Client Zertifikaten und Remote-IP werden momentan direkt durch manuelle Änderungen an der Datenbank im System hinterlegt.
--Der entsprechende Datenbankname lautet "fsadministrationCenter" und die Collection wird als "apiKey" bezeichnet.
++![[API Key Anlegen|@ApiKeyAnlegen_Stammdaten.jpg]]
--### 2.2) Einrichten mit Client-Zertifikat
++#### 2.2) Einrichten mit Client-Zertifikat
--Ein Eintrag in der apiKey Collection muss die Attribute "certificate" und "certificateSha1Fingerprint" enthalten.
--`certificate` enthält das base64-codiert (.pem) Zertifikat (zu beachten ist, dass Zeilenumbrüche durch `\n` ersetzt werden müssen).
--`certificateSha1Fingerprint` enthält den SHA-1 Fingerabdruck des Zertifikats.
++Es ist möglich ein Zertifikat per Upload-Komponente in der Konfiguration des API-Keys hochzuladen.
--Zum Anlegen eines entsprechenden Eintrages in der apiKey Tabelle muss wie folgt aussehen (der Zertifikat-Eintrag ist gekürzt):
++#### 2.2) Konfiguration des Clients mit Remote-IP
--```
--use fsadministrationCenter
--```
++Sollte es mit der zertifikatsbasierten Abholung Probleme geben, gibt es alternativ noch die Möglichkeit die Abholung via Remote-IP abzusichern. Die Remote-IP kann wie unter dem Punkt 2.1 beschrieben bei einem API-Key hinterlegt werden. Die entsprechende Remote-IP-Adresse können Sie aus dem Access-Log des Formularservers ermitteln.
--```
--db.apiKey.save({
--	"_id" : "CMS_Key...",
--	"_class" : "de.formsolutions.administrationcenter.model.entities.ApiKey",
--	"organizationId" : "22222222-2222",
--	"validUntil" : ISODate("2020-06-14T13:16:27.626Z"),
--	"createdAt" : ISODate("2017-06-14T13:16:27.626Z"),
--	"description" : "Test Key",
--	"certificate" : "-----BEGIN CERTIFICATE-----\nMIIDxzCCAq+gAwIBAgIEGdOgVzANBgkqhkiG9w0BAQsFADCBkzELMAkGA1UEBhMC\n___BEISPIELEINTRAG_GEKÜRZT___\nZ1UA5Z7b0EYYTOY=\n-----END CERTIFICATE-----",
--	"certificateSha1Fingerprint" : "dfa4139224337185428ebf8d7d4eeed93a6f0000"
--});
--```
--### 2.2) Konfiguration dies Clients mit Remote-IP
++#### 2.2) Konfiguration von Standesamtzuweisungen
--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:
--
--```
--use fsadministrationCenter
--```
--
--```
--db.apiKey.save({
--
--	"_id" : "CMS_Key...",
--	"_class" : "de.formsolutions.administrationcenter.model.entities.ApiKey",
--	"organizationId" : "22222222-2222",
--	"validUntil" : ISODate("2020-06-14T13:16:27.626Z"),
--	"createdAt" : ISODate("2017-06-14T13:16:27.626Z"),
--	"description" : "Test Key",
--	"remoteIp" : "<IP-Adresse>"
--});
--```
--
--Die entsprechende Remote-IP-Adresse können Sie aus dem access-Log des Formularservers ermitteln.
--
--### 2.2) Konfiguration von Standesamtzuweisungen
--
  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.
  Diese befindet sich in der Datenbank `administrationCenter` und hier in der Collection `organizationConfiguration`.
  Diese Modulkonfiguration hat ein Attribut `civilRegistryOfficeIds`, welches eine Liste von Standesamtnummern enthält.

ApiKeyAnlegen_Stammdaten.jpg

Author

...	...	@@ -1,0 +1,1 @@
	1	+xwiki:XWiki.Dokumentation

Größe

...	...	@@ -1,0 +1,1 @@
	1	+136.5 KB

Inhalt