| ... |
... |
@@ -1,7 +5,3 @@ |
| 1 |
|
-[[**Plugin download**>>url:https://customer.formcycle.eu/index.php/apps/files/?dir=/FORMCYCLE%20-%20Plugins%20Customer/plugin-bundle-akdb-epayment&fileid=2674||rel="noopener noreferrer" target="_blank"]] (requires login) |
| 2 |
|
- |
| 3 |
|
-{{content/}} |
| 4 |
|
- |
| 5 |
5 |
{{info}} |
| 6 |
6 |
**Achtung:** |
| 7 |
7 |
Bevor Sie die AKDB EPayment in ihren Formular-Prozessen einbinden, stellen Sie bitte sicher, dass die konfigurative Anbindung des Dienstes durch den {{formcycle/}}-Administrator erfolgt ist! |
| ... |
... |
@@ -34,11 +34,9 @@ |
| 34 |
34 |
{{/figure}} |
| 35 |
35 |
|
| 36 |
36 |
Über das Formular-Element //EPayment Artikel// werden die für eine Bestell-Transaktion notwendigen Artikel definiert. |
| 37 |
|
-Das Formular-Element dient dabei zum Einen für eine visuelle Darstellung des Artikels (mit Bild, Beschreibung, Preisangabe, Eingabemöglichkeit für Bestellmenge) innerhalb eines Formulars, als auch als Vorlage für die Erstellung einer konkreten Bestellposition zum Zeitpunkt der Ausführung einer Bezahl-Transaktion. |
|
33 |
+Das Formular-Element dient dabei zum Einen für eine visuelle Darstellung des Artikels (mit Bild, Preisangabe, Eingabemöglichkeit für Bestellmenge) innerhalb eines Formulars, als auch als Vorlage für die Erstellung einer |
|
34 |
+konkreten Bestell-Position zum Zeitpunkt der Ausführung einer Bezahl-Transaktion. |
| 38 |
38 |
|
| 39 |
|
-Ab Plugin-Version {{version major="3" minor="3" patch="0"}}{{/version}} können Bestellpositionen auch direkt in der Workflow-Aktion definiert werden. |
| 40 |
|
-Dadurch muss kein //EPayment Artikel// zwingend im Formular vorhanden sein. Bei Konfiguration der Workflow-Aktion **[[Bestellung übermitteln>>doc:||anchor="plugin_epay_init"]]** wird geprüft, dass mindestens ein //EPayment Artikel// im Formular oder eine Bestellposition direkt in der Workflow-Aktion vorhanden ist. |
| 41 |
|
- |
| 42 |
42 |
__Grundeigenschaften:__ |
| 43 |
43 |
|
| 44 |
44 |
; Versteckt |
| ... |
... |
@@ -59,7 +59,7 @@ |
| 59 |
59 |
; Max. Bestellmenge |
| 60 |
60 |
: Hier kann die für den Nutzer maximal auswählbare Bestellmenge für einen Artikel definiert werden. |
| 61 |
61 |
; Belegnummer |
| 62 |
|
-: Die Belegnummer ist ein optionaler Wert, welcher zur weiterführenden Verarbeitung auf Seiten von ePay-BL dient. |
|
56 |
+: Die Belegnummer ist ein optionaler Wert, welcher zur weiterführenden Verarbeitung auf Seiten von ePay-BL dient |
| 63 |
63 |
|
| 64 |
64 |
{{info}} |
| 65 |
65 |
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. |
| ... |
... |
@@ -89,7 +89,8 @@ |
| 89 |
89 |
=== 1.3. Bestellung an den Server übermitteln: === |
| 90 |
90 |
|
| 91 |
91 |
Um eine Bestellung auszulösen und die bestellten Artikel zum Server zu übertragen muss dem Formular eine //Senden//-Schaltfläche hinzugefügt werden. |
| 92 |
|
-\\{{id name="config_process"/}} |
|
86 |
+ |
|
87 |
+{{id name="config_process"/}} |
| 93 |
93 |
|
| 94 |
94 |
== 2. Workflow für EPayment konfigurieren == |
| 95 |
95 |
|
| ... |
... |
@@ -98,13 +98,14 @@ |
| 98 |
98 |
* 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. |
| 99 |
99 |
* 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. |
| 100 |
100 |
* 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. |
|
96 |
+* HTML-Template **AKDB ePayment Bezahlung Erfolg**: Standard-Template für Anzeige bei erfolgreich abgeschlossener Bezahlung. |
|
97 |
+* HTML-Template **AKDB ePayment Bezahlung Fehler**: Standard-Template für Anzeige bei offenen bzw. fehlerhaft beendeten Bezahlvorgang |
|
98 |
+* HTML-Template **AKDB ePayment Fehler**: Standard-Template für Anzeige bei allgemeinen technischen Fehlern |
| 101 |
101 |
|
| 102 |
102 |
Ein Workflow für einen einfachen Fall kann folgendermaßen konfiguriert sein: |
| 103 |
103 |
|
| 104 |
|
-{{figure image="hilfe_workflow.png"}} |
| 105 |
|
-Workflow mit EPayment Anbindung |
| 106 |
|
-{{/figure}} |
| 107 |
|
- |
|
102 |
+(% style="background-color:transparent; border:none" %) |
|
103 |
+|(% style="border-style:none; width:180px" %)[[image:hilfe_workflow.png||alt="Workflow mit EPayment Anbindung"]]|(% style="border-style:none; width:800px" %)((( |
| 108 |
108 |
__Kurze Ablaufbeschreibung zum dargestellten Workflow:__ |
| 109 |
109 |
|
| 110 |
110 |
~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. |
| ... |
... |
@@ -111,19 +111,21 @@ |
| 111 |
111 |
|
| 112 |
112 |
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. |
| 113 |
113 |
|
| 114 |
|
-3. Ist die Bezahlung erfolgt, wird in den Status //Bezahlt// gewechselt und dem Nutzer wird eine entsprechende Abschlussseite angezeigt. |
|
110 |
+3. Im Falle das die Bezahlung erfolgt ist, wird im Beispiel in den Status //Bezahlt// gewechselt und dem Nutzer wird eine entsprechende Abschlussseite angezeigt. |
| 115 |
115 |
|
| 116 |
|
-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 |
| 117 |
|
-wird eine entsprechende Abschlussseite angezeigt. |
|
112 |
+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 Fall eien E-Mail erzeugt, in der der Benutzer auf die noch ausstehende Zahlung hingewiesen wird. Der Workflow wird in diesem Beispiel mit einem Wechsel in den Status //Nicht bezahlt// |
|
113 |
+abgeschlossen. Dem Nutzer wird eine entsprechende Abschlussseite angezeigt. |
|
114 |
+ |
|
115 |
+))) |
| 118 |
118 |
|
| 119 |
119 |
{{id name="plugin_epay_init"/}} |
| 120 |
120 |
|
| 121 |
121 |
=== 2.1. Konfigurationsmöglichkeiten des Aktions-Plugins //Bestellung übermitteln// === |
| 122 |
122 |
|
| 123 |
|
-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. |
|
121 |
+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, Rechnungsadresse etc.), festgelegt. Weiterhin erfolgt die Festlegung in welchen Status, nach Rückkehr aus dem ePay-BL Portal, gewechselt werden soll. |
| 124 |
124 |
|
| 125 |
125 |
{{info}} |
| 126 |
|
-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. |
|
124 |
+Wenn vor der Konfiguration des Plugins bereits mindestens ein **[[EPayment-Artikel>>doc:||anchor="epay_artikel"]]**, der **[[EPayment Bestellen Button>>doc:||anchor="epay_btn"]]** sowie die **[[Vorlage>>doc:||anchor="epay_vorlage"]]** für die **persönlichen Daten** im Formular hinterlegt wurden, werden bei einer Neueinrichtung der //AKDB:EPayment initialisieren// Plugin-Aktion die notwendigen Pflicht-Konfigurationen bereits mit den ermittelten Daten aus dem Formular vorbelegt. Es muss anschließend nur noch der Ziel-Status für eine erfolgreiche / nicht erfolgreiche Transaktion festgelegt werden. |
| 127 |
127 |
|
| 128 |
128 |
Es empfiehlt sich deshalb die in diesem Artikel beschriebene [[Konfigurations-Reihenfolge>>doc:||anchor="config_reihenfolge"]] einzuhalten. |
| 129 |
129 |
|
| ... |
... |
@@ -132,291 +132,85 @@ |
| 132 |
132 |
|
| 133 |
133 |
Die Konfigurationsoberfläche des Aktions-Plugins ist in einzelne Bereiche unterteilt die nachfolgend kurz beschrieben werden. |
| 134 |
134 |
|
| 135 |
|
-{{panel title="Kundenstammdaten" fullwidth="true" initial="visible" triggerable="true"}} |
|
133 |
+{{panel title="Konfiguration AKDB EPayment-Mandant" fullwidth="true" initial="visible" triggerable="true"}} |
| 136 |
136 |
|
| 137 |
|
-{{figure image="plugin_init_config_kundenstammdaten.png"}} |
| 138 |
|
-Konfiguration für die Kundenstammdaten |
| 139 |
|
-{{/figure}} |
| 140 |
|
- |
| 141 |
|
-In diesem Bereich werden die Daten des Benutzers hinterlegt, für den die Bezahl-Transaktion erzeugt werden soll. |
| 142 |
|
-Die einzelnen Parameter können per Platzhalter oder fest definiert hinterlegt werden. |
| 143 |
|
- |
| 144 |
|
-{{info}} |
| 145 |
|
-Über den [[image:icon_update.png]]-Button können diese Felder durch Nutzung der EPayment-Vorlage //Persönliche Daten// vorbelegt werden. |
| 146 |
|
-{{/info}} |
| 147 |
|
- |
| 148 |
|
-; Anrede |
| 149 |
|
-; Titel |
| 150 |
|
-; Vorname |
| 151 |
|
-; Nachname (Pflichtfeld) |
| 152 |
|
-; Geburtsdatum |
| 153 |
|
-: Geburtsdatum muss in der Form **dd.MM.yyyy** übermittelt werden. |
| 154 |
|
-; E-Mail |
| 155 |
|
-: Wird für die Zustellung von Emails an den Kunden in Abhängigkeit von der ePay-BL-Mandantkonfiguration benötigt. |
| 156 |
|
-; Telefon |
| 157 |
|
-; Mobiltelefon |
| 158 |
|
- |
| 159 |
|
-{{/panel}} |
| 160 |
|
- |
| 161 |
|
-{{id name="config_paypage"/}} |
| 162 |
|
- |
| 163 |
|
-{{panel title="Konfiguration für die PayPage" fullwidth="true" initial="visible" triggerable="true"}} |
| 164 |
|
- |
| 165 |
|
-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. |
| 166 |
|
- |
| 167 |
|
-{{figure image="plugin_init_config_paypage.png"}} |
| 168 |
|
-Konfiguration für die PayPage |
| 169 |
|
-{{/figure}} |
| 170 |
|
- |
| 171 |
|
-; Automatische Weiterleitung zur PayPage verhindern |
| 172 |
|
-: Bei aktivierter Einstellung kann eine automatische Weiterleitung zur PayPage unterbunden werden. |
| 173 |
|
-; Fälligkeitsdatum |
| 174 |
|
-: Der konfigurierte Wert muss sich in ein gültiges Datum umwandeln lassen. Wenn an dieser Stelle ein Wert hinterlegt ist, wird dieser als Fälligkeitszeitpunkt für die Zahlung übermittelt und die globale Einstellung für den **Fälligkeitszeitraum** wird nicht beachtet. |
| 175 |
|
-; Buchungstext auf PayPage |
| 176 |
|
-: Der hier festgelegte Buchungstext wird dem Benutzer auf der PayPage angezeigt. |
| 177 |
|
-{{/panel}} |
| 178 |
|
- |
| 179 |
|
-{{panel title="Definition zusätzlicher Bestellpositionen" fullwidth="true" triggerable="true"}} |
| 180 |
|
- |
| 181 |
|
-{{figure image="plugin_init_config_bestellposition.png"}} |
| 182 |
|
-Konfiguration von zusätzlichen Bestellpositionen |
| 183 |
|
-{{/figure}} |
| 184 |
|
- |
| 185 |
|
-; Anzahl |
| 186 |
|
-: 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 |
| 187 |
|
-; Buchungstext |
| 188 |
|
-: 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. |
| 189 |
|
-; Preis (in Euro) |
| 190 |
|
-: 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) |
| 191 |
|
-; Beschreibung |
| 192 |
|
-: Dient der interne Beschreibung der Bestellposition. Diese Information wird nicht an ePay-BL weiter gegeben. |
| 193 |
|
-; Belegnummer |
| 194 |
|
-: Die Belegnummer ist ein optionaler Wert, welcher zur weiterführenden Verarbeitung auf Seiten von ePay-BL dient. |
| 195 |
|
- |
| 196 |
|
-Ü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. |
| 197 |
|
- |
| 198 |
|
-{{/panel}} |
| 199 |
|
- |
| 200 |
|
-{{panel title="Konfiguration AKDB ePayment-Mandant" fullwidth="true" initial="visible" triggerable="true"}} |
| 201 |
|
- |
| 202 |
202 |
{{figure image="plugin_init_config_akdb_mandant.png"}} |
| 203 |
203 |
Konfiguration AKDB EPayment-Mandant |
| 204 |
204 |
{{/figure}} |
| 205 |
205 |
|
| 206 |
|
-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 |
| 207 |
|
-der richtigen Behörde (entspricht der festgelegten Mandant-Nummer), dem Bewirtschafter und der Haushaltsstelle zuzuordnen. |
| 208 |
|
-In den meisten Fällen sind diese Einstellungen bereits durch einen Plugin-Administrator global hinterlegt worden, sodass an dieser Stelle keine Konfiguration notwendig ist. |
|
139 |
+In diesem Bereich werden die für den Formular-Prozess zu verwendenden Einstellungen des ePay-BL Mandanten hinterlegt. Diese sind notwendig, um später die Transaktion auf Seiten von ePay-BL |
|
140 |
+der richtigen Behörde (entspricht der festgelegten Mandant-Nummer), Bewirtschafter und Haushaltsstelle zuzuordnen. Die Daten in diesem Bereich sind meistens bereits mit globalen Einstellungen vorbefüllt, |
|
141 |
+sofern diese durch einen Plugin-Administrator korrekt hinterlegt wurden. |
| 209 |
209 |
|
| 210 |
|
-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. |
| 211 |
211 |
|
| 212 |
|
-; Mandant-Nummer |
|
144 |
+Die einzelnen Parameter können per Platzhalter oder fest definiert hinterlegt werden. Weiterhin kann über den Button [[image:icon_update.png]] //EPayment Webservice Erreichbarkeit prüfen// die generelle Erreichbarkeit des EPayment Webservice geprüft werden. |
|
145 |
+ |
|
146 |
+; Mandant-Nummer (Pflichtfeld) |
| 213 |
213 |
: AKDB-Mandantennummer des aufrufenden eShops (FORMCYCLE) (Wird durch ePay-BL-System vorgegeben) |
| 214 |
|
-; Bewirtschafter-Nummer |
|
148 |
+; Bewirtschafter-Nummer (Pflichtfeld) |
| 215 |
215 |
: Bewirtschafternummer (Wird durch ePay-BL-System vorgegeben) |
| 216 |
|
-; Haushaltsstelle |
|
150 |
+; Haushaltsstelle (Pflichtfeld) |
| 217 |
217 |
: Nummer der Haushaltsstelle, welcher die Buchung zugeordnet werden soll. (Wird durch ePay-BL-System vorgegeben) |
| 218 |
|
-; Objektnummer |
|
152 |
+; Objektnummer (Pflichtfeld) |
| 219 |
219 |
: Dient der internen Verbuchung im EPayment-System. (Wird durch ePay-BL-System vorgegeben) |
| 220 |
|
-; Kennzeichen-Mahnverfahren |
|
154 |
+; Kennzeichen-Mahnverfahren (Pflichtfeld) |
| 221 |
221 |
: Einstellung für das Kennzeichen in einem Mahnverfahren. (Mögliche Werte werden durch ePay-BL-System vorgegeben) |
| 222 |
|
-; Fälligkeitszeitraum |
|
156 |
+; Fälligkeitszeitraum (Pflichtfeld) |
| 223 |
223 |
: Einstellung für die Berechnung des Fälligkeitszeitraumes der Zahlung (Dauer in Tagen). |
|
158 |
+; Währung |
|
159 |
+: Währung in welcher der Betrag ausgewiesen wird. Ist nichts definiert wird als Wert **EUR** angenommen. |
| 224 |
224 |
|
| 225 |
225 |
{{/panel}} |
| 226 |
226 |
|
| 227 |
|
-==== 2.1.1 Rückgabewerte der Workflow-Aktion ==== |
|
163 |
+{{id name="config_paypage"/}} |
| 228 |
228 |
|
| 229 |
|
-{{figure image="plugin_init_result.png"}} |
| 230 |
|
-Rückgabewert und Fehlercodes der Aktion |
| 231 |
|
-{{/figure}} |
|
165 |
+{{panel title="Konfiguration für die PayPage" fullwidth="true" initial="visible" triggerable="true"}} |
| 232 |
232 |
|
| 233 |
|
-__Rückgabewerte__ |
|
167 |
+Bei der "PayPage" handelt es sich dabei um eine bereits ausgefüllte Bezahlseite zur Online-Bezahlung der vom Gläubiger, für die jeweils erbrachten Leistungen, veranschlagten Gebühren, Entgelte etc. |
| 234 |
234 |
|
| 235 |
|
-; [%$[Name der Aktion].RESULT.BestellPosition[i]['key']%] |
| 236 |
|
-: Eine Auflistung über alle Bestell-Positionen, welche in der aktuellen Bestellung enthalten sind. |
| 237 |
|
-Zu jeder Bestell-Position können folgende Werte abgefragt werden: |
| 238 |
|
- |
| 239 |
|
-((( |
| 240 |
|
-* **Artikelnummer**: Die am //EPayment Artikel// hinterlegte eindeutige Kennung für den Artikel |
| 241 |
|
-* **Buchungstext**: Der übermittelte Buchungstext (max.21 Zeichen, SEPA konform) |
| 242 |
|
-* **Menge**: Die bestellte Menge für die aktuelle Bestell-Position |
| 243 |
|
-* **Beschreibung**: Die am //EPayment Artikel// hinterlegte Artikel-Beschreibung |
| 244 |
|
-* **Einzelpreis**: Der am //EPayment Artikel// hinterlegte Preis für ein Stück. Ausgabe mit Währungssymbol. |
| 245 |
|
-* **Preis**: Der errechnete Gesamtpreis für die aktuelle Bestell-Position. Ergibt sich aus //Menge x Einzelpreis//. Ausgabe mit Währungssysmbol |
| 246 |
|
- |
| 247 |
|
- Nachfolgend einige Beispiele für die Datenabfrage aus den Bestellpositionen: |
| 248 |
|
- Für die Beispiele wird folgender durch eine Aktion mit Namen //Bestellung übermitteln// bereitgestellter Platzhalter zu Grunde |
| 249 |
|
- gelegt: **[%$Bestellung übermitteln.RESULT.Bestellung[i][''key'']%]** |
| 250 |
|
- Die in den eckigen Klammern hinterlegten Werte sind variabel und haben folgende Bedeutung: |
| 251 |
|
- |
| 252 |
|
- |
| 253 |
|
-* **i**: Zählvariable für den Zugriff auf eine Bestell-Position aus der Gruppe aller Bestell-Positionen. Ein möglicher Wert muss sich im Bereich von 0 bis zum Wert der BestellPositionAnzahl -1 befinden. |
| 254 |
|
-* **key**: Schlüssel für den Zugriff auf die jeweilige Eigenschaft |
| 255 |
|
- |
| 256 |
|
- Beispiele: |
| 257 |
|
- Abfrage des Einzelpreises an der 1. Bestell-Position: **[%$Bestellung übermitteln.RESULT.Bestellung[0][''Einzelpreis'']%]** |
| 258 |
|
- Abfrage der Menge an der 3. Bestell-Position: **[%$Bestellung übermitteln.RESULT.Bestellung[2][''Menge'']%]** |
| 259 |
|
-))) |
| 260 |
|
- |
| 261 |
|
-; [%$[Name der Aktion].RESULT.BestellPositionAnzahl%] |
| 262 |
|
-: Die Gesamtanzahl der Bestellpositionen, welche in der aktuellen Bestellung enthalten sind |
| 263 |
|
-; [%$[Name der Aktion].RESULT.Gesamtbetrag%] |
| 264 |
|
-: Der in der Zahlungstransaktion ausgewiesene zu zahlende Geldbetrag. Angabe in Euro |
| 265 |
|
-; [%$[Name der Aktion].RESULT.Kassenzeichen%] |
| 266 |
|
-: Das aktuelle Kassenzeichen unter dem die Zahlungstransaktion im ePay-BL Portal geführt wird. |
| 267 |
|
-; [%$[Name der Aktion].RESULT.UrlToPaypage%] |
| 268 |
|
-: Die URL zur Bezahlseite auf Seiten von ePay-BL, wo die Bezahlung der aktuellen Transaktion durchgeführt werden kann. |
| 269 |
|
- |
| 270 |
|
-__Fehlercodes__ |
| 271 |
|
- |
| 272 |
|
-; NO_ORDER_DATA |
| 273 |
|
-: Fehlercode, wenn zur Laufzeit keine Bestellpositionen übermittelt wurden. Diese kann beispielweise auftreten, wenn der Formular-Nutzer beispielsweise keine Artikel zum Bestellen ausgewählt hatte. |
| 274 |
|
-; SRV_NOT_AVIALABLE |
| 275 |
|
-: Fehlercode, wenn der ePay-BL Service nicht verfügbar ist. |
| 276 |
|
-; SRV_METHOD_ERROR |
| 277 |
|
-: Fehlercode, wenn eine ePay-BL Webservice-Methode einen Fehler lieferte. Bei Auftreten von solchen Fehlertypen sollte das |
| 278 |
|
-{{formcycle/}} interne Fehler-Protokoll für eine tiefere Analyse einbezogen werden. |
| 279 |
|
-; INTERNAL_ERROR |
| 280 |
|
-: Fehlercode für einen nicht nähere beschriebenen Fehler. Bei Auftreten von solchen Fehlertypen sollte das |
| 281 |
|
-{{formcycle/}} interne Fehler-Protokoll für eine tiefere Analyse einbezogen werden. |
| 282 |
|
-{{id name="plugin_event_epay_success"/}} |
| 283 |
|
- |
| 284 |
|
-=== 2.2. Workflow-Ereignis //Bezahlung erfolgreich// === |
| 285 |
|
- |
| 286 |
|
-{{figure image="trigger_success.png"}} |
| 287 |
|
-Workflow-Ereignis bei erfolgreicher Bezahlung |
|
169 |
+{{figure image="plugin_init_config_paypage.png"}} |
|
170 |
+Konfiguration für die PayPage |
| 288 |
288 |
{{/figure}} |
| 289 |
289 |
|
| 290 |
|
-Eine Workflow-Verarbeitungskette mit diesem Ereignis wird ausgeführt, wenn eine Rückleitung aus dem ePay-BL Portal erfolgt |
| 291 |
|
-und die Bezahlung erfolgreich durchgeführt wurde. Pro Formular-Vorgang kann dieses Ereignis genau einmal eintreten. |
| 292 |
|
-Das Ereignis stellt dabei folgende Werte bereit, die per Platzhalter in nachfolgenden Aktionen ausgewertet werden können: |
| 293 |
293 |
|
| 294 |
|
-; **[%$TRIGGER.paymentStatus%]** |
| 295 |
|
-: Bezeichnung des Status, wie er vom ePay-BL Portal zurück geliefert wird. (Möglicher Wert: INAKTIV) |
| 296 |
|
-; **[%$TRIGGER.paymentStatusText%]** |
| 297 |
|
-: Eine Nachricht, die den zurück gelieferten Status näher beschreibt |
| 298 |
|
-; **[%$TRIGGER.paymentMethod%] {{version major="3" minor="5"}}{{/version}}** |
| 299 |
|
-: Parameter gibt Auskunft über das in der Bezahl-Transaktion angewendete Zahlverfahren |
|
174 |
+; URL zur PayPage (Pflichtfeld) |
|
175 |
+: URL zur PayPage des EPayment-Systems. Die hier hinterlegte URL wird durch das ePay-BL-System vorgegeben und beinhaltete den Verweis auf die PayPage im ePay-BL-System. |
|
176 |
+; Automatische Weiterleitung zur PayPage verhindern |
|
177 |
+: Bei aktivierter Einstellung kann eine automatische Weiterleitung zur PayPage unterbunden werden. |
|
178 |
+; Status, in welchen nach erfolgreicher Transaktion gewechselt wird (Pflichtfeld) |
|
179 |
+: Hier muss ein Status festgelegt werden, in welchen gewechselt wird, wenn der Bezahlvorgang auf Seiten des ePay-BL-Systems erfolgreich durchlaufen wurde. |
|
180 |
+; Status, in welchen nach fehlerhafter oder abgebrochener Transaktion gewechselt wird (Pflichtfeld) |
|
181 |
+: Hier muss ein Status festgelegt werden, in welchen gewechselt wird, wenn der Bezahlvorgang auf Seiten des ePay-BL-Systems abgebrochen wurde. |
|
182 |
+; PayPage Buchungstext |
|
183 |
+: Dieser Buchungstext wird dem Benutzer auf der PayPage angezeigt. |
|
184 |
+; Fälligkeitsdatum |
|
185 |
+: Der konfigurierte Wert muss sich in ein gültiges Datum umwandeln lassen. Wenn an dieser Stelle ein Wert hinterlegt ist, wird dieser als Fälligkeitszeitpunkt für die Zahlung übermittelt und |
|
186 |
+die Einstellung für den **Fälligkeitszeitraum** wird nicht beachtet. |
|
187 |
+{{/panel}} |
| 300 |
300 |
|
| 301 |
|
-{{id name="plugin_event_epay_error"/}} |
|
189 |
+{{panel title="Kundenstammdaten" fullwidth="true" initial="visible" triggerable="true"}} |
| 302 |
302 |
|
| 303 |
|
-=== 2.3. Workflow-Ereignis //Bezahlung nicht erfolgreich// === |
| 304 |
|
- |
| 305 |
|
-{{figure image="trigger_error.png"}} |
| 306 |
|
-Workflow-Ereignis bei nicht erfolgreicher Bezahlung |
|
191 |
+{{figure image="plugin_init_config_kundenstammdaten.png"}} |
|
192 |
+Konfiguration für die Kundenstammdaten |
| 307 |
307 |
{{/figure}} |
| 308 |
308 |
|
| 309 |
|
-Eine Workflow-Verarbeitungskette mit diesem Ereignis wird immer dann ausgeführt, wenn eine Rückleitung aus dem ePay-BL Portal erfolgte |
| 310 |
|
-und die Bezahlung nicht durchgeführt wurde. Pro Formular-Vorgang kann dieses Ereignis mehrfach eintreten (Bei Fehlern im ePay-BL Portal oder bei Abbruch des Bezahlvorgangs durch den Nutzer). |
| 311 |
|
-Das Ereignis stellt folgende Werte bereit, die per Platzhalter in nachfolgenden Aktionen ausgewertet werden können: |
|
195 |
+In diesem Bereich werden die Daten des Benutzers hinterlegt, für den die Bezahl-Transaktion erzeugt werden soll. |
|
196 |
+Die einzelnen Parameter können per Platzhalter oder fest definiert hinterlegt werden. |
| 312 |
312 |
|
| 313 |
|
-; **[%$TRIGGER.paymentStatus%]** |
| 314 |
|
-: Bezeichnung des Status, wie er vom ePay-BL Portal zurückgeliefert wird. |
| 315 |
|
-: Folgende Werte sind möglich: |
| 316 |
|
-: **AKTIV**: Die Bezahlung über die PayPage ist noch nicht erfolgt. |
| 317 |
|
-: **MANDANT_NICHT_GEFUNDEN**: Der Mandant wurde im ePayment-System nicht gefunden. |
| 318 |
|
-: **MANDANT_INAKTIV**: Der Mandant ist im ePayment-System derzeit als inaktiv gekennzeichnet. |
| 319 |
|
-: **VERBINDUNG_OHNE_HTTPS**: Die Verbindung zum Webservice erfolgte nicht über HTTPS mit Client-Zertifikaten. |
| 320 |
|
-: **VERBINDUNG_ZERTIFIKAT_FEHLER**: Das für die Verbindung verwendete Client-Zertifikat darf nicht für den gewählten Mandanten verwendet werden. |
| 321 |
|
-: **KASSENZEICHEN_NICHT_VORHANDEN**: Das gewählte Kassenzeichen ist nicht vorhanden. |
| 322 |
|
-: **KASSENZEICHEN_NICHT_GEFUNDEN**: Das gewählte Kassenzeichen konnte nicht gefunden werden. |
| 323 |
|
-: **INTERNER_EPAYMENT_FEHLER**: Interner nicht dokumentierter Fehler im ePayment-System. |
| 324 |
|
-: **UNDEFINIERT**: Ein im System nicht bekannter Status |
| 325 |
|
-; **[%$TRIGGER.paymentStatusText%]** |
| 326 |
|
-: Eine Nachricht, die den zurückgelieferten Status näher beschreibt |
| 327 |
|
-; **[%$TRIGGER.paypageUrl%]** |
| 328 |
|
-: URL zur Paypage mit der aktuellen Transaktionsnummer. Damit ist ein nochmaliges Aufrufen und Bezahlen der offenen Transaktion möglich. |
| 329 |
|
-; **[%$TRIGGER.paymentMethod%]** {{version major="3" minor="5"}}{{/version}} |
| 330 |
|
-: Parameter gibt Auskunft über das in der Bezahl-Transaktion angewendete Zahlverfahren |
| 331 |
|
-; **[%$TRIGGER.paymentVerifyUrl%] {{version major="3" minor="5"}}{{/version}}** |
| 332 |
|
-: URL zum erneuten Prüfen des Bezahlstatus. Ein Aufruf der URL löst im Anschluss, an die Überprüfung des aktuellen Bezahlstatus, die entsprechenden Workflow-Ereignisse aus |
| 333 |
|
- |
| 334 |
|
-== 3. Ergebnisanzeige == |
| 335 |
|
- |
| 336 |
|
-Die Anzeige des Ergebnisses bzw. des Status einer Bezahl-Transaktion erfolgt standardmäßig mittels einer extra Abschluss-Seite. |
| 337 |
|
-Dafür stellt das Plugin 3 HTML-Templates bereit: |
| 338 |
|
- |
| 339 |
|
-* **AKDB ePayment Bezahlung Erfolg**: Standard-Template für Anzeige bei erfolgreich abgeschlossener Bezahlung. |
| 340 |
|
-* **AKDB ePayment Bezahlung Fehler**: Standard-Template für Anzeige bei offenen bzw. fehlerhaft beendeten Bezahlvorgang. Dieser Template enthält Platzhalter für Anzeige des konkreten Fehlers und einen Link zum Wiederaufruf des noch ausstehenden Bezahlvorgangs. |
| 341 |
|
-* **AKDB ePayment Fehler**: Standard-Template für Anzeige bei allgemeinen technischen Fehlern. Der genaue Fehler wird mittels enthaltener Platzhalter ausgewiesen. |
| 342 |
|
- |
| 343 |
343 |
{{info}} |
| 344 |
|
-Die durch das Plugin bereitgestellten HTML-Templates können bearbeitet werden. Änderungen haben dabei auf alle Formulare mit Bezahl-Workflow Auswirkungen, wenn Sie diese Standard-Templates nutzen. |
| 345 |
|
-Möchte man in einem einzelnen Bezahl-Workflow ein eigenes Abschluss-Seiten Template verwenden, so kann man dies über eine Aktion //HTML-Abschlussseite// in der jeweiligen Verarbeitungskette realisieren. |
|
199 |
+Über den Link [[image:icon_update.png]] //Formular-Elemente für Kundenstammdaten ermitteln// können die Felder bei Nutzung der EPayment-Vorlage //Persönliche Daten// vorbelegt werden. |
| 346 |
346 |
{{/info}} |
| 347 |
347 |
|
| 348 |
|
-== Versionshistorie == |
|
202 |
+; Anrede |
|
203 |
+; Titel |
|
204 |
+; Vorname |
|
205 |
+; Nachname (Pflichtfeld) |
|
206 |
+; Geburtsdatum |
|
207 |
+: Geburtsdatum muss in der Form **dd.MM.yyyy** übermittelt werden. |
|
208 |
+; E-Mail |
|
209 |
+: Wird für die Zustellung von Emails an den Kunden in Abhängigkeit von der ePay-BL-Mandantkonfiguration benötigt. |
|
210 |
+; Telefon (privat) |
|
211 |
+; Telefon (dienstlich) |
|
212 |
+; Mobiltelefon |
| 349 |
349 |
|
| 350 |
|
-=== 3.5.0 === |
| 351 |
|
- |
| 352 |
|
-* Erweiterungen: EPayment-Verifikation-Aktion (V6) um 'Zahlverfahren' erweitert. |
| 353 |
|
-Trigger (Workflow V7) um genutztes 'Zahlverfahren' innerhalb der Rückgabewerte erweitert. |
| 354 |
|
-Error-Trigger (Workflow V7) um 'PaymentVerifyUrl' erweitert. Dieser Parameter kann zum nochmaligen Aufruf der Verifizierung einer Bezahlung genutzt werden. |
| 355 |
|
-* Erweiterung AKDB ePay Setup: Eingabemöglichkeit für Daten des anzubindenden ePayment-Mandanten; Zusätzlicher Hinweis auf freizugebende URLs (notwendige Firewall-Freigaben) |
| 356 |
|
- |
| 357 |
|
-=== 3.4.3 === |
| 358 |
|
- |
| 359 |
|
-* Fehlerbehebung bei Rückleitung von der PayPage zum Formular: In einigen Fällen, insbesondere bei Kommunikation über den Frontend-Server, kam es zu Störungen beim Auslösen der nachgelagerten Workflow-Verarbeitung. Dies wurde behoben. |
| 360 |
|
- |
| 361 |
|
-=== 3.4.2 === |
| 362 |
|
- |
| 363 |
|
-* Fehlerbehebung: ein Anzeige-Fehler bei der Berechnung des Gesamtpreises für einen EPayment-Bestellartikel wurde behoben |
| 364 |
|
-* Fehlerbehebung: Aufgrund von Fehlern beim Decodieren und Entschlüsseln von URL-Parametern, wurde die Verschlüsselungs-Routine angepasst. |
| 365 |
|
- |
| 366 |
|
-=== 3.4.1 === |
| 367 |
|
- |
| 368 |
|
-* Fehlerbehebung EPayment Bestellartikel: Die Werte der widget-internen HTML-Elemente sind bei einer Zwischenspeicherung nicht berücksichtigt worden. Dies wurde behoben. |
| 369 |
|
- |
| 370 |
|
-=== 3.4.0 === |
| 371 |
|
- |
| 372 |
|
-* Erweiterung AKDB ePay Setup: Ein Verbindungstest ist jetzt auch ohne Konfiguration eines AKDB-Mandanten möglich. |
| 373 |
|
-* Anpassung EPayment Bestellartikel: HTML-Elemente innerhalb des Widgets um 'data-' Präfix erweitert |
| 374 |
|
-* Fehlerbehebung: Session-Replacer werden bei Verarbeitung der Workflow-Ereignisse berücksichtigt. |
| 375 |
|
- |
| 376 |
|
-=== 3.3.1 === |
| 377 |
|
- |
| 378 |
|
-* Fehlerbehebung: Mehrfache Anfragen auf den gleichen Vorgang bei Rückleitung vom ePay-BL-Portal werden jetzt vom System abgelehnt, solange der aktuell angefragte Vorgang sich in Verarbeitung befindet. |
| 379 |
|
- |
| 380 |
|
-=== 3.3.0 === |
| 381 |
|
- |
| 382 |
|
-* Plugin benötigt mindestens {{formcycle/}} in der Version {{version major="7" patch="9"}}{{/version}} |
| 383 |
|
-* Erweiterung Workflow-Aktion //Bestellung übermitteln//: Möglichkeit für serverseitige Definition von Bestellpositionen |
| 384 |
|
-* Einführung AKDB ePay Setup: Je nach Umgebung (Test oder Live) werden die korrekten URL's zum WS-Endpoint und zur PayPage hinterlegt. Weiterhin kann das Zertifikat für die Anbindung des ePay-Live Systems hinterlegt werden. |
| 385 |
|
- |
| 386 |
|
-=== 3.2.0 === |
| 387 |
|
- |
| 388 |
|
-* Erweiterung EPayment Bestellartikel: Am Element ist der Gesamtpreis (Anzahl * Einzelpreis) als verstecktes Element verfügbar. Dieser kann über die CSS-Klasse 'CXOrderItemTotalPrice' eingeblendet werden. |
| 389 |
|
-* Erweiterung Anzahl-Eingabe-Element am EPayment Bestellartikel: Bei einer direkten Werteingabe wird diese sofort gegen die definierte untere und obere Wertgrenze validiert. |
| 390 |
|
- |
| 391 |
|
-=== 3.1.4 === |
| 392 |
|
- |
| 393 |
|
-* Formatierung des Rückgabewertes für den Gesamtbetrag auf #0,00 € |
| 394 |
|
- |
| 395 |
|
-=== 3.1.3 === |
| 396 |
|
- |
| 397 |
|
-* Fehlerbehebung: Es wurden Problem behoben, welche beim Öffnen von EPayment-Formularen im Designe aufgetreten sind. |
| 398 |
|
- |
| 399 |
|
-=== 3.1.2 === |
| 400 |
|
- |
| 401 |
|
-* Neuer Pluginparameter *epayment.webservice.timeout* zum Konfigurieren des Timeouts zum Webservice in Sekunden. |
| 402 |
|
- |
| 403 |
|
-=== 3.1.1 === |
| 404 |
|
- |
| 405 |
|
-* Fehlerbehebung: Bei EPayment-Artikel Objekt werden bei fehlenden Werten, Defaultwerte angenommen. |
| 406 |
|
- |
| 407 |
|
-=== 3.1.0 === |
| 408 |
|
- |
| 409 |
|
-* Neue Eigenschaften am EPayment-Artikel Objekte hinzugefügt: |
| 410 |
|
-** Pflicht-Artikel: Ein Artikel kann als Pflicht definiert werden und wird dadurch automatisch der Bestellung hinzugefügt, egal ob dieser durch Manipulation vor dem Absenden aus der Bestellung entfernt wurde |
| 411 |
|
-** Maximale Bestellmenge: Die durch den Nutzer maximal auswählbare Bestellmenge lässt sich begrenzen |
| 412 |
|
- |
| 413 |
|
-=== 3.0.1 === |
| 414 |
|
- |
| 415 |
|
-* Plugin benötigt mindestens {{formcycle/}} in der Version {{version major="7" minor="0" patch="1"}}{{/version}} |
| 416 |
|
-** Anpassungen der Validierungen im Designer für EPayment-Artikel Objekte |
| 417 |
|
- |
| 418 |
|
-=== 3.0.0 === |
| 419 |
|
- |
| 420 |
|
-* Plugin benötigt mindestens {{formcycle/}} in der Version {{version major="7" minor="0" patch="0"}}{{/version}} |
| 421 |
|
-** Neue Workflow-Aktion für Initialisierung der Bezahl-Transaktion |
| 422 |
|
-** Einführung Ereignisse für Absenden der Bestellung, sowie Verifizierung der erfolgreichen / nicht erfolgreichen Bezahltransaktion |
|
214 |
+{{/panel}} |
