| ... |
... |
@@ -20,15 +20,71 @@ |
| 20 |
20 |
|
| 21 |
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 |
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 **//infra-pre.buergerserviceportal.de//**. |
| 28 |
|
-: Für das Livesystem war dies bisher **//epay.akdb.de//**. |
|
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. |
| 29 |
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. |
|
40 |
+=== Vorbereitung === |
| 31 |
31 |
|
|
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 |
+ |
| 32 |
32 |
{{info}} |
| 33 |
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 {{formcycle/}} Workflow. |
| 34 |
34 |
{{/info}} |
| ... |
... |
@@ -51,8 +51,8 @@ |
| 51 |
51 |
|
| 52 |
52 |
* Jetzt ist ein neuer Menüpunkt **ePayBL Setup** vorhanden, welcher aufgerufen werden kann. |
| 53 |
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//. |
|
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//. |
| 56 |
56 |
|
| 57 |
57 |
== ePayBL Setup - Mandant == |
| 58 |
58 |
|
| ... |
... |
@@ -60,6 +60,8 @@ |
| 60 |
60 |
Der Mandant muss hier alle weiteren Felder ausfüllen, um das Setup zu speichern. |
| 61 |
61 |
{{/figure}} |
| 62 |
62 |
|
|
119 |
+Der Mandant vervollständigt das **ePayBL Setup**. |
|
120 |
+ |
| 63 |
63 |
=== Obligatorische Installationsschritte === |
| 64 |
64 |
|
| 65 |
65 |
* Anmeldung in den FORMCYCLE-Mandanten, welcher eine Anbindung erhalten soll. |
| ... |
... |
@@ -66,33 +66,6 @@ |
| 66 |
66 |
* Jetzt ist ein neuer Menüpunkt **ePayBL Setup** vorhanden, welcher aufgerufen werden muss. |
| 67 |
67 |
* Nun müssen alle Werte hinterlegt werden, außer es existieren bereits Default-Werte: |
| 68 |
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 |
96 |
{{info}} |
| 97 |
97 |
Hinweis: Nur wenn sowohl Hostname als auch Port angegeben sind, wird die Verbindung darüber aufgebaut. |
| 98 |
98 |
{{/info}} |
| ... |
... |
@@ -116,14 +116,34 @@ |
| 116 |
116 |
Die URL der anzubindenden Umgebung muss **vom FORMCYCLE Master-Server aus erreichbar** sein. |
| 117 |
117 |
{{/warning}} |
| 118 |
118 |
|
| 119 |
|
-== Anpassungen zum späteren Zeitpunkt == |
| 120 |
120 |
|
| 121 |
|
-=== Aktualisierung des Zugriffszertifikats für den ePayBL ePayment LIVE-Service === |
|
151 |
+== Eingabefelder == |
| 122 |
122 |
|
| 123 |
|
-==== Vorbedingung ==== |
|
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. |
| 124 |
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. |
|
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. |
