Änderungen von Dokument Verwendung


Von Version 10.1
bearbeitet von rth
am 04.10.2021, 12:50
Änderungskommentar: Neues Bild plugin_init_config_paypage.png hochladen
Auf Version 11.4
bearbeitet von rth
am 06.01.2022, 12:16
Änderungskommentar: Es gibt keinen Kommentar für diese Version

Zusammenfassung

Details

Seiteneigenschaften
Inhalt
... ... @@ -30,9 +30,11 @@
30 30  {{/figure}}
31 31  
32 32  Über das Formular-Element //EPayment Artikel// werden die für eine Bestell-Transaktion notwendigen Artikel definiert.
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.
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 konkreten Bestellposition zum Zeitpunkt der Ausführung einer Bezahl-Transaktion.
35 35  
35 +Ab Plugin-Version {{version major="3" minor="3" patch="0"}}{{/version}} können Bestellpositionen direkt in den Workflow-Aktion definiert werden.
36 +Dadurch muss kein //EPayment Artikel// 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.
37 +
36 36  __Grundeigenschaften:__
37 37  
38 38  ; Versteckt
... ... @@ -83,8 +83,7 @@
83 83  === 1.3. Bestellung an den Server übermitteln: ===
84 84  
85 85  Um eine Bestellung auszulösen und die bestellten Artikel zum Server zu übertragen muss dem Formular eine //Senden//-Schaltfläche hinzugefügt werden.
86 -
87 -{{id name="config_process"/}}
88 +\\{{id name="config_process"/}}
88 88  
89 89  == 2. Workflow für EPayment konfigurieren ==
90 90  
... ... @@ -93,14 +93,13 @@
93 93  * 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.
94 94  * 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.
95 95  * 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
99 99  
100 100  Ein Workflow für einen einfachen Fall kann folgendermaßen konfiguriert sein:
101 101  
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" %)(((
100 +{{figure image="hilfe_workflow.png"}}
101 +Workflow mit EPayment Anbindung
102 +{{/figure}}
103 +
104 104  __Kurze Ablaufbeschreibung zum dargestellten Workflow:__
105 105  
106 106  ~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,8 +111,6 @@
111 111  
112 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 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
113 113  wird eine entsprechende Abschlussseite angezeigt.
114 -
115 -)))
116 116  
117 117  {{id name="plugin_epay_init"/}}
118 118  
... ... @@ -201,3 +201,94 @@
201 201  
202 202  {{/panel}}
203 203  
202 +{{id name="plugin_event_epay_success"/}}
203 +
204 +=== 2.2. Workflow-Ereignis //Bezahlung erfolgreich// ===
205 +
206 +Eine Workflow-Verarbeitungskette mit diesem Ereignis wird ausgeführt, wenn eine Rückleitung aus dem ePay-BL Portal erfolgt
207 +und die Bezahlung erfolgreich durchgeführt wurde. Pro Formular-Vorgang kann dieses Ereignis genau einmal eintreten.
208 +Das Ereignis stellt dabei folgende Werte bereit, die per Platzhalter in nachfolgenden Aktionen ausgewertet werden können:
209 +
210 +; **[%$TRIGGER.paymentStatus%]**
211 +: Bezeichnung des Status, wie er vom ePay-BL Portal zurückgeliefert wird. (Möglicher Wert: INAKTIV)
212 +; **[%$TRIGGER.paymentStatusText%]**
213 +: Eine Nachricht, die den zurückgelieferten Status näher beschreibt
214 +
215 +{{id name="plugin_event_epay_error"/}}
216 +
217 +=== 2.3. Workflow-Ereignis //Bezahlung nicht erfolgreich// ===
218 +
219 +Eine Workflow-Verarbeitungskette mit diesem Ereignis wird immer dann ausgeführt, wenn eine Rückleitung aus dem ePay-BL Portal erfolgte
220 +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).
221 +Das Ereignis stellt folgende Werte bereit, die per Platzhalter in nachfolgenden Aktionen ausgewertet werden können:
222 +
223 +; **[%$TRIGGER.paymentStatus%]**
224 +: Bezeichnung des Status, wie er vom ePay-BL Portal zurückgeliefert wird.
225 +: Folgende Werte sind möglich:
226 +: **AKTIV**: Die Bezahlung über die PayPage ist noch nicht erfolgt.
227 +: **MANDANT_NICHT_GEFUNDEN**: Der Mandant wurde im ePayment-System nicht gefunden.
228 +: **MANDANT_INAKTIV**: Der Mandant ist im ePayment-System derzeit als inaktiv gekennzeichnet.
229 +: **VERBINDUNG_OHNE_HTTPS**: Die Verbindung zum Webservice erfolgte nicht über HTTPS mit Client-Zertifikaten.
230 +: **VERBINDUNG_ZERTIFIKAT_FEHLER**: Das für die Verbindung verwendete Client-Zertifikat darf nicht für den gewählten Mandanten verwendet werden.
231 +: **KASSENZEICHEN_NICHT_VORHANDEN**: Das gewählte Kassenzeichen ist nicht vorhanden.
232 +: **KASSENZEICHEN_NICHT_GEFUNDEN**: Das gewählte Kassenzeichen konnte nicht gefunden werden.
233 +: **INTERNER_EPAYMENT_FEHLER**: Interner nicht dokumentierter Fehler im ePayment-System.
234 +: **UNDEFINIERT**: Ein im System nicht bekannter Status
235 +; **[%$TRIGGER.paymentStatusText%]**
236 +: Eine Nachricht, die den zurückgelieferten Status näher beschreibt
237 +; **[%$TRIGGER.paypageUrl%]**
238 +: URL zur Paypage mit der aktuellen Transaktionsnummer. Damit ist ein nochmaliges Aufrufen und Bezahlen der offenen Transaktion möglich.
239 +
240 +== 3. Ergebnisanzeige ==
241 +
242 +Die Anzeige des Ergebnisses bzw. des Status einer Bezahl-Transaktion erfolgt standardmäßig mittels einer extra Abschluss-Seite.
243 +Dafür stellt das Plugin 3 HTML-Templates bereit:
244 +
245 +* **AKDB ePayment Bezahlung Erfolg**: Standard-Template für Anzeige bei erfolgreich abgeschlossener Bezahlung.
246 +* **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.
247 +* **AKDB ePayment Fehler**: Standard-Template für Anzeige bei allgemeinen technischen Fehlern. Der genaue Fehler wird mittels enthaltener Platzhalter ausgewiesen.
248 +
249 +{{info}}
250 +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.
251 +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.
252 +{{/info}}
253 +
254 +== Versionshistorie ==
255 +
256 +=== 3.2.0 ===
257 +
258 +* Erweiterung EPayment Bestellartikel: Am Element ist der Gesamtpreis (Anzahl * Einzelpreis) als verstecktes Element verfügbar. Dieser kann über die CSS-Klasse 'CXOrderItemTotalPrice' eingeblendet werden.
259 +* Erweiterung Anzahl-Eingabe-Element am EPayment Bestellartikel: Bei einer direkten Werteingabe wird diese sofort gegen die definierte untere und obere Wertgrenze validiert.
260 +
261 +=== 3.1.4 ===
262 +
263 +* Formatierung des Rückgabewertes für den Gesamtbetrag auf #0,00 €
264 +
265 +=== 3.1.3 ===
266 +
267 +* Fehlerbehebung: Es wurden Problem behoben, welche beim Öffnen von EPayment-Formularen im Designe aufgetreten sind.
268 +
269 +=== 3.1.2 ===
270 +
271 +* Neuer Pluginparameter *epayment.webservice.timeout* zum Konfigurieren des Timeouts zum Webservice in Sekunden.
272 +
273 +=== 3.1.1 ===
274 +
275 +* Fehlerbehebung: Bei EPayment-Artikel Objekt werden bei fehlenden Werten, Defaultwerte angenommen.
276 +
277 +=== 3.1.0 ===
278 +
279 +* Neue Eigenschaften am EPayment-Artikel Objekte hinzugefügt:
280 +** 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
281 +** Maximale Bestellmenge: Die durch den Nutzer maximal auswählbare Bestellmenge lässt sich begrenzen
282 +
283 +=== 3.0.1 ===
284 +
285 +* Plugin benötigt mindestens {{formcycle/}} in der Version {{version major="7" minor="0" patch="1"}}{{/version}}
286 +** Anpassungen der Validierungen im Designer für EPayment-Artikel Objekte
287 +
288 +=== 3.0.0 ===
289 +
290 +* Plugin benötigt mindestens {{formcycle/}} in der Version {{version major="7" minor="0" patch="0"}}{{/version}}
291 +** Neue Workflow-Aktion für Initialisierung der Bezahl-Transaktion
292 +** Einführung Ereignisse für Absenden der Bestellung, sowie Verifizierung der erfolgreichen / nicht erfolgreichen Bezahltransaktion