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 1. Gehen Sie in den Menüpunkt //AKDB ePay Setup//
24 1. Notieren Sie sich Ihre bisherigen Angaben
25 1.1 Mandant-Nummer
26 1.2 Bewirtschafter-Nummer
27 1.3 Haushaltsstelle
28 1.4 Objektnummer
29 1.5 Kennzeichen-Manverfahren
30 1.6 Proxy (falls vorhanden)
31 1. Ermitteln Sie die URL Ihres ePayBL Providers
32 1. Stellen Sie Zertifikat und Zertifikatspasswort sicher
33 1. Ermitteln Sie die erlaubten Zahlverfahren Ihres ePayBL Providers
34 1. Deaktivieren Sie das //AKDB: EPayment-Plugin// in Ihrem Mandanten
35 1. Loggen Sie sich als Systemadministrator an
36 1. Hinterlegen Sie das //ePayBL: EPayment-Plugin// in den System-Plugins
37 1. Gehen Sie in den neuen Menüpunkt //ePayBL Setup//
38 1. Hinterlegen Sie Ihre notierten Angaben, nähere Informationen sind in den folgenden Abschnitten hinterlegt.
39
40 === Vorbereitung ===
41
42 Um die neue ePayBL Schnittstelle anzubinden, benötigen Sie ein Zertifikat von der AKDB. Wenn Sie es für die Produktivumgebung noch nicht haben, wenden Sie sich an Ihren Ansprechpartner bei der AKDB.
43
44 === Migration ===
45
46 1. Datensicherung
47 1.1 Gehen Sie im FORMCYCLE Hauptmenü auf **AKDB ePay Setup**.
48 1.2 Klicken Sie auf **Zur Anbindung ePay-BL Umgebung**.
49 1.3 Notieren Sie die Informationen für Mandant-Nummer, Bewirtschafter-Nummer, Haushaltsstelle, Objektnummer, Kennzeichen-Mahnverfahren, Fälligkeitszeitraum (in Tagen) und Buchungstext für die PayPage.
50 1. Bestimmen der URL Ihres ePayBL Providers
51 2.1 Wenn unter "Anzubindende Umgebung" der Wert "TEST" ausgewählt ist, verwenden Sie in Zukunft die Adresse "xxxxxxxxxxxxxxxx" zur Anbindung.
52 2.2 Wenn unter "Anzubindende Umgebung" der Wert "LIVE" ausgewählt ist, verwenden Sie in Zukunft die Adresse "xxxxxxxxxxxxxxxx" zur Anbindung.
53 1. Deaktivieren des AKDB: EPayment-Plugin
54 3.1 Gehen Sie im FORMCYCLE Hauptmenü auf "Mandant" -> "Plugin".
55 3.2 Fahren Sie mit der Maus über den Eintrag //plugin-bundle-akdb-epayment.jar//. Es erscheint das Symbol zum Deaktivieren des Plugins.
56 3.3 Klicken Sie auf das Symbol, um das Plugin zu deaktivieren.
57 3.4 Das Plugin wird nun durchgestrichen dargestellt.
58 1. Löschen der Datei //epay_wf_result.js//
59 4.1 Gehen Sie im FORMCYCLE Hauptmenü auf "Dateien & Templates" -> "Dateien".
60 4.2 Wählen Sie den Eintrag //epay_wf_result.js// aus indem Sie das Kästchen links davon anhaken.
61 4.3 Klicken Sie auf das löschen Symbolüberhalb der Auflistung.
62 1. Installation des //plugin-bundle-epaybl.jar
63 5.1 Melden Sie sich als Systemadministrator (sadmin) am FORMCYCLE Backend an.
64 5.2 Gehen Sie im FORMCYCLE Hauptmenü auf "System" -> "Systemplugins".
65 5.3 Klicken Sie auf den Plus-Button, um die Datei //plugin-bundle-epaybl.jar// hinzuzufügen.//
66 1. Einrichten mit ePayBL Setup
67 6.1 Im FORMCYCLE Hauptmenü steht Ihnen nun ein neuer Punkt **ePayBL Setup** zur Verfügung.
68 6.2 Klicken Sie auf dem Menüpunk **ePayBL Setup**
69 6.3 Tragen Sie die URL aus Schritt 2 ein.
70 6.4 Geben Sie nun die Informationen für Mandant-Nummer, Bewirtschafter-Nummer, Haushaltsstelle, Objektnummer, Kennzeichen-Mahnverfahren, Fälligkeitszeitraum (in Tagen) und Buchungstext für die PayPage ein, die für alle Mandanten gelten sollen.
71 6.5 Laden Sie das Zertifikat hoch, das Sie von der AKDB erhalten haben, und geben Sie das dazugehörige Passwort ein.
72 6.6 Klicken Sie auf „Speichern“.
73 6.7 Alle Angaben, die Sie als Systemadministrator in den Systemeinstellungen hinterlegen, sind optional und sind als Standardeinstellungen, die für alle Mandanten in Ihrer FORMCYCLE Umgebung gelten zu verstehen.
74 6.8 Informationen, die nicht durch den Systemadministrator hinterlegt wurden, werden im Mandanten als Pflichtangabe angezeigt und müssen später dort angegeben werden.
75 1. Vervollständigung des Setups im Mandanten
76 7.1 Melden Sie sich beim Mandanten an, in dem Sie zuvor das AKDB: EPayment-Plugin deaktiviert haben.
77 7.2 Klicken Sie auf dem Menüpunk **ePayBL Setup**
78 7.3 Ergänzen Sie ggf. noch fehlende Informationen.
79 7.4 Klicken Sie auf **Verbindung prüfen**. Es sollten nun entsprechende Erfolgsmeldungen angezeigt werden.
80 7.5 Klicken Sie auf „Speichern“. 
81
82 ==== Checklist ====
83
84 1. Testen Sie die Anbindung durch Auslösen einer Testzahlung.
85 1. Überprüfen Sie, ob die Testzahlung erfolgreich durchgeführt wurde.
86 1. Wenn alles funktioniert hat, können Sie nun die ePayBL Schnittstelle produktiv nutzen.
87
88 {{info}}
89 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.
90 {{/info}}
91
92 == Installation als Systemadministrator ==
93
94 {{figure image="epaybl-system.png"}}
95 Der **sadmin** gibt hier URL des Providers, Zertifikat sowie Passwort und Proxy vor.
96 {{/figure}}
97
98 Das Plugin wird als System-Plugin installiert.
99
100
101 === Obligatorische Installationsschritte ===
102
103 * Anmeldung als **sadmin **am FORMCYCLE-System.
104 * Registrierung des **//plugin-bundle-epaybl.jar//** Plugins im Bereich der System-Plugins.
105
106 === Fakultative Installationsschritte ===
107
108 * Jetzt ist ein neuer Menüpunkt **ePayBL Setup** vorhanden, welcher aufgerufen werden kann.
109 {{info}}Hinweis: Sollte der Menüpunkt nicht sofort ersichtlich sein, ist ein Abmelden und anschließendes Anmelden als sadmin notwendig.{{/info}}
110 * Hier kann der {{formcycle/}} Systemadministrator Default-Werte hinterlegen, welche den Mandanten als Platzhalter angezeigt werden und jenes Feld nicht ausfüllen müssen.
111 * Für genauere Informationen zu den einzelnen Eingabefeldern siehe //Eingabefelder//.
112
113 == ePayBL Setup - Mandant ==
114
115 {{figure image="epaybl-client.png"}}
116 Der Mandant muss hier alle weiteren Felder ausfüllen, um das Setup zu speichern.
117 {{/figure}}
118
119 Der Mandant vervollständigt das **ePayBL Setup**.
120
121 === Obligatorische Installationsschritte ===
122
123 * Anmeldung in den FORMCYCLE-Mandanten, welcher eine Anbindung erhalten soll.
124 * Jetzt ist ein neuer Menüpunkt **ePayBL Setup** vorhanden, welcher aufgerufen werden muss.
125 * Nun müssen alle Werte hinterlegt werden, außer es existieren bereits Default-Werte:
126
127 {{info}}
128 Hinweis: Nur wenn sowohl Hostname als auch Port angegeben sind, wird die Verbindung darüber aufgebaut.
129 {{/info}}
130
131 * Abschließend kann ein Verbindungstest durchgeführt werden. Dabei wird auch das Zertifikat geprüft, weswegen auch das Passwort stimmen muss.
132 * 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).
133
134 Damit ist die Konfiguration abgeschlossen.
135
136
137 {{warning}}
138 **Hinweise zur Erreichbarkeit notwendiger System-URLs**
139
140 Bitte konfigurieren Sie gegebenenfalls ihre Firewall hinsichtlich der Erreichbarkeit der nachfolgenden URL(s).
141 \\Folgende URL(s) müssen von **Extern erreichbar** sein, damit eine Rückmeldung vom ePayBL-Portal korrekt verarbeitet werden kann:
142
143 * https:~/~/<//Domain-Adresse des Master-Servers//>/formcycle/plugin (Master-Server)
144 ODER
145 * https:~/~/<//Domain-Adresse des Frontend-Servers//>/frontend-server/plugin (Frontend-Server)
146
147 Die URL der anzubindenden Umgebung muss **vom FORMCYCLE Master-Server aus erreichbar** sein.
148 {{/warning}}
149
150
151 == Eingabefelder ==
152
153 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.
154
155 ; URL des Providers
156 : Die URL der anzubindenen Umgebung. Default-Wert wird als Platzhalter angezeigt.
157 ; Mandant-Nummer
158 : Die Mandant-Nummer ist den ePayBL Vertragsdaten zu entnehmen. Default-Wert wird als Platzhalter angezeigt.
159 ; Bewirtschafter-Nummer
160 : Die Bewirtschafter-Nummer ist den ePayBL Vertragsdaten zu entnehmen. Default-Wert wird als Platzhalter angezeigt.
161 ; Haushaltsstelle
162 : Die Haushaltsstelle ist den ePayBL Vertragsdaten zu entnehmen. Default-Wert wird als Platzhalter angezeigt.
163 ; Objekt-Nummer
164 : Die Objekt-Nummer ist den ePayBL Vertragsdaten zu entnehmen. Default-Wert wird als Platzhalter angezeigt.
165 ; Kennzeichen-Mahnverfahren
166 : Das Kennzeichen-Mahnverfahren ist den ePayBL Vertragsdaten zu entnehmen. Default-Wert wird als Platzhalter angezeigt.
167 ; Fälligkeitszeitraum (in Tagen)
168 : Der Fälligkeitszeitraum ist frei wählbar. Default-Wert wird als Platzhalter angezeigt.
169 ; Buchungstext auf der PayPage
170 : Der Buchungstext ist frei wählbar. Default-Wert wird als Platzhalter angezeigt.
171 ; Unterstütze Zahlverfahren
172 : Eingrenzung der Zahlverfahren nötig. Default-Auswahl wird initial übernommen.
173 ; Zertifikat
174 : Dieses muss im Format **//p12//** sein. Name des Default-Zertifikats wird angezeigt.
175 ; Passwort
176 : Passwort zum entschlüsseln des Zertifikats. Default-Passwort wird initial übernommen.
177 ; Hostname oder IP des zu verwenden Proxy-Servers
178 : Default-Wert wird als Platzhalter angezeigt.
179 ; Port
180 : Der Port zum Proxy-Host. Default-Wert wird als Platzhalter angezeigt.