Änderungen von Dokument AKDB: EPayment-Plugin

Von Version < 24.22 >

bearbeitet von rth
am 12.03.2020, 11:39

Auf Version < 24.28 >

bearbeitet von rth
am 12.03.2020, 12:11

< >

Ä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

@@ -1,5
          +1,10 @@
  {{content/}}
++{{info}}
++**Achtung:**
++Bevor Sie die AKDB EPayment in ihren Formular-Prozessen einbinden, stellen Sie bitte sicher, dass die konfigurative Anbindung des Dienstes durch den Xima® Formcycle-Administrator erfolgt ist!
++{{/info}}
++
  Das AKDB EPayment Plugin ermöglicht es über die von der AKDB bereitgestellte Payment-Schnittstelle Bezahlvorgänge in einen Formularprozesse einzubauen.
  Der nachfolgende Artikel beschreibt beispielhaft die von einen Formular-Ersteller auszuführenden Schritte, um einen Bezahlvorgang in einem Formular einzubauen.
@@ -26,7
          +26,7 @@
  Über das Formular-Element //EPayment Artikel// werden die für eine Bestell-Transaktion notwendigen Artikel definiert.
  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 notwendige serverseitige Konfiguration des Artikels innerhalb des Aktions-Plugins ~*~*AKDB:EPayment initialisieren~*~*.
++für die notwendige serverseitige Konfiguration des Artikels innerhalb des Aktions-Plugins **AKDB:EPayment initialisieren**.
  __Grundeigenschaften:__
@@ -85,6
          +85,8 @@
  ; Eingaben pruefen vor Absenden
  : Wenn ausgewählt, wird das Formular vor dem Absenden validiert, sonst erfolgt keine Prüfung.
++{{id name="config_process"/}}
++
  == 2. Statusverarbeitung für EPayment konfigurieren ==
  Um eine Bezahl-Transaktion in einen Formularprozess einzubauen werden die folgenden Aktions-Plugins zur Verfügung gestellt:
@@ -98,18
          +98,18 @@
  |(% 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 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 **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.
--2. Nach Abschluss des Bezahlvorgangs auf im ePay-BL Portal wird der Benutzer wieder zu FORMCYCLE-Formular zurückgeleitet. Dies erfolgt unter Benutzung des angegebenen Rücksprung-Ziels.
++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.
 . 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.
--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 durch eine **Weiterleitungs**-Aktion eine Weiterleitung ins aktuelle Formular konfiguriert, sodass dieses dem Benutzer wieder angezeigt wird. Innerhalb dieses Formulares kann dann ein Formular-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** 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.
  __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.: Nutzer hat Bezahlvorgang im ePay-BL Portal abgebrochen, Es kam zu Fehlern während des Bezahlvorgangs) wird unter Zuhilfenahme der Aktion Statusänderung in den Status Bezahlung offen gewechselt. Es erfolgt wieder eine Weiterleitung ins aktuelle Formular, wo eine Formular-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** 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.
  )))
@@ -116,7
          +116,7 @@
  === 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"]] 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.
++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}}
  Wenn vor der Konfiguration des Plugins bereits mindestens ein **[[EPayment-Artikel>>doc:||anchor="epay_artikel"]]**, der **[[EPayment Bestellen Button>>doc:||anchor="epay_btn"]]** sowie die **[[Vorlage>>doc:||anchor="epay_vorlage"]]** für die **persönlichen Daten** im Formular hinterlegt wurden, werden bei einer Neueinrichtung der //AKDB:EPayment initialisieren// Plugin-Aktion die notwendigen Pflicht-Konfigurationen bereits mit den ermittelten Daten aus dem Formular vorbelegt. Es muss anschließend nur noch der Ziel-Status für eine erfolgreiche / nicht erfolgreiche Transaktion festgelegt werden.
@@ -160,15
          +160,13 @@
  {{panel title="Konfiguration für die PayPage" fullwidth="true" initial="hidden" 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"}}
  Konfiguration für die PayPage
  {{/figure}}
--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.
--(((
--
--)))
  ; URL zur PayPage (Pflichtfeld)
  : URL zur PayPage des EPayment-Systems. Die hier hinterlegte URL wird durch das ePay-BL-System vorgegeben und beinhaltete den Verweis auf die PayPage im ePay-BL-System.
  ; Automatische Weiterleitung zur PayPage verhindern
@@ -190,7
          +190,7 @@
  Konfiguration für die Kundenstammdaten
  {{/figure}}
--In diesem Bereich werden die Daten des Benutzers, für den die Bezahl-Transaktion erzeugt werden soll, hinterlegt.
++In diesem Bereich werden die Daten des Benutzers hinterlegt, für den die Bezahl-Transaktion erzeugt werden soll.
  Die einzelnen Parameter können per Platzhalter oder fest definiert hinterlegt werden.
  {{info}}
@@ -219,14
          +219,14 @@
  {{/figure}}
  In diesem Bereich werden die bestellbaren Artikel definiert.
--Weiterhin wird im Feld //Übermittelte Bestellung//, per Platzhalter, der Wert festgelegt, welcher zum Ausführungszeitpunkt die JSON-Struktur mit den im Formular bestellten Artikeln enthält.
++In dem Feld //Übermittelte Bestellung// wird der Wert per Platzhalter festgelegt, welcher zum Ausführungszeitpunkt die JSON-Struktur mit den im Formular bestellten Artikeln enthält.
  {{info}}
--Wenn das Formular über die Elemente **EPayment-Artikel** und **EPayment Bestellen Button** verfügt kann über den jeweiligen Button [[image:icon_update.png]] eine Vorbefüllung der vorhandenen Pflichtfelder durchgeführt werden.
++Wenn das Formular über die Elemente **[[EPayment-Artikel>>doc:||anchor="epay_artikel"]]** und **[[EPayment Bestellen Button>>doc:||anchor="epay_btn"]]** verfügt kann über den jeweiligen Button [[image:icon_update.png]] eine Vorbefüllung der vorhandenen Pflichtfelder durchgeführt werden.
  {{/info}}
--In der Tabelle //Bestellartikel-Definitionen// erfolgt die Definition der einzelnen Bestell-Artikel. Die hier konfigurierten Angaben sind maßgeblich für eine Übermittlung an den ePay-BL-Service.
++In der Tabelle //Bestellartikel-Definitionen// erfolgt die Definition der einzelnen Bestellartikel. Die hier konfigurierten Angaben sind maßgeblich für eine Übermittlung an den ePay-BL-Service.
  Jeder Artikel muss über folgende Parameter verfügen:
  ; Artikelnummer (Pflichtfeld)
  : Eine Nummer die den einzelnen Artikel innerhalb einer Bestellung eindeutig identifizierbar macht.
@@ -239,7
          +239,7 @@
  {{info}}
--__Hinweis:__ Um zur Laufzeit den Gesamtpreis einer Zahlungsanweisung zu errechnen, wird immer der Artikel-Preis aus der //Bestellartikel-Definitionen//-Tabelle entnommen.
++**Achtung:** Um zur Laufzeit den Gesamtpreis einer Zahlungsanweisung zu errechnen, wird **immer** der Artikel-Preis aus der //Bestellartikel-Definitionen//-Tabelle entnommen.
  Einzig Artikelnummer und Bestellmenge werden aus den vom Browser übermittelten Daten zur Erstellung der Bezahl-Transaktion herangezogen.
  {{/info}}
@@ -372,7
          +372,7 @@
  Konfiguration des Plugins //AKDB:EPayment verifizieren//
  {{/figure}}
--Dieses Plugin ist zum Auswerten des Status einer Bezahl-Transaktion zuständig. Im Standardfall muss innerhalb des Plugins keine weitere Konfiguration erfolgen, da alle notwendigen Parameter, für eine Prüfanfrage am ePay-BL-Service, intern hinterlegt sind.
++Dieses Aktions-Plugin ist zum Auswerten des Status einer Bezahl-Transaktion zuständig. Im Standardfall muss innerhalb des Plugins keine weitere Konfiguration erfolgen, da alle notwendigen Parameter, für eine Prüfanfrage am ePay-BL-Service, intern hinterlegt sind.
  Es besteht aber auch die Möglichkeit die //AKDB-Mandantennummer// und das //Kassenzeichen// durch eine Konfiguration zu übersteuern. Dies kann immer dann der Fall sein, wenn die Prüfung in einem anderem Formularvorgang erfolgen soll, in dem **nicht** die eigentliche Bezahl-Transaktion erzeugt wurde.
@@ -419,17
          +419,16 @@
  == 3. Ergebnisanzeige ==
  {{figure image="hilfe_statusverabeitung_bedingung.png"}}
--Beispiel für die Konfiguration einer Bedingung, welche den aktuelle Status einer Bezahl-Transaktion beinhaltet. Die Bedingung im vorliegenden Beispiel wird positiv durchlaufen wenn der Nutzer zuvor bezahlt hat.
++Beispiel für die Konfiguration einer Bedingung, welche den aktuelle Status einer Bezahl-Transaktion beinhaltet. Die Bedingung im vorliegenden Beispiel wird positiv durchlaufen, wenn der Nutzer zuvor bezahlt hat.
  {{/figure}}
  Für die Anzeige des Ergebnisses bzw. dem Status einer Bezahl-Transaktion bestehen mehrere Möglichkeiten.
  Man kann dem Nutzer dieses in einer extra dafür hinterlegten Abschluss-Seite oder durch die Wiederanzeige das Formulars anzeigen.
--Ein Beispiel für die Ergebnisanzeige innerhalb des Formular ist unter //Punkt 2// aufgeführt.
++Ein Beispiel für die Ergebnisanzeige innerhalb des Formular ist unter dem Punkt //[[Statusverarbeitung für EPayment konfigurieren>>doc:||anchor="config_process"]]// aufgeführt.
--In den meisten Fällen ist es gewünscht, dass je nach Status der Bezahl-Transaktion unterscheidliche Rückmeldungstexte angezeigt oder
--zusätzliche Aktionen ausgeführt, werden.
++In den meisten Fällen ist es gewünscht, dass je nach Status der Bezahl-Transaktion unterscheidliche Rückmeldungstexte angezeigt oder zusätzliche Aktionen ausgeführt werden.
--Erreichen kann man dies über eine entsprechende Bedingung am Status oder der jeweiligen Aktion.
++Erreichen kann man dies über eine entsprechende Bedingung an der jeweiligen Aktion.
  == Weiterführende Informationen ==
@@ -436,5
          +436,5 @@
  === Aktions-Plugin //AKDB:EPayment PayPageURL bereitstellen// ===
--Durch dieses 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 Plugins **AKDB:EPayment initialisieren** konfiguriert sein.
++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.

Änderungen von Dokument AKDB: EPayment-Plugin

Zusammenfassung

Details

Navigation