Wiki-Quellcode von Verwendung


Zeige letzte Bearbeiter
1 [[**Plugin download**>>url:https://customer.formcycle.eu/index.php/apps/files/?dir=/FORMCYCLE%20-%20Plugins%20Customer/ePayBL%3A%20Epayment%20Plugin%20(plugin-bundle-epaybl)&fileid=50473||rel="noopener noreferrer" target="_blank"]] (Anmeldung erforderlich)
2
3 {{info}}
4 **Hinweis zur Inbetriebnahme des Plugins:**
5 Im Download-Ordner der jeweilige Plugin-Version befindet sich eine Anleitung zur initialen Inbetriebnahme, sowie zu weiter reichenden Information die den allgemeinen Betrieb dieses Plugins betreffen.
6 {{/info}}
7
8 {{content/}}
9
10 {{info}}
11 **Achtung:**
12 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!
13 {{/info}}
14
15 Das kostenpflichtige AKDB EPayment Plugin ermöglicht es, über das von der AKDB bereitgestellte [[ePay-BL Portal>>https://www.epaybl.de/||rel="noopener noreferrer" target="_blank" title="E-Payment Bund und Länder"]], einen Bezahlvorgang in einen Formularprozess einzubauen.
16
17 Der nachfolgende Artikel beschreibt beispielhaft die von einen Formular-Ersteller auszuführenden Schritte, um einen Bezahlvorgang in einem Formular zu integrieren.
18 Auf die notwendigen Schritte, um den Service technisch in {{formcycle/}} einzubinden wird an dieser Stelle nicht eingegangen.
19
20 {{id name="config_reihenfolge"/}}
21 Prinzipiell sind immer folgende Schritte für eine Einbindung auszuführen:
22
23 1. Formular mit "bestellbaren" Artikeln und notwendigen Dateneingaben versehen
24 1. Workflow konfigurieren mit:
25 1*. einer Aktionen zum Starten einer Bezahl-Transaktion
26 1*. Ereignissen für eine gezielten Reaktion auf Rückmeldungen vom Bezahl-Portal
27 1. Anzeige des Ergebnisses der Bezahl-Transaktion
28
29 == 1. Formular für den Bezahlvorgang designen ==
30
31 Durch die Installation des Plugins im {{formcycle/}}-System sind im Designer ein zusätzliches Element, sowie 4 Vorlagen vorhanden, welche den Nutzer bei der notwendigen Konfiguration für das EPayment unterstützen sollen.
32
33 {{id name="epay_artikel"/}}
34
35 === 1.1. Artikel definieren durch das Formular-Element: //EPayment Artikel//: ===
36
37 {{figure image="hilfe_epay_artikel_form.png"}}
38 Konfigurationsmöglichkeiten am Formular-Element //EPayment Artikel//
39 {{/figure}}
40
41 Über das Formular-Element //EPayment Artikel// werden die für eine Bestell-Transaktion notwendigen Artikel definiert.
42 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.
43
44 Ab Plugin-Version {{version major="3" minor="3" patch="0"}}{{/version}} können Bestellpositionen auch direkt in der Workflow-Aktion definiert werden.
45 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.
46
47 __Grundeigenschaften:__
48
49 ; Versteckt
50 : Durch das Auswählen dieser Option wird es möglich einen Bestellartikel vor dem Nutzer zu verbergen.
51 Wenn gleichzeitig dazu noch die Option **Pflicht-Artikel** ausgewählt wird, so wird beim Absenden des Formulars dieser Artikel automatisch der Bestellung hinzugefügt.
52 : Dies kann immer dann sinnvoll sein, wenn dem Benutzer selbst keine Entscheidung für die Auswahl eines Bestellartikels ermöglicht werden soll, zum Beispiel bei der Erhebung einer Gebühr.
53
54 __EPayment Bestellartikel Einstellungen:__
55
56 ; Pflicht-Artikel
57 : Diese Option ermöglicht es, einen Artikel als ausgewählt zu markieren, sodass er beim Absenden des Formulars automatisch der Bestellung hinzugefügt wird.
58 ; Beschreibung
59 : Nähere Beschreibung eines Artikels
60 ; Artikel-Preis (in Euro)
61 : Der Preis für einen Artikel. Der an dieser Stelle konfigurierte Wert dient zum Einen für die Anzeige innerhalb des Formulars, als auch zur Berechnung der Gesamtsumme im Fall einer Bestellung des Artikels.
62 ; Artikelnummer
63 : Eine eindeutige Nummer für den einzelnen Artikel innerhalb des Formulars. Dient bei der Ausführung eines Bestell-Prozesses zur eindeutigen Identifizierung des jeweiligen Artikels.
64 ; Max. Bestellmenge
65 : Hier kann die für den Nutzer maximal auswählbare Bestellmenge für einen Artikel definiert werden.
66 ; Belegnummer
67 : Die Belegnummer ist ein optionaler Wert, welcher zur weiterführenden Verarbeitung auf Seiten von ePay-BL dient.
68
69 {{info}}
70 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.
71 {{/info}}
72
73 {{id name="epay_vorlage"/}}
74
75 === 1.2. Vorlagen zur Ermittlung von Bestellinformationen: ===
76
77 {{figure image="hilfe_epay_vorlagen_form.png"}}
78 Vorlagen zur Datenerhebung für das EPayment
79 {{/figure}}
80
81 Durch das Plugin werden verschiedene Designer-Vorlagen bereitgestellt, mit denen es ermöglicht wird die nachfolgend aufgeführten Daten vom Benutzer zu ermitteln:
82
83 * **Persönliche Daten**: Anrede, Name, Vorname, E-Mail etc.
84 * **Rechnungsadresse**
85 * **Lieferadresse**
86 * **Bankverbindung**
87
88 {{info}}
89 Die Vorlagen "Persönliche Daten" und "Rechnungsadresse" können im Zusammenspiel mit dem //Bürgerkonto-Login// der AKDB verwendet werden. Sie werden nach einem erfolgreichen Login automatisch vorbelegt.
90 {{/info}}
91
92 {{id name="epay_btn"/}}
93
94 === 1.3. Bestellung an den Server übermitteln: ===
95
96 Um eine Bestellung auszulösen und die bestellten Artikel zum Server zu übertragen muss dem Formular eine //Senden//-Schaltfläche hinzugefügt werden.
97 \\{{id name="config_process"/}}
98
99 == 2. Workflow für EPayment konfigurieren ==
100
101 Um eine Bezahl-Transaktion in einen Formularprozess einzubauen werden folgende Elemente vom Plugin zur Verfügung gestellt:
102
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.
106
107 Ein Workflow für einen einfachen Fall kann folgendermaßen konfiguriert sein:
108
109 {{figure image="hilfe_workflow.png"}}
110 Workflow mit EPayment Anbindung
111 {{/figure}}
112
113 __Kurze Ablaufbeschreibung zum dargestellten Workflow:__
114
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.
116
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.
118
119 3. Ist die Bezahlung erfolgt, wird in den Status //Bezahlt// gewechselt und dem Nutzer wird eine entsprechende Abschlussseite angezeigt.
120
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
122 wird eine entsprechende Abschlussseite angezeigt.
123
124 {{id name="plugin_epay_init"/}}
125
126 === 2.1. Konfigurationsmöglichkeiten des Aktions-Plugins //Bestellung übermitteln// ===
127
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.
129
130 {{info}}
131 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.
132
133 Es empfiehlt sich deshalb die in diesem Artikel beschriebene [[Konfigurations-Reihenfolge>>doc:||anchor="config_reihenfolge"]] einzuhalten.
134
135 Es ist aber auch möglich das Formular im Nachhinein anzupassen und anschließend die Daten innerhalb des Aktions-Plugins zu aktualisieren.
136 {{/info}}
137
138 Die Konfigurationsoberfläche des Aktions-Plugins ist in einzelne Bereiche unterteilt die nachfolgend kurz beschrieben werden.
139
140 {{panel title="Kundenstammdaten" fullwidth="true" initial="visible" triggerable="true"}}
141
142 {{figure image="plugin_init_config_kundenstammdaten.png"}}
143 Konfiguration für die Kundenstammdaten
144 {{/figure}}
145
146 In diesem Bereich werden die Daten des Benutzers hinterlegt, für den die Bezahl-Transaktion erzeugt werden soll.
147 Die einzelnen Parameter können per Platzhalter oder fest definiert hinterlegt werden.
148
149 {{info}}
150 Über den [[image:icon_update.png]]-Button können diese Felder durch Nutzung der EPayment-Vorlage //Persönliche Daten// vorbelegt werden.
151 {{/info}}
152
153 ; Anrede
154 ; Titel
155 ; Vorname
156 ; Nachname (Pflichtfeld)
157 ; Geburtsdatum
158 : Geburtsdatum muss in der Form **dd.MM.yyyy** übermittelt werden.
159 ; E-Mail
160 : Wird für die Zustellung von Emails an den Kunden in Abhängigkeit von der ePay-BL-Mandantkonfiguration benötigt.
161 ; Telefon
162 ; Mobiltelefon
163
164 {{/panel}}
165
166 {{id name="config_paypage"/}}
167
168 {{panel title="Konfiguration für die PayPage" fullwidth="true" initial="visible" triggerable="true"}}
169
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.
171
172 {{figure image="plugin_init_config_paypage.png"}}
173 Konfiguration für die PayPage
174 {{/figure}}
175
176 ; Automatische Weiterleitung zur PayPage verhindern
177 : Bei aktivierter Einstellung kann eine automatische Weiterleitung zur PayPage unterbunden werden.
178 ; Fälligkeitsdatum
179 : 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.
180 ; Buchungstext auf PayPage
181 : Der hier festgelegte Buchungstext wird dem Benutzer auf der PayPage angezeigt.
182 {{/panel}}
183
184 {{panel title="Definition zusätzlicher Bestellpositionen" fullwidth="true" triggerable="true"}}
185
186 {{figure image="plugin_init_config_bestellposition.png"}}
187 Konfiguration von zusätzlichen Bestellpositionen
188 {{/figure}}
189
190 ; Anzahl
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
193 : 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.
194 ; Preis (in Euro)
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)
196 ; Beschreibung
197 : Dient der interne Beschreibung der Bestellposition. Diese Information wird nicht an ePay-BL weiter gegeben.
198 ; Belegnummer
199 : Die Belegnummer ist ein optionaler Wert, welcher zur weiterführenden Verarbeitung auf Seiten von ePay-BL dient.
200
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.
202
203 {{/panel}}
204
205 {{panel title="Konfiguration AKDB ePayment-Mandant" fullwidth="true" initial="visible" triggerable="true"}}
206
207 {{figure image="plugin_init_config_akdb_mandant.png"}}
208 Konfiguration AKDB EPayment-Mandant
209 {{/figure}}
210
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.
213 In den meisten Fällen sind diese Einstellungen bereits durch einen Plugin-Administrator global hinterlegt worden, sodass an dieser Stelle keine Konfiguration notwendig ist.
214
215 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.
216
217 ; Mandant-Nummer
218 : AKDB-Mandantennummer des aufrufenden eShops (FORMCYCLE) (Wird durch ePay-BL-System vorgegeben)
219 ; Bewirtschafter-Nummer
220 : Bewirtschafternummer (Wird durch ePay-BL-System vorgegeben)
221 ; Haushaltsstelle
222 : Nummer der Haushaltsstelle, welcher die Buchung zugeordnet werden soll. (Wird durch ePay-BL-System vorgegeben)
223 ; Objektnummer
224 : Dient der internen Verbuchung im EPayment-System. (Wird durch ePay-BL-System vorgegeben)
225 ; Kennzeichen-Mahnverfahren
226 : Einstellung für das Kennzeichen in einem Mahnverfahren. (Mögliche Werte werden durch ePay-BL-System vorgegeben)
227 ; Fälligkeitszeitraum
228 : Einstellung für die Berechnung des Fälligkeitszeitraumes der Zahlung (Dauer in Tagen).
229
230 {{/panel}}
231
232 ==== 2.1.1 Rückgabewerte der Workflow-Aktion ====
233
234 {{figure image="plugin_init_result.png"}}
235 Rückgabewert und Fehlercodes der Aktion
236 {{/figure}}
237
238 __Rückgabewerte__
239
240 ; [%$[Name der Aktion].RESULT.BestellPosition[i]['key']%]
241 : Eine Auflistung über alle Bestell-Positionen, welche in der aktuellen Bestellung enthalten sind.
242 Zu jeder Bestell-Position können folgende Werte abgefragt werden:
243
244 (((
245 * **Artikelnummer**: Die am //EPayment Artikel// hinterlegte eindeutige Kennung für den Artikel
246 * **Buchungstext**: Der übermittelte Buchungstext (max.21 Zeichen, SEPA konform)
247 * **Menge**: Die bestellte Menge für die aktuelle Bestell-Position
248 * **Beschreibung**: Die am //EPayment Artikel// hinterlegte Artikel-Beschreibung
249 * **Einzelpreis**: Der am //EPayment Artikel// hinterlegte Preis für ein Stück. Ausgabe mit Währungssymbol.
250 * **Preis**: Der errechnete Gesamtpreis für die aktuelle Bestell-Position. Ergibt sich aus //Menge x Einzelpreis//. Ausgabe mit Währungssysmbol
251
252 Nachfolgend einige Beispiele für die Datenabfrage aus den Bestellpositionen:
253 Für die Beispiele wird folgender durch eine Aktion mit Namen //Bestellung übermitteln// bereitgestellter Platzhalter zu Grunde
254 gelegt: **[%$Bestellung übermitteln.RESULT.Bestellung[i][''key'']%]**
255 Die in den eckigen Klammern hinterlegten Werte sind variabel und haben folgende Bedeutung:
256
257
258 * **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.
259 * **key**: Schlüssel für den Zugriff auf die jeweilige Eigenschaft
260
261 Beispiele:
262 Abfrage des Einzelpreises an der 1. Bestell-Position: **[%$Bestellung übermitteln.RESULT.Bestellung[0][''Einzelpreis'']%]**
263 Abfrage der Menge an der 3. Bestell-Position: **[%$Bestellung übermitteln.RESULT.Bestellung[2][''Menge'']%]**
264 )))
265
266 ; [%$[Name der Aktion].RESULT.BestellPositionAnzahl%]
267 : Die Gesamtanzahl der Bestellpositionen, welche in der aktuellen Bestellung enthalten sind
268 ; [%$[Name der Aktion].RESULT.Gesamtbetrag%]
269 : Der in der Zahlungstransaktion ausgewiesene zu zahlende Geldbetrag. Angabe in Euro
270 ; [%$[Name der Aktion].RESULT.Kassenzeichen%]
271 : Das aktuelle Kassenzeichen unter dem die Zahlungstransaktion im ePay-BL Portal geführt wird.
272 ; [%$[Name der Aktion].RESULT.UrlToPaypage%]
273 : Die URL zur Bezahlseite auf Seiten von ePay-BL, wo die Bezahlung der aktuellen Transaktion durchgeführt werden kann.
274
275 __Fehlercodes__
276
277 ; NO_ORDER_DATA
278 : Fehlercode, wenn zur Laufzeit keine Bestellpositionen übermittelt wurden. Diese kann beispielweise auftreten, wenn der Formular-Nutzer beispielsweise keine Artikel zum Bestellen ausgewählt hatte.
279 ; SRV_NOT_AVIALABLE
280 : Fehlercode, wenn der ePay-BL Service nicht verfügbar ist.
281 ; SRV_METHOD_ERROR
282 : Fehlercode, wenn eine ePay-BL Webservice-Methode einen Fehler lieferte. Bei Auftreten von solchen Fehlertypen sollte das
283 {{formcycle/}} interne Fehler-Protokoll für eine tiefere Analyse einbezogen werden.
284 ; INTERNAL_ERROR
285 : Fehlercode für einen nicht nähere beschriebenen Fehler. Bei Auftreten von solchen Fehlertypen sollte das
286 {{formcycle/}} interne Fehler-Protokoll für eine tiefere Analyse einbezogen werden.
287 {{id name="plugin_event_epay_success"/}}
288
289 === 2.2. Workflow-Ereignis //Bezahlung erfolgreich// ===
290
291 {{figure image="trigger_success.png"}}
292 Workflow-Ereignis bei erfolgreicher Bezahlung
293 {{/figure}}
294
295 Eine Workflow-Verarbeitungskette mit diesem Ereignis wird ausgeführt, wenn eine Rückleitung aus dem ePay-BL Portal erfolgt
296 und die Bezahlung erfolgreich durchgeführt wurde. Pro Formular-Vorgang kann dieses Ereignis genau einmal eintreten.
297 Das Ereignis stellt dabei folgende Werte bereit, die per Platzhalter in nachfolgenden Aktionen ausgewertet werden können:
298
299 ; **[%$TRIGGER.paymentStatus%]**
300 : Bezeichnung des Status, wie er vom ePay-BL Portal zurück geliefert wird. (Möglicher Wert: INAKTIV)
301 ; **[%$TRIGGER.paymentStatusText%]**
302 : Eine Nachricht, die den zurück gelieferten Status näher beschreibt
303 ; **[%$TRIGGER.paymentMethod%] {{version major="3" minor="5"}}{{/version}}**
304 : Parameter gibt Auskunft über das in der Bezahl-Transaktion angewendete Zahlverfahren
305
306 {{id name="plugin_event_epay_error"/}}
307
308 === 2.3. Workflow-Ereignis //Bezahlung nicht erfolgreich// ===
309
310 {{figure image="trigger_error.png"}}
311 Workflow-Ereignis bei nicht erfolgreicher Bezahlung
312 {{/figure}}
313
314 Eine Workflow-Verarbeitungskette mit diesem Ereignis wird immer dann ausgeführt, wenn eine Rückleitung aus dem ePay-BL Portal erfolgte
315 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).
316 Das Ereignis stellt folgende Werte bereit, die per Platzhalter in nachfolgenden Aktionen ausgewertet werden können:
317
318 ; **[%$TRIGGER.paymentStatus%]**
319 : Bezeichnung des Status, wie er vom ePay-BL Portal zurückgeliefert wird.
320 : Folgende Werte sind möglich:
321 : **AKTIV**: Die Bezahlung über die PayPage ist noch nicht erfolgt (z.B. weil der Nutzer den Bezahlvorgang auf Seiten von ePay-BL abgebrochen hat).
322 : **MANDANT_NICHT_GEFUNDEN**: Der Mandant wurde im ePayment-System nicht gefunden.
323 : **MANDANT_INAKTIV**: Der Mandant ist im ePayment-System derzeit als inaktiv gekennzeichnet.
324 : **VERBINDUNG_OHNE_HTTPS**: Die Verbindung zum Webservice erfolgte nicht über HTTPS mit Client-Zertifikaten.
325 : **VERBINDUNG_ZERTIFIKAT_FEHLER**: Das für die Verbindung verwendete Client-Zertifikat darf nicht für den gewählten Mandanten verwendet werden.
326 : **KASSENZEICHEN_NICHT_VORHANDEN**: Das gewählte Kassenzeichen ist nicht vorhanden.
327 : **KASSENZEICHEN_NICHT_GEFUNDEN**: Das gewählte Kassenzeichen konnte nicht gefunden werden.
328 : **INTERNER_EPAYMENT_FEHLER**: Interner nicht dokumentierter Fehler im ePayment-System.
329 : **UNDEFINIERT**: Ein im System nicht bekannter Status
330 ; **[%$TRIGGER.paymentStatusText%]**
331 : Eine Nachricht, die den zurückgelieferten Status näher beschreibt
332 ; **[%$TRIGGER.paypageUrl%]**
333 : URL zur Paypage mit der aktuellen Transaktionsnummer. Damit ist ein nochmaliges Aufrufen und Bezahlen der offenen Transaktion möglich.
334 ; **[%$TRIGGER.paymentMethod%]** {{version major="3" minor="5"}}{{/version}}
335 : Parameter gibt Auskunft über das in der Bezahl-Transaktion angewendete Zahlverfahren
336 ; **[%$TRIGGER.paymentVerifyUrl%] {{version major="3" minor="5"}}{{/version}}**
337 : 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
338
339 == 3. Ergebnisanzeige ==
340
341 Die Anzeige des Ergebnisses bzw. des Status einer Bezahl-Transaktion erfolgt standardmäßig mittels einer extra Abschluss-Seite.
342 Dafür stellt das Plugin 3 HTML-Templates bereit:
343
344 * **AKDB ePayment Bezahlung Erfolg**: Standard-Template für Anzeige bei erfolgreich abgeschlossener Bezahlung.
345 * **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.
346 * **AKDB ePayment Fehler**: Standard-Template für Anzeige bei allgemeinen technischen Fehlern. Der genaue Fehler wird mittels enthaltener Platzhalter ausgewiesen.
347
348 {{info}}
349 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.
350 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.
351 {{/info}}
352
353 == Versionshistorie ==
354
355 === 3.6.0 ===
356
357 * Erweiterung AKDB ePay Setup: Konfigurationsmöglichkeit für Proxy-Server-Einstellungen
358 * Platzhalter für Payment Verify-Url: Mit dem Platzhalter [%$PAYMENT_VERIFY_URL%] kann Status-übergreifend auf den URL zum nochmaligen Prüfen des Status einer Bezahltransaktion zugegriffen werden.
359
360 === 3.5.1 ===
361
362 * Fehlerbehebung: Im Zusammenspiel mit der {{formcycle/}} Version {{version major="7" patch="10"}}{{/version}} konnten Zertifikatsdateien nicht über das AKDB ePay Setup hochgeladen werden. Dieser Fehler wurde behoben.
363
364 === 3.5.0 ===
365
366 * Erweiterungen: EPayment-Verifikation-Aktion (V6) um 'Zahlverfahren' erweitert.
367 Trigger (Workflow V7) um genutztes 'Zahlverfahren' innerhalb der Rückgabewerte erweitert.
368 Error-Trigger (Workflow V7) um 'PaymentVerifyUrl' erweitert. Dieser Parameter kann zum nochmaligen Aufruf der Verifizierung einer Bezahlung genutzt werden.
369 * Erweiterung AKDB ePay Setup: Eingabemöglichkeit für Daten des anzubindenden ePayment-Mandanten; Zusätzlicher Hinweis auf freizugebende URLs (notwendige Firewall-Freigaben)
370
371 === 3.4.3 ===
372
373 * 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.
374
375 === 3.4.2 ===
376
377 * Fehlerbehebung: ein Anzeige-Fehler bei der Berechnung des Gesamtpreises für einen EPayment-Bestellartikel wurde behoben
378 * Fehlerbehebung: Aufgrund von Fehlern beim Decodieren und Entschlüsseln von URL-Parametern, wurde die Verschlüsselungs-Routine angepasst.
379
380 === 3.4.1 ===
381
382 * Fehlerbehebung EPayment Bestellartikel: Die Werte der widget-internen HTML-Elemente sind bei einer Zwischenspeicherung nicht berücksichtigt worden. Dies wurde behoben.
383
384 === 3.4.0 ===
385
386 * Erweiterung AKDB ePay Setup: Ein Verbindungstest ist jetzt auch ohne Konfiguration eines AKDB-Mandanten möglich.
387 * Anpassung EPayment Bestellartikel: HTML-Elemente innerhalb des Widgets um 'data-' Präfix erweitert
388 * Fehlerbehebung: Session-Replacer werden bei Verarbeitung der Workflow-Ereignisse berücksichtigt. 
389
390 === 3.3.1 ===
391
392 * 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.
393
394 === 3.3.0 ===
395
396 * Plugin benötigt mindestens {{formcycle/}} in der Version {{version major="7" patch="9"}}{{/version}}
397 * Erweiterung Workflow-Aktion //Bestellung übermitteln//: Möglichkeit für serverseitige Definition von Bestellpositionen
398 * 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.
399
400 === 3.2.0 ===
401
402 * Erweiterung EPayment Bestellartikel: Am Element ist der Gesamtpreis (Anzahl * Einzelpreis) als verstecktes Element verfügbar. Dieser kann über die CSS-Klasse 'CXOrderItemTotalPrice' eingeblendet werden.
403 * Erweiterung Anzahl-Eingabe-Element am EPayment Bestellartikel: Bei einer direkten Werteingabe wird diese sofort gegen die definierte untere und obere Wertgrenze validiert.
404
405 === 3.1.4 ===
406
407 * Formatierung des Rückgabewertes für den Gesamtbetrag auf #0,00 €
408
409 === 3.1.3 ===
410
411 * Fehlerbehebung: Es wurden Problem behoben, welche beim Öffnen von EPayment-Formularen im Designe aufgetreten sind.
412
413 === 3.1.2 ===
414
415 * Neuer Pluginparameter *epayment.webservice.timeout* zum Konfigurieren des Timeouts zum Webservice in Sekunden.
416
417 === 3.1.1 ===
418
419 * Fehlerbehebung: Bei EPayment-Artikel Objekt werden bei fehlenden Werten, Defaultwerte angenommen.
420
421 === 3.1.0 ===
422
423 * Neue Eigenschaften am EPayment-Artikel Objekte hinzugefügt:
424 ** 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
425 ** Maximale Bestellmenge: Die durch den Nutzer maximal auswählbare Bestellmenge lässt sich begrenzen
426
427 === 3.0.1 ===
428
429 * Plugin benötigt mindestens {{formcycle/}} in der Version {{version major="7" minor="0" patch="1"}}{{/version}}
430 ** Anpassungen der Validierungen im Designer für EPayment-Artikel Objekte
431
432 === 3.0.0 ===
433
434 * Plugin benötigt mindestens {{formcycle/}} in der Version {{version major="7" minor="0" patch="0"}}{{/version}}
435 ** Neue Workflow-Aktion für Initialisierung der Bezahl-Transaktion
436 ** Einführung Ereignisse für Absenden der Bestellung, sowie Verifizierung der erfolgreichen / nicht erfolgreichen Bezahltransaktion