Änderungen von Dokument Plugin Setup


Von Version 1.1
bearbeitet von sas
am 25.02.2022, 16:15
Änderungskommentar: Es gibt keinen Kommentar für diese Version
Auf Version 8.1
bearbeitet von sas
am 09.03.2022, 11:02
Änderungskommentar: Es gibt keinen Kommentar für diese Version

Zusammenfassung

Details

Seiteneigenschaften
Titel
... ... @@ -1,1 +1,1 @@
1 -Einrichtung
1 +Plugin Setup
Inhalt
... ... @@ -1,1 +1,84 @@
1 -~-~- IN BEARBEITUNG ~-~-
1 +{{content/}}
2 +
3 +== Vertragliche Voraussetzungen ==
4 +
5 +Damit das ePayment der AKDB in FORMCYCLE eingerichtet werden kann, muss zuvor ein Vertrag mit der AKDB geschlossen werden. Der Antrag kann dabei formlos von der AKDB, über die Mail-Adresse** BayernID@akdb.de**, angefordert werden. Dabei sollte angegebenen werden, ob das Test- oder Live-ePayment-System der AKDB angebunden werden soll.
6 +
7 +Ist bereits ein Vertrag über das ePayment mit der AKDB vorhanden, so kann dieser herangezogen werden und mit dem Schritt der Initialen Installation fortgesetzt werden.
8 +
9 +
10 += Initiale Installation =
11 +
12 +== AKDB ePay Setup - Schritt 1 ==
13 +
14 +=== Voraussetzungen ===
15 +
16 +* Es wurde ein Vertrag über das ePayment mit der AKDB geschlossen und die notwendigen Daten (AKDB-EPayment-Mandant) liegen vor.
17 +* Bei Anbindung des **ePayment Live-Systems** muss zusätzlich ein Zertifikat für den Zugriff auf den Payment-Webservice von der AKDB vorhanden sein.
18 +** Sollte bereits das Live-System vom **AKDB Bürgerkonto-Service / Postkorb** angebunden sein, so kann dieses Zertifikat für den Zugriff verwendet werden.
19 +** Ist der vorherige Punkt nicht gegeben, so muss dies explizit bei der AKDB angefordert werden.
20 +* Das Plugin-Bundle //**plugin-bundle-akdb-epayment.jar**// ist vorhanden und kompatibel mit der installierten FORMCYCLE-Version.
21 +
22 +=== Installationsschritte ===
23 +
24 +* Anmeldung als **sadmin **am FORMCYCLE-System.
25 +* Wechsel in den FORMCYCLE-Mandanten, welcher eine Anbindung an das AKDB-Bürgerkonto erhalten soll.
26 +Sollte ein Auswahl des Mandanten nicht möglich sein, dann muss dies als Mandant-Administrator noch freigebeben werden. Die Einstellung finden Sie unter Mandant > [[Einstellungen>>doc:Formcycle.UserInterface.Client.SupportAccess.WebHome||target="_blank"]].
27 +* Registrierung des **//plugin-bundle-akdb-epayment.jar//** Plugins im Bereich des FROMCYCLE-Mandanten (Menüpunkt: Mandant > [[Plugins>>doc:Formcycle.UserInterface.Client.Plugins||target="_blank"]]).
28 +* Jetzt ist ein neuer Menüpunkt **AKDB ePay Setup** vorhanden, welcher aufgerufen werden muss.
29 +{{info}}Hinweis: Sollte der Menüpunkt nicht sofort ersichtlich sein, ist ein Abmelden und anschließendes Anmelden als sadmin mit Wechsel in den Mandanten notwendig.{{/info}}
30 +* Beim Aufruf des Setups muss jetzt der Punkt **Zur Anbindung ePay-BL Umgebung** ausgeführt werden.
31 +Zu Beginn müssen Sie sich entscheiden, ob Sie die Test- oder Liveumgebung des AKDB EPayment Dienstes anbinden möchen. Liegt ein Vertrag bereits vor, so können auch alle weiteren Daten zum AKDB ePayment Mandanten hinterlegt und gespeichert werden.
32 +* Nach dem Speichern werden die Daten in den Properties des Plugins entsprechend hinterlegt.
33 +
34 +{{warning}}
35 +**Hinweise zur Erreichbarkeit notwendiger System-URLs**
36 +
37 +Bitte konfigurieren Sie gegebenenfalls ihre Firewall hinsichtlich der Erreichbarkeit der nachfolgenden URL(s).
38 +\\Folgende URL(s) müssen von **Extern erreichbar** sein, damit eine Rückmeldung vom ePay-BL-Portal korrekt verarbeitet werden kann:
39 +
40 +* https:~/~/<//Domain-Adresse des Master-Servers//>/formcycle/plugin (Master-Server)
41 +ODER
42 +* https:~/~/<//Domain-Adresse des Frontend-Servers//>/frontend-server/plugin (Frontend-Server)
43 +
44 +Folgende URL muss **vom FORMCYCLE Master-Server aus erreichbar** sein:
45 +
46 +* Testsystem: https:~/~/infra-pre.buergerserviceportal.de/soap/servlet/rpcrouter
47 +ODER
48 +* Livesystem: https:~/~/buergerserviceportal.de/soap/servlet/rpcrouter
49 +{{/warning}}
50 +
51 +Damit ist der 1. Schritt der Einrichtung abgeschlossen. Bei Anbindung des Testsystem ist die Einrichtung hiermit abgeschlossen.
52 +
53 +== AKDB ePay Setup - Schritt 2 ==
54 +
55 +=== Vorbedingungen ===
56 +
57 +* Dieser Installationsschritt muss nur ausgeführt werden, wenn das ePayment Live-System angebunden werden soll.
58 +* Bei Anbindung des ePayment Test-Systems ist kein Zugriffs-Zertifikat notwendig und kann deshalb auch nicht hinterlegt werden.
59 +
60 +=== Installationsschritte ===
61 +
62 +* Aufruf des Menüpunkt **AKDB ePay Setup** und dort **Zur Zertifikats-Registrierung und Verbindungsprüfung** ausführen.
63 +* Das von der AKDB erhaltene Zertifikat muss hochgeladen und das Zertifikats-Passwort hinterlegt werden.
64 +* Anschließend kann der Button **Prüfen und Speichern** geklickt werden.
65 +Damit wird das Zertifikat im System gespeichert und an den Plugin-Einstellungen registriert.
66 +Weiterhin wird versucht mit dem hinterlegten Passwort auf das Zertifikat zuzugreifen und bei Erfolg wird das Gültigkeitsdatum des Zertifikats angezeigt.
67 +* Mit dem Button **Verbindung zu ePay-BL prüfen** kann jetzt testweise eine Verbindungsprüfung stattfinden. Dabei wird ebenfalls im Vorfeld eine Zertifikatsprüfung durchgeführt.
68 +Wenn der ePayment-Webservice nicht erreicht werden kann, so sind gegebenenfalls Firewall-Einstellungen zu prüfen. Die konkrete URL zum Webservice wird dabei in der Fehlermeldung angezeigt. Der Aufbau der Webservice-Verbindung muss dabei vom FORMCYCLE Master-Server oder Frontend-Server aus möglich sein (siehe Hinweis oben).
69 +{{info}}Hinweis: Für eine vollständige Prüfung des Webservice-Zugriffs muss im Vorfeld die EPayment-MandantNr konfiguriert sein. Ansonst findet an dieser Stelle nur eine generelle Verbindungsprüfung statt.{{/info}}
70 +
71 +Damit ist die Konfiguration abgeschlossen.
72 +
73 +
74 += Anpassungen zum späteren Zeitpunkt =
75 +
76 +== Aktualisierung des Zugriffszertifikats für den AKDB ePayment LIVE-Service ==
77 +
78 +=== Vorbedingung ===
79 +
80 +Sie haben ein neues Zertifikat für den Zugriff auf den AKDB-ePayment Webservice erhalten, da ihr altes Zertifikat abgelaufen ist
81 +
82 +=== Vorgehen ===
83 +
84 +Folgen Sie der Anleitung unter dem Punkt **AKDB ePay Setup** - Schritt 2: [[Installationsschritte>>doc:]] und aktualisieren Sie ihr Zertifikat.