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 **Achtung:**
5 Mit diesem Plugin ist ein Anbindung an von der AKDB unabhängige ePayBL-Anbieter 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 Formular-Elemente und Workflow-Aktionen müssen nicht neu eingerichtet werden, nach dem [[**Setup** >>url:https://help7.formcycle.de/xwiki/bin/view/Formcycle/PluginDocumentation/ePayBLEPaymentPlugin/ePayBLEPaymentSetup/]] können bestehende Formulare direkt weiter genutzt werden.
7 Bezahlvorgänge, welche im EPayment der AKDB gestartet und abgebrochen wurden, können nicht nach dem Wechsel auf dieses Plugin abgeschlossen werden.
8 {{/info}}
9
10 {{content/}}
11
12 {{info}}
13 **Achtung:**
14 Bevor Sie die ePayBL EPayment in ihren Formular-Prozessen einbinden, stellen Sie bitte sicher, dass die konfigurative Anbindung des Dienstes durch den {{formcycle/}}-Administrator erfolgt ist!
15 {{/info}}
16
17 Das kostenpflichtige ePayBL EPayment Plugin ermöglicht es, über das [[ePayBL Portal>>https://www.epaybl.de/||rel="noopener noreferrer" target="_blank" title="E-Payment Bund und Länder"]], einen Bezahlvorgang in einen Formularprozess einzubauen.
18
19 Der nachfolgende Artikel beschreibt beispielhaft die von einen Formular-Ersteller auszuführenden Schritte, um einen Bezahlvorgang in einem Formular zu integrieren.
20 Auf die notwendigen Schritte, um den Service technisch in {{formcycle/}} einzubinden wird an dieser Stelle nicht eingegangen.
21
22 {{id name="config_reihenfolge"/}}
23 Prinzipiell sind immer folgende Schritte für eine Einbindung auszuführen:
24
25 1. Formular mit "bestellbaren" Artikeln und notwendigen Dateneingaben versehen
26 1. Workflow konfigurieren mit:
27 1*. einer Aktionen zum Starten einer Bezahl-Transaktion
28 1*. Ereignissen für eine gezielten Reaktion auf Rückmeldungen vom Bezahl-Portal
29 1. Anzeige des Ergebnisses der Bezahl-Transaktion
30
31 == 1. Formular für den Bezahlvorgang designen ==
32
33 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.
34
35 {{id name="epay_artikel"/}}
36
37 === 1.1. Artikel definieren durch das Formular-Element: //EPayment Artikel//: ===
38
39 {{figure image="hilfe_epay_artikel_form.png"}}
40 Konfigurationsmöglichkeiten am Formular-Element //EPayment Artikel//
41 {{/figure}}
42
43 Über das Formular-Element //EPayment Artikel// werden die für eine Bestell-Transaktion notwendigen Artikel definiert.
44 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.
45
46 Bestellpositionen können auch direkt in der Workflow-Aktion definiert werden.
47 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.
48
49 __Grundeigenschaften:__
50
51 ; Versteckt
52 : Durch das Auswählen dieser Option wird es möglich einen Bestellartikel vor dem Nutzer zu verbergen.
53 Wenn gleichzeitig dazu noch die Option **Pflicht-Artikel** ausgewählt wird, so wird beim Absenden des Formulars dieser Artikel automatisch der Bestellung hinzugefügt.
54 : 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.
55
56 __EPayment Bestellartikel Einstellungen:__
57
58 ; Pflicht-Artikel
59 : Diese Option ermöglicht es, einen Artikel als ausgewählt zu markieren, sodass er beim Absenden des Formulars automatisch der Bestellung hinzugefügt wird.
60 ; Beschreibung
61 : Nähere Beschreibung eines Artikels
62 ; Artikel-Preis (in Euro)
63 : 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.
64 ; Artikelnummer
65 : 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.
66 ; Max. Bestellmenge
67 : Hier kann die für den Nutzer maximal auswählbare Bestellmenge für einen Artikel definiert werden.
68 ; Belegnummer
69 : Die Belegnummer ist ein optionaler Wert, welcher zur weiterführenden Verarbeitung auf Seiten von ePayBL dient.
70
71 {{info}}
72 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.
73 {{/info}}
74
75 {{id name="epay_vorlage"/}}
76
77 === 1.2. Vorlagen zur Ermittlung von Bestellinformationen: ===
78
79 {{figure image="hilfe_epay_vorlagen_form.png"}}
80 Vorlagen zur Datenerhebung für das EPayment
81 {{/figure}}
82
83 Durch das Plugin werden verschiedene Designer-Vorlagen bereitgestellt, mit denen es ermöglicht wird die nachfolgend aufgeführten Daten vom Benutzer zu ermitteln:
84
85 * **Persönliche Daten**: Anrede, Name, Vorname, E-Mail etc.
86 * **Rechnungsadresse**
87 * **Lieferadresse**
88 * **Bankverbindung**
89
90 {{info}}
91 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.
92 {{/info}}
93
94 {{id name="epay_btn"/}}
95
96 === 1.3. Bestellung an den Server übermitteln: ===
97
98 Um eine Bestellung auszulösen und die bestellten Artikel zum Server zu übertragen muss dem Formular eine //Senden//-Schaltfläche hinzugefügt werden.
99 \\{{id name="config_process"/}}
100
101 == 2. Workflow für EPayment konfigurieren ==
102
103 Um eine Bezahl-Transaktion in einen Formularprozess einzubauen werden folgende Elemente vom Plugin zur Verfügung gestellt:
104
105 * 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.
106 * 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.
107 * 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.
108
109 Ein Workflow für einen einfachen Fall kann folgendermaßen konfiguriert sein:
110
111 {{figure image="hilfe_workflow.png"}}
112 Workflow mit EPayment Anbindung
113 {{/figure}}
114
115 __Kurze Ablaufbeschreibung zum dargestellten Workflow:__
116
117 ~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.
118
119 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.
120
121 3. Ist die Bezahlung erfolgt, wird in den Status //Bezahlt// gewechselt und dem Nutzer wird eine entsprechende Abschlussseite angezeigt.
122
123 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
124 wird eine entsprechende Abschlussseite angezeigt.
125
126 {{id name="plugin_epay_init"/}}
127
128 === 2.1. Konfigurationsmöglichkeiten des Aktions-Plugins //Bestellung übermitteln// ===
129
130 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.
131
132 {{info}}
133 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.
134
135 Es empfiehlt sich deshalb die in diesem Artikel beschriebene [[Konfigurations-Reihenfolge>>doc:||anchor="config_reihenfolge"]] einzuhalten.
136
137 Es ist aber auch möglich das Formular im Nachhinein anzupassen und anschließend die Daten innerhalb des Aktions-Plugins zu aktualisieren.
138 {{/info}}
139
140 Die Konfigurationsoberfläche des Aktions-Plugins ist in einzelne Bereiche unterteilt die nachfolgend kurz beschrieben werden.
141
142 {{panel title="Kundenstammdaten" fullwidth="true" initial="visible" triggerable="true"}}
143
144 {{figure image="plugin_init_config_kundenstammdaten.png"}}
145 Konfiguration für die Kundenstammdaten
146 {{/figure}}
147
148 In diesem Bereich werden die Daten des Benutzers hinterlegt, für den die Bezahl-Transaktion erzeugt werden soll.
149 Die einzelnen Parameter können per Platzhalter oder fest definiert hinterlegt werden.
150
151 {{info}}
152 Über den [[image:icon_update.png]]-Button können diese Felder durch Nutzung der EPayment-Vorlage //Persönliche Daten// vorbelegt werden.
153 {{/info}}
154
155 ; Anrede
156 ; Titel
157 ; Vorname
158 ; Nachname (Pflichtfeld)
159 ; Geburtsdatum
160 : Geburtsdatum muss in der Form **dd.MM.yyyy** übermittelt werden.
161 ; E-Mail
162 : Wird für die Zustellung von Emails an den Kunden in Abhängigkeit von der ePay-BL-Mandantkonfiguration benötigt.
163 ; Telefon
164 ; Mobiltelefon
165
166 {{info}}
167 Aktuell muss die Eingabe der E-Mail dem Pattern **//^[a-zA-Z0-9_\.+\-]+@[a-zA-Z0-9\-]+\.[a-zA-Z0-9\-\.]+$//** entsprechen. Die Datentyp Reglementierung der EPayment Vorlage erlaubt auch Umlaute und Sonderzeichen, so dass es zu einem Fehler vor Start des Bezahlvorgangs kommen kann.
168 {{/info}}
169
170 {{/panel}}
171
172 {{id name="config_paypage"/}}
173
174 {{panel title="Konfiguration für die PayPage" fullwidth="true" initial="visible" triggerable="true"}}
175
176 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.
177
178 {{figure image="plugin_init_config_paypage.png"}}
179 Konfiguration für die PayPage
180 {{/figure}}
181
182 ; Automatische Weiterleitung zur PayPage verhindern
183 : Bei aktivierter Einstellung kann eine automatische Weiterleitung zur PayPage unterbunden werden.
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 die globale Einstellung für den **Fälligkeitszeitraum** wird nicht beachtet.
186 ; Buchungstext auf PayPage
187 : Der hier festgelegte Buchungstext wird dem Benutzer auf der PayPage angezeigt.
188 : Eingabe muss dem Pattern //^[\w\-\./+\ @,\:\&\'\?\#{}\(\)\[\]\u00C0-\u017F\u1E9E]*$// entsprechen.
189 ; Server für die Rücksprungadresse
190 : Der Standardwert ist ein Platzhalter, welcher den **aktuellen** Server zurück gibt. **Aktuell** richtet sich hier nach dem Zeitpunkt und Ort der Ausführung der "Bestellung übermitteln" Aktion. Falls die Aktion auf einem anderen Server ausgeführt wird (z.B.: im Postfach), jedoch das Formular auf einem Frontend-Server ausgeliefert wird, muss dieser Frontend-Server hier ausgewählt werden. Ansonsten wird nach Abschluss der Bezahlung zurück auf Server geleitet, welcher möglicherweise nicht erreichbar ist für den/die Antragssteller*in.
191 {{/panel}}
192
193 {{panel title="Definition zusätzlicher Bestellpositionen" fullwidth="true" triggerable="true"}}
194
195 {{figure image="plugin_init_config_bestellposition.png"}}
196 Konfiguration von zusätzlichen Bestellpositionen
197 {{/figure}}
198
199 ; Anzahl
200 : 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
201 ; Buchungstext
202 : 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.
203 ; Netto-Preis (in Euro)
204 : Der (Einzel)Netto-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)
205 ; Steuersatz in %
206 : Der anzuwendende Steuersatz ist frei wählbar und wird mit den oben genannten Netto-Preis verrechnet zum endgültigen Brutto-Preis.
207
208 {{info}}
209 Falls bereits Bestellpositionen im **AKDB: EPayment-Plugin** konfiguriert wurden, wird der Steuersatz auf 0% gesetzt. Somit ist initial Netto-Preis = Brutto-Preis.
210 {{/info}}
211
212 ; Beschreibung
213 : Dient der interne Beschreibung der Bestellposition. Diese Information wird nicht an ePayBL weiter gegeben.
214 ; Belegnummer
215 : Die Belegnummer ist ein optionaler Wert, welcher zur weiterführenden Verarbeitung auf Seiten von ePayBL dient.
216
217 Ü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.
218
219 {{/panel}}
220
221 {{panel title="Konfiguration ePayBL ePayment-Mandant" fullwidth="true" initial="visible" triggerable="true"}}
222
223 {{figure image="plugin_init_config_mandant.png"}}
224 Konfiguration ePayBL EPayment-Mandant
225 {{/figure}}
226
227 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 der richtigen Behörde (entspricht der festgelegten Mandant-Nummer), dem Bewirtschafter und der Haushaltsstelle zuzuordnen.
228 Diese Einstellungen wurden möglicherweise bereits durch einen Xima® Formcycle-Administrator und/oder Mandant-Administrator global hinterlegt. Entsprechende Werte werden als Platzhalter angezeigt.
229
230
231 Die einzelnen Parameter können per Platzhalter oder fest definiert hinterlegt werden. Weiterhin kann über den Button //Verbindung prüfen// die generelle Erreichbarkeit des EPayment Webservice geprüft werden.
232
233 ; Mandant-Nummer
234 : ePayBL-Mandantennummer des aufrufenden eShops (FORMCYCLE) (Wird durch ePayBL-System vorgegeben)
235 ; Bewirtschafter-Nummer
236 : Bewirtschafternummer (Wird durch ePayBL-System vorgegeben)
237 ; Haushaltsstelle
238 : Nummer der Haushaltsstelle, welcher die Buchung zugeordnet werden soll. (Wird durch ePayBL-System vorgegeben)
239 ; Objektnummer
240 : Dient der internen Verbuchung im EPayment-System. (Wird durch ePayBL-System vorgegeben)
241 ; Kennzeichen-Mahnverfahren
242 : Einstellung für das Kennzeichen in einem Mahnverfahren. (Mögliche Werte werden durch ePayBL-System vorgegeben)
243 ; Fälligkeitszeitraum
244 : Einstellung für die Berechnung des Fälligkeitszeitraumes der Zahlung (Dauer in Tagen).
245
246 {{/panel}}
247
248 ==== 2.1.1 Rückgabewerte der Workflow-Aktion ====
249
250 {{figure image="plugin_init_result.png"}}
251 Rückgabewert und Fehlercodes der Aktion
252 {{/figure}}
253
254 __Rückgabewerte__
255
256 ; [%$[Name der Aktion].RESULT.BestellPosition[i]['key']%]
257 : Eine Auflistung über alle Bestell-Positionen, welche in der aktuellen Bestellung enthalten sind.
258 Zu jeder Bestell-Position können folgende Werte abgefragt werden:
259
260 (((
261 * **Artikelnummer**: Die am //EPayment Artikel// hinterlegte eindeutige Kennung für den Artikel
262 * **Buchungstext**: Der übermittelte Buchungstext (max.21 Zeichen, SEPA konform)
263 * **Menge**: Die bestellte Menge für die aktuelle Bestell-Position
264 * **Beschreibung**: Die am //EPayment Artikel// hinterlegte Artikel-Beschreibung
265 * **Einzelpreis**: Der am //EPayment Artikel// hinterlegte Preis für ein Stück. Ausgabe mit Währungssymbol.
266 * **Preis**: Der errechnete Gesamtpreis für die aktuelle Bestell-Position. Ergibt sich aus //Menge x Einzelpreis//. Ausgabe mit Währungssysmbol
267
268 Nachfolgend einige Beispiele für die Datenabfrage aus den Bestellpositionen:
269 Für die Beispiele wird folgender durch eine Aktion mit Namen //Bestellung übermitteln// bereitgestellter Platzhalter zu Grunde
270 gelegt: **[%$Bestellung übermitteln.RESULT.Bestellung[i][''key'']%]**
271 Die in den eckigen Klammern hinterlegten Werte sind variabel und haben folgende Bedeutung:
272
273
274 * **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.
275 * **key**: Schlüssel für den Zugriff auf die jeweilige Eigenschaft
276
277 Beispiele:
278 Abfrage des Einzelpreises an der 1. Bestell-Position: **[%$Bestellung übermitteln.RESULT.Bestellung[0][''Einzelpreis'']%]**
279 Abfrage der Menge an der 3. Bestell-Position: **[%$Bestellung übermitteln.RESULT.Bestellung[2][''Menge'']%]**
280 )))
281
282 ; [%$[Name der Aktion].RESULT.BestellPositionAnzahl%]
283 : Die Gesamtanzahl der Bestellpositionen, welche in der aktuellen Bestellung enthalten sind
284 ; [%$[Name der Aktion].RESULT.Gesamtbetrag%]
285 : Der in der Zahlungstransaktion ausgewiesene zu zahlende Geldbetrag. Angabe in Euro
286 ; [%$[Name der Aktion].RESULT.Kassenzeichen%]
287 : Das aktuelle Kassenzeichen unter dem die Zahlungstransaktion im ePayBL Portal geführt wird.
288 ; [%$[Name der Aktion].RESULT.UrlToPaypage%]
289 : Die URL zur Bezahlseite auf Seiten von ePayBL, wo die Bezahlung der aktuellen Transaktion durchgeführt werden kann.
290
291 __Fehlercodes__
292
293 ; NO_ORDER_DATA
294 : Fehlercode, wenn zur Laufzeit keine Bestellpositionen übermittelt wurden. Diese kann beispielweise auftreten, wenn der Formular-Nutzer beispielsweise keine Artikel zum Bestellen ausgewählt hatte.
295 ; SRV_NOT_AVIALABLE
296 : Fehlercode, wenn der ePayBL Service nicht verfügbar ist.
297 ; SRV_METHOD_ERROR
298 : Fehlercode, wenn eine ePayBL Webservice-Methode einen Fehler lieferte. Bei Auftreten von solchen Fehlertypen sollte das
299 {{formcycle/}} interne Fehler-Protokoll für eine tiefere Analyse einbezogen werden.
300 ; INTERNAL_ERROR
301 : Fehlercode für einen nicht nähere beschriebenen Fehler. Bei Auftreten von solchen Fehlertypen sollte das
302 {{formcycle/}} interne Fehler-Protokoll für eine tiefere Analyse einbezogen werden.
303 {{id name="plugin_event_epay_success"/}}
304
305 === 2.2. Workflow-Ereignis //Bezahlung erfolgreich// ===
306
307 {{figure image="trigger_success.png"}}
308 Workflow-Ereignis bei erfolgreicher Bezahlung
309 {{/figure}}
310
311 Eine Workflow-Verarbeitungskette mit diesem Ereignis wird ausgeführt, wenn eine Rückleitung aus dem ePayBL Portal erfolgt
312 und die Bezahlung erfolgreich durchgeführt wurde. Pro Formular-Vorgang kann dieses Ereignis genau einmal eintreten.
313 Das Ereignis stellt dabei folgende Werte bereit, die per Platzhalter in nachfolgenden Aktionen ausgewertet werden können:
314
315 ; **[%$TRIGGER.paymentStatus%]**
316 : Bezeichnung des Status, wie er vom ePayBL Portal zurück geliefert wird. (Möglicher Wert: INAKTIV)
317 ; **[%$TRIGGER.paymentStatusText%]**
318 : Eine Nachricht, die den zurück gelieferten Status näher beschreibt
319 ; **[%$TRIGGER.paymentMethod%]**
320 : Parameter gibt Auskunft über das in der Bezahl-Transaktion angewendete Zahlverfahren
321
322 {{id name="plugin_event_epay_error"/}}
323
324 === 2.3. Workflow-Ereignis //Bezahlung nicht erfolgreich// ===
325
326 {{figure image="trigger_error.png"}}
327 Workflow-Ereignis bei nicht erfolgreicher Bezahlung
328 {{/figure}}
329
330 Eine Workflow-Verarbeitungskette mit diesem Ereignis wird immer dann ausgeführt, wenn eine Rückleitung aus dem ePayBL Portal erfolgte
331 und die Bezahlung nicht durchgeführt wurde. Pro Formular-Vorgang kann dieses Ereignis mehrfach eintreten (Bei Fehlern im ePayBL Portal oder bei Abbruch des Bezahlvorgangs durch den Nutzer).
332 Das Ereignis stellt folgende Werte bereit, die per Platzhalter in nachfolgenden Aktionen ausgewertet werden können:
333
334 ; **[%$TRIGGER.paymentStatus%]**
335 : Bezeichnung des Status, wie er vom ePayBL Portal zurückgeliefert wird.
336 : Folgende Werte sind möglich:
337 : **AKTIV**: Die Bezahlung über die PayPage ist noch nicht erfolgt (z.B. weil der Nutzer den Bezahlvorgang auf Seiten von ePayBL abgebrochen hat).
338 : **MANDANT_NICHT_GEFUNDEN**: Der Mandant wurde im ePayment-System nicht gefunden.
339 : **MANDANT_INAKTIV**: Der Mandant ist im ePayment-System derzeit als inaktiv gekennzeichnet.
340 : **VERBINDUNG_OHNE_HTTPS**: Die Verbindung zum Webservice erfolgte nicht über HTTPS mit Client-Zertifikaten.
341 : **VERBINDUNG_ZERTIFIKAT_FEHLER**: Das für die Verbindung verwendete Client-Zertifikat darf nicht für den gewählten Mandanten verwendet werden.
342 : **KASSENZEICHEN_NICHT_VORHANDEN**: Das gewählte Kassenzeichen ist nicht vorhanden.
343 : **KASSENZEICHEN_NICHT_GEFUNDEN**: Das gewählte Kassenzeichen konnte nicht gefunden werden.
344 : **INTERNER_EPAYMENT_FEHLER**: Interner nicht dokumentierter Fehler im ePayment-System.
345 : **UNDEFINIERT**: Ein im System nicht bekannter Status
346 ; **[%$TRIGGER.paymentStatusText%]**
347 : Eine Nachricht, die den zurückgelieferten Status näher beschreibt
348 ; **[%$TRIGGER.paypageUrl%]**
349 : URL zur Paypage mit der aktuellen Transaktionsnummer. Damit ist ein nochmaliges Aufrufen und Bezahlen der offenen Transaktion möglich.
350 ; **[%$TRIGGER.paymentMethod%]**
351 : Parameter gibt Auskunft über das in der Bezahl-Transaktion angewendete Zahlverfahren
352 ; **[%$TRIGGER.paymentVerifyUrl%]**
353 : 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
354
355 == 3. Ergebnisanzeige ==
356
357 Die Anzeige des Ergebnisses bzw. des Status einer Bezahl-Transaktion erfolgt standardmäßig mittels einer extra Abschluss-Seite.
358 Dafür stellt das Plugin 3 HTML-Templates bereit:
359
360 * **ePayBL ePayment Bezahlung Erfolg**: Standard-Template für Anzeige bei erfolgreich abgeschlossener Bezahlung.
361 * **ePayBL 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.
362 * **ePayBL ePayment Fehler**: Standard-Template für Anzeige bei allgemeinen technischen Fehlern. Der genaue Fehler wird mittels enthaltener Platzhalter ausgewiesen.
363
364 {{info}}
365 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.
366 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.
367 {{/info}}