| ... |
... |
@@ -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, 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. |
| 35 |
35 |
|
|
35 |
+Ab Plugin-Version {{version major="3" minor="3" patch="0"}}{{/version}} können Bestellpositionen auch direkt in der Workflow-Aktion definiert werden. |
|
36 |
+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. |
|
37 |
+ |
| 36 |
36 |
__Grundeigenschaften:__ |
| 37 |
37 |
|
| 38 |
38 |
; Versteckt |
| ... |
... |
@@ -53,7 +53,7 @@ |
| 53 |
53 |
; Max. Bestellmenge |
| 54 |
54 |
: Hier kann die für den Nutzer maximal auswählbare Bestellmenge für einen Artikel definiert werden. |
| 55 |
55 |
; Belegnummer |
| 56 |
|
-: Die Belegnummer ist ein optionaler Wert, welcher zur weiterführenden Verarbeitung auf Seiten von ePay-BL dient |
|
58 |
+: Die Belegnummer ist ein optionaler Wert, welcher zur weiterführenden Verarbeitung auf Seiten von ePay-BL dient. |
| 57 |
57 |
|
| 58 |
58 |
{{info}} |
| 59 |
59 |
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. |
| ... |
... |
@@ -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 |
|
| ... |
... |
@@ -96,8 +96,10 @@ |
| 96 |
96 |
|
| 97 |
97 |
Ein Workflow für einen einfachen Fall kann folgendermaßen konfiguriert sein: |
| 98 |
98 |
|
| 99 |
|
-(% style="background-color:transparent; border:none" %) |
| 100 |
|
-|(% 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 |
+ |
| 101 |
101 |
__Kurze Ablaufbeschreibung zum dargestellten Workflow:__ |
| 102 |
102 |
|
| 103 |
103 |
~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. |
| ... |
... |
@@ -108,8 +108,6 @@ |
| 108 |
108 |
|
| 109 |
109 |
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 |
| 110 |
110 |
wird eine entsprechende Abschlussseite angezeigt. |
| 111 |
|
- |
| 112 |
|
-))) |
| 113 |
113 |
|
| 114 |
114 |
{{id name="plugin_epay_init"/}} |
| 115 |
115 |
|
| ... |
... |
@@ -171,6 +171,27 @@ |
| 171 |
171 |
: Der hier festgelegte Buchungstext wird dem Benutzer auf der PayPage angezeigt. |
| 172 |
172 |
{{/panel}} |
| 173 |
173 |
|
|
175 |
+{{panel title="Definition zusätzlicher Bestellpositionen" fullwidth="true" triggerable="true"}} |
|
176 |
+ |
|
177 |
+{{figure image="plugin_init_config_bestellposition.png"}} |
|
178 |
+Konfiguration von zusätzlichen Bestellpositionen |
|
179 |
+{{/figure}} |
|
180 |
+ |
|
181 |
+; Anzahl |
|
182 |
+: 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 |
|
183 |
+; Buchungstext |
|
184 |
+: 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. |
|
185 |
+; Preis (in Euro) |
|
186 |
+: 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) |
|
187 |
+; Beschreibung |
|
188 |
+: Dient der interne Beschreibung der Bestellposition. Diese Information wird nicht an ePay-BL weiter gegeben. |
|
189 |
+; Belegnummer |
|
190 |
+: Die Belegnummer ist ein optionaler Wert, welcher zur weiterführenden Verarbeitung auf Seiten von ePay-BL dient. |
|
191 |
+ |
|
192 |
+Ü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. |
|
193 |
+ |
|
194 |
+{{/panel}} |
|
195 |
+ |
| 174 |
174 |
{{panel title="Konfiguration AKDB ePayment-Mandant" fullwidth="true" initial="visible" triggerable="true"}} |
| 175 |
175 |
|
| 176 |
176 |
{{figure image="plugin_init_config_akdb_mandant.png"}} |
| ... |
... |
@@ -198,6 +198,57 @@ |
| 198 |
198 |
|
| 199 |
199 |
{{/panel}} |
| 200 |
200 |
|
|
223 |
+==== 2.1.1 Rückgabewerte der Workflow-Aktion ==== |
|
224 |
+ |
|
225 |
+{{figure image="plugin_init_result.png"}} |
|
226 |
+Rückgabewert und Fehlercodes der Aktion |
|
227 |
+{{/figure}} |
|
228 |
+ |
|
229 |
+__Rückgabewerte__ |
|
230 |
+ |
|
231 |
+; [%$[Name der Aktion].RESULT.BestellPosition[i]['key']%] |
|
232 |
+: Eine Auflistung über alle Bestell-Positionen, welche in der aktuellen Bestellung enthalten sind. |
|
233 |
+: Zu jeder Bestell-Position können folgende Werte abgefragt werden: |
|
234 |
+: |
|
235 |
+: * Artikelnummer: Die am //EPayment Artikel// hinterlegte eindeutige Kennung für den Artikel |
|
236 |
+: * Buchungstext: Der übermittelte Buchungstext (max.21 Zeichen, SEPA konform) |
|
237 |
+: * Menge: Die bestellte Menge für die aktuelle Bestell-Position |
|
238 |
+: * Beschreibung: Die am //EPayment Artikel// hinterlegte Artikel-Beschreibung |
|
239 |
+: * Einzelpreis: Der am //EPayment Artikel// hinterlegte Preis für ein Stück. Ausgabe mit Währungssymbol. |
|
240 |
+: * Preis: Der errechnete Gesamtpreis für die aktuelle Bestell-Position. Ergibt sich aus //Menge x Einzelpreis//. Ausgabe mit Währungssysmbol |
|
241 |
+: |
|
242 |
+: Nachfolgend einige Beispiele für die Datenabfrage aus den Bestellpositionen: |
|
243 |
+: \\Für die Beispiele wird folgender durch die Aktion bereitgestellter Platzhalter zu Grunde gelegt *[%$[Name der Aktion].RESULT.Bestellung[i][''key'']%]* |
|
244 |
+: Die in den eckigen Klammern hinterlegten Werte sind variabel und haben folgende Bedeutung: |
|
245 |
+: |
|
246 |
+: * i: Zählvariable für den Zugriff auf eine Bestell-Position aus der Gruppe aller Bestell-Positionen. |
|
247 |
+: Ein möglicher Wert muss sich im Bereich von 0 bis zum Wert der BestellPositionAnzahl -1 befinden. |
|
248 |
+: * key: Schlüssel für den Zugriff auf die jeweilige Eigenschaft |
|
249 |
+: |
|
250 |
+: Beispiele (mit einer Aktion mit Namen _Bestellung übermitteln_): |
|
251 |
+: Abfrage des Einzelpreises an der 1. Bestell-Position: *[%$Bestellung übermitteln.RESULT.Bestellung[0][''Einzelpreis'']%]* |
|
252 |
+: Abfrage der Menge an der 3. Bestell-Position: *[%$Bestellung übermitteln.RESULT.Bestellung[2][''Menge'']%]* |
|
253 |
+; [%$[Name der Aktion].RESULT.BestellPositionAnzahl%] |
|
254 |
+: Die Gesamtanzahl der Bestellpositionen, welche in der aktuellen Bestellung enthalten sind |
|
255 |
+; [%$[Name der Aktion].RESULT.Gesamtbetrag%] |
|
256 |
+: Der in der Zahlungstransaktion ausgewiesene zu zahlende Geldbetrag. Angabe in Euro |
|
257 |
+; [%$[Name der Aktion].RESULT.Kassenzeichen%] |
|
258 |
+: Das aktuelle Kassenzeichen unter dem die Zahlungstransaktion im ePay-BL Portal geführt wird. |
|
259 |
+; [%$[Name der Aktion].RESULT.UrlToPaypage%] |
|
260 |
+: Die URL zur Bezahlseite auf Seiten von ePay-BL, wo die Bezahlung der aktuellen Transaktion durchgeführt werden kann. |
|
261 |
+ |
|
262 |
+__Fehlercodes__ |
|
263 |
+ |
|
264 |
+; NO_ORDER_DATA |
|
265 |
+: Fehlercode, wenn zur Laufzeit keine Bestellpositionen übermittelt wurden. Diese kann beispielweise auftreten, wenn der Formular-Nutzer beispielsweise keine Artikel zum Bestellen ausgewählt hatte. |
|
266 |
+; SRV_NOT_AVIALABLE |
|
267 |
+: Fehlercode, wenn der ePay-BL Service nicht verfügbar ist. |
|
268 |
+; SRV_METHOD_ERROR |
|
269 |
+: Fehlercode, wenn eine ePay-BL Webservice-Methode einen Fehler lieferte. Bei Auftreten von solchen Fehlertypen sollte das |
|
270 |
+{{formcycle/}} interne Fehler-Protokoll für eine tiefere Analyse einbezogen werden. |
|
271 |
+; INTERNAL_ERROR |
|
272 |
+: Fehlercode für einen nicht nähere beschriebenen Fehler. Bei Auftreten von solchen Fehlertypen sollte das |
|
273 |
+{{formcycle/}} interne Fehler-Protokoll für eine tiefere Analyse einbezogen werden. |
| 201 |
201 |
{{id name="plugin_event_epay_success"/}} |
| 202 |
202 |
|
| 203 |
203 |
=== 2.2. Workflow-Ereignis //Bezahlung erfolgreich// === |
| ... |
... |
@@ -223,7 +223,7 @@ |
| 223 |
223 |
: Bezeichnung des Status, wie er vom ePay-BL Portal zurückgeliefert wird. |
| 224 |
224 |
: Folgende Werte sind möglich: |
| 225 |
225 |
: **AKTIV**: Die Bezahlung über die PayPage ist noch nicht erfolgt. |
| 226 |
|
-: **MANDANT_NICHT_GEFUNDEN**: Der Mandant wurde im ePayment-System nicht gefunden. |
|
299 |
+: **MANDANT_NICHT_GEFUNDEN**: Der Mandant wurde im ePayment-System nicht gefunden. |
| 227 |
227 |
: **MANDANT_INAKTIV**: Der Mandant ist im ePayment-System derzeit als inaktiv gekennzeichnet. |
| 228 |
228 |
: **VERBINDUNG_OHNE_HTTPS**: Die Verbindung zum Webservice erfolgte nicht über HTTPS mit Client-Zertifikaten. |
| 229 |
229 |
: **VERBINDUNG_ZERTIFIKAT_FEHLER**: Das für die Verbindung verwendete Client-Zertifikat darf nicht für den gewählten Mandanten verwendet werden. |
| ... |
... |
@@ -242,5 +242,56 @@ |
| 242 |
242 |
Dafür stellt das Plugin 3 HTML-Templates bereit: |
| 243 |
243 |
|
| 244 |
244 |
* **AKDB ePayment Bezahlung Erfolg**: Standard-Template für Anzeige bei erfolgreich abgeschlossener Bezahlung. |
| 245 |
|
-* **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, d |
| 246 |
|
-* **AKDB ePayment Fehler**: Standard-Template für Anzeige bei allgemeinen technischen Fehlern |
|
318 |
+* **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. |
|
319 |
+* **AKDB ePayment Fehler**: Standard-Template für Anzeige bei allgemeinen technischen Fehlern. Der genaue Fehler wird mittels enthaltener Platzhalter ausgewiesen. |
|
320 |
+ |
|
321 |
+{{info}} |
|
322 |
+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. |
|
323 |
+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. |
|
324 |
+{{/info}} |
|
325 |
+ |
|
326 |
+== Versionshistorie == |
|
327 |
+ |
|
328 |
+=== 3.3.0 === |
|
329 |
+ |
|
330 |
+* Plugin benötigt mindestens {{formcycle/}} in der Version {{version major="7" patch="9"}}{{/version}} |
|
331 |
+* Erweiterung Workflow-Aktion //Bestellung übermitteln//: Möglichkeit für serverseitige Definition von Bestellpositionen |
|
332 |
+* 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. |
|
333 |
+ |
|
334 |
+=== 3.2.0 === |
|
335 |
+ |
|
336 |
+* Erweiterung EPayment Bestellartikel: Am Element ist der Gesamtpreis (Anzahl * Einzelpreis) als verstecktes Element verfügbar. Dieser kann über die CSS-Klasse 'CXOrderItemTotalPrice' eingeblendet werden. |
|
337 |
+* Erweiterung Anzahl-Eingabe-Element am EPayment Bestellartikel: Bei einer direkten Werteingabe wird diese sofort gegen die definierte untere und obere Wertgrenze validiert. |
|
338 |
+ |
|
339 |
+=== 3.1.4 === |
|
340 |
+ |
|
341 |
+* Formatierung des Rückgabewertes für den Gesamtbetrag auf #0,00 € |
|
342 |
+ |
|
343 |
+=== 3.1.3 === |
|
344 |
+ |
|
345 |
+* Fehlerbehebung: Es wurden Problem behoben, welche beim Öffnen von EPayment-Formularen im Designe aufgetreten sind. |
|
346 |
+ |
|
347 |
+=== 3.1.2 === |
|
348 |
+ |
|
349 |
+* Neuer Pluginparameter *epayment.webservice.timeout* zum Konfigurieren des Timeouts zum Webservice in Sekunden. |
|
350 |
+ |
|
351 |
+=== 3.1.1 === |
|
352 |
+ |
|
353 |
+* Fehlerbehebung: Bei EPayment-Artikel Objekt werden bei fehlenden Werten, Defaultwerte angenommen. |
|
354 |
+ |
|
355 |
+=== 3.1.0 === |
|
356 |
+ |
|
357 |
+* Neue Eigenschaften am EPayment-Artikel Objekte hinzugefügt: |
|
358 |
+** 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 |
|
359 |
+** Maximale Bestellmenge: Die durch den Nutzer maximal auswählbare Bestellmenge lässt sich begrenzen |
|
360 |
+ |
|
361 |
+=== 3.0.1 === |
|
362 |
+ |
|
363 |
+* Plugin benötigt mindestens {{formcycle/}} in der Version {{version major="7" minor="0" patch="1"}}{{/version}} |
|
364 |
+** Anpassungen der Validierungen im Designer für EPayment-Artikel Objekte |
|
365 |
+ |
|
366 |
+=== 3.0.0 === |
|
367 |
+ |
|
368 |
+* Plugin benötigt mindestens {{formcycle/}} in der Version {{version major="7" minor="0" patch="0"}}{{/version}} |
|
369 |
+** Neue Workflow-Aktion für Initialisierung der Bezahl-Transaktion |
|
370 |
+** Einführung Ereignisse für Absenden der Bestellung, sowie Verifizierung der erfolgreichen / nicht erfolgreichen Bezahltransaktion |
