| ... |
... |
@@ -20,17 +20,39 @@ |
| 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 |
+1.1 Wenn unter "Anzubindende Umgebung" der Wert "TEST" ausgewählt ist, verwenden Sie in Zukunft die Adresse "xxxxxxxxxxxxxxxx" zur Anbindung.Wenn unter "Anzubindende Umgebung" der Wert "LIVE" ausgewählt ist, verwenden Sie in Zukunft die Adresse "xxxxxxxxxxxxxxxx" zur Anbindung.Deaktivieren des AKDB: EPayment-PluginGehen Sie im FORMCYCLE Hauptmenü auf "Mandant" -> "Plugin".Fahren Sie mit der Maus über den Eintrag "plugin-bundle-akdb-epayment.jar". Es erscheint das Symbol zum Deaktivieren des Plugins.Klicken Sie auf das Symbol , um das Plugin zu deaktivieren.Das Plugin wird nun durchgestrichen dargestellt.Installation des plugin-bundle-epaybl.jarMelden Sie sich als Systemadministrator (sadmin) am FORMCYCLE Backend an.Gehen Sie im FORMCYCLE Hauptmenü auf "System" -> "Systemplugins".Klicken Sie auf den Plus-Button, um die Datei "plugin-bundle-epaybl.jar" hinzuzufügen.Einrichten mit ePayBL SetupIm FORMCYCLE Hauptmenü steht Ihnen nun ein neuer Punkt "ePayBL Setup" zur Verfügung.Klicken Sie auf dem Menüpunk "ePayBL Setup"Tragen Sie die URL aus Schritt 2 ein.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.Laden Sie das Zertifikat hoch, das Sie von der AKDB erhalten haben, und geben Sie das dazugehörige Passwort ein.Klicken Sie auf „Speichern“.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 zu verstehen.Informationen, die nicht durch den Systemadministrator hinterlegt wurden, werden im Mandanten als Pflichtangabe angezeigt und müssen später dort angegeben werden.Melden Sie sich beim Mandanten an, in dem Sie zuvor das AKDB: EPayment-Plugin deaktiviert haben.Klicken Sie auf dem Menüpunk "ePayBL Setup"Ergänzen Sie ggf. noch fehlende Informationen.Klicken Sie auf „Verbindung prüfen“ Es sollten nun entsprechende Erfolgsmeldungen angezeigt werden.Klicken Sie auf „Speichern“. Testen Sie die Anbindung durch Auslösen einer Testzahlung.Überprüfen Sie, ob die Testzahlung erfolgreich durchgeführt wurde.Wenn alles funktioniert hat, können Sie nun die ePayBL Schnittstelle produktiv nutzen. |
|
52 |
+ |
|
53 |
+ |
| 32 |
32 |
{{info}} |
| 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 {{formcyle/}} Workflow. |
|
55 |
+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}} |
| 35 |
35 |
|
| 36 |
36 |
== Installation als Systemadministrator == |
| ... |
... |
@@ -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//. |
|
76 |
+* Hier kann der {{formcycle/}} Systemadministrator Default-Werte hinterlegen, welche den Mandanten als Platzhalter angezeigt werden und jenes Feld nicht ausfüllen müssen. |
|
77 |
+* 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 |
|
|
85 |
+Der Mandant vervollständigt das **ePayBL Setup**. |
|
86 |
+ |
| 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 === |
|
117 |
+== Eingabefelder == |
| 122 |
122 |
|
| 123 |
|
-==== Vorbedingung ==== |
|
119 |
+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. |
|
121 |
+; URL des Providers |
|
122 |
+: Die URL der anzubindenen Umgebung. Default-Wert wird als Platzhalter angezeigt. |
|
123 |
+; Mandant-Nummer |
|
124 |
+: Die Mandant-Nummer ist den ePayBL Vertragsdaten zu entnehmen. Default-Wert wird als Platzhalter angezeigt. |
|
125 |
+; Bewirtschafter-Nummer |
|
126 |
+: Die Bewirtschafter-Nummer ist den ePayBL Vertragsdaten zu entnehmen. Default-Wert wird als Platzhalter angezeigt. |
|
127 |
+; Haushaltsstelle |
|
128 |
+: Die Haushaltsstelle ist den ePayBL Vertragsdaten zu entnehmen. Default-Wert wird als Platzhalter angezeigt. |
|
129 |
+; Objekt-Nummer |
|
130 |
+: Die Objekt-Nummer ist den ePayBL Vertragsdaten zu entnehmen. Default-Wert wird als Platzhalter angezeigt. |
|
131 |
+; Kennzeichen-Mahnverfahren |
|
132 |
+: Das Kennzeichen-Mahnverfahren ist den ePayBL Vertragsdaten zu entnehmen. Default-Wert wird als Platzhalter angezeigt. |
|
133 |
+; Fälligkeitszeitraum (in Tagen) |
|
134 |
+: Der Fälligkeitszeitraum ist frei wählbar. Default-Wert wird als Platzhalter angezeigt. |
|
135 |
+; Buchungstext auf der PayPage |
|
136 |
+: Der Buchungstext ist frei wählbar. Default-Wert wird als Platzhalter angezeigt. |
|
137 |
+; Unterstütze Zahlverfahren |
|
138 |
+: Eingrenzung der Zahlverfahren nötig. Default-Auswahl wird initial übernommen. |
|
139 |
+; Zertifikat |
|
140 |
+: Dieses muss im Format **//p12//** sein. Name des Default-Zertifikats wird angezeigt. |
|
141 |
+; Passwort |
|
142 |
+: Passwort zum entschlüsseln des Zertifikats. Default-Passwort wird initial übernommen. |
|
143 |
+; Hostname oder IP des zu verwenden Proxy-Servers |
|
144 |
+: Default-Wert wird als Platzhalter angezeigt. |
|
145 |
+; Port |
|
146 |
+: Der Port zum Proxy-Host. Default-Wert wird als Platzhalter angezeigt. |
