... |
... |
@@ -6,68 +6,79 @@ |
6 |
6 |
|
7 |
7 |
Damit das ePayment in FORMCYCLE eingerichtet werden kann, muss zuvor ein Vertrag mit dem ePayBL Anbieter geschlossen werden. |
8 |
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. |
|
9 |
+Ist bereits ein Vertrag über das ePayment mit dem ePayBL Anbieter vorhanden, so kann dieser herangezogen werden und mit dem Schritt der initialen Installation fortgesetzt werden. |
10 |
10 |
|
|
11 |
+== Initiale Installation == |
11 |
11 |
|
12 |
|
-=== Voraussetzungen === |
|
13 |
+{{figure image="epaybl-system.png"}} |
|
14 |
+Der **sadmin** gibt hier URL des Providers, Zertifikat sowie Passwort und Proxy vor. |
|
15 |
+{{/figure}} |
13 |
13 |
|
|
17 |
+{{info}} |
|
18 |
+Bei einem Update von einem bestehenden [[**AKDB: EPayment-Plugin** >>doc:Formcycle.PluginDocumentation.AkdbEPaymentPlugin]] sollte vorher dieses in allen Mandanten deaktiviert werden. Ansonsten kann das Setup im Mandanten nicht abgeschlossen werden. |
|
19 |
+{{/info}} |
|
20 |
+ |
|
21 |
+==== Voraussetzungen ==== |
|
22 |
+ |
14 |
14 |
* Die notwendigen Daten des ePayBL-EPayment Mandanten liegen vor. |
15 |
15 |
* Ein Zertifikat für den Zugriff auf den ePayment-Webservice ist vorhanden. |
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 |
|
-== Migration einer bestehenden Installation == |
|
28 |
+=== ePayBL Setup - Systemadministrator === |
20 |
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 |
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//**. |
|
31 |
+==== Obligatorische Installationsschritte ==== |
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. |
31 |
|
- |
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 {{formcycle/}} Workflow. |
34 |
|
-{{/info}} |
35 |
|
- |
36 |
|
-== Installation als Systemadministrator == |
37 |
|
- |
38 |
|
-{{figure image="epaybl-system.png"}} |
39 |
|
-Der **sadmin** gibt hier URL des Providers, Zertifikat sowie Passwort und Proxy vor. |
40 |
|
-{{/figure}} |
41 |
|
- |
42 |
|
-Das Plugin wird als System-Plugin installiert. |
43 |
|
- |
44 |
|
- |
45 |
|
-=== Obligatorische Installationsschritte === |
46 |
|
- |
47 |
47 |
* Anmeldung als **sadmin **am FORMCYCLE-System. |
48 |
48 |
* Registrierung des **//plugin-bundle-epaybl.jar//** Plugins im Bereich der System-Plugins. |
49 |
49 |
|
50 |
|
-=== Fakultative Installationsschritte === |
|
36 |
+==== Fakultative Installationsschritte ==== |
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 {{formcycle/}} Systemadministrator 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 //Eingabefelder//. |
|
40 |
+* Hier kann der Xima® Formcycle-Administrator Default-Werte hinterlegen, welche den Mandanten als Platzhalter angezeigt werden und jenes Feld nicht ausfüllen müssen. |
|
41 |
+* Für genauere Informationen zu den einzelnen Eingabefeldern siehe //ePayBL Setup - Mandant//. |
56 |
56 |
|
57 |
|
-== ePayBL Setup - Mandant == |
|
43 |
+=== ePayBL Setup - Mandant === |
58 |
58 |
|
59 |
59 |
{{figure image="epaybl-client.png"}} |
60 |
60 |
Der Mandant muss hier alle weiteren Felder ausfüllen, um das Setup zu speichern. |
61 |
61 |
{{/figure}} |
62 |
62 |
|
63 |
|
-Der Mandant vervollständigt das **ePayBL Setup**. |
|
49 |
+==== Obligatorische Installationsschritte ==== |
64 |
64 |
|
65 |
|
-=== Obligatorische Installationsschritte === |
66 |
|
- |
67 |
67 |
* Anmeldung in den FORMCYCLE-Mandanten, welcher eine Anbindung erhalten soll. |
68 |
68 |
* Jetzt ist ein neuer Menüpunkt **ePayBL Setup** vorhanden, welcher aufgerufen werden muss. |
69 |
69 |
* Nun müssen alle Werte hinterlegt werden, außer es existieren bereits Default-Werte: |
70 |
70 |
|
|
55 |
+; URL des Providers |
|
56 |
+: Die URL der anzubindenen Umgebung. Default-Wert wird als Platzhalter angezeigt. Änderungen des Default-Wertes durch den Xima® Formcycle-Administrator werden im Platzhalter sichtbar. |
|
57 |
+; Mandant-Nummer |
|
58 |
+: 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. |
|
59 |
+; Bewirtschafter-Nummer |
|
60 |
+: 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. |
|
61 |
+; Haushaltsstelle |
|
62 |
+: 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. |
|
63 |
+; Objekt-Nummer |
|
64 |
+: 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. |
|
65 |
+; Kennzeichen-Mahnverfahren |
|
66 |
+: 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. |
|
67 |
+; Fälligkeitszeitraum (in Tagen) |
|
68 |
+: 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. |
|
69 |
+; Buchungstext auf der PayPage |
|
70 |
+: 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. |
|
71 |
+; Unterstütze Zahlverfahren |
|
72 |
+: 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. |
|
73 |
+; Zertifikat |
|
74 |
+: 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. |
|
75 |
+; Passwort |
|
76 |
+: 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. |
|
77 |
+; Hostname oder IP des zu verwenden Proxy-Servers |
|
78 |
+: Default-Wert wird als Platzhalter angezeigt. Änderungen des Default-Wertes durch den Xima® Formcycle-Administrator werden im Platzhalter sichtbar. |
|
79 |
+; Port |
|
80 |
+: Der Port zum Proxy-Host. Default-Wert wird als Platzhalter angezeigt. Änderungen des Default-Wertes durch den Xima® Formcycle-Administrator werden im Platzhalter sichtbar. |
|
81 |
+ |
71 |
71 |
{{info}} |
72 |
72 |
Hinweis: Nur wenn sowohl Hostname als auch Port angegeben sind, wird die Verbindung darüber aufgebaut. |
73 |
73 |
{{/info}} |
... |
... |
@@ -91,36 +91,14 @@ |
91 |
91 |
Die URL der anzubindenden Umgebung muss **vom FORMCYCLE Master-Server aus erreichbar** sein. |
92 |
92 |
{{/warning}} |
93 |
93 |
|
|
105 |
+== Anpassungen zum späteren Zeitpunkt == |
94 |
94 |
|
95 |
|
-== Eingabefelder == |
|
107 |
+=== Aktualisierung des Zugriffszertifikats für den ePayBL ePayment LIVE-Service === |
96 |
96 |
|
97 |
|
-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. |
|
109 |
+==== Vorbedingung ==== |
98 |
98 |
|
99 |
|
-; URL des Providers |
100 |
|
-: Die URL der anzubindenen Umgebung. Default-Wert wird als Platzhalter angezeigt. |
101 |
|
-; Mandant-Nummer |
102 |
|
-: Die Mandant-Nummer ist den ePayBL Vertragsdaten zu entnehmen. Default-Wert wird als Platzhalter angezeigt. |
103 |
|
-; Bewirtschafter-Nummer |
104 |
|
-: Die Bewirtschafter-Nummer ist den ePayBL Vertragsdaten zu entnehmen. Default-Wert wird als Platzhalter angezeigt. |
105 |
|
-; Haushaltsstelle |
106 |
|
-: Die Haushaltsstelle ist den ePayBL Vertragsdaten zu entnehmen. Default-Wert wird als Platzhalter angezeigt. |
107 |
|
-; Objekt-Nummer |
108 |
|
-: Die Objekt-Nummer ist den ePayBL Vertragsdaten zu entnehmen. Default-Wert wird als Platzhalter angezeigt. |
109 |
|
-; Kennzeichen-Mahnverfahren |
110 |
|
-: Das Kennzeichen-Mahnverfahren ist den ePayBL Vertragsdaten zu entnehmen. Default-Wert wird als Platzhalter angezeigt. |
111 |
|
-; Fälligkeitszeitraum (in Tagen) |
112 |
|
-: Der Fälligkeitszeitraum ist frei wählbar. Default-Wert wird als Platzhalter angezeigt. |
113 |
|
-; Buchungstext auf der PayPage |
114 |
|
-: Der Buchungstext ist frei wählbar. Default-Wert wird als Platzhalter angezeigt. |
115 |
|
-; Unterstütze Zahlverfahren |
116 |
|
-: Eingrenzung der Zahlverfahren nötig. Default-Auswahl wird initial übernommen. |
117 |
|
-; Zertifikat |
118 |
|
-: Dieses muss im Format **//p12//** sein. Name des Default-Zertifikats wird angezeigt. |
119 |
|
-; Passwort |
120 |
|
-: Passwort zum entschlüsseln des Zertifikats. Default-Passwort wird initial übernommen. |
121 |
|
-; Hostname oder IP des zu verwenden Proxy-Servers |
122 |
|
-: Default-Wert wird als Platzhalter angezeigt. |
123 |
|
-; Port |
124 |
|
-: Der Port zum Proxy-Host. Default-Wert wird als Platzhalter angezeigt. |
|
111 |
+Sie haben ein neues Zertifikat für den Zugriff auf den ePayBL Webservice erhalten, da ihr altes Zertifikat abgelaufen ist |
125 |
125 |
|
|
113 |
+==== Vorgehen ==== |
126 |
126 |
|
|
115 |
+Folgen Sie der Anleitung unter dem Punkt **ePayBL Setup** - Schritt 2: [[Installationsschritte>>doc:]] und aktualisieren Sie ihr Zertifikat. |