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 Installation als Systemadministrator fortgesetzt werden.
10
11
12 === Voraussetzungen ===
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
19 == Migration einer bestehenden Installation ==
20
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
24 1. Listenpunkt
25 1. Listenpunkt
26 1. Listenpunkt
27
28 ; Notieren Sie sich Ihre bisherigen Angaben
29 : Mandant-Nummer, Bewirtschafter-Nummer, Haushaltsstelle, Objektnummer und Kennzeichen-Mahnverfahren sowie Angaben Ihres Proxy falls vorhanden.
30 ; Stellen Sie Zertifikat und Passwort sicher, dieses wird auch für Ihr Testsystem benötigt.
31 ; Prüfen Sie die URL Ihres ePayBL-Providers
32 : Für das Testsystem war dies bisher **//epay-pre.akdb.de//**.
33 : Für das Livesystem war dies bisher **//epay.akdb.de//**.
34
35 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.
36
37 {{info}}
38 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 {{formcycle/}} Workflow.
39 {{/info}}
40
41 == Installation als Systemadministrator ==
42
43 {{figure image="epaybl-system.png"}}
44 Der **sadmin** gibt hier URL des Providers, Zertifikat sowie Passwort und Proxy vor.
45 {{/figure}}
46
47 Das Plugin wird als System-Plugin installiert.
48
49
50 === Obligatorische Installationsschritte ===
51
52 * Anmeldung als **sadmin **am FORMCYCLE-System.
53 * Registrierung des **//plugin-bundle-epaybl.jar//** Plugins im Bereich der System-Plugins.
54
55 === Fakultative Installationsschritte ===
56
57 * Jetzt ist ein neuer Menüpunkt **ePayBL Setup** vorhanden, welcher aufgerufen werden kann.
58 {{info}}Hinweis: Sollte der Menüpunkt nicht sofort ersichtlich sein, ist ein Abmelden und anschließendes Anmelden als sadmin notwendig.{{/info}}
59 * Hier kann der {{formcycle/}} Systemadministrator Default-Werte hinterlegen, welche den Mandanten als Platzhalter angezeigt werden und jenes Feld nicht ausfüllen müssen.
60 * Für genauere Informationen zu den einzelnen Eingabefeldern siehe //Eingabefelder//.
61
62 == ePayBL Setup - Mandant ==
63
64 {{figure image="epaybl-client.png"}}
65 Der Mandant muss hier alle weiteren Felder ausfüllen, um das Setup zu speichern.
66 {{/figure}}
67
68 Der Mandant vervollständigt das **ePayBL Setup**.
69
70 === Obligatorische Installationsschritte ===
71
72 * Anmeldung in den FORMCYCLE-Mandanten, welcher eine Anbindung erhalten soll.
73 * Jetzt ist ein neuer Menüpunkt **ePayBL Setup** vorhanden, welcher aufgerufen werden muss.
74 * Nun müssen alle Werte hinterlegt werden, außer es existieren bereits Default-Werte:
75
76 {{info}}
77 Hinweis: Nur wenn sowohl Hostname als auch Port angegeben sind, wird die Verbindung darüber aufgebaut.
78 {{/info}}
79
80 * Abschließend kann ein Verbindungstest durchgeführt werden. Dabei wird auch das Zertifikat geprüft, weswegen auch das Passwort stimmen muss.
81 * 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).
82
83 Damit ist die Konfiguration abgeschlossen.
84
85
86 {{warning}}
87 **Hinweise zur Erreichbarkeit notwendiger System-URLs**
88
89 Bitte konfigurieren Sie gegebenenfalls ihre Firewall hinsichtlich der Erreichbarkeit der nachfolgenden URL(s).
90 \\Folgende URL(s) müssen von **Extern erreichbar** sein, damit eine Rückmeldung vom ePayBL-Portal korrekt verarbeitet werden kann:
91
92 * https:~/~/<//Domain-Adresse des Master-Servers//>/formcycle/plugin (Master-Server)
93 ODER
94 * https:~/~/<//Domain-Adresse des Frontend-Servers//>/frontend-server/plugin (Frontend-Server)
95
96 Die URL der anzubindenden Umgebung muss **vom FORMCYCLE Master-Server aus erreichbar** sein.
97 {{/warning}}
98
99
100 == Eingabefelder ==
101
102 Falls bereits eine Eingabe durch den {{formcycle/}} Systemadministrator getätigt wurde, ist das Eingabefeld für den Mandanten kein Pflichtfeld mehr und der Default-Wert wird als Platzhalter angezeigt. Jeder Mandant kann die Default-Werte überschreiben, indem das entsprechende Eingabefeld ausgefüllt wird.
103
104 ; URL des Providers
105 : Die URL der anzubindenen Umgebung. Default-Wert wird als Platzhalter angezeigt.
106 ; Mandant-Nummer
107 : Die Mandant-Nummer ist den ePayBL Vertragsdaten zu entnehmen. Default-Wert wird als Platzhalter angezeigt.
108 ; Bewirtschafter-Nummer
109 : Die Bewirtschafter-Nummer ist den ePayBL Vertragsdaten zu entnehmen. Default-Wert wird als Platzhalter angezeigt.
110 ; Haushaltsstelle
111 : Die Haushaltsstelle ist den ePayBL Vertragsdaten zu entnehmen. Default-Wert wird als Platzhalter angezeigt.
112 ; Objekt-Nummer
113 : Die Objekt-Nummer ist den ePayBL Vertragsdaten zu entnehmen. Default-Wert wird als Platzhalter angezeigt.
114 ; Kennzeichen-Mahnverfahren
115 : Das Kennzeichen-Mahnverfahren ist den ePayBL Vertragsdaten zu entnehmen. Default-Wert wird als Platzhalter angezeigt.
116 ; Fälligkeitszeitraum (in Tagen)
117 : Der Fälligkeitszeitraum ist frei wählbar. Default-Wert wird als Platzhalter angezeigt.
118 ; Buchungstext auf der PayPage
119 : Der Buchungstext ist frei wählbar. Default-Wert wird als Platzhalter angezeigt.
120 ; Unterstütze Zahlverfahren
121 : Eingrenzung der Zahlverfahren nötig. Default-Auswahl wird initial übernommen.
122 ; Zertifikat
123 : Dieses muss im Format **//p12//** sein. Name des Default-Zertifikats wird angezeigt.
124 ; Passwort
125 : Passwort zum entschlüsseln des Zertifikats. Default-Passwort wird initial übernommen.
126 ; Hostname oder IP des zu verwenden Proxy-Servers
127 : Default-Wert wird als Platzhalter angezeigt.
128 ; Port
129 : Der Port zum Proxy-Host. Default-Wert wird als Platzhalter angezeigt.