Fachschnittstellen - Autista

Page / - zuletzt bearbeitet von Form-Solutions GmbH am 18.02.2022

Autista

zuletzt bearbeitet von Form-Solutions GmbH

am 18.02.2022

Inhaltsverzeichnis

Allgemeines

Voraussetzungen

Relevante Daten

Konfiguration des Webservices bei Versand über den GovManager aufseiten des Formularservers

1) Konfiguration des Webservices

2) Veröffentlichung des Assistenten

Konfiguration der Webservices bei Versand über COM Despina aufseiten des Formularservers

1) Konfiguration der Webservices

2) Veröffentlichung des Assistenten

Allgemeines

Voraussetzungen

Ein Payment ist bereits eingerichtet am Mandanten.

PDF und Assistentenrecht sind beim Mandanten vorhanden.

Relevante Daten

Folgende technischen Bereiche bei einer funktionsfähigen Schnittstellennutzung vom Assistenten mit der Übergabe zu Autista sind notwendig:

Paymentanbindung (wäre sinnvoll)

Standesamtsnummer

Gebühreninformationen

Konfiguration des Webservices bei Versand über den GovManager aufseiten des Formularservers

1) Konfiguration des Webservices

1.1) Webservice

Die „Erweiterte Modulkonfiguration“ 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.

1.1.1) Auswahl der WebService-Definition

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. Im Menüpunkt „WebService-Konfiguration“ müssen die folgenden WebService-Definition-Einstellungen gewählt werden:

Feld	Wert
WebService-Name:	XTA XÖV
WebService-OrganisationsID:	22222222-2222
WebService-Version:	1.1.1

1.1.2) Konfiguration der Webservice URL

Anschließend muss die URL des Webservices in das Feld WebService-Url eingetragen werden.

Hinweis: Es darf kein "/" am Ende der URL hinterlegt sein.

1.1.3) Konfiguration der Authentifizierung

Der Formularserver muss sich gegenüber dem empfangenden GovManager mit einem Zertifikat authentifizieren. Es ist daher notwendig, im Bereich „Werte für Zertifikatsauthentifizierung“ einen Java KeyStore (.jks) hochzuladen und das entsprechende Passwort zu hinterlegen. Den KeyStore sowie das Passwort bekommen Sie von der GovManager-betreibenden Instanz.

1.2) WebService, WebService-Aktion und WebService-SOAP-Header

Weiterhin müssen im Bereich „WebService-Konfiguration“ folgendes konfiguriert werden.

1.2.1) Konfiguration des WebService

Folgende Werte müssen dem WebService hinterlegt werden:

Feld	Wert
SOAP-Version:	1.1
Transportmodus für die Anfrage:	SOAP

Den KeyStore sowie das dazugehörige Passwort bekommen Sie von der GovManager-betreibenden Instanz.

1.2.2) Konfiguration der WebService-Aktion für das Mapping der Inhaltsdaten (nach xSta Standard)

Im Unterpunkt „WebService-Aktionen“ muss die Funktion "Bearbeiten" aufgerufen werden. Anschließend muss eine WebService-Aktion mit den folgenden Werten hinzugefügt werden:

Ab der Version 4.33.0 muss der obere Eintrag entfernt werden und durch die folgenden 4 Werte ersetzt werden:

Feld	Wert
Aktionsname des WebServices:	Send Message
Parametername:	{http://www.xoevta.de/xta/xtaws110}SendMessage.{http://www.xoevta.de/xta/xtaws110}Nachricht*
Wert des Parameters mappen:	Ja
Kundennummer des Mandanten, welcher das XML-Schema bereitstellt:	22222222-2222
XML-Schema:	portal2StA.Geburt.081030
XML-Schema-Version:	1.7.6
Feld	Wert
Aktionsname des WebServices:	Send Message
Parametername:	{http://www.xoevta.de/xta/xtaws110}SendMessage.{http://www.xoevta.de/xta/xtaws110}Nachricht*
Wert des Parameters mappen:	Ja
Kundennummer des Mandanten, welcher das XML-Schema bereitstellt:	22222222-2222
XML-Schema:	portal2StA.Ehe.082030
XML-Schema-Version:	1.7.6
Feld	Wert
Aktionsname des WebServices:	Send Message
Parametername:	{http://www.xoevta.de/xta/xtaws110}SendMessage.{http://www.xoevta.de/xta/xtaws110}Nachricht*
Wert des Parameters mappen:	Ja
Kundennummer des Mandanten, welcher das XML-Schema bereitstellt:	22222222-2222
XML-Schema:	portal2StA.LP.083030
XML-Schema-Version:	1.7.6
Feld	Wert
Aktionsname des WebServices:	Send Message
Parametername:	{http://www.xoevta.de/xta/xtaws110}SendMessage.{http://www.xoevta.de/xta/xtaws110}Nachricht*
Wert des Parameters mappen:	Ja
Kundennummer des Mandanten, welcher das XML-Schema bereitstellt:	22222222-2222
XML-Schema:	portal2StA.Sterbefall.084030
XML-Schema-Version:	1.7.6

Nach dem Hinzufügen kann mit dem Button „Zurück“ wieder in die WebService-Konfiguration gewechselt werden.

1.2.3) Konfiguration des WebService-SOAP-Headers

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:

Feld	Wert
Aktionsname des WebServices:	Send Message
Header aus einem Assistentenfeld beziehen:	Ja
Assistentenfeld des Headerwertes:	VerstecktesPanel.VF_SoapHeader

2) Veröffentlichung des Assistenten

2.1) Konfiguration der Webservice Anfrage während der Einreichung

2.1.1) Auswahl des Webservices

In der Veröffentlichungsmaske 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. 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.

Feld	Wert
Name des WebService:	XTA XÖV
Version des WebService:	1.1.1
Webservice Dienst:	SendMessage

2.1.2) Mapping der Anfrage (falls notwendig)

Diese Konfiguration ist nur auf Verlagsseite notwendig, alle Mandanten, welche den Verlagsassistenten nutze, benötigen hier keine weiteren Anpassungen.

Im Dialog „Auswahl eines Webservice-Dienstes“ kann ein Mapping für die Webservice Nachricht definiert werden. Ein Klick auf den Button „Webservice-Nachricht“ öffnet die entsprechende Fieldmapping Konfigurationsansicht. Hier muss als Zielsystem das folgende ausgewählt werden:

XTA XÖV-1.1.1-SendMessage

Anschließend muss ein Mapping für die folgenden Felder definiert werden:

VerstecktesPanel.VF_standesamt1 --> SendMessage.EmpfaengerKennung*

VerstecktesPanel.VF_uuid1 --> SendMessage.MessageId*

VerstecktesPanel.VF_PSW --> SendMessage.EmpfaengerPraefix*

Konfiguration der Webservices bei Versand über COM Despina aufseiten des Formularservers

1) Konfiguration der Webservices

1.1) Webservice

Die „Erweiterte Modulkonfiguration“ 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. 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.1) WebService "Despina - createMessageId"

Im Menüpunkt „WebService-Konfiguration“ müssen die folgenden WebService-Definition-Einstellungen gewählt werden:

Feld	Wert
WebService-Name:	Despina - createMessageId
WebService-OrganisationsID:	22222222-2222
WebService-Version:	5

1.1.1.1) Konfiguration der Webservice URL

Anschließend muss die URL des Webservices in das Feld WebService-Url eingetragen werden.

Hinweis: Es darf kein "/" am Ende der URL hinterlegt sein.

1.1.1.2) Konfiguration der Authentifizierung

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. Es ist daher notwendig, im Bereich „Werte für Zertifikatsauthentifizierung“ einen Java KeyStore (.jks) hochzuladen und das entsprechende Passwort zu hinterlegen. Den KeyStore sowie das Passwort bekommen Sie von der COM Despina-betreibenden bzw. RabbitMQ-betreibenden Instanz.

1.1.1.3) WebService und WebService-SOAP-Header

Weiterhin müssen im Bereich „WebService-Konfiguration“ folgendes konfiguriert werden.

1.1.1.4) Konfiguration des WebService

Folgende Werte müssen dem WebService hinterlegt werden:

Feld	Wert
SOAP-Version:	1.1
Transportmodus für die Anfrage:	MTOM
Feld	Wert
Daten per Queue-Messaging übertragen:	ja
Hostname des Message Brokers:	URL der RabbitMQ
Name des virtuellen Hosts:	vhost der RabbitMQ (Standard: Mandantennummer)
Name der Queue, in die die Nachrichten geschrieben werden:	Queue-Name

1.1.1.5) Konfiguration des WebService-SOAP-Headers

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:

Feld	Wert
Aktionsname des WebServices:	createMessageId
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>

1.1.2) WebService "Despina - send Message"

Im Menüpunkt „WebService-Konfiguration“ müssen die folgenden WebService-Definition-Einstellungen gewählt werden:

Feld	Wert
WebService-Name:	Despina - sendMessage
WebService-OrganisationsID:	22222222-2222
WebService-Version:	5

1.1.2.1) Konfiguration der Webservice URL

Anschließend muss die URL des Webservices in das Feld WebService-Url eingetragen werden.

Hinweis: Es darf kein "/" am Ende der URL hinterlegt sein.

1.1.2.2) Konfiguration der Authentifizierung

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. Es ist daher notwendig, im Bereich „Werte für Zertifikatsauthentifizierung“ einen Java KeyStore (.jks) hochzuladen und das entsprechende Passwort zu hinterlegen. Den KeyStore sowie das Passwort bekommen Sie von der COM Despina-betreibenden bzw. RabbitMQ-betreibenden Instanz.

1.1.2.3) WebService, WebService-Aktion und WebService-SOAP-Header

Weiterhin müssen im Bereich „WebService-Konfiguration“ folgendes konfiguriert werden.

1.1.2.4 Konfiguration des WebService

Folgende Werte müssen dem WebService hinterlegt werden:

Feld	Wert
SOAP-Version:	1.1
Transportmodus für die Anfrage:	MTOM
Feld	Wert
Daten per Queue-Messaging übertragen:	ja
Hostname des Message Brokers:	URL der RabbitMQ
Name des virtuellen Hosts:	vhost der RabbitMQ (Standard: Mandantennummer)
Name der Queue, in die die Nachrichten geschrieben werden:	Queue-Name

1.1.2.5) Konfiguration der WebService-Aktion für das Mapping der Inhaltsdaten (nach xSta Standard)

Im Unterpunkt „WebService-Aktionen“ muss die Funktion "Bearbeiten" aufgerufen werden. Anschließend muss eine WebService-Aktion mit den folgenden Werten hinzugefügt werden:

Ab der Version 4.33.0 muss der obere Eintrag entfernt werden und durch die folgenden 4 Werte ersetzt werden:

Feld	Wert
Aktionsname des WebServices:	sendMessage
Parametername:	{http://xoev.de/transport/xta/211}GenericContentContainer*.{http://xoev.de/transport/xta/211}ContentContainer*.{http://xoev.de/transport/xta/211}Message*
Wert des Parameters mappen:	Ja
Kundennummer des Mandanten, welcher das XML-Schema bereitstellt:	22222222-2222
XML-Schema:	portal2StA.Geburt.081030
XML-Schema-Version:	1.7.6
Feld	Wert
Aktionsname des WebServices:	sendMessage
Parametername:	{http://xoev.de/transport/xta/211}GenericContentContainer*.{http://xoev.de/transport/xta/211}ContentContainer*.{http://xoev.de/transport/xta/211}Message*
Wert des Parameters mappen:	Ja
Kundennummer des Mandanten, welcher das XML-Schema bereitstellt:	22222222-2222
XML-Schema:	portal2StA.Ehe.082030
XML-Schema-Version:	1.7.6
Feld	Wert
Aktionsname des WebServices:	sendMessage
Parametername:	{http://xoev.de/transport/xta/211}GenericContentContainer*.{http://xoev.de/transport/xta/211}ContentContainer*.{http://xoev.de/transport/xta/211}Message*
Wert des Parameters mappen:	Ja
Kundennummer des Mandanten, welcher das XML-Schema bereitstellt:	22222222-2222
XML-Schema:	portal2StA.LP.083030
XML-Schema-Version:	1.7.6
Feld	Wert
Aktionsname des WebServices:	sendMessage
Parametername:	{http://xoev.de/transport/xta/211}GenericContentContainer*.{http://xoev.de/transport/xta/211}ContentContainer*.{http://xoev.de/transport/xta/211}Message*
Wert des Parameters mappen:	Ja
Kundennummer des Mandanten, welcher das XML-Schema bereitstellt:	22222222-2222
XML-Schema:	portal2StA.Sterbefall.084030
XML-Schema-Version:	1.7.6

Nach dem Hinzufügen kann mit dem Button „Zurück“ wieder in die WebService-Konfiguration gewechselt werden.

1.2.3) Konfiguration des WebService-SOAP-Headers

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:

Feld	Wert
Aktionsname des WebServices:	sendMessage
Header aus einem Assistentenfeld beziehen:	Ja
Assistentenfeld des Headerwertes:	VerstecktesPanel.VF_SoapHeader

2) Veröffentlichung des Assistenten

2.1) Konfiguration der Webservice Anfrage während der Einreichung

2.1.1) Auswahl des Webservices

In der Veröffentlichungsmaske 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. 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.

Feld	Wert
Name des WebService:	Despina - sendMessage
Version des WebService:	5
Webservice Dienst:	sendMessage

2.1.2) Mapping der Anfrage (falls notwendig)

Diese Konfiguration ist nur auf Verlagsseite notwendig, alle Mandanten, welche den Verlagsassistenten nutze, benötigen hier keine weiteren Anpassungen.

Im Dialog „Auswahl eines Webservice-Dienstes“ kann ein Mapping für die Webservice Nachricht definiert werden. Ein Klick auf den Button „Webservice-Nachricht“ öffnet die entsprechende Fieldmapping Konfigurationsansicht. Hier muss als Zielsystem das folgende ausgewählt werden:

Despina - sendMessage-5-sendMessage-GenericContentContainer

Anschließend muss ein Mapping für die folgenden Felder definiert werden:

VerstecktesPanel.contentType --> {http://xoev.de/transport/xta/211}GenericContentContainer*.{http://xoev.de/transport/xta/211}ContentContainer*.{http://xoev.de/transport/xta/211}Message*:contentType*

VerstecktesPanel.encoding --> {http://xoev.de/transport/xta/211}GenericContentContainer*.{http://xoev.de/transport/xta/211}ContentContainer*.{http://xoev.de/transport/xta/211}Message*:encoding