Wiki-Quellcode von ePayBL Setup

Zeige letzte Bearbeiter
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
9 Ist bereits ein Vertrag über das ePayment mit dem ePayBL Anbieter vorhanden, so kann dieser herangezogen werden und mit dem Schritt der initialen Installation fortgesetzt werden.
10
11 == Initiale Installation ==
12
13 {{figure image="epaybl-system.png"}}
14 Der **sadmin** gibt hier URL des Providers, Zertifikat sowie Passwort und Proxy vor.
15 {{/figure}}
16
17 {{info}}
18 Bei einem Update von einem bestehenden [[**AKDB: EPayment-Plugin** >>url:https://help.formcycle.de/xwiki/bin/view/Formcycle/PluginDocumentation/AkdbEPaymentPlugin/]] sollte vorher dieses in allen Mandanten deaktiviert werden. Ansonsten kann das Setup im Mandanten nicht abgeschlossen werden.
19 {{/info}}
20
21 ==== Voraussetzungen ====
22
23 * Die notwendigen Daten des ePayBL-EPayment Mandanten liegen vor.
24 * Ein Zertifikat für den Zugriff auf den ePayment-Webservice ist vorhanden.
25 ** Sollte bereits das Live-System vom **AKDB Bürgerkonto-Service / Postkorb** angebunden sein, so kann dieses Zertifikat für den Zugriff verwendet werden.
26 * Das Plugin-Bundle //**plugin-bundle-epaybl.jar**// ist vorhanden und kompatibel mit der installierten FORMCYCLE-Version.
27
28 === ePayBL Setup - Systemadministrator ===
29
30
31 ==== Obligatorische Installationsschritte ====
32
33 * Anmeldung als **sadmin **am FORMCYCLE-System.
34 * Registrierung des **//plugin-bundle-epaybl.jar//** Plugins im Bereich der System-Plugins.
35
36 ==== Fakultative Installationsschritte ====
37
38 * Jetzt ist ein neuer Menüpunkt **ePayBL Setup** vorhanden, welcher aufgerufen werden kann.
39 {{info}}Hinweis: Sollte der Menüpunkt nicht sofort ersichtlich sein, ist ein Abmelden und anschließendes Anmelden als sadmin notwendig.{{/info}}
40 * Hier kann der Xima® Formcycle-Administrator Default-Werte hinterlegen, welche den Mandanten als Platzhalter angezeigt werden und jenes Feld nicht ausfüllen müssen.
41 * Für genauere Informationen zu den einzelnen Eingabefeldern siehe //ePayBL Setup - Mandant//.
42
43 === ePayBL Setup - Mandant ===
44
45 {{figure image="epaybl-client.png"}}
46 Der Mandant muss hier alle weiteren Felder ausfüllen, um das Setup zu speichern.
47 {{/figure}}
48
49 ==== Obligatorische Installationsschritte ====
50
51 * Anmeldung in den FORMCYCLE-Mandanten, welcher eine Anbindung erhalten soll.
52 * Jetzt ist ein neuer Menüpunkt **ePayBL Setup** vorhanden, welcher aufgerufen werden muss.
53 * Nun müssen alle Werte hinterlegt werden, außer es existieren bereits Default-Werte:
54
55 ; URL des Providers
56 : Die URL der anzubindenen Umgebung. Default-Wert wird als Platzhalter angezeigt. Änderungen des Default-Wertes durch den Xima® Formcycle-Administrator werden im Platzhalter sichtbar.
57 ; Mandant-Nummer
58 : 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.
59 ; Bewirtschafter-Nummer
60 : 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.
61 ; Haushaltsstelle
62 : 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.
63 ; Objekt-Nummer
64 : 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.
65 ; Kennzeichen-Mahnverfahren
66 : 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.
67 ; Fälligkeitszeitraum (in Tagen)
68 : 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.
69 ; Buchungstext auf der PayPage
70 : 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.
71 ; Unterstütze Zahlverfahren
72 : 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.
73 ; Zertifikat
74 : 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.
75 ; Passwort
76 : 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.
77 ; Hostname oder IP des zu verwenden Proxy-Servers
78 : Default-Wert wird als Platzhalter angezeigt. Änderungen des Default-Wertes durch den Xima® Formcycle-Administrator werden im Platzhalter sichtbar.
79 ; Port
80 : Der Port zum Proxy-Host. Default-Wert wird als Platzhalter angezeigt. Änderungen des Default-Wertes durch den Xima® Formcycle-Administrator werden im Platzhalter sichtbar.
81
82 {{info}}
83 Hinweis: Nur wenn sowohl Hostname als auch Port angegeben sind, wird die Verbindung darüber aufgebaut.
84 {{/info}}
85
86 * Abschließend kann ein Verbindungstest durchgeführt werden. Dabei wird auch das Zertifikat geprüft, weswegen auch das Passwort stimmen muss.
87 * 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).
88
89 Damit ist die Konfiguration abgeschlossen.
90
91
92 {{warning}}
93 **Hinweise zur Erreichbarkeit notwendiger System-URLs**
94
95 Bitte konfigurieren Sie gegebenenfalls ihre Firewall hinsichtlich der Erreichbarkeit der nachfolgenden URL(s).
96 \\Folgende URL(s) müssen von **Extern erreichbar** sein, damit eine Rückmeldung vom ePayBL-Portal korrekt verarbeitet werden kann:
97
98 * https:~/~/<//Domain-Adresse des Master-Servers//>/formcycle/plugin (Master-Server)
99 ODER
100 * https:~/~/<//Domain-Adresse des Frontend-Servers//>/frontend-server/plugin (Frontend-Server)
101
102 Die URL der anzubindenden Umgebung muss **vom FORMCYCLE Master-Server aus erreichbar** sein.
103 {{/warning}}
104
105 == Anpassungen zum späteren Zeitpunkt ==
106
107 === Aktualisierung des Zugriffszertifikats für den ePayBL ePayment LIVE-Service ===
108
109 ==== Vorbedingung ====
110
111 Sie haben ein neues Zertifikat für den Zugriff auf den ePayBL Webservice erhalten, da ihr altes Zertifikat abgelaufen ist
112
113 ==== Vorgehen ====
114
115 Folgen Sie der Anleitung unter dem Punkt **ePayBL Setup** - Schritt 2: [[Installationsschritte>>doc:]] und aktualisieren Sie ihr Zertifikat.