Änderungen von Dokument AKDB: EPayment-Plugin

Von 2.1 nach 3.1 Von 12.1 nach 13.1

Von Version 3.1

bearbeitet von gru
am 29.06.2021, 09:46

Änderungskommentar: Renamed back-links.

Auf Version 12.1

bearbeitet von fse
am 23.12.2022, 11:43

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

Rohform
Im Layout

Zusammenfassung

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

Details

Seiteneigenschaften

Titel

@@ -1,1 +1,1 @@
--AKDB: EPayment-Plugin
++ePayBL: EPayment-Plugin

Dokument-Autor

@@ -1,1 +1,1 @@
--XWiki.gru
++XWiki.fse

Inhalt

@@ -1,516 +5,11 @@
--[[**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"]] (requires login)
--
--{{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!
++Bevor Sie die ePayBL 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 kostenpflichtige AKDB EPayment Plugin ermöglicht es, über das von der AKDB bereitgestellte [[ePay-BL Portal>>https://www.epaybl.de/||rel="noopener noreferrer" target="_blank" title="E-Payment Bund und Länder"]], einen Bezahlvorgang in einen Formularprozess einzubauen.
++Das kostenpflichtige ePayBL EPayment Plugin ermöglicht es, über das [[ePay-BL Portal>>https://www.epaybl.de/||rel="noopener noreferrer" target="_blank" title="E-Payment Bund und Länder"]], einen Bezahlvorgang in einen Formularprozess einzubauen.
--Der nachfolgende Artikel beschreibt beispielhaft die von einen Formular-Ersteller auszuführenden Schritte, um einen Bezahlvorgang in einem Formular zu integrieren.
--Auf die notwendigen Schritte, um den Service technisch in {{formcycle/}} einzubinden wird an dieser Stelle nicht eingegangen.
++Was bei der Einbindung in Formulare zu beachten ist, finden Sie unter [[**Verwendung** >>doc:Usage]]beschrieben.
--{{id name="config_reihenfolge"/}}
--Prinzipiell sind immer folgende Schritte für eine Einbindung auszuführen:
++Wenn Sie über ein {{formcycle/}}-V6-System verfügen, oder V6-Formulare mit dem EPayment ausstatten bzw. dieses bearbeiten möchten, so finden Sie die dafür notwendige Beschreibung auf dieser **[[Hilfe-Seite>>doc:UsageV6]]**.
--1. Formular mit "bestellbaren" Artikeln und notwendigen Dateneingaben versehen
--1. Statusverarbeitung konfigurieren mit Aktionen zum Starten einer Bezahl-Transaktion und zum Kontrollieren des Status der Transaktion
--1. Anzeige des Ergebnisses der Bezahl-Transaktion
--
--== 1. Formular für den Bezahlvorgang designen ==
--
--Durch die Installation des Plugins im FORMCYCLE-System sind im Designer 2 zusätzliche Elemente, sowie 4 Vorlagen vorhanden, welche den Nutzer bei der notwendigen Konfiguration für das EPayment unterstützen sollen.
--
--{{id name="epay_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//
--{{/figure}}
--
--Ü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**.
--
--__Grundeigenschaften:__
--
--; Angehackt, Versteckt
--: Durch das initiale Auswählen dieser zwei Optionen wird es möglich einen Bestellartikel vor dem Nutzer zu verbergen und direkt bei Absenden eines Formulars in den Warenkorb zu legen.
--: Dies kann immer dann der Fall sein, wenn dem Benutzer selbst keine Entscheidung für die Auswahl eines Bestellartikels ermöglicht werden soll, zum Beispiel bei der Erhebung einer Gebühr.
--
--__EPayment Bestellartikel Einstellungen:__
--
--; Artikelbeschreibung
--: Nähere Beschreibung eines Artikels
--; Artikel-Preis
--: Der Preis für einen Artikel. Der an dieser Stelle konfigurierte Wert dient zum Einen für die Anzeige innerhalb des Formulars, als auch für eine Vorbelegung der [[Bestellinformationen bei der serverseitigen Konfiguration>>doc:||anchor="config_artikel"]] des EPayments.
--; Artikelnummer
--: Eine eindeutige Nummer für den einzelnen Artikel innerhalb des Formulars. Dient bei der Ausführung eines Bestell-Prozesses zur eindeutigen Identifizierung des jeweiligen Artikels.
--
--{{info}}
--Bei Durchführung eines Bestellvorgangs 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.
--{{/info}}
--
--{{id name="epay_vorlage"/}}
--
--=== 1.2. Vorlagen zur Ermittlung von Bestellinformationen: ===
--
--{{figure image="hilfe_epay_vorlagen_form.png"}}
--Vorlagen zur Datenerhebung für das EPayment
--{{/figure}}
--
--Durch das Plugin werden verschiedene Designer-Vorlagen bereitgestellt, mit denen es ermöglicht wird die nachfolgend aufgeführten Daten vom Benutzer zu ermitteln:
--
--* **Persönliche Daten**: Anrede, Name, Vorname, E-Mail etc.
--* **Rechnungsadresse**
--* **Lieferadresse**
--* **Bankverbindung**
--
--{{info}}
--Die Vorlagen "Persönliche Daten" und "Rechnungsadresse" können im Zusammenspiel mit dem //Bürgerkonto-Login// der AKDB verwendet werden. Sie werden nach einem erfolgreichen Login automatisch vorbelegt.
--{{/info}}
--
--{{id name="epay_btn"/}}
--
--=== 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//
--{{/figure}}
--
--Über das Formular-Element //EPayment Bestellen Button// kann das Formular durch den Nutzer abgesendet und damit der Bezahlvorgang gestartet werden.
--Bei Nutzung dieses speziellen Absende-Buttons werden zum Absende-Zeitpunkt alle ausgewählten Artikeln ermittelt und deren Artikelnummer sowie Bestellmenge zum Server übertragen.
--
--__EPayment Einstellungen:__
--
--; Schaltflächentext
--: Beschriftung des Absenden-Buttons
--; 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:
--
--* **[[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:
--
--(% style="background-color:transparent; border:none" %)
--|(% 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>>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 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>>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**>>doc:Formcycle.FormDesigner.Workflow.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**>>doc:Formcycle.FormDesigner.Workflow.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.
--
--
--)))
--
--{{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}}
--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.
--
--Es empfiehlt sich deshalb die in diesem Artikel beschriebene [[Konfigurations-Reihenfolge>>doc:||anchor="config_reihenfolge"]] einzuhalten.
--
--Es ist aber auch möglich das Formular im Nachhinein anzupassen und anschließend die Daten innerhalb des Aktions-Plugins zu aktualisieren.
--{{/info}}
--
--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="visible" triggerable="true"}}
--
--{{figure image="plugin_init_config_akdb_mandant.png"}}
--Konfiguration AKDB EPayment-Mandant
--{{/figure}}
--
--In diesem Bereich werden die für den Formular-Prozess zu verwendenden Einstellungen des ePay-BL Mandanten hinterlegt. Diese sind notwendig, um später die Transaktion auf Seiten von ePay-BL
--der richtigen Behörde (entspricht der festgelegten Mandant-Nummer), Bewirtschafter und Haushaltsstelle zuzuordnen. Die Daten in diesem Bereich sind meistens bereits mit globalen Einstellungen vorbefüllt,
--sofern diese durch einen Plugin-Administrator korrekt hinterlegt wurden.
--
--
--Die einzelnen Parameter können per Platzhalter oder fest definiert hinterlegt werden. Weiterhin kann über den Button [[image:icon_update.png]] //EPayment Webservice Erreichbarkeit prüfen// die generelle Erreichbarkeit des EPayment Webservice geprüft werden.
--
--; Mandant-Nummer (Pflichtfeld)
--: AKDB-Mandantennummer des aufrufenden eShops (FORMCYCLE) (Wird durch ePay-BL-System vorgegeben)
--; Bewirtschafter-Nummer (Pflichtfeld)
--: Bewirtschafternummer (Wird durch ePay-BL-System vorgegeben)
--; Haushaltsstelle (Pflichtfeld)
--: Nummer der Haushaltsstelle, welcher die Buchung zugeordnet werden soll. (Wird durch ePay-BL-System vorgegeben)
--; Objektnummer (Pflichtfeld)
--: Dient der internen Verbuchung im EPayment-System. (Wird durch ePay-BL-System vorgegeben)
--; Kennzeichen-Mahnverfahren (Pflichtfeld)
--: Einstellung für das Kennzeichen in einem Mahnverfahren. (Mögliche Werte werden durch ePay-BL-System vorgegeben)
--; Fälligkeitszeitraum (Pflichtfeld)
--: Einstellung für die Berechnung des Fälligkeitszeitraumes der Zahlung (Dauer in Tagen).
--; Währung
--: Währung in welcher der Betrag ausgewiesen wird. Ist nichts definiert wird als Wert **EUR** angenommen.
--
--{{/panel}}
--
--{{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"}}
--Konfiguration für die PayPage
--{{/figure}}
--
--
--; 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
--: Bei aktivierter Einstellung kann eine automatische Weiterleitung zur PayPage unterbunden werden.
--; Status, in welchen nach erfolgreicher Transaktion gewechselt wird (Pflichtfeld)
--: Hier muss ein Status festgelegt werden, in welchen gewechselt wird, wenn der Bezahlvorgang auf Seiten des ePay-BL-Systems erfolgreich durchlaufen wurde.
--; Status, in welchen nach fehlerhafter oder abgebrochener Transaktion gewechselt wird (Pflichtfeld)
--: Hier muss ein Status festgelegt werden, in welchen gewechselt wird, wenn der Bezahlvorgang auf Seiten des ePay-BL-Systems abgebrochen wurde.
--; PayPage Buchungstext
--: Dieser Buchungstext wird dem Benutzer auf der PayPage angezeigt.
--; Fälligkeitsdatum
--: Der konfigurierte Wert muss sich in ein gültiges Datum umwandeln lassen. Wenn an dieser Stelle ein Wert hinterlegt ist, wird dieser als Fälligkeitszeitpunkt für die Zahlung übermittelt und
--die Einstellung für den **Fälligkeitszeitraum** wird nicht beachtet.
--{{/panel}}
--
--{{panel title="Kundenstammdaten" fullwidth="true" initial="visible" triggerable="true"}}
--
--{{figure image="plugin_init_config_kundenstammdaten.png"}}
--Konfiguration für die Kundenstammdaten
--{{/figure}}
--
--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}}
--Über den Link [[image:icon_update.png]] //Formular-Elemente für Kundenstammdaten ermitteln// können die Felder bei Nutzung der EPayment-Vorlage //Persönliche Daten// vorbelegt werden.
--{{/info}}
--
--; Anrede
--; Titel
--; Vorname
--; Nachname (Pflichtfeld)
--; Geburtsdatum
--: Geburtsdatum muss in der Form **dd.MM.yyyy** übermittelt werden.
--; E-Mail
--: Wird für die Zustellung von Emails an den Kunden in Abhängigkeit von der ePay-BL-Mandantkonfiguration benötigt.
--; Telefon (privat)
--; Telefon (dienstlich)
--; Mobiltelefon
--
--{{/panel}}
--
--{{id name="config_artikel"/}}
--
--{{panel title="Bestellinformationen" fullwidth="true" initial="visible" triggerable="true"}}
--{{figure image="plugin_init_config_artikel.png"}}
--Konfiguration der Bestellinformationen
--{{/figure}}
--
--In diesem Bereich werden die bestellbaren Artikel definiert.
--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>>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 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.
--; Beschreibung (Pflichtfeld)
--: Der Buchungstext darf nur folgende Zeichen enthalten: //A-Za-z0-9,.:/+& -*$%ÄÖÜäöüß// und ist in seiner Länge auf maximal 21 Zeichen begrenzt.
--; Betrag (Pflichtfeld)
--: Komma separierte Zahl, die den Preis eines Artikels definiert.
--; Belegnummer
--: Die Belegnummer ist optional und dient der weiterführenden Verarbeitung auf Seiten von ePay-BL.
--
--
--{{info}}
--**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}}
--
--
--{{/panel}}
--
--{{panel title="Konfiguration Rechnungsadresse (optional)" fullwidth="true" initial="visible" triggerable="true"}}
--
--{{figure image="plugin_init_config_rechadr.png"}}
--Konfiguration der Rechnungsadresse
--{{/figure}}
--
--Die in diesem Bereich konfigurierbaren Werte sind grundlegend optional. Das heißt, die Daten zur Rechnungsadresse müssen nicht an den EPayment-Service übergeben werden.
--Bei Festlegung einer Konfiguration innerhalb dieses Bereichs werden aber einige Felder "bedingt verpflichtend".
--
--{{info}}
--Über den Link [[image:icon_update.png]] //Formular-Elemente für Rechnungsadresse ermitteln// können die Felder bei Nutzung der EPayment-Vorlage //Rechnungsadresse// vorbelegt werden.
--{{/info}}
--
--
--; Strasse (bedingt verpflichtend)
--: Wahlweise ist Strasse und Hausnummer **oder** Postfach bei Nutzung von Rechnungsadressdaten ein Pflichtfeld.
--; Hausnummer (bedingt verpflichtend)
--: Wahlweise ist Strasse und Hausnummer **oder** Postfach bei Nutzung von Rechnungsadressdaten ein Pflichtfeld.
--; Postfach (bedingt verpflichtend)
--: Wahlweise ist Postfach **oder** Strasse und Hausnummer bei Nutzung von Rechnungsadressdaten ein Pflichtfeld.
--; Ort (bedingt verpflichtend)
--; PLZ (bedingt verpflichtend)
--: Postleitzahl
--; Land (bedingt verpflichtend)
--: Wenn gesetzt, muss die Angabe gemäß ISO 3166-1 erfolgen (zwei Großbuchstaben, z.B.: DE)
--
--{{/panel}}
--
--{{panel title="Konfiguration Lieferadresse (optional)" fullwidth="true" initial="visible" triggerable="true"}}
--
--{{figure image="plugin_init_config_lieferadr.png"}}
--Konfiguration der Lieferadressdaten
--{{/figure}}
--
--In diesem Bereich konfigurierten Werte sind grundlegend optional. Das heißt, die Daten zur Lieferadresse müssen nicht an den EPayment-Service übergeben werden.
--Dies ist zum Beispiel dann der Fall, wenn es sich bei dem zu bezahlenden Objekt um ein immaterielles Gut handelt.
--Bei Festlegung einer Konfiguration innerhalb dieses Bereichs werden aber einige Felder "bedingt verpflichtend".
--
--{{info}}
--Über den Link [[image:icon_update.png]] //Formular-Elemente für Lieferadresse ermitteln// können die Felder bei Nutzung der EPayment-Vorlage //Lieferadresse// vorbelegt werden.
--{{/info}}
--
--
--; Anrede
--; Vorname
--; Nachname
--; Strasse (bedingt verpflichtend)
--: Wahlweise ist Strasse und Hausnummer **oder** Postfach bei Nutzung von Lieferadressdaten ein Pflichtfeld.
--; Hausnummer (bedingt verpflichtend)
--: Wahlweise ist Strasse und Hausnummer **oder** Postfach bei Nutzung von Lieferadressdaten ein Pflichtfeld.
--; Postfach (bedingt verpflichtend)
--: Wahlweise ist Postfach **oder** Strasse und Hausnummer bei Nutzung von Lieferadressdaten ein Pflichtfeld.
--; Ort (bedingt verpflichtend)
--; PLZ (bedingt verpflichtend)
--: Postleitzahl
--; Land (bedingt verpflichtend)
--: Wenn gesetzt, muss die Angabe gemäß ISO 3166-1 erfolgen (zwei Großbuchstaben, z.B.: DE)
--
--{{/panel}}
--
--{{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
--{{/figure}}
--
--In diesem Bereich konfigurierten Werte sind grundlegend optional. Das heißt, die Daten zur Bankverbindung müssen nicht an den EPayment-Service übergeben werden.
--Bei Festlegung einer Konfiguration innerhalb dieses Bereichs werden aber einige Felder "bedingt verpflichtend".
--
--{{info}}
--Über den Link [[image:icon_update.png]] //Formular-Elemente für Bankverbindung ermitteln// können die Felder bei Nutzung der EPayment-Vorlage //Bankverbindung// vorbelegt werden.
--{{/info}}
--
--
--; Kontoinhaber
--: Falls der Inhaber des Kontos vom Namen des Kunden abweicht, muss dieser hier übertragen werden. Falls das Feld leer ist, wird bei den Zahlungsüberstellungen der Nachname des Kunden verwendet.
--; Kontonummer (bedingtes Pflichtfeld)
--: Kontonummer vom Zahlungspflichtigen. Wenn Kontodaten konfiguriert werden, ist dies ein Pflichtfeld.
--; IBAN
--: **I**nternational **B**ank **A**ccount **N**umber des Kontos
--; BIC
--: **B**ank **I**dentification **C**ode des Kontos
--; BLZ (bedingtes Pflichtfeld)
--: Bankleitzahl vom Konto des Zahlungspflichtigen. Wenn Kontodaten konfiguriert werden, ist dies ein Pflichtfeld.
--
--{{/panel}}
--
--{{panel title="Allgemeine Rückgabeparameter" fullwidth="true" initial="visible" triggerable="true"}}
--
--{{figure image="plugin_init_config_result.png"}}
--Konfiguration der Plugin Rückgabedaten (Platzhalter)
--{{/figure}}
--
--In diesem Bereich werden die vom Plugin als Ergebnis der Bezahl-Transaktion zurückgelieferten Parameter aufgeführt.
--Für die einzelnen Parameter kann ein Alias vergeben werden.
--In weiteren Aktionen kann auf den entsprechenden Rückgabeparameter per Platzhalter-Syntax zugegriffen werden.
--Der Platzhalter wird dabei nach dem folgenden Muster gebildet:
--
--
--{{code language="java"}}
--[%$<Plugin-Name>.RESULT[0].<Name oder vergebener Alias der Rückgabeparameters>%]
--{{/code}}
--
--
--
--; Kassenzeichen
--: Das für die Transaktion, auf Seiten von ePay-BL erzeugte, notwendige Kassenzeichen.
--; EShopKundenNr
--: Die für die Transaktion automatisch erzeugte EShopKundenNr. (Dient der internen Verarbeitung.)
--; Gesamtbetrag
--: Der errechnete Gesamtbetrag der Bezahl-Transaktion. (Ergibt sich aus der Summe aller bestellten Artikel X deren Bestellmenge.)
--
--
--{{info}}
--Über den [[image:icon_copy.png]] Button kann der aus dem Namen oder Alias erzeugte Platzhalter einfach in die Zwischenablage kopiert
--und an anderer Stelle, z.B.: im Text einer E-Mail-Aktion, eingefügt werden.
--{{/info}}
--
--{{/panel}}
--
--{{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}}
--
--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.
--
--
--
--{{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.
--Für die einzelnen Parameter kann ein Alias vergeben werden.
--In weiteren Aktionen kann auf den entsprechenden Rückgabeparameter per Platzhalter-Syntax zugegriffen werden.
--Der Platzhalter wird dabei nach dem folgenden Muster gebildet:
--
--
--{{code language="java"}}
--[%$<Plugin-Name>.RESULT[0].<Name oder vergebener Alias der Rückgabeparameters>%]
--{{/code}}
--
--
--
--; PayPageStatus
--: Enthält den vom ePay-BL-Service zurückgelieferten Statuscode. Die nachfolgende Tabelle gibt einen Überblick über die möglichen Statuscode und deren Bedeutung:
--|=Statuscode|=Bedeutung
--|INAKTIV | Die Bezahlung über die PayPage ist erfolgreich durchgeführt worden
--|AKTIV | Die Bezahlung über die PayPage ist noch nicht erfolgt.
--|MANDANT_NICHT_GEFUNDEN | Der Mandant wurde im ePayment-System nicht gefunden.
--|MANDANT_INAKTIV | Der Mandant ist im ePayment-System derzeit als inaktiv gekennzeichnet.
--|VERBINDUNG_OHNE_HTTPS | Die Verbindung zum Webservice erfolgte nicht über HTTPS mit Client-Zertifikaten.
--|VERBINDUNG_ZERTIFIKAT_FEHLER | Das für die Verbindung verwendete Client-Zertifikat darf nicht für den gewählten Mandanten verwendet werden.
--|KASSENZEICHEN_NICHT_VORHANDEN | Das gewählte Kassenzeichen ist nicht vorhanden.
--|KASSENZEICHEN_NICHT_GEFUNDEN | Das gewählte Kassenzeichen konnte nicht gefunden werden.
--|INTERNER_EPAYMENT_FEHLER | Interner nicht dokumentierter Fehler im ePayment-System.
--|UNDEFINIERT | Ein im System nicht bekannter Status
--; WebserviceErgebnisText
--: Enthält den vom ePay-BL Service zurückgelieferten Erläuterungstext zum übermittelten Status.
--
--{{info}}
--Über den [[image:icon_copy.png]] Button kann der aus dem Namen oder Alias erzeugte Platzhalter einfach in die Zwischenablage kopiert
--und an anderer Stelle, z.B.: als Wert innerhalb einer Bedingung, eingefügt werden.
--{{/info}}
--
--
--{{/panel}}
--
--== 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.
--{{/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 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.
--
--Erreichen kann man dies über eine entsprechende Bedingung an der jeweiligen Aktion.
--
--
--== Weiterführende Informationen ==
--
--=== 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>>doc:||anchor="plugin_epay_init"]]** konfiguriert sein.
--
--=== Formular-Projekt zum Download ===
--
--[[Hier>>https://customer.formcycle.eu/index.php/s/YacSssWhhr23q7o||rel="noopener noreferrer" target="_blank"]] können Sie sich ein bereits vorkonfiguriertes Formular-Projekt herunterladen.
--
--== Versionshistorie ==
--
--=== 2.2.0 ===
--
--* Plugin benötigt mindestens {{formcycle/}} in der Version {{version major="6" minor="6"}}{{/version}}
--* Fehlerbehebung: Fehlende Beschriftungen an den Eigenschaften für die Formular-Elemente //EPayment ArtikelEPayment Artikel// und //EPayment Bestellen Button// wurden behoben.
--
--=== 2.1.0 ===
--
--* Bei Speicherung einer Konfiguration im Aktions-Plugin //AKDB:EPayment initialisieren// wird für den betroffenen Status immer die "Unregistrierte Wiederanzeige" gestattet.
--* Anpassung Template-Vorlage für Rechungsadresse: Bei einem AKDB Bürgerkonto-Login werden die zurückgelieferten Adressdaten auf Strasse und Hausnummer aufgeteilt, wenn dies möglich ist.
--* Überarbeitung der Konfigurationsoberfläche des Aktions-Plugin //AKDB:EPayment PayPageURL bereitstellen//
--* Anpassung Aktions-Plugin //AKDB:EPayment initialisieren: //Einstellungen für den AKDB-Mandanten werden zur Laufzeit aus den Bundle-Properties bezogen, wenn nicht explizit konfiguriert
--* Internes Refactoring: Umstellung von ID auf UUID
--
--=== 2.0.8 ===
--
--* Anpassung für PDF Blanko-Druck: Absenden-Button und einzelne Bestellartikel-Definitionen werden standardmäßig aus dem Blanko-Druck entfernt.
--* Bestellen-Button um Auswahlmöglichkeit für Seitenvalidierung vor Beginn des EPayment-Prozesses erweitert
--
--=== 2.0.7 ===
--
--* Anpassungen für Zusammenspiel mit AKDB Bürgerkonto-Login bei Wiederanzeige
--* Einführung Transaktions-Logging um Recherche des jeweiligen Status eines Kassenzeichens durchführen zu können.
--* Fehlerbehebungen
--* internes Refactoring im Zusammenhang mit Einführung des Transaktions-Loggings
--
--=== 2.0.6 ===
--
--* Bereitstellung Widgets für {{designer/}}
--** Widget für Definition von Bestell-Artikeln mit Konfigurationsmöglichkeit von Beschreibung und Preis
--** Widget zum Absenden einer Bestellung
--* Template-Vorlagen für: Persönliche Daten, Bankverbindung, Rechnungsadresse, Lieferadresse
--* Umfangreiches Überarbeitung der bestehenden Logik und der Konfigurationsoberflächen der bereitgesteelten Aktions-Plugins
--
--=== 2.0.5 ===
--
--* Fehlerbehebung: Lauffähigkeit unter Java 11 sichergestellt
--
--=== 2.0.4 ===
--
--* Projekt um //Changelog//- und //Readme //- Datei ergänzt.
--
--=== 2.0.3 ===
--
--* Anpassung im Aktions-Plugin //AKDB:EPayment initialisieren//: Als Rückgabewert stehen jetzt die berechneten Gesamtkosten zur Verfügung (in vollen Cent)
--* Im Falle von Bestell-Gesamtkosten mit Summe "0" werden keine Transaktionsdaten übermittelt und damit keine unnötige Transaktion auf Seiten des ePay-BL Portals erzeugt.
--
--=== 2.0.2 ===
--
--* Anpassung im Pre-Renderer zum Verifizieren des PayPage Results
--
--=== 2.0.1 ===
--
--* Template-Vorlage für EPayment Rechnungsadresse hinzugefügt.
--
--=== 2.0.0 ===
--
--* Bereitstellung der Plugin-Logik für {{formcycle/}} {{version major="6"}}{{/version}}