| ... |
... |
@@ -3,7 +3,6 @@ |
| 3 |
3 |
{{info}} |
| 4 |
4 |
**Achtung:** |
| 5 |
5 |
Seit Plugin-Version {{version major="4" minor="0" patch="0"}}{{/version}} ist ein Anbindung an von der AKDB unabhängigen Anbietern möglich. Alte AKDB spezifische Plugin-Versionen sind [[**unter diesem Link **>>url:https://customer.formcycle.eu/index.php/apps/files/?dir=/FORMCYCLE%20-%20Plugins%20Customer/AKDB%3A%20EPayment%20plugin%20(plugin-bundle-akdb-epayment)&fileid=2674||rel="noopener noreferrer" target="_blank"]] (Anmeldung erforderlich) zu finden. |
| 6 |
|
-**Es wird eine minor Version folgen, welche die Migration von alten Plugin-Versionen erleichtert.** |
| 7 |
7 |
{{/info}} |
| 8 |
8 |
|
| 9 |
9 |
{{content/}} |
| ... |
... |
@@ -65,7 +65,7 @@ |
| 65 |
65 |
; Max. Bestellmenge |
| 66 |
66 |
: Hier kann die für den Nutzer maximal auswählbare Bestellmenge für einen Artikel definiert werden. |
| 67 |
67 |
; Belegnummer |
| 68 |
|
-: Die Belegnummer ist ein optionaler Wert, welcher zur weiterführenden Verarbeitung auf Seiten von ePayBL dient. |
|
67 |
+: Die Belegnummer ist ein optionaler Wert, welcher zur weiterführenden Verarbeitung auf Seiten von ePay-BL dient. |
| 69 |
69 |
|
| 70 |
70 |
{{info}} |
| 71 |
71 |
Bei Übermittlung einer Bestellung werden nur die Artikelnummer, sowie die jeweilige Anzahl von einem Bestellartikel, zum Server übertragen. Damit ein Artikel innerhalb einer Bestellung übermittelt wird, muss die "Bestellen"-Option angehakt sein. |
| ... |
... |
@@ -101,9 +101,9 @@ |
| 101 |
101 |
|
| 102 |
102 |
Um eine Bezahl-Transaktion in einen Formularprozess einzubauen werden folgende Elemente vom Plugin zur Verfügung gestellt: |
| 103 |
103 |
|
| 104 |
|
-* Workflow-Aktion **[[Bestellung übermitteln>>doc:||anchor="plugin_epay_init"]]**: Diese erzeugt eine neue Bezahl-Transaktion auf Seiten des ePayBL Anbieters und leitet den Benutzer auf dessen Portalseite weiter. |
| 105 |
|
-* Workflow-Ereignis **[[Bezahlung erfolgreich>>doc:||anchor="plugin_event_epay_success"]]**: Verarbeitet ein Ereignis, welches auf der Rückmeldung über eine erfolgreiche Bezahlung auf dem ePayBL Portal basiert. |
| 106 |
|
-* Workflow-Ereignis **[[Bezahlung nicht erfolgreich>>doc:||anchor="plugin_event_epay_error"]]**: Verarbeitet ein Ereignis, welches auf der Rückmeldung über eine noch offene Bezahlung auf dem ePayBL Portal basiert. Dabei kann dies verschiedene Ursachen haben. Zum einen kann die Bezahlvorgang durch den Nutzer abgebrochen worden sein oder es ist zu einem Fehler im ePayBL Portal gekommen. |
|
103 |
+* Workflow-Aktion **[[Bestellung übermitteln>>doc:||anchor="plugin_epay_init"]]**: Diese erzeugt eine neue Bezahl-Transaktion auf Seiten der AKDB und leitet den Benutzer auf dessen Portalseite weiter. |
|
104 |
+* Workflow-Ereignis **[[Bezahlung erfolgreich>>doc:||anchor="plugin_event_epay_success"]]**: Verarbeitet ein Ereignis, welches auf der Rückmeldung über eine erfolgreiche Bezahlung auf dem ePay-BL Portal basiert. |
|
105 |
+* Workflow-Ereignis **[[Bezahlung nicht erfolgreich>>doc:||anchor="plugin_event_epay_error"]]**: Verarbeitet ein Ereignis, welches auf der Rückmeldung über eine noch offene Bezahlung auf dem ePay-BL Portal basiert. Dabei kann dies verschiedene Ursachen haben. Zum einen kann die Bezahlvorgang durch den Nutzer abgebrochen worden sein oder es ist zu einem Fehler im ePay-BL Portal gekommen. |
| 107 |
107 |
|
| 108 |
108 |
Ein Workflow für einen einfachen Fall kann folgendermaßen konfiguriert sein: |
| 109 |
109 |
|
| ... |
... |
@@ -113,13 +113,13 @@ |
| 113 |
113 |
|
| 114 |
114 |
__Kurze Ablaufbeschreibung zum dargestellten Workflow:__ |
| 115 |
115 |
|
| 116 |
|
-~1. Durch das Absenden des Bestellformulars wird das Ereignis //Bestellen// aufgerufen und dort das Aktions-Plugin **[[ePayBL:Bestellung übermitteln>>doc:||anchor="plugin_epay_init"]]** ausgeführt. Dieses ermittelt die für den Bestellvorgang notwendigen Daten aus dem Formular und startet eine Bezahl-Transaktion auf Seiten des ePayBL Anbieters. Wenn dies erfolgreich war, wird der Benutzer zum [[ePayBL>>https://www.epaybl.de/||rel="noopener noreferrer" target="_blank" title="E-Payment Bund und Länder"]] Portal der angebundenden Umgebung weitergeleitet. |
|
115 |
+~1. Durch das Absenden des Bestellformulars wird das Ereignis //Bestellen// aufgerufen und dort das Aktions-Plugin **[[AKDB:Bestellung übermitteln>>doc:||anchor="plugin_epay_init"]]** ausgeführt. Dieses ermittelt die für den Bestellvorgang notwendigen Daten aus dem Formular und startet eine Bezahl-Transaktion auf Seiten der AKDB. Wenn dies erfolgreich war, wird der Benutzer zum [[ePay-BL>>https://www.epaybl.de/||rel="noopener noreferrer" target="_blank" title="E-Payment Bund und Länder"]] Portal der AKDB weitergeleitet. |
| 117 |
117 |
|
| 118 |
|
-2. Nach Abschluss des Bezahlvorgangs im ePayBL Portal wird der Benutzer wieder zu {{formcycle/}} zurückgeleitet. Dort erfolgt automatisch eine Überprüfung des Bezahlstatus am EPayment-System. Aus dem Ergebnis dieser Überprüfung ergibt sich das vom System ausgelöste Ereignis. Wenn die Überprüfung ergeben hat, dass die Bezahlung erfolgreich war, wird ein **[[Bezahlung erfolgreich>>doc:||anchor="plugin_event_epay_success"]]**-Ereignis durch das System ausgelöst. In allen anderen Fällen ist es ein **[[Bezahlung nicht erfolgreich>>doc:||anchor="plugin_event_epay_error"]]** Ereignis. |
|
117 |
+2. Nach Abschluss des Bezahlvorgangs im ePay-BL Portal wird der Benutzer wieder zu {{formcycle/}} zurückgeleitet. Dort erfolgt automatisch eine Überprüfung des Bezahlstatus am EPayment-System. Aus dem Ergebnis dieser Überprüfung ergibt sich das vom System ausgelöste Ereignis. Wenn die Überprüfung ergeben hat, dass die Bezahlung erfolgreich war, wird ein **[[Bezahlung erfolgreich>>doc:||anchor="plugin_event_epay_success"]]**-Ereignis durch das System ausgelöst. In allen anderen Fällen ist es ein **[[Bezahlung nicht erfolgreich>>doc:||anchor="plugin_event_epay_error"]]** Ereignis. |
| 119 |
119 |
|
| 120 |
120 |
3. Ist die Bezahlung erfolgt, wird in den Status //Bezahlt// gewechselt und dem Nutzer wird eine entsprechende Abschlussseite angezeigt. |
| 121 |
121 |
|
| 122 |
|
-4. Im Falle eines negativen Ergebnisses der Überprüfung des Bezahlvorgangs (z.B.: der Nutzer hat den Bezahlvorgang im ePayBL Portal abgebrochen; während des Bezahlvorgangs ist ein Fehler aufgetreten), wird im vorliegenden Beispiel eine E-Mail erzeugt, in der der Benutzer auf die noch ausstehende Zahlung hingewiesen wird. Der Workflow wird in den Status //Nicht bezahlt// versetzt und dem Nutzer |
|
121 |
+4. Im Falle eines negativen Ergebnisses der Überprüfung des Bezahlvorgangs (z.B.: der Nutzer hat den Bezahlvorgang im ePay-BL Portal abgebrochen; während des Bezahlvorgangs ist ein Fehler aufgetreten), wird im vorliegenden Beispiel eine E-Mail erzeugt, in der der Benutzer auf die noch ausstehende Zahlung hingewiesen wird. Der Workflow wird in den Status //Nicht bezahlt// versetzt und dem Nutzer |
| 123 |
123 |
wird eine entsprechende Abschlussseite angezeigt. |
| 124 |
124 |
|
| 125 |
125 |
{{id name="plugin_epay_init"/}} |
| ... |
... |
@@ -126,7 +126,7 @@ |
| 126 |
126 |
|
| 127 |
127 |
=== 2.1. Konfigurationsmöglichkeiten des Aktions-Plugins //Bestellung übermitteln// === |
| 128 |
128 |
|
| 129 |
|
-Dieses Aktions-Plugin ist für das Erzeugen einer Bezahl-Transaktion im [[ePayBL>>https://www.epaybl.de/||rel="noopener noreferrer" target="_blank" title="E-Payment Bund und Länder"]] Portal zuständig. Hier werden im Vorfeld die Daten, welche im Zusammenhang mit der Transaktion stehen (bestellte Artikel, Preisbestimmung, persönliche Daten des Käufers etc.), festgelegt. |
|
128 |
+Dieses Aktions-Plugin ist für das Erzeugen einer Bezahl-Transaktion im [[ePay-BL>>https://www.epaybl.de/||rel="noopener noreferrer" target="_blank" title="E-Payment Bund und Länder"]] Portal zuständig. Hier werden im Vorfeld die Daten, welche im Zusammenhang mit der Transaktion stehen (bestellte Artikel, Preisbestimmung, persönliche Daten des Käufers etc.), festgelegt. |
| 130 |
130 |
|
| 131 |
131 |
{{info}} |
| 132 |
132 |
Wenn vor der Konfiguration des Plugins bereits mindestens ein **[[EPayment-Artikel>>doc:||anchor="epay_artikel"]]**, sowie die **[[Vorlage>>doc:||anchor="epay_vorlage"]]** für die **persönlichen Daten** im Formular hinterlegt wurden, werden bei einer Neueinrichtung der //Bestellung übermitteln// Plugin-Aktion die notwendigen Pflicht-Konfigurationen bereits mit den ermittelten Daten aus dem Formular vorbelegt. |
| ... |
... |
@@ -168,7 +168,7 @@ |
| 168 |
168 |
|
| 169 |
169 |
{{panel title="Konfiguration für die PayPage" fullwidth="true" initial="visible" triggerable="true"}} |
| 170 |
170 |
|
| 171 |
|
-Bei der "PayPage" handelt es sich um eine bereits vorbefüllte Bezahlseite zur Online-Bezahlung. Der Nutzer hat hier noch die Auswahl, mit welchem Bezahl-Dienstleister er bezahlen möchte (Paypal, giropay etc.). Die Art und Anzahl der dem Nutzer zur Auswahl stehenden Bezahl-Dienstleister hängt dabei davon ab, was im Vorfeld vertraglich mit dem ePayBL Anbieter vereinbart wurde. |
|
170 |
+Bei der "PayPage" handelt es sich um eine bereits vorbefüllte Bezahlseite zur Online-Bezahlung. Der Nutzer hat hier noch die Auswahl, mit welchem Bezahl-Dienstleister er bezahlen möchte (Paypal, SEPA-Lastschrift, giropay etc.). Die Art und Anzahl der dem Nutzer zur Auswahl stehenden Bezahl-Dienstleister hängt dabei davon ab, was im Vorfeld vertraglich mit der AKDB verbart wurde. |
| 172 |
172 |
|
| 173 |
173 |
{{figure image="plugin_init_config_paypage.png"}} |
| 174 |
174 |
Konfiguration für die PayPage |
| ... |
... |
@@ -189,42 +189,42 @@ |
| 189 |
189 |
{{/figure}} |
| 190 |
190 |
|
| 191 |
191 |
; Anzahl |
| 192 |
|
-: Definiert die für die Bestellposition geltende Anzahl. Der hier definierte Wert muss zur Laufzeit einer Zahl größer 0 entsprechen, damit die Bestellposition mit in die aktuelle Bestellung einbezogen wird. Die Anzahl dient weiterhin zur Berechnung des Gesamtpreises der Bestellposition innerhalb der Bestellung |
| 193 |
|
-; Buchungstext |
|
191 |
+: Definiert die für die Bestellposition geltende Anzahl. Der hier definierte Wert muss zur Laufzeit einer Zahl größer 0 entsprechen, damit die Bestellposition mit in die aktuelle Bestellung einbezogen wird. Die Anzahl dient weiterhin zur Berechnung des Gesamtpreises der Bestellposition innerhalb der Bestellung |
|
192 |
+; Buchungstext |
| 194 |
194 |
: Der hier definierte Text wird als Buchungstext übermittelt. Er darf nur aus SEPA-konformen Zeichen bestehen und maximal 21 Zeichen lang sein. Der Text kann dabei auch aus Platzhaltern stammen. Er wird, wenn dies notwendig ist, automatisch auf 21 Zeichen eingekürzt. |
| 195 |
195 |
; Preis (in Euro) |
| 196 |
|
-: Der (Einzel)Preis für die Bestellposition. Der an dieser Stelle konfigurierten Wert muss sich in eine kommaseparierte Zahl umwandeln lassen und dient zur Berechnung der Gesamtsumme für die Bestellposition. (Berechnung: Gesamtpreis = Anzahl x Preis) |
|
195 |
+: Der (Einzel)Preis für die Bestellposition. Der an dieser Stelle konfigurierte Wert muss sich in eine kommaseparierte Zahl umwandeln lassen und dient zur Berechnung der Gesamtsumme für die Bestellposition. (Berechnung: Gesamtpreis = Anzahl x Preis) |
| 197 |
197 |
; Beschreibung |
| 198 |
|
-: Dient der interne Beschreibung der Bestellposition. Diese Information wird nicht an ePayBL weiter gegeben. |
|
197 |
+: Dient der interne Beschreibung der Bestellposition. Diese Information wird nicht an ePay-BL weiter gegeben. |
| 199 |
199 |
; Belegnummer |
| 200 |
|
-: Die Belegnummer ist ein optionaler Wert, welcher zur weiterführenden Verarbeitung auf Seiten von ePayBL dient. |
|
199 |
+: Die Belegnummer ist ein optionaler Wert, welcher zur weiterführenden Verarbeitung auf Seiten von ePay-BL dient. |
| 201 |
201 |
|
| 202 |
|
-Über den Button [[image:icon_add.png]] können neue Bestellpositionen hinzugefügt werden. Über den Button [[image:icon_del.png]] lässt sich die jeweilige Bestellposition wieder aus der Tabelle entfernen. |
|
201 |
+Über den Button [[image:icon_add.png]] können neue Bestellpositionen hinzugefügt werden. Über den Button [[image:icon_del.png]] lässt sich die jeweilige Bestellposition wieder aus der Tabelle entfernen. |
| 203 |
203 |
|
| 204 |
204 |
{{/panel}} |
| 205 |
205 |
|
| 206 |
|
-{{panel title="Konfiguration ePayBL ePayment-Mandant" fullwidth="true" initial="visible" triggerable="true"}} |
|
205 |
+{{panel title="Konfiguration AKDB ePayment-Mandant" fullwidth="true" initial="visible" triggerable="true"}} |
| 207 |
207 |
|
| 208 |
208 |
{{figure image="plugin_init_config_akdb_mandant.png"}} |
| 209 |
|
-Konfiguration ePayBL EPayment-Mandant |
|
208 |
+Konfiguration AKDB EPayment-Mandant |
| 210 |
210 |
{{/figure}} |
| 211 |
211 |
|
| 212 |
|
-In diesem Bereich können die globalen Einstellungen für den zu verwendenden ePayBL Mandanten übersteuert werden. Die Einstellungen zum ePayBL Mandanten sind notwendig, um später die Transaktion auf Seiten von ePayBL |
| 213 |
|
-der richtigen Behörde (entspricht der festgelegten Mandant-Nummer), dem Bewirtschafter und der Haushaltsstelle zuzuordnen. |
|
211 |
+In diesem Bereich können die globalen Einstellungen für den zu verwendenden ePay-BL Mandanten übersteuert werden. Die Einstellungen zum ePay-BL Mandanten sind notwendig, um später die Transaktion auf Seiten von ePay-BL |
|
212 |
+der richtigen Behörde (entspricht der festgelegten Mandant-Nummer), dem Bewirtschafter und der Haushaltsstelle zuzuordnen. |
| 214 |
214 |
In den meisten Fällen sind diese Einstellungen bereits durch einen Plugin-Administrator global hinterlegt worden, sodass an dieser Stelle keine Konfiguration notwendig ist. |
| 215 |
215 |
|
| 216 |
216 |
Die einzelnen Parameter können per Platzhalter oder fest definiert hinterlegt werden. Weiterhin kann über den Button [[image:icon_update.png]] //Webservice Erreichbarkeit prüfen// die generelle Erreichbarkeit des EPayment Webservice geprüft werden. |
| 217 |
217 |
|
| 218 |
218 |
; Mandant-Nummer |
| 219 |
|
-: ePayBL-Mandantennummer des aufrufenden eShops (FORMCYCLE) (Wird durch ePayBL-System vorgegeben) |
|
218 |
+: AKDB-Mandantennummer des aufrufenden eShops (FORMCYCLE) (Wird durch ePay-BL-System vorgegeben) |
| 220 |
220 |
; Bewirtschafter-Nummer |
| 221 |
|
-: Bewirtschafternummer (Wird durch ePayBL-System vorgegeben) |
|
220 |
+: Bewirtschafternummer (Wird durch ePay-BL-System vorgegeben) |
| 222 |
222 |
; Haushaltsstelle |
| 223 |
|
-: Nummer der Haushaltsstelle, welcher die Buchung zugeordnet werden soll. (Wird durch ePayBL-System vorgegeben) |
|
222 |
+: Nummer der Haushaltsstelle, welcher die Buchung zugeordnet werden soll. (Wird durch ePay-BL-System vorgegeben) |
| 224 |
224 |
; Objektnummer |
| 225 |
|
-: Dient der internen Verbuchung im EPayment-System. (Wird durch ePayBL-System vorgegeben) |
|
224 |
+: Dient der internen Verbuchung im EPayment-System. (Wird durch ePay-BL-System vorgegeben) |
| 226 |
226 |
; Kennzeichen-Mahnverfahren |
| 227 |
|
-: Einstellung für das Kennzeichen in einem Mahnverfahren. (Mögliche Werte werden durch ePayBL-System vorgegeben) |
|
226 |
+: Einstellung für das Kennzeichen in einem Mahnverfahren. (Mögliche Werte werden durch ePay-BL-System vorgegeben) |
| 228 |
228 |
; Fälligkeitszeitraum |
| 229 |
229 |
: Einstellung für die Berechnung des Fälligkeitszeitraumes der Zahlung (Dauer in Tagen). |
| 230 |
230 |
|
