Zum Inhalt springen

Wiki-Quellcode von Autista

Version 1.1 von MACH ProForms GmbH am 10.03.2020
Zeige letzte Bearbeiter
1 # Allgemeines
2
3 ## Voraussetzungen
4
5 - Ein Payment ist bereits eingerichtet am Mandanten.
6 - PDF und Assistentenrecht sind beim Mandanten vorhanden.
7
8 ## Relevante Daten
9
10 Folgende technischen Bereiche bei einer funktionsfähigen Schnittstellennutzung vom Assistenten mit der Übergabe zu Autista sind notwendig:
11
12 - Paymentanbindung (wäre sinnvoll)
13 - Standesamtsnummer
14 - Gebühreninformationen
15 - Aussage ob push oder pull genutzt wird
16  - push:
17 - URL zum XSTA-Server
18 - Betreuer vom XSTA-Server zum Austausch der Zertifikate
19 - das öffentliche Zertifikat vom xsta-Server muss im Java-Truststore einggespielt werden
20
21 - pull:
22 - Zertifikate oder IP-Adresse die vom Verlagsserver ankommt
23 - Betreibendes Rechenzentrum von Autista, da wir ggf. unsere Abhol-URL mitteilen müssen
24 ___
25
26
27 # Konfiguration der Autista Push-Variante auf Seiten des Form-Solutions Formularservers.
28
29 Bei Verwendung der Push-Variante werden die Inhaltsdaten, beim Einreichen des Assistenten, an einen Webservice verschickt.
30 Für einen erfolgreichen Versand ist es notwendig, dass die Inhaltsdaten zunächst in ein XML (nach xSta Standard) gemappt werden.
31 Anschließend wird dieses XML als Inhalt einer WebService-Nachricht (nach XTA Standard) an die Autista-Webservice-Schnittstelle des Empfängers verschickt.
32
33 ## 1) Konfiguration der Webservices
34
35 ### 1.1) Webservice
36
37 Die „[[Erweiterte Modulkonfiguration|Main.07_Einstellungen-Fachadministration.03_Module.06_Webservice]]“ bietet unter den Menüpunkten „Web Services“ und „WebService-Konfiguration“ die Möglichkeit einen Webservice zu konfigurieren, welcher anschließend bei der Einreichung von Formulardaten genutzt werden kann.
38
39 #### 1.1.1) Auswahl der WebService-Definition
40
41 Für die Konfiguration eines Autista XTA Webservices wird zunächst passende WebService-Definition benötigt. Der Verlag Form-Solutions stellt für alle Mandanten bereits die WebService-Definition „XTA XÖV“ bereit.
42 Im Menüpunkt „WebService-Konfiguration“ müssen die folgenden WebService-Definition-Einstellungen gewählt werden:
43
44 | Feld | Wert |
45 |--------|--------|--------|
46 |WebService-Name:| XTA XÖV|
47 |WebService-OrganisationsID:|22222222-2222|
48 |WebService-Version:|1.1.1|
49
50
51 #### 1.1.2) Konfiguration der Webservice URL
52
53 Anschließend muss die URL des Webservices in das Feld `WebService-Url` eingetragen werden.
54
55 #### 1.1.3) Konfiguration der Authentifizierung
56
57 Der Formularserver muss sich gegenüber dem empfangenden Autista System mit einem Zertifikat authentifizieren.
58 Es ist daher notwendig im Bereich „Werte für Zertifikatsauthentifizierung“ einen Java KeyStore (.jks) hochzuladen und das entsprechende Passwort zu hinterlegen.
59
60 Die folgenden Daten müssen im KeyStore hinterlegt werden:
61
62 1. Schlüsselpaar für die Client-Authentifizierung:<br />
63 Dieser Datensatz besteht aus einem öffentlichen Zertifikat und dem dazu passenden privaten Schlüssel. Hierbei handelt es sich um den KeyStore des Senders. Das öffentliche Zertifikat muss im TrustStore des empfangenden Servers hinterlegt sein.
64 <br />
65
66 2. Öffentliches Zertifikat des Servers vom empfangenden Autista System:<br />
67 Dieses Zertifikat teilt dem Formularserver mit, dass eine Verbindung mit dem Autista System erlaubt ist (TrustStore des Senders).
68
69 ### 1.2) WebService-Aktion und des WebService-SOAP-Header
70
71 Weiterhin müssen im Bereich „WebService-Konfiguration“ folgendes konfiguriert werden.
72
73 #### 1.2.1) Konfiguration der WebService-Aktion für das Mapping der Inhaltsdaten (nach xSta Standard)
74
75 Im Unterpunkt „WebService-Aktionen“ muss die Funktion "Bearbeiten" aufgerufen werden. Anschließend muss eine WebService-Aktion mit den folgenden Werten hinzugefügt werden:
76
77 | Feld | Wert |
78 |--------|--------|--------|
79 |Aktionsname des WebServices:| Send Message|
80 |Parametername:|{http://www.xoevta.de/xta/xtaws110}SendMessage.{http://www.xoevta.de/xta/xtaws110}Nachricht*|
81 |Wert des Parameters mappen:|Ja|
82 |Kundennummer des Mandanten, welcher das XML-Schema bereitstellt:|22222222-2222|
83 |XML-Schema:|Autista|
84 |XML-Schema-Version:| 2|
85
86 Ab der Version 4.33.0 muss der obere Eintrag entfernt werden und durch die folgenden 4 Werte ersetzt werden:
87
88 | Feld | Wert |
89 |--------|--------|--------|
90 |Aktionsname des WebServices:| Send Message|
91 |Parametername:|{http://www.xoevta.de/xta/xtaws110}SendMessage.{http://www.xoevta.de/xta/xtaws110}Nachricht*|
92 |Wert des Parameters mappen:|Ja|
93 |Kundennummer des Mandanten, welcher das XML-Schema bereitstellt:|22222222-2222|
94 |XML-Schema:|portal2StA.Geburt.081030|
95 |XML-Schema-Version:| 1.7.4|
96
97 | Feld | Wert |
98 |--------|--------|--------|
99 |Aktionsname des WebServices:| Send Message|
100 |Parametername:|{http://www.xoevta.de/xta/xtaws110}SendMessage.{http://www.xoevta.de/xta/xtaws110}Nachricht*|
101 |Wert des Parameters mappen:|Ja|
102 |Kundennummer des Mandanten, welcher das XML-Schema bereitstellt:|22222222-2222|
103 |XML-Schema:|portal2StA.Ehe.082030|
104 |XML-Schema-Version:| 1.7.4|
105 |Aktionsname des WebServices:| Send Message|
106 |Parametername:|{http://www.xoevta.de/xta/xtaws110}SendMessage.{http://www.xoevta.de/xta/xtaws110}Nachricht*|
107 |Wert des Parameters mappen:|Ja|
108 |Kundennummer des Mandanten, welcher das XML-Schema bereitstellt:|22222222-2222|
109 |XML-Schema:|portal2StA.LP.083030|
110 |XML-Schema-Version:| 1.7.4|
111 |Aktionsname des WebServices:| Send Message|
112 |Parametername:|{http://www.xoevta.de/xta/xtaws110}SendMessage.{http://www.xoevta.de/xta/xtaws110}Nachricht*|
113 |Wert des Parameters mappen:|Ja|
114 |Kundennummer des Mandanten, welcher das XML-Schema bereitstellt:|22222222-2222|
115 |XML-Schema:|portal2StA.Sterbefall.084030|
116 |XML-Schema-Version:| 1.7.4|
117
118 Nach dem Hinzufügen kann mit dem Button „Zurück“ wieder in die WebService-Konfiguration gewechselt werden.
119
120 #### 1.2.2) Konfiguration des WebService-SOAP-Headers
121
122 Im Unterpunkt „WebService SOAP-Header“ muss die Funktion „Bearbeiten“ aufgerufen werden. Anschließend muss ein WebService-SOAP-Header mit den folgenden Werten hinzugefügt werden:
123
124 | Feld | Wert |
125 |--------|--------|--------|
126 |Aktionsname des WebServices:| Send Message|
127 |Header aus einem Assistentenfeld beziehen:|Ja|
128 |Assistentenfeld des Headerwertes:|VerstecktesPanel.VF_SoapHeader|
129
130 ## 2) Veröffentlichung des Assistenten
131
132 ### 2.1) Konfiguration der Webservice Anfrage während der Einreichung
133
134 #### 2.1.1) Auswahl des Webservices
135
136 In der [[Veröffentlichungsmaske|Main.05_Assistenten.02_VeröffentlichungvonAssistenten]] des Assistenten (AS_050033) muss zum einen die Option „Senden mit Webservice“ und die URL https://localhost:1234 sowie die Option „WebService-Anfrage während Einreichung“ auf den Wert „Ja“ gesetzt werden.
137 Anschließend steht in diesem Bereich eine Konfigurationsoption zur Verfügung. Ein Klick auf „Konfiguration“ öffnet den entsprechenden Konfigurationsdialog „Auswahl eines Webservice-Dienstes“, hier muss der unter Punkt 1 konfigurierte Webservice gewählt werden.
138
139 | Feld | Wert |
140 |--------|--------|--------|
141 |Name des WebService:|XTA XÖV|
142 |Version des WebService:|1.1.1|
143 |Webservice Dienst: |SendMessage|
144
145 #### 2.1.2) Mapping der Anfrage (falls notwendig)
146
147 Diese Konfiguration ist nur auf Verlagsseite notwendig, alle Mandanten, welche den Verlagsassistenten nutze, benötigen hier keine weiteren Anpassungen.
148
149 Im Dialog „Auswahl eines Webservice-Dienstes“ kann ein Mapping für die Webservice Nachricht definiert werden.
150 Ein Klick auf den Button „Webservice-Nachricht“ öffnet die entsprechende Fieldmapping Konfigurationsansicht. Hier muss als Zielsystem die folgendes ausgewählt werden:
151
152 `XTA XÖV-1.1.1-SendMessage`
153
154 Anschließend muss ein Mapping für die folgenden Felder definiert werden:
155
156 `VerstecktesPanel.VF_standesamt1` --> `SendMessage.EmpfaengerKennung*`
157
158 `VerstecktesPanel.VF_uuid1` --> `SendMessage.MessageId*`
159
160 #### 2.2) Konfiguration des Freigabelinks
161
162 Nachdem der Urkundenbestellassistent (AS_050033) freigegeben und ein Veröffentlichungslink generiert wurde, muss dem Veröffentlichungslink der folgende Parameter hinzugefügt werden:
163
164 ```
165 ?san=<STANDESAMTNUMMER>
166 ```
167
168 Wobei die Angabe `<STANDESAMTNUMMER>` durch die Tatsächliche (8 Stellige) Standesamtnummer ersetzt werden muss.
169 Nur auf diese Weise ist es möglich die eingereichten Inhaltsdaten der Bürger einem bestimmten Standesamt zuzuordnen und eine erfolgreiche Einreichung zu gewährleisten.
170
171
172 Beispiel Ursprünglicher Veröffentlichungslink:
173
174 https://ofs.form-solutions.de:443/metaform/Form-Solutions/sid/assistant/5aa3e36daffffffff
175
176 Beispiel Finaler Veröffentlichungslink:
177
178 https://ofs.form-solutions.de:443/metaform/Form-Solutions/sid/assistant/5aa3e36daffffffff?san=12345678
179 ___
180
181 # Konfiguration der Autista Pull-Variante auf Seiten des Form-Solutions Formularservers
182
183 ## 1) Konfiguration des Autista-Assistenten
184
185 In der [[erweiterten Modulkonfiguration|Main.07_Einstellungen-Fachadministration.03_Module.12_Autista]] (Autistakonfiguration) muss der Urkundenbestellassistent (AS_050033) hinterlegt werden, diese Einstellung ist Mandantenübergreifend und wird in der Regel vom Serveradmin vorgenommen.
186
187 ## 2) Veröffentlichung des Assistenten
188
189 Nachdem der Urkundenbestellassistent (AS_050033) freigegeben und ein [[Veröffentlichungslink|Main.05_Assistenten.02_VeröffentlichungvonAssistenten]] generiert wurde, muss dem Veröffentlichungslink der folgende Parameter hinzugefügt werden:
190
191 ```
192 ?san=<STANDESAMTNUMMER>
193 ```
194
195 Wobei die Angabe `<STANDESAMTNUMMER>` durch die Tatsächliche (8 Stellige) Standesamtnummer ersetzt werden muss.
196 Nur auf diese Weise ist es möglich die eingereichten Inhaltsdaten der Bürger einem bestimmten Standesamt zuzuordnen und eine erfolgreiche Einreichung zu gewährleisten.
197
198
199 Beispiel Ursprünglicher Veröffentlichungslink:
200
201 https://ofs.form-solutions.de:443/metaform/Form-Solutions/sid/assistant/5aa3e36daffffffff
202
203 Beispiel Finaler Veröffentlichungslink:
204
205 https://ofs.form-solutions.de:443/metaform/Form-Solutions/sid/assistant/5aa3e36daffffffff?san=12345678