| ... |
... |
@@ -1,4 +1,13 @@ |
|
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"]] (Benötigt ein Login) |
|
2 |
+ |
| 1 |
1 |
{{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}} |
| 2 |
2 |
**Achtung:** |
| 3 |
3 |
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! |
| 4 |
4 |
{{/info}} |
| ... |
... |
@@ -172,9 +172,9 @@ |
| 172 |
172 |
: Der hier festgelegte Buchungstext wird dem Benutzer auf der PayPage angezeigt. |
| 173 |
173 |
{{/panel}} |
| 174 |
174 |
|
| 175 |
|
-{{panel title="Kundenstammdaten" fullwidth="true" initial="visible" triggerable="true"}} |
|
184 |
+{{panel title="Definition zusätzlicher Bestellpositionen" fullwidth="true" triggerable="true"}} |
| 176 |
176 |
|
| 177 |
|
-{{figure image="plugin_init_config_akdb_bestellposition.png"}} |
|
186 |
+{{figure image="plugin_init_config_bestellposition.png"}} |
| 178 |
178 |
Konfiguration von zusätzlichen Bestellpositionen |
| 179 |
179 |
{{/figure}} |
| 180 |
180 |
|
| ... |
... |
@@ -189,6 +189,8 @@ |
| 189 |
189 |
; Belegnummer |
| 190 |
190 |
: Die Belegnummer ist ein optionaler Wert, welcher zur weiterführenden Verarbeitung auf Seiten von ePay-BL dient. |
| 191 |
191 |
|
|
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 |
+ |
| 192 |
192 |
{{/panel}} |
| 193 |
193 |
|
| 194 |
194 |
{{panel title="Konfiguration AKDB ePayment-Mandant" fullwidth="true" initial="visible" triggerable="true"}} |
| ... |
... |
@@ -218,23 +218,88 @@ |
| 218 |
218 |
|
| 219 |
219 |
{{/panel}} |
| 220 |
220 |
|
|
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. |
| 221 |
221 |
{{id name="plugin_event_epay_success"/}} |
| 222 |
222 |
|
| 223 |
223 |
=== 2.2. Workflow-Ereignis //Bezahlung erfolgreich// === |
| 224 |
224 |
|
|
291 |
+{{figure image="trigger_success.png"}} |
|
292 |
+Workflow-Ereignis bei erfolgreicher Bezahlung |
|
293 |
+{{/figure}} |
|
294 |
+ |
| 225 |
225 |
Eine Workflow-Verarbeitungskette mit diesem Ereignis wird ausgeführt, wenn eine Rückleitung aus dem ePay-BL Portal erfolgt |
| 226 |
226 |
und die Bezahlung erfolgreich durchgeführt wurde. Pro Formular-Vorgang kann dieses Ereignis genau einmal eintreten. |
| 227 |
227 |
Das Ereignis stellt dabei folgende Werte bereit, die per Platzhalter in nachfolgenden Aktionen ausgewertet werden können: |
| 228 |
228 |
|
| 229 |
229 |
; **[%$TRIGGER.paymentStatus%]** |
| 230 |
|
-: Bezeichnung des Status, wie er vom ePay-BL Portal zurückgeliefert wird. (Möglicher Wert: INAKTIV) |
|
300 |
+: Bezeichnung des Status, wie er vom ePay-BL Portal zurück geliefert wird. (Möglicher Wert: INAKTIV) |
| 231 |
231 |
; **[%$TRIGGER.paymentStatusText%]** |
| 232 |
|
-: Eine Nachricht, die den zurückgelieferten Status näher beschreibt |
|
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 |
| 233 |
233 |
|
| 234 |
234 |
{{id name="plugin_event_epay_error"/}} |
| 235 |
235 |
|
| 236 |
236 |
=== 2.3. Workflow-Ereignis //Bezahlung nicht erfolgreich// === |
| 237 |
237 |
|
|
310 |
+{{figure image="trigger_error.png"}} |
|
311 |
+Workflow-Ereignis bei nicht erfolgreicher Bezahlung |
|
312 |
+{{/figure}} |
|
313 |
+ |
| 238 |
238 |
Eine Workflow-Verarbeitungskette mit diesem Ereignis wird immer dann ausgeführt, wenn eine Rückleitung aus dem ePay-BL Portal erfolgte |
| 239 |
239 |
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). |
| 240 |
240 |
Das Ereignis stellt folgende Werte bereit, die per Platzhalter in nachfolgenden Aktionen ausgewertet werden können: |
| ... |
... |
@@ -255,6 +255,10 @@ |
| 255 |
255 |
: Eine Nachricht, die den zurückgelieferten Status näher beschreibt |
| 256 |
256 |
; **[%$TRIGGER.paypageUrl%]** |
| 257 |
257 |
: 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 |
| 258 |
258 |
|
| 259 |
259 |
== 3. Ergebnisanzeige == |
| 260 |
260 |
|
| ... |
... |
@@ -272,6 +272,42 @@ |
| 272 |
272 |
|
| 273 |
273 |
== Versionshistorie == |
| 274 |
274 |
|
|
355 |
+=== 3.5.0 === |
|
356 |
+ |
|
357 |
+* Erweiterungen: EPayment-Verifikation-Aktion (V6) um 'Zahlverfahren' erweitert. |
|
358 |
+Trigger (Workflow V7) um genutztes 'Zahlverfahren' innerhalb der Rückgabewerte erweitert. |
|
359 |
+Error-Trigger (Workflow V7) um 'PaymentVerifyUrl' erweitert. Dieser Parameter kann zum nochmaligen Aufruf der Verifizierung einer Bezahlung genutzt werden. |
|
360 |
+* Erweiterung AKDB ePay Setup: Eingabemöglichkeit für Daten des anzubindenden ePayment-Mandanten; Zusätzlicher Hinweis auf freizugebende URLs (notwendige Firewall-Freigaben) |
|
361 |
+ |
|
362 |
+=== 3.4.3 === |
|
363 |
+ |
|
364 |
+* 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. |
|
365 |
+ |
|
366 |
+=== 3.4.2 === |
|
367 |
+ |
|
368 |
+* Fehlerbehebung: ein Anzeige-Fehler bei der Berechnung des Gesamtpreises für einen EPayment-Bestellartikel wurde behoben |
|
369 |
+* Fehlerbehebung: Aufgrund von Fehlern beim Decodieren und Entschlüsseln von URL-Parametern, wurde die Verschlüsselungs-Routine angepasst. |
|
370 |
+ |
|
371 |
+=== 3.4.1 === |
|
372 |
+ |
|
373 |
+* Fehlerbehebung EPayment Bestellartikel: Die Werte der widget-internen HTML-Elemente sind bei einer Zwischenspeicherung nicht berücksichtigt worden. Dies wurde behoben. |
|
374 |
+ |
|
375 |
+=== 3.4.0 === |
|
376 |
+ |
|
377 |
+* Erweiterung AKDB ePay Setup: Ein Verbindungstest ist jetzt auch ohne Konfiguration eines AKDB-Mandanten möglich. |
|
378 |
+* Anpassung EPayment Bestellartikel: HTML-Elemente innerhalb des Widgets um 'data-' Präfix erweitert |
|
379 |
+* Fehlerbehebung: Session-Replacer werden bei Verarbeitung der Workflow-Ereignisse berücksichtigt. |
|
380 |
+ |
|
381 |
+=== 3.3.1 === |
|
382 |
+ |
|
383 |
+* 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. |
|
384 |
+ |
|
385 |
+=== 3.3.0 === |
|
386 |
+ |
|
387 |
+* Plugin benötigt mindestens {{formcycle/}} in der Version {{version major="7" patch="9"}}{{/version}} |
|
388 |
+* Erweiterung Workflow-Aktion //Bestellung übermitteln//: Möglichkeit für serverseitige Definition von Bestellpositionen |
|
389 |
+* 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. |
|
390 |
+ |
| 275 |
275 |
=== 3.2.0 === |
| 276 |
276 |
|
| 277 |
277 |
* Erweiterung EPayment Bestellartikel: Am Element ist der Gesamtpreis (Anzahl * Einzelpreis) als verstecktes Element verfügbar. Dieser kann über die CSS-Klasse 'CXOrderItemTotalPrice' eingeblendet werden. |
