| ... |
... |
@@ -16,14 +16,62 @@ |
| 16 |
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 |
17 |
* Das Plugin-Bundle //**plugin-bundle-epaybl.jar**// ist vorhanden und kompatibel mit der installierten FORMCYCLE-Version. |
| 18 |
18 |
|
| 19 |
|
- |
| 20 |
20 |
== Migration einer bestehenden Installation == |
| 21 |
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 |
+ |
|
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://epay-pre.akdb.de" zur Anbindung. |
|
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 |
+ |
| 22 |
22 |
{{info}} |
| 23 |
|
-Bei einem Update von einem bestehenden [[**AKDB: EPayment-Plugin** >>url:https://help.formcycle.de/xwiki/bin/view/Formcycle/PluginDocumentation/AkdbEPaymentPlugin/]] muss vorher dieses in allen Mandanten deaktiviert werden. Ansonsten kann das Setup im Mandanten nicht abgeschlossen werden, da der Menüpunkt nicht sichtbar ist. |
|
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. |
| 24 |
24 |
{{/info}} |
| 25 |
25 |
|
| 26 |
|
- |
| 27 |
27 |
== Installation als Systemadministrator == |
| 28 |
28 |
|
| 29 |
29 |
{{figure image="epaybl-system.png"}} |
| ... |
... |
@@ -35,18 +35,16 @@ |
| 35 |
35 |
|
| 36 |
36 |
=== Obligatorische Installationsschritte === |
| 37 |
37 |
|
| 38 |
|
-* Anmeldung als **sadmin **am FORMCYCLE-System. |
|
86 |
+* Anmeldung als **sadmin **am {{formcycle/}}-System. |
| 39 |
39 |
* Registrierung des **//plugin-bundle-epaybl.jar//** Plugins im Bereich der System-Plugins. |
| 40 |
40 |
|
| 41 |
|
- |
| 42 |
42 |
=== Fakultative Installationsschritte === |
| 43 |
43 |
|
| 44 |
44 |
* Jetzt ist ein neuer Menüpunkt **ePayBL Setup** vorhanden, welcher aufgerufen werden kann. |
| 45 |
45 |
{{info}}Hinweis: Sollte der Menüpunkt nicht sofort ersichtlich sein, ist ein Abmelden und anschließendes Anmelden als sadmin notwendig.{{/info}} |
| 46 |
|
-* Hier kann der Xima® Formcycle-Administrator Default-Werte hinterlegen, welche den Mandanten als Platzhalter angezeigt werden und jenes Feld nicht ausfüllen müssen. |
| 47 |
|
-* Für genauere Informationen zu den einzelnen Eingabefeldern siehe //ePayBL Setup - Mandant//. |
|
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//. |
| 48 |
48 |
|
| 49 |
|
- |
| 50 |
50 |
== ePayBL Setup - Mandant == |
| 51 |
51 |
|
| 52 |
52 |
{{figure image="epaybl-client.png"}} |
| ... |
... |
@@ -53,6 +53,8 @@ |
| 53 |
53 |
Der Mandant muss hier alle weiteren Felder ausfüllen, um das Setup zu speichern. |
| 54 |
54 |
{{/figure}} |
| 55 |
55 |
|
|
102 |
+Der Mandant vervollständigt das **ePayBL Setup**. |
|
103 |
+ |
| 56 |
56 |
=== Obligatorische Installationsschritte === |
| 57 |
57 |
|
| 58 |
58 |
* Anmeldung in den FORMCYCLE-Mandanten, welcher eine Anbindung erhalten soll. |
| ... |
... |
@@ -59,33 +59,6 @@ |
| 59 |
59 |
* Jetzt ist ein neuer Menüpunkt **ePayBL Setup** vorhanden, welcher aufgerufen werden muss. |
| 60 |
60 |
* Nun müssen alle Werte hinterlegt werden, außer es existieren bereits Default-Werte: |
| 61 |
61 |
|
| 62 |
|
-; URL des Providers |
| 63 |
|
-: Die URL der anzubindenen Umgebung. Default-Wert wird als Platzhalter angezeigt. Änderungen des Default-Wertes durch den Xima® Formcycle-Administrator werden im Platzhalter sichtbar. |
| 64 |
|
-; Mandant-Nummer |
| 65 |
|
-: 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. |
| 66 |
|
-; Bewirtschafter-Nummer |
| 67 |
|
-: 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. |
| 68 |
|
-; Haushaltsstelle |
| 69 |
|
-: 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. |
| 70 |
|
-; Objekt-Nummer |
| 71 |
|
-: 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. |
| 72 |
|
-; Kennzeichen-Mahnverfahren |
| 73 |
|
-: 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. |
| 74 |
|
-; Fälligkeitszeitraum (in Tagen) |
| 75 |
|
-: 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. |
| 76 |
|
-; Buchungstext auf der PayPage |
| 77 |
|
-: 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. |
| 78 |
|
-; Unterstütze Zahlverfahren |
| 79 |
|
-: 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. |
| 80 |
|
-; Zertifikat |
| 81 |
|
-: 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. |
| 82 |
|
-; Passwort |
| 83 |
|
-: 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. |
| 84 |
|
-; Hostname oder IP des zu verwenden Proxy-Servers |
| 85 |
|
-: Default-Wert wird als Platzhalter angezeigt. Änderungen des Default-Wertes durch den Xima® Formcycle-Administrator werden im Platzhalter sichtbar. |
| 86 |
|
-; Port |
| 87 |
|
-: Der Port zum Proxy-Host. Default-Wert wird als Platzhalter angezeigt. Änderungen des Default-Wertes durch den Xima® Formcycle-Administrator werden im Platzhalter sichtbar. |
| 88 |
|
- |
| 89 |
89 |
{{info}} |
| 90 |
90 |
Hinweis: Nur wenn sowohl Hostname als auch Port angegeben sind, wird die Verbindung darüber aufgebaut. |
| 91 |
91 |
{{/info}} |
| ... |
... |
@@ -109,14 +109,34 @@ |
| 109 |
109 |
Die URL der anzubindenden Umgebung muss **vom FORMCYCLE Master-Server aus erreichbar** sein. |
| 110 |
110 |
{{/warning}} |
| 111 |
111 |
|
| 112 |
|
-== Anpassungen zum späteren Zeitpunkt == |
| 113 |
113 |
|
| 114 |
|
-=== Aktualisierung des Zugriffszertifikats für den ePayBL ePayment LIVE-Service === |
|
134 |
+== Eingabefelder == |
| 115 |
115 |
|
| 116 |
|
-==== Vorbedingung ==== |
|
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. |
| 117 |
117 |
|
| 118 |
|
-Sie haben ein neues Zertifikat für den Zugriff auf den ePayBL Webservice erhalten, da ihr altes Zertifikat abgelaufen ist |
| 119 |
|
- |
| 120 |
|
-==== Vorgehen ==== |
| 121 |
|
- |
| 122 |
|
-Folgen Sie der Anleitung unter dem Punkt **ePayBL Setup** - Schritt 2: [[Installationsschritte>>doc:]] und aktualisieren Sie ihr Zertifikat. |
|
138 |
+; URL des Providers |
|
139 |
+: Die URL der anzubindenen Umgebung. Default-Wert wird als Platzhalter angezeigt. |
|
140 |
+; Mandant-Nummer |
|
141 |
+: Die Mandant-Nummer ist den ePayBL Vertragsdaten zu entnehmen. Default-Wert wird als Platzhalter angezeigt. |
|
142 |
+; Bewirtschafter-Nummer |
|
143 |
+: Die Bewirtschafter-Nummer ist den ePayBL Vertragsdaten zu entnehmen. Default-Wert wird als Platzhalter angezeigt. |
|
144 |
+; Haushaltsstelle |
|
145 |
+: Die Haushaltsstelle ist den ePayBL Vertragsdaten zu entnehmen. Default-Wert wird als Platzhalter angezeigt. |
|
146 |
+; Objekt-Nummer |
|
147 |
+: Die Objekt-Nummer ist den ePayBL Vertragsdaten zu entnehmen. Default-Wert wird als Platzhalter angezeigt. |
|
148 |
+; Kennzeichen-Mahnverfahren |
|
149 |
+: Das Kennzeichen-Mahnverfahren ist den ePayBL Vertragsdaten zu entnehmen. Default-Wert wird als Platzhalter angezeigt. |
|
150 |
+; Fälligkeitszeitraum (in Tagen) |
|
151 |
+: Der Fälligkeitszeitraum ist frei wählbar. Default-Wert wird als Platzhalter angezeigt. |
|
152 |
+; Buchungstext auf der PayPage |
|
153 |
+: Der Buchungstext ist frei wählbar. Default-Wert wird als Platzhalter angezeigt. |
|
154 |
+; Unterstütze Zahlverfahren |
|
155 |
+: Eingrenzung der Zahlverfahren nötig. Default-Auswahl wird initial übernommen. |
|
156 |
+; Zertifikat |
|
157 |
+: Dieses muss im Format **//p12//** sein. Name des Default-Zertifikats wird angezeigt. |
|
158 |
+; Passwort |
|
159 |
+: Passwort zum entschlüsseln des Zertifikats. Default-Passwort wird initial übernommen. |
|
160 |
+; Hostname oder IP des zu verwenden Proxy-Servers |
|
161 |
+: Default-Wert wird als Platzhalter angezeigt. |
|
162 |
+; Port |
|
163 |
+: Der Port zum Proxy-Host. Default-Wert wird als Platzhalter angezeigt. |
