Wiki-Quellcode von Autista

Zuletzt geändert von MACH ProForms GmbH am 18.02.2022

version	line-number	content
2.1	1	## Allgemeines
1.1	2
2.1	3	### Voraussetzungen
1.1	4
	5	- Ein Payment ist bereits eingerichtet am Mandanten.
	6	- PDF und Assistentenrecht sind beim Mandanten vorhanden.
	7
2.1	8	### Relevante Daten
1.1	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
	16	___
	17
4.1	18	## Konfiguration des Webservices bei Versand über den GovManager aufseiten des Formularservers
1.1	19
4.1	20	### 1) Konfiguration des Webservices
1.1	21
2.1	22	#### 1.1) Webservice
1.1	23
	24	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.
	25
2.1	26	##### 1.1.1) Auswahl der WebService-Definition
1.1	27
	28	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.
	29	Im Menüpunkt „WebService-Konfiguration“ müssen die folgenden WebService-Definition-Einstellungen gewählt werden:
	30
	31	\| Feld \| Wert \|
	32	\|--------\|--------\|--------\|
	33	\|WebService-Name:\| XTA XÖV\|
	34	\|WebService-OrganisationsID:\|22222222-2222\|
	35	\|WebService-Version:\|1.1.1\|
	36
	37
2.1	38	##### 1.1.2) Konfiguration der Webservice URL
1.1	39
	40	Anschließend muss die URL des Webservices in das Feld `WebService-Url` eingetragen werden.
	41
4.1	42	> {{icon name="far fa-info-circle" size="3"/}} *Hinweis:*
3.1	43	> Es darf kein "/" am Ende der URL hinterlegt sein.
	44
2.1	45	##### 1.1.3) Konfiguration der Authentifizierung
1.1	46
4.1	47	Der Formularserver muss sich gegenüber dem empfangenden GovManager mit einem Zertifikat authentifizieren.
	48	Es ist daher notwendig, im Bereich „Werte für Zertifikatsauthentifizierung“ einen Java KeyStore (.jks) hochzuladen und das entsprechende Passwort zu hinterlegen.
	49	Den KeyStore sowie das Passwort bekommen Sie von der GovManager-betreibenden Instanz.
1.1	50
	51
4.1	52	#### 1.2) WebService, WebService-Aktion und WebService-SOAP-Header
1.1	53
	54	Weiterhin müssen im Bereich „WebService-Konfiguration“ folgendes konfiguriert werden.
	55
4.1	56	##### 1.2.1) Konfiguration des WebService
1.1	57
4.1	58	Folgende Werte müssen dem WebService hinterlegt werden:
1.1	59
	60	\| Feld \| Wert \|
	61	\|--------\|--------\|--------\|
4.1	62	\| SOAP-Version:\| 1.1 \|
	63	\| Transportmodus für die Anfrage: \| SOAP \|
1.1	64
4.1	65	Den KeyStore sowie das dazugehörige Passwort bekommen Sie von der GovManager-betreibenden Instanz.
	66
	67	##### 1.2.2) Konfiguration der WebService-Aktion für das Mapping der Inhaltsdaten (nach xSta Standard)
	68
	69	Im Unterpunkt „WebService-Aktionen“ muss die Funktion "Bearbeiten" aufgerufen werden. Anschließend muss eine WebService-Aktion mit den folgenden Werten hinzugefügt werden:
	70
1.1	71	Ab der Version 4.33.0 muss der obere Eintrag entfernt werden und durch die folgenden 4 Werte ersetzt werden:
	72
	73	\| Feld \| Wert \|
	74	\|--------\|--------\|--------\|
	75	\|Aktionsname des WebServices:\| Send Message\|
	76	\|Parametername:\|{http://www.xoevta.de/xta/xtaws110}SendMessage.{http://www.xoevta.de/xta/xtaws110}Nachricht*\|
	77	\|Wert des Parameters mappen:\|Ja\|
	78	\|Kundennummer des Mandanten, welcher das XML-Schema bereitstellt:\|22222222-2222\|
	79	\|XML-Schema:\|portal2StA.Geburt.081030\|
4.1	80	\|XML-Schema-Version:\| 1.7.6\|
1.1	81
	82	\| Feld \| Wert \|
	83	\|--------\|--------\|--------\|
	84	\|Aktionsname des WebServices:\| Send Message\|
	85	\|Parametername:\|{http://www.xoevta.de/xta/xtaws110}SendMessage.{http://www.xoevta.de/xta/xtaws110}Nachricht*\|
	86	\|Wert des Parameters mappen:\|Ja\|
	87	\|Kundennummer des Mandanten, welcher das XML-Schema bereitstellt:\|22222222-2222\|
	88	\|XML-Schema:\|portal2StA.Ehe.082030\|
4.1	89	\|XML-Schema-Version:\| 1.7.6\|
	90
	91	\| Feld \| Wert \|
	92	\|--------\|--------\|--------\|
1.1	93	\|Aktionsname des WebServices:\| Send Message\|
	94	\|Parametername:\|{http://www.xoevta.de/xta/xtaws110}SendMessage.{http://www.xoevta.de/xta/xtaws110}Nachricht*\|
	95	\|Wert des Parameters mappen:\|Ja\|
	96	\|Kundennummer des Mandanten, welcher das XML-Schema bereitstellt:\|22222222-2222\|
	97	\|XML-Schema:\|portal2StA.LP.083030\|
4.1	98	\|XML-Schema-Version:\| 1.7.6\|
	99
	100	\| Feld \| Wert \|
	101	\|--------\|--------\|--------\|
1.1	102	\|Aktionsname des WebServices:\| Send Message\|
	103	\|Parametername:\|{http://www.xoevta.de/xta/xtaws110}SendMessage.{http://www.xoevta.de/xta/xtaws110}Nachricht*\|
	104	\|Wert des Parameters mappen:\|Ja\|
	105	\|Kundennummer des Mandanten, welcher das XML-Schema bereitstellt:\|22222222-2222\|
	106	\|XML-Schema:\|portal2StA.Sterbefall.084030\|
4.1	107	\|XML-Schema-Version:\| 1.7.6\|
1.1	108
	109	Nach dem Hinzufügen kann mit dem Button „Zurück“ wieder in die WebService-Konfiguration gewechselt werden.
	110
4.1	111	##### 1.2.3) Konfiguration des WebService-SOAP-Headers
1.1	112
	113	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:
	114
	115	\| Feld \| Wert \|
	116	\|--------\|--------\|--------\|
	117	\|Aktionsname des WebServices:\| Send Message\|
	118	\|Header aus einem Assistentenfeld beziehen:\|Ja\|
	119	\|Assistentenfeld des Headerwertes:\|VerstecktesPanel.VF_SoapHeader\|
	120
2.1	121	### 2) Veröffentlichung des Assistenten
1.1	122
2.1	123	#### 2.1) Konfiguration der Webservice Anfrage während der Einreichung
1.1	124
2.1	125	##### 2.1.1) Auswahl des Webservices
1.1	126
	127	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.
	128	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.
	129
	130	\| Feld \| Wert \|
	131	\|--------\|--------\|--------\|
	132	\|Name des WebService:\|XTA XÖV\|
	133	\|Version des WebService:\|1.1.1\|
	134	\|Webservice Dienst: \|SendMessage\|
	135
2.1	136	##### 2.1.2) Mapping der Anfrage (falls notwendig)
1.1	137
	138	Diese Konfiguration ist nur auf Verlagsseite notwendig, alle Mandanten, welche den Verlagsassistenten nutze, benötigen hier keine weiteren Anpassungen.
	139
	140	Im Dialog „Auswahl eines Webservice-Dienstes“ kann ein Mapping für die Webservice Nachricht definiert werden.
4.1	141	Ein Klick auf den Button „Webservice-Nachricht“ öffnet die entsprechende Fieldmapping Konfigurationsansicht. Hier muss als Zielsystem das folgende ausgewählt werden:
1.1	142
	143	`XTA XÖV-1.1.1-SendMessage`
	144
	145	Anschließend muss ein Mapping für die folgenden Felder definiert werden:
	146
	147	`VerstecktesPanel.VF_standesamt1` --> `SendMessage.EmpfaengerKennung*`
	148
	149	`VerstecktesPanel.VF_uuid1` --> `SendMessage.MessageId*`
	150
4.1	151	`VerstecktesPanel.VF_PSW` --> `SendMessage.EmpfaengerPraefix*`
1.1	152
	153
4.1	154	___
1.1	155
4.1	156	## Konfiguration der Webservices bei Versand über COM Despina aufseiten des Formularservers
1.1	157
4.1	158	### 1) Konfiguration der Webservices
1.1	159
4.1	160	#### 1.1) Webservice
1.1	161
4.1	162	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.
	163	Für die Konfiguration der COM Despina Webservices werden zunächst passende WebService-Definitionen benötigt. Der Verlag Form-Solutions stellt für alle Mandanten bereits die WebService-Definitionen „Despina - createMessageId“ und "Despina - sendMessage" bereit.
1.1	164
4.1	165	##### 1.1.1) WebService "Despina - createMessageId"
1.1	166
4.1	167	Im Menüpunkt „WebService-Konfiguration“ müssen die folgenden WebService-Definition-Einstellungen gewählt werden:
1.1	168
4.1	169	\| Feld \| Wert \|
	170	\|--------\|--------\|--------\|
	171	\|WebService-Name:\| Despina - createMessageId \|
	172	\|WebService-OrganisationsID:\|22222222-2222\|
	173	\|WebService-Version:\|5\|
1.1	174
	175
4.1	176	##### 1.1.1.1) Konfiguration der Webservice URL
1.1	177
4.1	178	Anschließend muss die URL des Webservices in das Feld `WebService-Url` eingetragen werden.
1.1	179
4.1	180	> {{icon name="far fa-info-circle" size="3"/}} *Hinweis:*
	181	> Es darf kein "/" am Ende der URL hinterlegt sein.
	182
	183	##### 1.1.1.2) Konfiguration der Authentifizierung
	184
	185	Der Formularserver muss sich gegenüber dem empfangenden COM Despina mit einem Zertifikat authentifizieren. Zusätzlich wird ein Zertifikat für die vorgelagerte RabbitMQ benötigt.
	186	Es ist daher notwendig, im Bereich „Werte für Zertifikatsauthentifizierung“ einen Java KeyStore (.jks) hochzuladen und das entsprechende Passwort zu hinterlegen.
	187	Den KeyStore sowie das Passwort bekommen Sie von der COM Despina-betreibenden bzw. RabbitMQ-betreibenden Instanz.
	188
	189
	190	#### 1.1.1.3) WebService und WebService-SOAP-Header
	191
	192	Weiterhin müssen im Bereich „WebService-Konfiguration“ folgendes konfiguriert werden.
	193
	194	##### 1.1.1.4) Konfiguration des WebService
	195
	196	Folgende Werte müssen dem WebService hinterlegt werden:
	197
	198	\| Feld \| Wert \|
	199	\|--------\|--------\|--------\|
	200	\| SOAP-Version:\| 1.1 \|
	201	\| Transportmodus für die Anfrage: \| MTOM \|
	202
	203
	204	\| Feld \| Wert \|
	205	\|--------\|--------\|--------\|
	206	\|Daten per Queue-Messaging übertragen: \| ja\|
	207	\|Hostname des Message Brokers: \| URL der RabbitMQ \|
	208	\|Name des virtuellen Hosts: \| vhost der RabbitMQ (Standard: Mandantennummer) \|
	209	\|Name der Queue, in die die Nachrichten geschrieben werden: \| Queue-Name \|
	210
	211	##### 1.1.1.5) Konfiguration des WebService-SOAP-Headers
	212
	213	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:
	214
	215	\| Feld \| Wert \|
	216	\|--------\|--------\|--------\|
	217	\|Aktionsname des WebServices:\| createMessageId \|
	218	\|Header: \|<wsa:Action xmlns:wsa="http://www.w3.org/2005/08/addressing">http://www.xta.de/XTA/CreateMessageID</wsa:Action><wsa:MessageID xmlns:wsa="http://www.w3.org/2005/08/addressing"></wsa:MessageID>\|
	219
	220	##### 1.1.2) WebService "Despina - send Message"
	221
	222	Im Menüpunkt „WebService-Konfiguration“ müssen die folgenden WebService-Definition-Einstellungen gewählt werden:
	223
	224	\| Feld \| Wert \|
	225	\|--------\|--------\|--------\|
	226	\|WebService-Name:\| Despina - sendMessage \|
	227	\|WebService-OrganisationsID:\|22222222-2222\|
	228	\|WebService-Version:\|5\|
	229
	230
	231	##### 1.1.2.1) Konfiguration der Webservice URL
	232
	233	Anschließend muss die URL des Webservices in das Feld `WebService-Url` eingetragen werden.
	234
	235	> {{icon name="far fa-info-circle" size="3"/}} *Hinweis:*
	236	> Es darf kein "/" am Ende der URL hinterlegt sein.
	237
	238	##### 1.1.2.2) Konfiguration der Authentifizierung
	239
	240	Der Formularserver muss sich gegenüber dem empfangenden COM Despina mit einem Zertifikat authentifizieren. Zusätzlich wird ein Zertifikat für die vorgelagerte RabbitMQ benötigt.
	241	Es ist daher notwendig, im Bereich „Werte für Zertifikatsauthentifizierung“ einen Java KeyStore (.jks) hochzuladen und das entsprechende Passwort zu hinterlegen.
	242	Den KeyStore sowie das Passwort bekommen Sie von der COM Despina-betreibenden bzw. RabbitMQ-betreibenden Instanz.
	243
	244	#### 1.1.2.3) WebService, WebService-Aktion und WebService-SOAP-Header
	245
	246	Weiterhin müssen im Bereich „WebService-Konfiguration“ folgendes konfiguriert werden.
	247
	248	##### 1.1.2.4 Konfiguration des WebService
	249
	250	Folgende Werte müssen dem WebService hinterlegt werden:
	251
	252	\| Feld \| Wert \|
	253	\|--------\|--------\|--------\|
	254	\| SOAP-Version:\| 1.1 \|
	255	\| Transportmodus für die Anfrage: \| MTOM \|
	256
	257	\| Feld \| Wert \|
	258	\|--------\|--------\|--------\|
	259	\|Daten per Queue-Messaging übertragen: \| ja\|
	260	\|Hostname des Message Brokers: \| URL der RabbitMQ \|
	261	\|Name des virtuellen Hosts: \| vhost der RabbitMQ (Standard: Mandantennummer) \|
	262	\|Name der Queue, in die die Nachrichten geschrieben werden: \| Queue-Name \|
	263
	264	##### 1.1.2.5) Konfiguration der WebService-Aktion für das Mapping der Inhaltsdaten (nach xSta Standard)
	265
	266	Im Unterpunkt „WebService-Aktionen“ muss die Funktion "Bearbeiten" aufgerufen werden. Anschließend muss eine WebService-Aktion mit den folgenden Werten hinzugefügt werden:
	267
	268	Ab der Version 4.33.0 muss der obere Eintrag entfernt werden und durch die folgenden 4 Werte ersetzt werden:
	269
	270	\| Feld \| Wert \|
	271	\|--------\|--------\|--------\|
	272	\|Aktionsname des WebServices:\| sendMessage\|
	273	\|Parametername:\|{http://xoev.de/transport/xta/211}GenericContentContainer.{http://xoev.de/transport/xta/211}ContentContainer.{http://xoev.de/transport/xta/211}Message*\|
	274	\|Wert des Parameters mappen:\|Ja\|
	275	\|Kundennummer des Mandanten, welcher das XML-Schema bereitstellt:\|22222222-2222\|
	276	\|XML-Schema:\|portal2StA.Geburt.081030\|
	277	\|XML-Schema-Version:\| 1.7.6\|
	278
	279	\| Feld \| Wert \|
	280	\|--------\|--------\|--------\|
	281	\|Aktionsname des WebServices:\| sendMessage\|
	282	\|Parametername:\|{http://xoev.de/transport/xta/211}GenericContentContainer.{http://xoev.de/transport/xta/211}ContentContainer.{http://xoev.de/transport/xta/211}Message*\|
	283	\|Wert des Parameters mappen:\|Ja\|
	284	\|Kundennummer des Mandanten, welcher das XML-Schema bereitstellt:\|22222222-2222\|
	285	\|XML-Schema:\|portal2StA.Ehe.082030\|
	286	\|XML-Schema-Version:\| 1.7.6\|
	287
	288	\| Feld \| Wert \|
	289	\|--------\|--------\|--------\|
	290	\|Aktionsname des WebServices:\| sendMessage\|
	291	\|Parametername:\|{http://xoev.de/transport/xta/211}GenericContentContainer.{http://xoev.de/transport/xta/211}ContentContainer.{http://xoev.de/transport/xta/211}Message*\|
	292	\|Wert des Parameters mappen:\|Ja\|
	293	\|Kundennummer des Mandanten, welcher das XML-Schema bereitstellt:\|22222222-2222\|
	294	\|XML-Schema:\|portal2StA.LP.083030\|
	295	\|XML-Schema-Version:\| 1.7.6\|
	296
	297	\| Feld \| Wert \|
	298	\|--------\|--------\|--------\|
	299	\|Aktionsname des WebServices:\| sendMessage\|
	300	\|Parametername:\|{http://xoev.de/transport/xta/211}GenericContentContainer.{http://xoev.de/transport/xta/211}ContentContainer.{http://xoev.de/transport/xta/211}Message*\|
	301	\|Wert des Parameters mappen:\|Ja\|
	302	\|Kundennummer des Mandanten, welcher das XML-Schema bereitstellt:\|22222222-2222\|
	303	\|XML-Schema:\|portal2StA.Sterbefall.084030\|
	304	\|XML-Schema-Version:\| 1.7.6\|
	305
	306	Nach dem Hinzufügen kann mit dem Button „Zurück“ wieder in die WebService-Konfiguration gewechselt werden.
	307
	308	##### 1.2.3) Konfiguration des WebService-SOAP-Headers
	309
	310	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:
	311
	312	\| Feld \| Wert \|
	313	\|--------\|--------\|--------\|
	314	\|Aktionsname des WebServices:\| sendMessage\|
	315	\|Header aus einem Assistentenfeld beziehen:\|Ja\|
	316	\|Assistentenfeld des Headerwertes:\|VerstecktesPanel.VF_SoapHeader\|
	317
	318	### 2) Veröffentlichung des Assistenten
	319
	320	#### 2.1) Konfiguration der Webservice Anfrage während der Einreichung
	321
	322	##### 2.1.1) Auswahl des Webservices
	323
	324	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.
	325	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.
	326
	327	\| Feld \| Wert \|
	328	\|--------\|--------\|--------\|
	329	\|Name des WebService:\|Despina - sendMessage\|
	330	\|Version des WebService:\|5\|
	331	\|Webservice Dienst: \|sendMessage\|
	332
	333
	334	##### 2.1.2) Mapping der Anfrage (falls notwendig)
	335
	336	Diese Konfiguration ist nur auf Verlagsseite notwendig, alle Mandanten, welche den Verlagsassistenten nutze, benötigen hier keine weiteren Anpassungen.
	337
	338	Im Dialog „Auswahl eines Webservice-Dienstes“ kann ein Mapping für die Webservice Nachricht definiert werden.
	339	Ein Klick auf den Button „Webservice-Nachricht“ öffnet die entsprechende Fieldmapping Konfigurationsansicht. Hier muss als Zielsystem das folgende ausgewählt werden:
	340
	341	`Despina - sendMessage-5-sendMessage-GenericContentContainer`
	342
	343	Anschließend muss ein Mapping für die folgenden Felder definiert werden:
	344
	345	`VerstecktesPanel.contentType` --> `{http://xoev.de/transport/xta/211}GenericContentContainer.{http://xoev.de/transport/xta/211}ContentContainer.{http://xoev.de/transport/xta/211}Message:contentType`
	346
	347	`VerstecktesPanel.encoding` --> `{http://xoev.de/transport/xta/211}GenericContentContainer.{http://xoev.de/transport/xta/211}ContentContainer.{http://xoev.de/transport/xta/211}Message*:encoding`