Änderungen von Dokument AKDB: EPayment-Plugin

Von Version < 24.28 >

bearbeitet von rth
am 12.03.2020, 12:11

Auf Version < 24.34 >

bearbeitet von rth
am 12.03.2020, 13:36

< >

Änderungskommentar: Es gibt keinen Kommentar für diese Version

Rohform
Im Layout

Zusammenfassung

Seiteneigenschaften (1 geändert, 0 hinzugefügt, 0 gelöscht)

Details

Seiteneigenschaften

Inhalt

@@ -23,7
          +23,7 @@
  {{id name="epay_artikel"/}}
--=== Artikel definieren durch das Formular-Element: //EPayment Artikel//: ===
++=== 1.1. Artikel definieren durch das Formular-Element: //EPayment Artikel//: ===
  {{figure image="hilfe_epay_artikel_form.png"}}
  Konfigurationsmöglichkeiten am Formular-Element //EPayment Artikel//
@@ -55,7
          +55,7 @@
  {{id name="epay_vorlage"/}}
--=== Vorlagen zur Ermittlung von Bestellinformationen: ===
++=== 1.2. Vorlagen zur Ermittlung von Bestellinformationen: ===
  {{figure image="hilfe_epay_vorlagen_form.png"}}
  Vorlagen zur Datenerhebung für das EPayment
@@ -74,7
          +74,7 @@
  {{id name="epay_btn"/}}
--=== Bestellprozess starten mittels Formular-Element //EPayment Bestellen Button//: ===
++=== 1.3. Bestellprozess starten mittels Formular-Element //EPayment Bestellen Button//: ===
  {{figure image="hilfe_epay_button_form.png"}}
  Konfigurationsmöglichkeiten am Formular-Element //EPayment Bestellen Button//
@@ -96,8
          +96,8 @@
  Um eine Bezahl-Transaktion in einen Formularprozess einzubauen werden die folgenden Aktions-Plugins zur Verfügung gestellt:
--* **AKDB:EPayment initialisieren**: Dieses erzeugt eine neue Bezahl-Transaktion auf Seiten der AKDB und leitet den Benutzer auf dessen Portalseite weiter.
--* **AKDB:EPayment verifizieren**: Prüft den aktuellen Status einer Bezahl-Transaktion
++* **[[AKDB:EPayment initialisieren>>doc:||anchor="plugin_epay_init"]]**: Dieses erzeugt eine neue Bezahl-Transaktion auf Seiten der AKDB und leitet den Benutzer auf dessen Portalseite weiter.
++* **[[AKDB:EPayment verifizieren>>doc:||anchor="plugin_epay_verify"]]**: Prüft den aktuellen Status einer Bezahl-Transaktion
  Ein Statusverarbeitung für einen einfachen Fall kann folgendermaßen konfiguriert sein:
@@ -105,24
          +105,26 @@
  |(% style="border-style:none; width:180px" %)[[image:hilfe_statusverabeitung.png||alt="Statusverarbeitung mit Anbindung EPayment"]]|(% style="border-style:none; width:700px" %)(((
  __Kurze Ablaufbeschreibung zur dargestellten Statusverarbeitung:__
--~1. Nach dem Absenden des Bestellformulars wird in den Status //Eingegangen// gewechselt und dort das Aktions-Plugin **AKDB:EPayment initialisieren **ausgeführt. Dieses ermittelt die für den Bestellvorgang notwendigen Daten aus dem Formular und startet mit diesen 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, unter vorheriger Angabe eines Rücksprung-Ziels, weitergeleitet.
++~1. Nach dem Absenden des Bestellformulars wird in den Status //Eingegangen// gewechselt und dort das Aktions-Plugin **[[AKDB:EPayment initialisieren>>doc:||anchor="plugin_epay_init"]]** ausgeführt. Dieses ermittelt die für den Bestellvorgang notwendigen Daten aus dem Formular und startet mit diesen 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, unter vorheriger [[Angabe eines Rücksprung-Ziels>>doc:||anchor="config_paypage"]] (Realisiert über Festlegung eines Ziel-Status), weitergeleitet.
--2. Nach Abschluss des Bezahlvorgangs auf im ePay-BL Portal wird der Benutzer wieder zum {{formcycle/}}-Formular zurückgeleitet. Dies erfolgt unter Benutzung des angegebenen Rücksprung-Ziels.
--Aus einer im Vorfeld festgelegten Konfiguration im **AKDB:EPayment initialisieren **Aktions-Plugin wird der Ziel-Status nach Rückkehr aus dem ePay-BL Portal ermittelt. Im vorliegenden Beispiel wird deshalb in den Status //Zahlung pruefen// gewechselt.
++2. Nach Abschluss des Bezahlvorgangs im ePay-BL Portal wird der Benutzer wieder zum {{formcycle/}}-Formular zurückgeleitet. Dies erfolgt unter Benutzung des angegebenen Rücksprung-Ziels.
++Aus einer im Vorfeld festgelegten Konfiguration im **[[AKDB:EPayment initialisieren>>doc:||anchor="plugin_epay_init"]]** Aktions-Plugin wird der Ziel-Status nach Rückkehr aus dem ePay-BL Portal ermittelt. Im vorliegenden Beispiel wird deshalb in den Status //Zahlung pruefen// gewechselt.
--3. Die Statusverarbeitung //Zahlung pruefen// wird ausgeführt und dort das Aktions-Plugin **AKDB:EPayment verifizieren** durchlaufen. Unter Zuhilfenahme dieses Plugins wird der aktuelle Status der Bezahlung am EPayment-System geprüft und in der weiteren Statusverarbeitung (per Platzhalter) zur Verfügung gestellt.
++3. Die Statusverarbeitung //Zahlung pruefen// wird ausgeführt und dort das Aktions-Plugin **[[AKDB:EPayment verifizieren>>doc:||anchor="plugin_epay_verify"]]** durchlaufen. Unter Zuhilfenahme dieses Plugins wird der aktuelle Status der Bezahlung am EPayment-System geprüft und in der weiteren Statusverarbeitung (per Platzhalter) zur Verfügung gestellt.
--4. Im Falle einer positiven Verifizierung des Bezahlvorgangs wird unter Zuhilfenahme der Aktion **Statusänderung** in den Status //Bezahlt //gewechselt. Innerhalb von diesem Status ist eine **Weiterleitungs**-Aktion zum aktuellen Formular konfiguriert, sodass dieses dem Benutzer wieder angezeigt wird. Innerhalb dieses Formulares kann dann ein Text-Element konfiguriert werden, welches nur im Status //Bezahlt// angezeigt wird und dem Benutzer eine positive Rückmeldung zum Ausgang seinen Bezahlvorgangs anzeigt.
++4. Im Falle einer positiven Verifizierung des Bezahlvorgangs wird unter Zuhilfenahme der Aktion [[**Statusänderung**>>doc:Formcycle.UserInterface.MyForms.WorkflowProcessing.Actions.ChangeState]] in den Status //Bezahlt //gewechselt. Innerhalb von diesem Status ist eine [[**Weiterleitungs**>>doc:Formcycle.UserInterface.MyForms.WorkflowProcessing.Actions.Redirect]]-Aktion zum aktuellen Formular konfiguriert, sodass dieses dem Benutzer wieder angezeigt wird. Innerhalb dieses Formulares kann dann ein Text-Element konfiguriert werden, welches nur im Status //Bezahlt// angezeigt wird und dem Benutzer eine positive Rückmeldung zum Ausgang seines Bezahlvorgangs anzeigt.
  __Hinweis:__ Anstatt einer Rückleitung ins Formular kann im Status //Bezahlt// auch eine individuelle Abschluss-Seite konfiguriert sein. Dann würde diese dem Nutzer angezeigt werden.
--5. Im Falle einer negativen Verifizierung des Bezahlvorgangs (z.B.: der Nutzer hat den Bezahlvorgang im ePay-BL Portal abgebrochen; während des Bezahlvorgangs ist ein Fehler aufgetreten) wird unter Zuhilfenahme der Aktion **Statusänderung** in den Status //Bezahlung offen// gewechselt. Es erfolgt wieder eine Weiterleitung ins aktuelle Formular, wo ein Text-Element konfiguriert ist, welches nur im Status //Bezahlung offen// angezeigt wird und dem Benutzer eine Rückmeldung zu seiner noch ausstehenden Bezahlung anzeigt.
++5. Im Falle einer negativen Verifizierung des Bezahlvorgangs (z.B.: der Nutzer hat den Bezahlvorgang im ePay-BL Portal abgebrochen; während des Bezahlvorgangs ist ein Fehler aufgetreten) wird unter Zuhilfenahme der Aktion [[**Statusänderung**>>doc:Formcycle.UserInterface.MyForms.WorkflowProcessing.Actions.ChangeState]] in den Status //Bezahlung offen// gewechselt. Es erfolgt wieder eine [[**Weiterleitung**>>doc:Formcycle.UserInterface.MyForms.WorkflowProcessing.Actions.Redirect]] ins aktuelle Formular, wo ein Text-Element konfiguriert ist, welches nur im Status //Bezahlung offen// angezeigt wird und dem Benutzer eine Rückmeldung zu seiner noch ausstehenden Bezahlung anzeigt.
  )))
--=== Konfigurationsmöglichkeiten des Aktions-Plugins //AKDB:EPayment initialisieren// ===
++{{id name="plugin_epay_init"/}}
++=== 2.1. Konfigurationsmöglichkeiten des Aktions-Plugins //AKDB:EPayment initialisieren// ===
++
  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, Rechnungsadresse etc.), festgelegt. Weiterhin erfolgt die Festlegung in welchen Status, nach Rückkehr aus dem ePay-BL Portal, gewechselt werden soll.
  {{info}}
@@ -135,7
          +135,7 @@
  Die Konfigurationsoberfläche des Aktions-Plugins ist in einzelne Bereiche unterteilt die nachfolgend kurz beschrieben werden.
--{{panel title="Konfiguration AKDB EPayment-Mandant" fullwidth="true" initial="hidden" triggerable="true"}}
++{{panel title="Konfiguration AKDB EPayment-Mandant" fullwidth="true" initial="visible" triggerable="true"}}
  {{figure image="plugin_init_config_akdb_mandant.png"}}
  Konfiguration AKDB EPayment-Mandant
@@ -165,8
          +165,10 @@
  {{/panel}}
--{{panel title="Konfiguration für die PayPage" fullwidth="true" initial="hidden" triggerable="true"}}
++{{id name="config_paypage"/}}
++{{panel title="Konfiguration für die PayPage" fullwidth="true" initial="visible" triggerable="true"}}
++
  Bei der "PayPage" handelt es sich dabei um eine bereits ausgefüllte Bezahlseite zur Online-Bezahlung der vom Gläubiger, für die jeweils erbrachten Leistungen, veranschlagten Gebühren, Entgelte etc.
  {{figure image="plugin_init_config_paypage.png"}}
@@ -189,7
          +189,7 @@
  die Einstellung für den **Fälligkeitszeitraum** wird nicht beachtet.
  {{/panel}}
--{{panel title="Kundenstammdaten" fullwidth="true" initial="hidden" triggerable="true"}}
++{{panel title="Kundenstammdaten" fullwidth="true" initial="visible" triggerable="true"}}
  {{figure image="plugin_init_config_kundenstammdaten.png"}}
  Konfiguration für die Kundenstammdaten
@@ -218,7
          +218,7 @@
  {{id name="config_artikel"/}}
--{{panel title="Bestellinformationen" fullwidth="true" initial="hidden" triggerable="true"}}
++{{panel title="Bestellinformationen" fullwidth="true" initial="visible" triggerable="true"}}
  {{figure image="plugin_init_config_artikel.png"}}
  Konfiguration der Bestellinformationen
  {{/figure}}
@@ -251,7
          +251,7 @@
  {{/panel}}
--{{panel title="Konfiguration Rechnungsadresse (optional)" fullwidth="true" initial="hidden" triggerable="true"}}
++{{panel title="Konfiguration Rechnungsadresse (optional)" fullwidth="true" initial="visible" triggerable="true"}}
  {{figure image="plugin_init_config_rechadr.png"}}
  Konfiguration der Rechnungsadresse
@@ -279,7
          +279,7 @@
  {{/panel}}
--{{panel title="Konfiguration Lieferadresse (optional)" fullwidth="true" initial="hidden" triggerable="true"}}
++{{panel title="Konfiguration Lieferadresse (optional)" fullwidth="true" initial="visible" triggerable="true"}}
  {{figure image="plugin_init_config_lieferadr.png"}}
  Konfiguration der Lieferadressdaten
@@ -311,7
          +311,7 @@
  {{/panel}}
--{{panel title="Konfiguration für die Bankverbindung (optional)" fullwidth="true" initial="hidden" triggerable="true"}}
++{{panel title="Konfiguration für die Bankverbindung (optional)" fullwidth="true" initial="visible" triggerable="true"}}
  {{figure image="plugin_init_config_bank.png"}}
  Konfiguration für die Bankverbindung
@@ -338,7
          +338,7 @@
  {{/panel}}
--{{panel title="Allgemeine Rückgabeparameter" fullwidth="true" initial="hidden" triggerable="true"}}
++{{panel title="Allgemeine Rückgabeparameter" fullwidth="true" initial="visible" triggerable="true"}}
  {{figure image="plugin_init_config_result.png"}}
  Konfiguration der Plugin Rückgabedaten (Platzhalter)
@@ -371,8
          +371,10 @@
  {{/panel}}
--=== Konfigurationsmöglichkeiten des Aktions-Plugins //AKDB:EPayment verifizieren// ===
++{{id name="plugin_epay_verify"/}}
++=== 2.2. Konfigurationsmöglichkeiten des Aktions-Plugins //AKDB:EPayment verifizieren// ===
++
  {{figure image="plugin_verify.png"}}
  Konfiguration des Plugins //AKDB:EPayment verifizieren//
  {{/figure}}
@@ -382,7
          +382,7 @@
--{{panel title="Allgemeine Rückgabeparameter" fullwidth="true" initial="hidden" triggerable="true"}}
++{{panel title="Allgemeine Rückgabeparameter" fullwidth="true" initial="visible" triggerable="true"}}
  In diesem Bereich werden die vom Plugin als Ergebnis der Status-Prüfung am ePay-BL-Service zurückgelieferten Parameter aufgeführt.
@@ -441,4
          +441,4 @@
  === Aktions-Plugin //AKDB:EPayment PayPageURL bereitstellen// ===
  Durch dieses Aktions-Plugin kann die aktuell gültige URL zur Bezahl-Transaktion ins ePay-BL-Portal aus dem Formular-Vorgang ermittet werden.
--Dadurch besteht die Möglichkeit eine noch nicht abgeschlossene Bezahl-Transaktion nochmals zur Anzeige zu bringen und die Zahlung durchzuführen. Dieses Aktions-Plugin muss dabei im zeitlichen Ablauf nach dem Plugin **AKDB:EPayment initialisieren** konfiguriert sein.
++Dadurch besteht die Möglichkeit eine noch nicht abgeschlossene Bezahl-Transaktion nochmals zur Anzeige zu bringen und die Zahlung durchzuführen. Dieses Aktions-Plugin muss dabei im zeitlichen Ablauf nach dem Plugin **[[AKDB:EPayment initialisieren>>doc:||anchor="plugin_epay_init"]]** konfiguriert sein.

Änderungen von Dokument AKDB: EPayment-Plugin

Zusammenfassung

Details

Navigation