Eidgenoumlssisches Finanzdepartement EFD

Bundesamt fuumlr Informatik und Telekommunikation BIT

Loumlsungszentrum

E-Government

sedex_eUmzug_AAR_benutzerhandbuch_V10docx

Sedex Webservice-Proxy Benutzerhandbuch zum Personenidentifikati-ons-Service (eUmzugCH)

Installation Konfiguration und Verwendung

Projektname Sedex

Projektnummer

Dokumenten-Version V10

Status in Arbeit in Pruumlfung genehmigt zur

Nutzung

Beteiligter Personenkreis

Autor Markus Antener

Genehmigung Stefan Leisi

BenuumltzerAnwender Softwarelieferanten BFS

zur InformationKenntnis

Aumlnderungskontrolle Pruumlfung Genehmigung

Wann Version Wer Beschreibung

28052015 V01 Markus Antener Initiale Version

02062015 V02 Thomas Wenger Review und Ergaumlnzungen

15082016 V10 Thomas Wenger Anpassungen an aktuelle Version AAR

Sedex Webservice-Proxy Benutzerhandbuch zum Personenidentifikations-Service (eUmzugCH)

sedex_eUmzug_AAR_benutzerhandbuch_V10docx 2 13

Referenzierte Dokumente

[sedexCli-ent]

Installationshandbuch fuumlr den sedex-Client V404

[WS-Proxy] Benutzerhandbuch des Webservice-Proxy V404

[eCH-0194] Schnittstellenstandard eUmzug 10 Entwurf

[IntAnlei-tung]

sedex im Projekt eUmzugCHeUmzugZH Integrationsanleitung fuumlr Nutzer und An-bieter synchroner SOAP-Webservices Version 12 vom 15082016

Begriffe Abkuumlrzungen

BFS Bundesamt fuumlr Statistik Neuenburg

SOAP Simple Object Access Protocol

soapUI Ein Werkzeug zum Testen von Webservices (httpwwwsoapuiorg)

Sedex Webservice-Proxy Benutzerhandbuch zum Personenidentifikations-Service (eUmzugCH)

sedex_eUmzug_AAR_benutzerhandbuch_V10docx 3 13

Inhaltsverzeichnis

1 EINFUumlHRUNG 4

11 Zweck diese Dokuments 4

12 Content Based Routing (CBR) 4

13 Hinweis zur Aktualitaumlt des Service-Verzeichnis 5

2 INSTALLATION DES PERSONENIDENTIFIKATIONS-SERVICES 6

21 Lieferumfang 6

22 Vorbedingungen 6

23 Netzwerk Firewall 6

24 Installation des Services in bestehendem sedex WS-Proxy 6

25 Aktivieren der Verbindungstests fuumlr Aufrufe via Webbrowser 7

26 Konfiguration Umgebung (Produktion oder Test) 7

3 VERWENDUNG 8

31 Personenidentifikation 8

32 Monitoring Verbindungstest 8

321 Verbindungstest zu allen Endpunkten via Webservice (SOAP) 8 322 Verbindungstest via Webbrowser (HTTP) 8

4 ENDPUNKTE DES PERSONENIDENTIFIKATIONSSERVICE 9

5 TEST-REQUESTS 10

51 Personenidentifikation searchPersonIdentification 10

52 Verbindungstest (via SOAP) 11

6 BEISPIELANTWORTEN 12

61 Personenidentifikationsservice 12

62 Verbindungstest 12

Sedex Webservice-Proxy Benutzerhandbuch zum Personenidentifikations-Service (eUmzugCH)

sedex_eUmzug_AAR_benutzerhandbuch_V10docx 4 13

1 Einfuumlhrung

11 Zweck diese Dokuments

Im Vorhaben eUmzugCH wird von den Umzugsplattformen Zugriff auf Webservices zur Per-sonenidentifikation gemaumlss [eCH-0194] benoumltigt Dieser Zugriff soll abgesichert uumlber den se-dex Webservice-Proxy erfolgen

Das vorliegende Dokument vermittelt das notwendige Wissen um via sedex Webservice-Proxy auf den Personenidentifikationsservice zuzugreifen Es wird vorausgesetzt dass der sedex Client inklusive der Option Webservice-Proxy gemaumlss [sedexClient] installiert wurde

Das vorliegende Dokument setzt den Fokus auf das AAR fuumlr die Personen-Identifikation also die Definitionsdatei fuumlr den sedex-Webservice-Proxy zu diesem Webservice Mit der Integra-tionsanleitung [IntAnleitung] gibt es aber eine umfassendere Anleitung welche als erste Lek-tuumlre eher empfohlen sei

12 Content Based Routing (CBR)

Der Webservice zur Personenidentifikation soll nicht zentral sondern von einer relativ gros-sen Anzahl (dutzenderhunderter) heterogener und dezentral organisierter EK-Systeme reali-siert werden Je nach politischer Gemeinde ist somit ein anderer bestimmter Webservice fuumlr die Personenidentifikation zustaumlndig

Die Kommunikation zur Personenidentifikation zwischen Client und Server erfordert also ein inhaltsbasiertes Umleiten der Anfragen (sog Content Based Routing1 CBR)

Damit Content Based Routing angewendet werden kann muumlssen folgende Voraussetzungen erfuumlllt sein

1 Content muss Routing-Kriterium enthalten

Eine Anfrage zur Personenidentifikation muss den Identifikator der betroffenen politischen Ge-

meinde enthalten Diese Anforderung ist bei der Spezifikation der Webservices zu beruumlcksich-

tigen

2 Kommunikation erfordert Service-Lookup

Entweder muss der Client (hier die Portal-Applikation) oder ein zwischengeschalteter Service-

Proxy einen Service-Lookup vornehmen um aufgrund der im Content enthaltenen politischen

Gemeinde den zustaumlndigen Ziel-Service bestimmen zu koumlnnen

3 Service-Directory muss verfuumlgbar sein

Fuumlr den Service-Lookup muss in einem Directory die fuumlr eine politische Gemeinde zustaumlndige

Webservice-Implementation definiert sein Gefuumlhrt werden im Directory konkret mindestens

der Gemeinde-Identifikator und der zugehoumlrige Webservice-Endpunkt (eine URI2) Idealer-

weise sind zusaumltzlich noch die zu akzeptierenden 3SSL-Zertifikate des Webservices (zwecks

Authentifikation desselben) verfuumlgbar

4 Routing der Service-Anfrage erforderlich

1 CBR httpwwwitwisseninfodefinitionlexikonCBR-content-based-routinghtml 2 URI httpdewikipediaorgwikiUniform_Resource_Identifier 3 Damit auch ein Zertifikatswechsel unterbruchsfrei erfolgen kann sollten mindestens zwei Zertifikate pro Webservice-Endpunkt gefuumlhrt werden koumlnnen

Sedex Webservice-Proxy Benutzerhandbuch zum Personenidentifikations-Service (eUmzugCH)

sedex_eUmzug_AAR_benutzerhandbuch_V10docx 2 13

Referenzierte Dokumente

[sedexCli-ent]

Installationshandbuch fuumlr den sedex-Client V404

[WS-Proxy] Benutzerhandbuch des Webservice-Proxy V404

[eCH-0194] Schnittstellenstandard eUmzug 10 Entwurf

[IntAnlei-tung]

sedex im Projekt eUmzugCHeUmzugZH Integrationsanleitung fuumlr Nutzer und An-bieter synchroner SOAP-Webservices Version 12 vom 15082016

Begriffe Abkuumlrzungen

BFS Bundesamt fuumlr Statistik Neuenburg

SOAP Simple Object Access Protocol

soapUI Ein Werkzeug zum Testen von Webservices (httpwwwsoapuiorg)

Sedex Webservice-Proxy Benutzerhandbuch zum Personenidentifikations-Service (eUmzugCH)

sedex_eUmzug_AAR_benutzerhandbuch_V10docx 3 13

Inhaltsverzeichnis

1 EINFUumlHRUNG 4

11 Zweck diese Dokuments 4

12 Content Based Routing (CBR) 4

13 Hinweis zur Aktualitaumlt des Service-Verzeichnis 5

2 INSTALLATION DES PERSONENIDENTIFIKATIONS-SERVICES 6

21 Lieferumfang 6

22 Vorbedingungen 6

23 Netzwerk Firewall 6

24 Installation des Services in bestehendem sedex WS-Proxy 6

25 Aktivieren der Verbindungstests fuumlr Aufrufe via Webbrowser 7

26 Konfiguration Umgebung (Produktion oder Test) 7

3 VERWENDUNG 8

31 Personenidentifikation 8

32 Monitoring Verbindungstest 8

321 Verbindungstest zu allen Endpunkten via Webservice (SOAP) 8 322 Verbindungstest via Webbrowser (HTTP) 8

4 ENDPUNKTE DES PERSONENIDENTIFIKATIONSSERVICE 9

5 TEST-REQUESTS 10

51 Personenidentifikation searchPersonIdentification 10

52 Verbindungstest (via SOAP) 11

6 BEISPIELANTWORTEN 12

61 Personenidentifikationsservice 12

62 Verbindungstest 12

Sedex Webservice-Proxy Benutzerhandbuch zum Personenidentifikations-Service (eUmzugCH)

sedex_eUmzug_AAR_benutzerhandbuch_V10docx 4 13

1 Einfuumlhrung

11 Zweck diese Dokuments

Im Vorhaben eUmzugCH wird von den Umzugsplattformen Zugriff auf Webservices zur Per-sonenidentifikation gemaumlss [eCH-0194] benoumltigt Dieser Zugriff soll abgesichert uumlber den se-dex Webservice-Proxy erfolgen

Das vorliegende Dokument vermittelt das notwendige Wissen um via sedex Webservice-Proxy auf den Personenidentifikationsservice zuzugreifen Es wird vorausgesetzt dass der sedex Client inklusive der Option Webservice-Proxy gemaumlss [sedexClient] installiert wurde

Das vorliegende Dokument setzt den Fokus auf das AAR fuumlr die Personen-Identifikation also die Definitionsdatei fuumlr den sedex-Webservice-Proxy zu diesem Webservice Mit der Integra-tionsanleitung [IntAnleitung] gibt es aber eine umfassendere Anleitung welche als erste Lek-tuumlre eher empfohlen sei

12 Content Based Routing (CBR)

Der Webservice zur Personenidentifikation soll nicht zentral sondern von einer relativ gros-sen Anzahl (dutzenderhunderter) heterogener und dezentral organisierter EK-Systeme reali-siert werden Je nach politischer Gemeinde ist somit ein anderer bestimmter Webservice fuumlr die Personenidentifikation zustaumlndig

Die Kommunikation zur Personenidentifikation zwischen Client und Server erfordert also ein inhaltsbasiertes Umleiten der Anfragen (sog Content Based Routing1 CBR)

Damit Content Based Routing angewendet werden kann muumlssen folgende Voraussetzungen erfuumlllt sein

1 Content muss Routing-Kriterium enthalten

Eine Anfrage zur Personenidentifikation muss den Identifikator der betroffenen politischen Ge-

meinde enthalten Diese Anforderung ist bei der Spezifikation der Webservices zu beruumlcksich-

tigen

2 Kommunikation erfordert Service-Lookup

Entweder muss der Client (hier die Portal-Applikation) oder ein zwischengeschalteter Service-

Proxy einen Service-Lookup vornehmen um aufgrund der im Content enthaltenen politischen

Gemeinde den zustaumlndigen Ziel-Service bestimmen zu koumlnnen

3 Service-Directory muss verfuumlgbar sein

Fuumlr den Service-Lookup muss in einem Directory die fuumlr eine politische Gemeinde zustaumlndige

Webservice-Implementation definiert sein Gefuumlhrt werden im Directory konkret mindestens

der Gemeinde-Identifikator und der zugehoumlrige Webservice-Endpunkt (eine URI2) Idealer-

weise sind zusaumltzlich noch die zu akzeptierenden 3SSL-Zertifikate des Webservices (zwecks

Authentifikation desselben) verfuumlgbar

4 Routing der Service-Anfrage erforderlich

1 CBR httpwwwitwisseninfodefinitionlexikonCBR-content-based-routinghtml 2 URI httpdewikipediaorgwikiUniform_Resource_Identifier 3 Damit auch ein Zertifikatswechsel unterbruchsfrei erfolgen kann sollten mindestens zwei Zertifikate pro Webservice-Endpunkt gefuumlhrt werden koumlnnen

Sedex Webservice-Proxy Benutzerhandbuch zum Personenidentifikations-Service (eUmzugCH)

sedex_eUmzug_AAR_benutzerhandbuch_V10docx 3 13

Inhaltsverzeichnis

1 EINFUumlHRUNG 4

11 Zweck diese Dokuments 4

12 Content Based Routing (CBR) 4

13 Hinweis zur Aktualitaumlt des Service-Verzeichnis 5

2 INSTALLATION DES PERSONENIDENTIFIKATIONS-SERVICES 6

21 Lieferumfang 6

22 Vorbedingungen 6

23 Netzwerk Firewall 6

24 Installation des Services in bestehendem sedex WS-Proxy 6

25 Aktivieren der Verbindungstests fuumlr Aufrufe via Webbrowser 7

26 Konfiguration Umgebung (Produktion oder Test) 7

3 VERWENDUNG 8

31 Personenidentifikation 8

32 Monitoring Verbindungstest 8

321 Verbindungstest zu allen Endpunkten via Webservice (SOAP) 8 322 Verbindungstest via Webbrowser (HTTP) 8

4 ENDPUNKTE DES PERSONENIDENTIFIKATIONSSERVICE 9

5 TEST-REQUESTS 10

51 Personenidentifikation searchPersonIdentification 10

52 Verbindungstest (via SOAP) 11

6 BEISPIELANTWORTEN 12

61 Personenidentifikationsservice 12

62 Verbindungstest 12

Sedex Webservice-Proxy Benutzerhandbuch zum Personenidentifikations-Service (eUmzugCH)

sedex_eUmzug_AAR_benutzerhandbuch_V10docx 4 13

1 Einfuumlhrung

11 Zweck diese Dokuments

Im Vorhaben eUmzugCH wird von den Umzugsplattformen Zugriff auf Webservices zur Per-sonenidentifikation gemaumlss [eCH-0194] benoumltigt Dieser Zugriff soll abgesichert uumlber den se-dex Webservice-Proxy erfolgen

Das vorliegende Dokument vermittelt das notwendige Wissen um via sedex Webservice-Proxy auf den Personenidentifikationsservice zuzugreifen Es wird vorausgesetzt dass der sedex Client inklusive der Option Webservice-Proxy gemaumlss [sedexClient] installiert wurde

Das vorliegende Dokument setzt den Fokus auf das AAR fuumlr die Personen-Identifikation also die Definitionsdatei fuumlr den sedex-Webservice-Proxy zu diesem Webservice Mit der Integra-tionsanleitung [IntAnleitung] gibt es aber eine umfassendere Anleitung welche als erste Lek-tuumlre eher empfohlen sei

12 Content Based Routing (CBR)

Der Webservice zur Personenidentifikation soll nicht zentral sondern von einer relativ gros-sen Anzahl (dutzenderhunderter) heterogener und dezentral organisierter EK-Systeme reali-siert werden Je nach politischer Gemeinde ist somit ein anderer bestimmter Webservice fuumlr die Personenidentifikation zustaumlndig

Die Kommunikation zur Personenidentifikation zwischen Client und Server erfordert also ein inhaltsbasiertes Umleiten der Anfragen (sog Content Based Routing1 CBR)

Damit Content Based Routing angewendet werden kann muumlssen folgende Voraussetzungen erfuumlllt sein

1 Content muss Routing-Kriterium enthalten

Eine Anfrage zur Personenidentifikation muss den Identifikator der betroffenen politischen Ge-

meinde enthalten Diese Anforderung ist bei der Spezifikation der Webservices zu beruumlcksich-

tigen

2 Kommunikation erfordert Service-Lookup

Entweder muss der Client (hier die Portal-Applikation) oder ein zwischengeschalteter Service-

Proxy einen Service-Lookup vornehmen um aufgrund der im Content enthaltenen politischen

Gemeinde den zustaumlndigen Ziel-Service bestimmen zu koumlnnen

3 Service-Directory muss verfuumlgbar sein

Fuumlr den Service-Lookup muss in einem Directory die fuumlr eine politische Gemeinde zustaumlndige

Webservice-Implementation definiert sein Gefuumlhrt werden im Directory konkret mindestens

der Gemeinde-Identifikator und der zugehoumlrige Webservice-Endpunkt (eine URI2) Idealer-

weise sind zusaumltzlich noch die zu akzeptierenden 3SSL-Zertifikate des Webservices (zwecks

Authentifikation desselben) verfuumlgbar

4 Routing der Service-Anfrage erforderlich

1 CBR httpwwwitwisseninfodefinitionlexikonCBR-content-based-routinghtml 2 URI httpdewikipediaorgwikiUniform_Resource_Identifier 3 Damit auch ein Zertifikatswechsel unterbruchsfrei erfolgen kann sollten mindestens zwei Zertifikate pro Webservice-Endpunkt gefuumlhrt werden koumlnnen

Sedex Webservice-Proxy Benutzerhandbuch zum Personenidentifikations-Service (eUmzugCH)

sedex_eUmzug_AAR_benutzerhandbuch_V10docx 4 13

1 Einfuumlhrung

11 Zweck diese Dokuments

Im Vorhaben eUmzugCH wird von den Umzugsplattformen Zugriff auf Webservices zur Per-sonenidentifikation gemaumlss [eCH-0194] benoumltigt Dieser Zugriff soll abgesichert uumlber den se-dex Webservice-Proxy erfolgen

Das vorliegende Dokument vermittelt das notwendige Wissen um via sedex Webservice-Proxy auf den Personenidentifikationsservice zuzugreifen Es wird vorausgesetzt dass der sedex Client inklusive der Option Webservice-Proxy gemaumlss [sedexClient] installiert wurde

Das vorliegende Dokument setzt den Fokus auf das AAR fuumlr die Personen-Identifikation also die Definitionsdatei fuumlr den sedex-Webservice-Proxy zu diesem Webservice Mit der Integra-tionsanleitung [IntAnleitung] gibt es aber eine umfassendere Anleitung welche als erste Lek-tuumlre eher empfohlen sei

12 Content Based Routing (CBR)

Der Webservice zur Personenidentifikation soll nicht zentral sondern von einer relativ gros-sen Anzahl (dutzenderhunderter) heterogener und dezentral organisierter EK-Systeme reali-siert werden Je nach politischer Gemeinde ist somit ein anderer bestimmter Webservice fuumlr die Personenidentifikation zustaumlndig

Die Kommunikation zur Personenidentifikation zwischen Client und Server erfordert also ein inhaltsbasiertes Umleiten der Anfragen (sog Content Based Routing1 CBR)

Damit Content Based Routing angewendet werden kann muumlssen folgende Voraussetzungen erfuumlllt sein

1 Content muss Routing-Kriterium enthalten

Eine Anfrage zur Personenidentifikation muss den Identifikator der betroffenen politischen Ge-

meinde enthalten Diese Anforderung ist bei der Spezifikation der Webservices zu beruumlcksich-

tigen

2 Kommunikation erfordert Service-Lookup

Entweder muss der Client (hier die Portal-Applikation) oder ein zwischengeschalteter Service-

Proxy einen Service-Lookup vornehmen um aufgrund der im Content enthaltenen politischen

Gemeinde den zustaumlndigen Ziel-Service bestimmen zu koumlnnen

3 Service-Directory muss verfuumlgbar sein

Fuumlr den Service-Lookup muss in einem Directory die fuumlr eine politische Gemeinde zustaumlndige

Webservice-Implementation definiert sein Gefuumlhrt werden im Directory konkret mindestens

der Gemeinde-Identifikator und der zugehoumlrige Webservice-Endpunkt (eine URI2) Idealer-

weise sind zusaumltzlich noch die zu akzeptierenden 3SSL-Zertifikate des Webservices (zwecks

Authentifikation desselben) verfuumlgbar

4 Routing der Service-Anfrage erforderlich

1 CBR httpwwwitwisseninfodefinitionlexikonCBR-content-based-routinghtml 2 URI httpdewikipediaorgwikiUniform_Resource_Identifier 3 Damit auch ein Zertifikatswechsel unterbruchsfrei erfolgen kann sollten mindestens zwei Zertifikate pro Webservice-Endpunkt gefuumlhrt werden koumlnnen

Sedex Webservice-Proxy Benutzerhandbuch zum Personenidentifikations-Service (eUmzugCH)

sedex_eUmzug_AAR_benutzerhandbuch_V10docx 5 13

Die Anfrage des Portals muss letztlich an den aus dem Service-Lookup resultierenden Webs-

ervice adressiert werden (konkret an dessen URI) Entweder muss der Client (hier die Portal-

Applikation) oder ein zwischengeschalteter Service-Proxy dieses Routing vornehmen

In der realisierten Variante wird die Personenidentifikation durch eine einzige AAR-Konfigurationsdatei im WS-Proxy abgedeckt Dieses AAR ist fuumlr sedex neuartig indem es das Konzept des Content Based Routing (CBR) realisiert Als Vorteile sind die Entlastung der Portallogik vom Routing und die Reduktion der Webservice-Endpunkte gegenuumlber dem Portal zu sehen

13 Hinweis zur Aktualitaumlt des Service-Verzeichnis

Das Service-Verzeichnis aller Endpunkte wird vom WS-Proxy nicht als Datei zwischenge-speichert sondern ist einzig zur Laufzeit im Hauptspeicher verfuumlgbar Somit muss das Ser-vice-Verzeichnis nach jedem Neustart des WS-Proxy mit dem ersten Zugriff auf eine Perso-nenidentifikation zuerst neu vom sedex Server herunter geladen werden Kann nach einem Neustart des WS-Proxy das Service-Verzeichnis nicht heruntergeladen werden dann fehlt dem WS-Proxy das benoumltigte Service-Verzeichnis In so einem Fall kann er allfaumlllige Personenidendifikationsanfragen nicht erfolgreich abarbeiten und antwortet mit einem SOAP-Fault Mit jeder neuen Anfrage wird der WS-Proxy aber versuchen das Ser-vice-Verzeichnis doch noch herunterzuladen Im normalen Betrieb sorg der WS-Proxy dafuumlr dass das Service-Verzeichnis perio-disch erneuert wird Standardmaumlssig ist dies 24h nach dem letzten Download der Fall

Sedex Webservice-Proxy Benutzerhandbuch zum Personenidentifikations-Service (eUmzugCH)

sedex_eUmzug_AAR_benutzerhandbuch_V10docx 6 13

2 Installation des Personenidentifikations-Ser-vices

21 Lieferumfang

Folgende Dateien werden zum Installieren des Personenidentifikations-Services in ihrer aktu-ellsten Version benoumltigt

22 Vorbedingungen

Um das Personeidentifikationsmodul installieren zu koumlnnen muss bereits ein sedex Client in der Version 40 oder houmlher installiert und fertig konfiguriert sein Details zum sedex Client und der WS-Proxy-Komponente sind den jeweiligen Handbuumlchern [sedexClient] und [WS-Proxy] zu entnehmen

23 Netzwerk Firewall

Damit der Service ordnungsgemaumlss funktionieren kann muss der sedex Client ausgehende Verbindungen zu folgendem Endpunkt aufbauen koumlnnen

sedex-serviceadminch Port 443 https-Protokoll

Wichtig Neben den Verbindungen zum sedex-Server muss der WS-Proxy zu allen Anbietern des Per-sonenidentifikations-Service eine Verbindung aufbauen koumlnnen (vgl Abschnitt 4 - Endpunkte des Personenidentifikationsservice)

Hinweis Falls in einer Betriebsumgebung fuumlr ausgehende https-Request ein Web-Proxyserver verwen-det werden muss ist dieser gemaumlss [WS-Proxy] in der WS-Proxy-Konfiguration einzutragen

24 Installation des Services in bestehendem sedex WS-Proxy

Der Personenidentifikationsservice wird als Webservice-Archive mit der Dateiendung bdquoAARldquo geliefert Die Installation eines solchen Webservice-Archivs wird dadurch vorgenommen dass die ent-sprechende Archivdatei einfach in das folgende Verzeichnis kopiert wird

Installationsverzeichnis [SedexClientDir]adapteraxis2repositoryservices

Sedex Webservice-Proxy Benutzerhandbuch zum Personenidentifikations-Service (eUmzugCH)

sedex_eUmzug_AAR_benutzerhandbuch_V10docx 6 13

2 Installation des Personenidentifikations-Ser-vices

21 Lieferumfang

Folgende Dateien werden zum Installieren des Personenidentifikations-Services in ihrer aktu-ellsten Version benoumltigt

22 Vorbedingungen

Um das Personeidentifikationsmodul installieren zu koumlnnen muss bereits ein sedex Client in der Version 40 oder houmlher installiert und fertig konfiguriert sein Details zum sedex Client und der WS-Proxy-Komponente sind den jeweiligen Handbuumlchern [sedexClient] und [WS-Proxy] zu entnehmen

23 Netzwerk Firewall

Damit der Service ordnungsgemaumlss funktionieren kann muss der sedex Client ausgehende Verbindungen zu folgendem Endpunkt aufbauen koumlnnen

sedex-serviceadminch Port 443 https-Protokoll

Wichtig Neben den Verbindungen zum sedex-Server muss der WS-Proxy zu allen Anbietern des Per-sonenidentifikations-Service eine Verbindung aufbauen koumlnnen (vgl Abschnitt 4 - Endpunkte des Personenidentifikationsservice)

Hinweis Falls in einer Betriebsumgebung fuumlr ausgehende https-Request ein Web-Proxyserver verwen-det werden muss ist dieser gemaumlss [WS-Proxy] in der WS-Proxy-Konfiguration einzutragen

24 Installation des Services in bestehendem sedex WS-Proxy

Der Personenidentifikationsservice wird als Webservice-Archive mit der Dateiendung bdquoAARldquo geliefert Die Installation eines solchen Webservice-Archivs wird dadurch vorgenommen dass die ent-sprechende Archivdatei einfach in das folgende Verzeichnis kopiert wird

Installationsverzeichnis [SedexClientDir]adapteraxis2repositoryservices

Sedex Webservice-Proxy Benutzerhandbuch zum Personenidentifikations-Service (eUmzugCH)

sedex_eUmzug_AAR_benutzerhandbuch_V10docx 7 13

25 Aktivieren der Verbindungstests fuumlr Aufrufe via Webbrowser

Um im Rahmen eines Monitorings der Webservice-Endpunkte das Resultat der Verbindungs-tests abfragen zu koumlnnen (zB mit einem normalen Webbrowser) muss in der Axis2-Konfigu-ration ein Parameter aktiviert werden

Konfigurationsdatei [SedexClientDir]adapteraxis2confaxis2xml

In dieser Datei muss der Parameter disableREST auf false gesetzt werden lt-- Following parameter will completely disable REST handling in Axis2--gt

ltparameter name=disableREST locked=truegtfalseltparametergt

26 Konfiguration Umgebung (Produktion oder Test)

Fuumlr das Content-Based-Routing auf den jeweils fuumlr eine bestimmte Gemeinde-ID zustaumlndigen Webservice-Endpunkt werden zentral Verzeichnisse fuumlr zwei Umgebungen gepflegt

Umgebung URL des Verzeichnis der Endpunkte

Produktion httpssedex-serviceadminchsedexupdatesdownloadsdirectoriespersonIdentificationpersonIdentificationDirectoryjar

Test httpssedex-serviceadminchsedexupdatesdownloadsdirectoriespersonIdentification-testpersonIdentificationDirectory-testjar

Automatische Konfiguration der verwendeten Umgebung

Wird das PersonIdentificationAAR in einem WS-Proxy mit einem sedex Test-Teilnehmer (se-dex-ID beginnt mit einem bdquoTldquo) verwendet so wird automatisch die Test-Umgebung aktiviert Fuumlr normale sedex-Teilnehmer wird automatisch die Produktions-Umgebung aktiviert

Manuelle Konfiguration der verwendeten Umgebung

Konfigurationsdatei [SedexClientDir]adapterconfwsproxyproperties

In dieser Datei kann der Parameter sedexwsproxyPersonIdentificationServiceenviron-

ment auf test oder prod gesetzt werden um die Automatik zu uumlbersteuern und die Umge-bung manuell zu setzen Manual configuration of environment for PersonIentification ldquotestrdquo or ldquoprodrdquo

sedexwsproxyPersonIdentificationServiceenvironment=prod

Sedex Webservice-Proxy Benutzerhandbuch zum Personenidentifikations-Service (eUmzugCH)

sedex_eUmzug_AAR_benutzerhandbuch_V10docx 8 13

3 Verwendung

Im Folgenden bezeichnet WS-Proxyhost die IP-Adresse oder den DNS-Host-Eintrag (sym-

bolischer Name) des Rechners auf dem der Webservice-Proxy installiert ist und WS-

Proxyport den Port auf dem der Webservice-Proxy seine Dienste anbietet

31 Personenidentifikation

Fuumlr Personenidentifikationen steht das bdquoPersonIdentificationServiceldquo-Interface zur Verfuumlgung Die Dokumentation dieses Interfaces ist in [eCH-0194] beschrieben

Endpunkt-URL httpWS-ProxyhostWS-ProxyportwsproxyservicesPersonIdentificationService

WSDL-URL httpWS-ProxyhostWS-ProxyportwsproxyservicesPersonIdentificationServicewsdl

32 Monitoring Verbindungstest

Mit Hilfe des Verbindungstest kann uumlberpruumlft werden ob alle verfuumlgbaren Endpunkte der Per-sonenidentifikation erreichbar sind

321 Verbindungstest zu allen Endpunkten via Webservice (SOAP)

Monitor-URL SOAP-Client

httpWS-ProxyhostWS-ProxyportwsproxyservicesPersonIdentificationServiceTest

WSDL-URL httpWS-ProxyhostWS-ProxyportwsproxyservicesPersonIdentificationServiceTestwsdl

322 Verbindungstest via Webbrowser (HTTP)

Monitor-URL Webbrowser

httpWS-ProxyhostWS-ProxyportwsproxyservicesPersonIdentificationServiceTestmonitor

Hinweis Damit der Verbindungstest uumlber den Webbrowser durchgefuumlhrt werden kann muss zuerst die Axis2-Konfiguration angepasst werden siehe Kapitel 25

Sedex Webservice-Proxy Benutzerhandbuch zum Personenidentifikations-Service (eUmzugCH)

sedex_eUmzug_AAR_benutzerhandbuch_V10docx 8 13

3 Verwendung

Im Folgenden bezeichnet WS-Proxyhost die IP-Adresse oder den DNS-Host-Eintrag (sym-

bolischer Name) des Rechners auf dem der Webservice-Proxy installiert ist und WS-

Proxyport den Port auf dem der Webservice-Proxy seine Dienste anbietet

31 Personenidentifikation

Fuumlr Personenidentifikationen steht das bdquoPersonIdentificationServiceldquo-Interface zur Verfuumlgung Die Dokumentation dieses Interfaces ist in [eCH-0194] beschrieben

Endpunkt-URL httpWS-ProxyhostWS-ProxyportwsproxyservicesPersonIdentificationService

WSDL-URL httpWS-ProxyhostWS-ProxyportwsproxyservicesPersonIdentificationServicewsdl

32 Monitoring Verbindungstest

Mit Hilfe des Verbindungstest kann uumlberpruumlft werden ob alle verfuumlgbaren Endpunkte der Per-sonenidentifikation erreichbar sind

321 Verbindungstest zu allen Endpunkten via Webservice (SOAP)

Monitor-URL SOAP-Client

httpWS-ProxyhostWS-ProxyportwsproxyservicesPersonIdentificationServiceTest

WSDL-URL httpWS-ProxyhostWS-ProxyportwsproxyservicesPersonIdentificationServiceTestwsdl

322 Verbindungstest via Webbrowser (HTTP)

Monitor-URL Webbrowser

httpWS-ProxyhostWS-ProxyportwsproxyservicesPersonIdentificationServiceTestmonitor

Hinweis Damit der Verbindungstest uumlber den Webbrowser durchgefuumlhrt werden kann muss zuerst die Axis2-Konfiguration angepasst werden siehe Kapitel 25

Sedex Webservice-Proxy Benutzerhandbuch zum Personenidentifikations-Service (eUmzugCH)

sedex_eUmzug_AAR_benutzerhandbuch_V10docx 9 13

4 Endpunkte des Personenidentifikationsservice

Die jeweils aktuellen Endpunkte des Personenidentifikationsservice koumlnnen pro Umgebung den zentralen Verzeichnissen entnommen werden

Umgebung URL des Verzeichnis der Endpunkte

Produktion httpssedex-serviceadminchsedexupdatesdownloadsdirectoriespersonIdentificationpersonIdentificationDirectoryjar

Test httpssedex-serviceadminchsedexupdatesdownloadsdirectoriespersonIdentification-testpersonIdentificationDirectory-testjar

Sedex Webservice-Proxy Benutzerhandbuch zum Personenidentifikations-Service (eUmzugCH)

sedex_eUmzug_AAR_benutzerhandbuch_V10docx 10 13

5 Test-Requests

Im Folgenden werden SOAP-Requests aufgefuumlhrt die zum Testen der Verfuumlgbarkeit des Webservice-Proxys und der dahinterliegenden Diensterbringer verwendet werden koumlnnen

Die Requests koumlnnen zB mit Hilfe des frei erhaumlltlichen Programms bdquosoapUIldquo (wwwsoapuiorg) an die entsprechenden Webservice-Proxy-Endpunkte geschickt werden

Hinweis Typische Antworten sind Kapitel 6 zu entnehmen

51 Personenidentifikation searchPersonIdentification

Im folgenden Request ist der CBR-Parameter municipalityId mit 1 oder 2 zu ersetzen

um entweder den Server bdquoIntegration ZHSldquo bzw bdquoIntegration KStAldquo zu erreichen

ltsoapenvEnvelope

xmlnssoapenv=httpschemasxmlsoaporgsoapenvelope

xmlnsweb=httpwwwechchxmlnseCH-01941webservice

xmlnsns=httpwwwechchxmlnseCH-00585 xmlnsns1=httpwwwechchxmlnseCH-01941

xmlnsns2=httpwwwechchxmlnseCH-00444

xmlnsns3=httpwwwechchxmlnseCH-00075gt

ltsoapenvHeadergt

ltsoapenvBodygt

ltwebsearchPersonIdentificationgt

ltheadergt

ltnssenderIdgtltnssenderIdgt

ltnsmessageIdgtltnsmessageIdgt

ltnsmessageTypegtltnsmessageTypegt

ltnssendingApplicationgt

ltnsmanufacturergtltnsmanufacturergt

ltnsproductgtltnsproductgt

ltnsproductVersiongtltnsproductVersiongt

ltnssendingApplicationgt

ltnsmessageDategtltnsmessageDategt

ltnsactiongtltnsactiongt

ltnstestDeliveryFlaggtltnstestDeliveryFlaggt

ltheadergt

ltpersonMoveRequestgt

ltns1personIdentificationgt

ltns2localPersonIdgt

ltns2personIdCategorygtltns2personIdCategorygt

ltns2personIdgtltns2personIdgt

ltns2localPersonIdgt

ltns2officialNamegtltns2officialNamegt

ltns2firstNamegtltns2firstNamegt

ltns2sexgtltns2sexgt

ltns2dateOfBirthgt

ltns2yearMonthDaygtltns2yearMonthDaygt

ltns2dateOfBirthgt

ltns1personIdentificationgt

ltns1municipalitygt

ltns3municipalityIdgt1ltns3municipalityIdgt ltns3municipalityNamegtltns3municipalityNamegt

ltns1municipalitygt

ltpersonMoveRequestgt

ltwebsearchPersonIdentificationgt

ltsoapenvBodygt

ltsoapenvEnvelopegt

Hinweis Die beiden Mock-Services schreiben jeweils ihren Namen in die Antwort Der Name ist zu finden im Element municipalityName

ltsoapenvEnvelope

xmlnssoapenv=httpschemasxmlsoaporgsoapenvelopegt

ltsoapenvBodygt

[]

ltns5municipalityNamegt serverIntegration KStAltns5municipalityNamegt []

ltsoapenvBodygt

Sedex Webservice-Proxy Benutzerhandbuch zum Personenidentifikations-Service (eUmzugCH)

sedex_eUmzug_AAR_benutzerhandbuch_V10docx 10 13

5 Test-Requests

Im Folgenden werden SOAP-Requests aufgefuumlhrt die zum Testen der Verfuumlgbarkeit des Webservice-Proxys und der dahinterliegenden Diensterbringer verwendet werden koumlnnen

Die Requests koumlnnen zB mit Hilfe des frei erhaumlltlichen Programms bdquosoapUIldquo (wwwsoapuiorg) an die entsprechenden Webservice-Proxy-Endpunkte geschickt werden

Hinweis Typische Antworten sind Kapitel 6 zu entnehmen

51 Personenidentifikation searchPersonIdentification

Im folgenden Request ist der CBR-Parameter municipalityId mit 1 oder 2 zu ersetzen

um entweder den Server bdquoIntegration ZHSldquo bzw bdquoIntegration KStAldquo zu erreichen

ltsoapenvEnvelope

xmlnssoapenv=httpschemasxmlsoaporgsoapenvelope

xmlnsweb=httpwwwechchxmlnseCH-01941webservice

xmlnsns=httpwwwechchxmlnseCH-00585 xmlnsns1=httpwwwechchxmlnseCH-01941

xmlnsns2=httpwwwechchxmlnseCH-00444

xmlnsns3=httpwwwechchxmlnseCH-00075gt

ltsoapenvHeadergt

ltsoapenvBodygt

ltwebsearchPersonIdentificationgt

ltheadergt

ltnssenderIdgtltnssenderIdgt

ltnsmessageIdgtltnsmessageIdgt

ltnsmessageTypegtltnsmessageTypegt

ltnssendingApplicationgt

ltnsmanufacturergtltnsmanufacturergt

ltnsproductgtltnsproductgt

ltnsproductVersiongtltnsproductVersiongt

ltnssendingApplicationgt

ltnsmessageDategtltnsmessageDategt

ltnsactiongtltnsactiongt

ltnstestDeliveryFlaggtltnstestDeliveryFlaggt

ltheadergt

ltpersonMoveRequestgt

ltns1personIdentificationgt

ltns2localPersonIdgt

ltns2personIdCategorygtltns2personIdCategorygt

ltns2personIdgtltns2personIdgt

ltns2localPersonIdgt

ltns2officialNamegtltns2officialNamegt

ltns2firstNamegtltns2firstNamegt

ltns2sexgtltns2sexgt

ltns2dateOfBirthgt

ltns2yearMonthDaygtltns2yearMonthDaygt

ltns2dateOfBirthgt

ltns1personIdentificationgt

ltns1municipalitygt

ltns3municipalityIdgt1ltns3municipalityIdgt ltns3municipalityNamegtltns3municipalityNamegt

ltns1municipalitygt

ltpersonMoveRequestgt

ltwebsearchPersonIdentificationgt

ltsoapenvBodygt

ltsoapenvEnvelopegt

Hinweis Die beiden Mock-Services schreiben jeweils ihren Namen in die Antwort Der Name ist zu finden im Element municipalityName

ltsoapenvEnvelope

xmlnssoapenv=httpschemasxmlsoaporgsoapenvelopegt

ltsoapenvBodygt

[]

ltns5municipalityNamegt serverIntegration KStAltns5municipalityNamegt []

ltsoapenvBodygt

Sedex Webservice-Proxy Benutzerhandbuch zum Personenidentifikations-Service (eUmzugCH)

sedex_eUmzug_AAR_benutzerhandbuch_V10docx 11 13

ltsoapenvEnvelopegt

52 Verbindungstest (via SOAP)

ltsoapenvEnvelope

xmlnssoapenv=httpschemasxmlsoaporgsoapenvelope

xmlnscon=httpwwwsedexchWS-Proxycontent-based-routinggt

ltsoapenvHeadergt

ltsoapenvBodygt

ltconmonitorRequestgt

ltsoapenvBodygt

ltsoapenvEnvelopegt

Sedex Webservice-Proxy Benutzerhandbuch zum Personenidentifikations-Service (eUmzugCH)

sedex_eUmzug_AAR_benutzerhandbuch_V10docx 12 13

6 Beispielantworten

61 Personenidentifikationsservice

SOAP-Fehler das Routing-Directory kann nicht von den Sedex-Servern heruntergela-den werden

ltsoapenvEnvelope

xmlnssoapenv=httpschemasxmlsoaporgsoapenvelopegt

ltsoapenvBodygt

ltsoapenvFaultgt

ltfaultcodegtsoapenvServerltfaultcodegt

ltfaultstringgt

An exception occured See log for details

ltfaultstringgt

ltdetailgt

chadminbitsedexWS-ProxyproxywscbrRoutingException Could not download

the routing info from the sedex server server certificate not found in trustStore

ltdetailgt

ltsoapenvFaultgt

ltsoapenvBodygt

ltsoapenvEnvelopegt

SOAP-Fehler zur Gemeinde ID wurde im Routing-Directory kein passender Endpunkt gefunden

ltsoapenvEnvelope xmlnssoapenv=httpschemasxmlsoaporgsoapenvelopegt

ltsoapenvBodygt

ltsoapenvFaultgt

ltfaultcodegtsoapenvServerltfaultcodegt

ltfaultstringgt

An exception occured See log for details

ltfaultstringgt

ltdetailgt

chadminbitsedexWS-ProxyproxywscbrRoutingException Could not find a

matching route (municipalityId = 3)

ltdetailgt

ltsoapenvFaultgt

ltsoapenvBodygt

ltsoapenvEnvelopegt

62 Verbindungstest

Alle Verbindungenstests erfolgreich

ltsoapenvEnvelope xmlnssoapenv=httpschemasxmlsoaporgsoapenvelopegt

ltsoapenvBodygt

ltns1monitorResult xmlnsns1=httpwwwsedexchWS-Proxycontent-based-routinggt

ltserviceDirectorygt

ltserviceNamegtPersonIdentificationServiceltserviceNamegt

ltdateLastSuccessfulUpdategt2015-06-01T150340928+0200ltdateLastSuccessfulUpdategt

ltstatusLastUpdategtOKltstatusLastUpdategt

ltupdateIntervalInSecondsgt60ltupdateIntervalInSecondsgt

ltserviceDirectorygt

ltconnectionTestgt

ltokgt

lthostgt

httpsintksta-adminserviceszhchPersonIdentificationService_1_0PersonIdentification lthostgt

lthostgt

httpsintzhs-adminserviceszhchPersonIdentificationService_1_0PersonIdentification lthostgt

ltokgt

ltconnectionTestgt

ltns1monitorResultgt

ltsoapenvBodygt

Sedex Webservice-Proxy Benutzerhandbuch zum Personenidentifikations-Service (eUmzugCH)

sedex_eUmzug_AAR_benutzerhandbuch_V10docx 12 13

6 Beispielantworten

61 Personenidentifikationsservice

SOAP-Fehler das Routing-Directory kann nicht von den Sedex-Servern heruntergela-den werden

ltsoapenvEnvelope

xmlnssoapenv=httpschemasxmlsoaporgsoapenvelopegt

ltsoapenvBodygt

ltsoapenvFaultgt

ltfaultcodegtsoapenvServerltfaultcodegt

ltfaultstringgt

An exception occured See log for details

ltfaultstringgt

ltdetailgt

chadminbitsedexWS-ProxyproxywscbrRoutingException Could not download

the routing info from the sedex server server certificate not found in trustStore

ltdetailgt

ltsoapenvFaultgt

ltsoapenvBodygt

ltsoapenvEnvelopegt

SOAP-Fehler zur Gemeinde ID wurde im Routing-Directory kein passender Endpunkt gefunden

ltsoapenvEnvelope xmlnssoapenv=httpschemasxmlsoaporgsoapenvelopegt

ltsoapenvBodygt

ltsoapenvFaultgt

ltfaultcodegtsoapenvServerltfaultcodegt

ltfaultstringgt

An exception occured See log for details

ltfaultstringgt

ltdetailgt

chadminbitsedexWS-ProxyproxywscbrRoutingException Could not find a

matching route (municipalityId = 3)

ltdetailgt

ltsoapenvFaultgt

ltsoapenvBodygt

ltsoapenvEnvelopegt

62 Verbindungstest

Alle Verbindungenstests erfolgreich

ltsoapenvEnvelope xmlnssoapenv=httpschemasxmlsoaporgsoapenvelopegt

ltsoapenvBodygt

ltns1monitorResult xmlnsns1=httpwwwsedexchWS-Proxycontent-based-routinggt

ltserviceDirectorygt

ltserviceNamegtPersonIdentificationServiceltserviceNamegt

ltdateLastSuccessfulUpdategt2015-06-01T150340928+0200ltdateLastSuccessfulUpdategt

ltstatusLastUpdategtOKltstatusLastUpdategt

ltupdateIntervalInSecondsgt60ltupdateIntervalInSecondsgt

ltserviceDirectorygt

ltconnectionTestgt

ltokgt

lthostgt

httpsintksta-adminserviceszhchPersonIdentificationService_1_0PersonIdentification lthostgt

lthostgt

httpsintzhs-adminserviceszhchPersonIdentificationService_1_0PersonIdentification lthostgt

ltokgt

ltconnectionTestgt

ltns1monitorResultgt

ltsoapenvBodygt

Sedex Webservice-Proxy Benutzerhandbuch zum Personenidentifikations-Service (eUmzugCH)

sedex_eUmzug_AAR_benutzerhandbuch_V10docx 13 13

ltsoapenvEnvelopegt

Die Verbindung zu einem Host war nicht erfolgreich

ltsoapenvEnvelope xmlnssoapenv=httpschemasxmlsoaporgsoapenvelopegt

ltsoapenvBodygt

ltns1monitorResult xmlnsns1=httpwwwsedexchWS-Proxycontent-based-routinggt

ltserviceDirectorygt

ltserviceNamegtPersonIdentificationServiceltserviceNamegt

ltdateLastSuccessfulUpdategt2015-06-01T150340928+0200ltdateLastSuccessfulUpdategt

ltstatusLastUpdategtOKltstatusLastUpdategt

ltupdateIntervalInSecondsgt60ltupdateIntervalInSecondsgt

ltserviceDirectorygt

ltconnectionTestgt

ltokgt

lthostgt

httpsintksta-adminserviceszhchPersonIdentificationService_1_0Person-

Identification

lthostgt

ltokgt

ltnotokgt

lterrorgt

lthostgt

httpsintzhs-adminserviceszhchPersonIdentificationService_1_0Per-

sonIdentification

lthostgt

ltmessagegt

Could not connect to the server got an IO Problem connect timed out

ltmessagegt

lterrorgt

ltnotokgt

ltconnectionTestgt

ltns1monitorResultgt

ltsoapenvBodygt

ltsoapenvEnvelopegt