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