Wiki-Quellcode von ePayBL Setup

Verstecke letzte Bearbeiter
fse 2.1 1 [[**Plugin download**>>url:https://customer.formcycle.eu/index.php/apps/files/?dir=/FORMCYCLE%20-%20Plugins%20Customer/ePayBL%3A%20Epayment%20Plugin%20(plugin-bundle-epaybl)&fileid=50473||rel="noopener noreferrer" target="_blank"]] (Anmeldung erforderlich)
2
3 {{content/}}
4
5 == Vertragliche Voraussetzungen ==
6
7 Damit das ePayment in FORMCYCLE eingerichtet werden kann, muss zuvor ein Vertrag mit dem ePayBL Anbieter geschlossen werden.
8
fse 7.1 9 Ist bereits ein Vertrag über das ePayment mit dem ePayBL Anbieter vorhanden, so kann dieser herangezogen werden und mit dem Schritt der Installation als Systemadministrator fortgesetzt werden.
fse 2.1 10
11
fse 7.1 12 === Voraussetzungen ===
fse 2.1 13
14 * Die notwendigen Daten des ePayBL-EPayment Mandanten liegen vor.
15 * Ein Zertifikat für den Zugriff auf den ePayment-Webservice ist vorhanden.
16 ** Sollte bereits das Live-System vom **AKDB Bürgerkonto-Service / Postkorb** angebunden sein, so kann dieses Zertifikat für den Zugriff verwendet werden.
17 * Das Plugin-Bundle //**plugin-bundle-epaybl.jar**// ist vorhanden und kompatibel mit der installierten FORMCYCLE-Version.
18
fse 7.1 19 == Migration einer bestehenden Installation ==
fse 2.1 20
fse 9.1 21 Falls Sie bereits das [[**AKDB: EPayment-Plugin** >>url:https://help.formcycle.de/xwiki/bin/view/Formcycle/PluginDocumentation/AkdbEPaymentPlugin/]] in Ihren Mandanten installiert haben, können Sie wie folgt vorgehen:
22
23 : Notieren Sie sich Ihre bisherigen Angaben
24 ; Mandant-Nummer, Bewirtschafter-Nummer, Haushaltsstelle, Objektnummer und Kennzeichen-Mahnverfahren sowie Angaben Ihres Proxy falls vorhanden.
25 : Stellen Sie Zertifikat und Passwort sicher, dieses wird auch für Ihr Testsystem benötigt.
26 : Prüfen Sie die URL Ihres ePayBL-Providers
27 ; Für das Testsystem war dies bisher **//https://infra-pre.buergerserviceportal.de//**.//**
28 ; Für das Livesystem war dies bisher **//https://epay.akdb.de//**.//**
29
30 Nun muss das alte //AKDB: EPayment-Plugin// im Mandanten deaktiviert werden. Ansonsten ist der Menüpunkt //ePayBL Setup// im Mandanten nicht sichtbar. Das neue //ePayBL: EPayment-Plugin// wird nur ausgeführt, wenn das alte //AKDB: EPayment-Plugin// deaktiviert wurde. Die Umstellung auf das neue Plugin kann sukzessiv erfolgen, das heißt das alte //AKDB: EPayment-Plugin// muss nicht sofort in jedem Mandanten deaktiviert werden. Somit kann die Installation erst einmal in einem (Test-)Mandanten erfolgen.
31
fse 7.1 32 {{info}}
fse 9.1 33 Es müssen keine Änderungen am Formular, weder Designer noch Workflow, durchgeführt werden. Jedoch gibt es keine Unterstützung für Formulare mit altem {{formcyle/}} Workflow.
fse 7.1 34 {{/info}}
fse 2.1 35
fse 7.1 36 == Installation als Systemadministrator ==
37
38 {{figure image="epaybl-system.png"}}
39 Der **sadmin** gibt hier URL des Providers, Zertifikat sowie Passwort und Proxy vor.
40 {{/figure}}
41
42 Das Plugin wird als System-Plugin installiert.
43
44
45 === Obligatorische Installationsschritte ===
46
fse 2.1 47 * Anmeldung als **sadmin **am FORMCYCLE-System.
48 * Registrierung des **//plugin-bundle-epaybl.jar//** Plugins im Bereich der System-Plugins.
49
fse 8.1 50 === Fakultative Installationsschritte ===
51
fse 2.1 52 * Jetzt ist ein neuer Menüpunkt **ePayBL Setup** vorhanden, welcher aufgerufen werden kann.
53 {{info}}Hinweis: Sollte der Menüpunkt nicht sofort ersichtlich sein, ist ein Abmelden und anschließendes Anmelden als sadmin notwendig.{{/info}}
54 * Hier kann der Xima® Formcycle-Administrator Default-Werte hinterlegen, welche den Mandanten als Platzhalter angezeigt werden und jenes Feld nicht ausfüllen müssen.
55 * Für genauere Informationen zu den einzelnen Eingabefeldern siehe //ePayBL Setup - Mandant//.
56
fse 8.1 57 == ePayBL Setup - Mandant ==
58
fse 2.1 59 {{figure image="epaybl-client.png"}}
60 Der Mandant muss hier alle weiteren Felder ausfüllen, um das Setup zu speichern.
61 {{/figure}}
62
fse 8.1 63 === Obligatorische Installationsschritte ===
fse 2.1 64
65 * Anmeldung in den FORMCYCLE-Mandanten, welcher eine Anbindung erhalten soll.
66 * Jetzt ist ein neuer Menüpunkt **ePayBL Setup** vorhanden, welcher aufgerufen werden muss.
67 * Nun müssen alle Werte hinterlegt werden, außer es existieren bereits Default-Werte:
68
69 ; URL des Providers
70 : Die URL der anzubindenen Umgebung. Default-Wert wird als Platzhalter angezeigt. Änderungen des Default-Wertes durch den Xima® Formcycle-Administrator werden im Platzhalter sichtbar.
71 ; Mandant-Nummer
72 : Die Mandant-Nummer ist den ePayBL Vertragsdaten zu entnehmen. Default-Wert wird als Platzhalter angezeigt. Änderungen des Default-Wertes durch den Xima® Formcycle-Administrator werden im Platzhalter sichtbar.
73 ; Bewirtschafter-Nummer
74 : Die Bewirtschafter-Nummer ist den ePayBL Vertragsdaten zu entnehmen. Default-Wert wird als Platzhalter angezeigt. Änderungen des Default-Wertes durch den Xima® Formcycle-Administrator werden im Platzhalter sichtbar.
75 ; Haushaltsstelle
76 : Die Haushaltsstelle ist den ePayBL Vertragsdaten zu entnehmen. Default-Wert wird als Platzhalter angezeigt. Änderungen des Default-Wertes durch den Xima® Formcycle-Administrator werden im Platzhalter sichtbar.
77 ; Objekt-Nummer
78 : Die Objekt-Nummer ist den ePayBL Vertragsdaten zu entnehmen. Default-Wert wird als Platzhalter angezeigt. Änderungen des Default-Wertes durch den Xima® Formcycle-Administrator werden im Platzhalter sichtbar.
79 ; Kennzeichen-Mahnverfahren
80 : Das Kennzeichen-Mahnverfahren ist den ePayBL Vertragsdaten zu entnehmen. Default-Wert wird als Platzhalter angezeigt. Änderungen des Default-Wertes durch den Xima® Formcycle-Administrator werden im Platzhalter sichtbar.
81 ; Fälligkeitszeitraum (in Tagen)
82 : Der Fälligkeitszeitraum ist frei wählbar. Default-Wert wird als Platzhalter angezeigt. Änderungen des Default-Wertes durch den Xima® Formcycle-Administrator werden im Platzhalter sichtbar.
83 ; Buchungstext auf der PayPage
84 : Der Buchungstext ist frei wählbar. Default-Wert wird als Platzhalter angezeigt. Änderungen des Default-Wertes durch den Xima® Formcycle-Administrator werden im Platzhalter sichtbar.
85 ; Unterstütze Zahlverfahren
86 : Eingrenzung der Zahlverfahren nötig. Default-Auswahl wird initial übernommen. Änderungen der Default-Auswahl durch den Xima® Formcycle-Administrator überschreibt keine bestehende Auswahl der Zahlverfahren in Mandanten.
87 ; Zertifikat
88 : Dieses muss im Format **//p12//** sein. Default-Zertifikat wird initial übernommen. Änderungen des Default-Zertifikats durch den Xima® Formcycle-Administrator überschreibt kein bestehendes Zertifikat in Mandanten.
89 ; Passwort
90 : Passwort zum entschlüsseln des Zertifikats. Default-Passwort wird initial übernommen. Änderungen des Default-Passwortes durch den Xima® Formcycle-Administrator überschreibt kein bestehendes Passwort in Mandanten.
91 ; Hostname oder IP des zu verwenden Proxy-Servers
92 : Default-Wert wird als Platzhalter angezeigt. Änderungen des Default-Wertes durch den Xima® Formcycle-Administrator werden im Platzhalter sichtbar.
93 ; Port
94 : Der Port zum Proxy-Host. Default-Wert wird als Platzhalter angezeigt. Änderungen des Default-Wertes durch den Xima® Formcycle-Administrator werden im Platzhalter sichtbar.
95
96 {{info}}
97 Hinweis: Nur wenn sowohl Hostname als auch Port angegeben sind, wird die Verbindung darüber aufgebaut.
98 {{/info}}
99
100 * Abschließend kann ein Verbindungstest durchgeführt werden. Dabei wird auch das Zertifikat geprüft, weswegen auch das Passwort stimmen muss.
101 * 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).
102
103 Damit ist die Konfiguration abgeschlossen.
104
105
106 {{warning}}
107 **Hinweise zur Erreichbarkeit notwendiger System-URLs**
108
109 Bitte konfigurieren Sie gegebenenfalls ihre Firewall hinsichtlich der Erreichbarkeit der nachfolgenden URL(s).
110 \\Folgende URL(s) müssen von **Extern erreichbar** sein, damit eine Rückmeldung vom ePayBL-Portal korrekt verarbeitet werden kann:
111
112 * https:~/~/<//Domain-Adresse des Master-Servers//>/formcycle/plugin (Master-Server)
113 ODER
114 * https:~/~/<//Domain-Adresse des Frontend-Servers//>/frontend-server/plugin (Frontend-Server)
115
116 Die URL der anzubindenden Umgebung muss **vom FORMCYCLE Master-Server aus erreichbar** sein.
117 {{/warning}}
118
119 == Anpassungen zum späteren Zeitpunkt ==
120
121 === Aktualisierung des Zugriffszertifikats für den ePayBL ePayment LIVE-Service ===
122
123 ==== Vorbedingung ====
124
125 Sie haben ein neues Zertifikat für den Zugriff auf den ePayBL Webservice erhalten, da ihr altes Zertifikat abgelaufen ist
126
127 ==== Vorgehen ====
128
129 Folgen Sie der Anleitung unter dem Punkt **ePayBL Setup** - Schritt 2: [[Installationsschritte>>doc:]] und aktualisieren Sie ihr Zertifikat.