Das kostenpflichtige AKDB EPayment Plugin ermöglicht es, über das von der AKDB bereitgestellte ePay-BL Portal, 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 Xima® Formcycle einzubinden wird an dieser Stelle nicht eingegangen.

Prinzipiell sind immer folgende Schritte für eine Einbindung auszuführen:

1. Formular mit "bestellbaren" Artikeln und notwendigen Dateneingaben versehen
2. Workflow konfigurieren mit:
   • einer Aktionen zum Starten einer Bezahl-Transaktion
   • Ereignissen für eine gezielten Reaktion auf Rückmeldungen vom Bezahl-Portal 
3. Anzeige des Ergebnisses der Bezahl-Transaktion

1. Formular für den Bezahlvorgang designen

Durch die Installation des Plugins im Xima® Formcycle-System sind im Designer ein zusätzliches Element, sowie 4 Vorlagen vorhanden, welche den Nutzer bei der notwendigen Konfiguration für das EPayment unterstützen sollen.

1.1. Artikel definieren durch das Formular-Element: EPayment Artikel:

Ü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 Erstellung einer
konkreten Bestell-Position zum Zeitpunkt der Ausführung einer Bezahl-Transaktion. 

Grundeigenschaften:

Versteckt

Durch das Auswählen dieser Option wird es möglich einen Bestellartikel vor dem Nutzer zu verbergen.
Wenn gleichzeitig dazu noch die Option Pflicht-Artikel ausgewählt wird, so wird beim Absenden des Formulars dieser Artikel automatisch der Bestellung hinzugefügt.

Dies kann immer dann sinnvoll 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:

Pflicht-Artikel

Diese Option ermöglicht es, einen Artikel als ausgewählt zu markieren, sodass er beim Absenden des Formulars automatisch der Bestellung hinzugefügt wird.

Beschreibung

Nähere Beschreibung eines Artikels

Artikel-Preis (in Euro)

Der Preis für einen Artikel. Der an dieser Stelle konfigurierte Wert dient zum Einen für die Anzeige innerhalb des Formulars, als auch zur Berechnung der Gesamtsumme im Fall einer Bestellung des Artikels.

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. 

Max. Bestellmenge

Hier kann die für den Nutzer maximal auswählbare Bestellmenge für einen Artikel definiert werden.

Belegnummer

Die Belegnummer ist ein optionaler Wert, welcher zur weiterführenden Verarbeitung auf Seiten von ePay-BL dient

1.2. Vorlagen zur Ermittlung von Bestellinformationen:

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

1.3. Bestellung an den Server übermitteln:

Um eine Bestellung auszulösen und die bestellten Artikel zum Server zu übertragen muss dem Formular eine Senden-Schaltfläche hinzugefügt werden.

2. Workflow für EPayment konfigurieren

Um eine Bezahl-Transaktion in einen Formularprozess einzubauen werden folgende Elemente vom Plugin zur Verfügung gestellt:

• Workflow-Aktion Bestellung übermitteln: Diese erzeugt eine neue Bezahl-Transaktion auf Seiten der AKDB und leitet den Benutzer auf dessen Portalseite weiter.
• Workflow-Ereignis Bezahlung erfolgreich: Verarbeitet ein Ereignis, welches auf der Rückmeldung über eine erfolgreiche Bezahlung auf dem ePay-BL Portal basiert.
• Workflow-Ereignis Bezahlung nicht erfolgreich: Verarbeitet ein Ereignis, welches auf der Rückmeldung über eine noch offene Bezahlung auf dem ePay-BL Portal basiert. Dabei kann dies verschiedene Ursachen haben. Zum einen kann die Bezahlvorgang durch den Nutzer abgebrochen worden sein oder es ist zu einem Fehler im ePay-BL Portal gekommen.

Ein Workflow für einen einfachen Fall kann folgendermaßen konfiguriert sein:

Kurze Ablaufbeschreibung zum dargestellten Workflow: 1. Durch das Absenden des Bestellformulars wird das Ereignis Bestellen aufgerufen und dort das Aktions-Plugin AKDB:Bestellung übermitteln 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 Portal der AKDB weitergeleitet. 2. Nach Abschluss des Bezahlvorgangs im ePay-BL Portal wird der Benutzer wieder zu Xima® Formcycle zurückgeleitet. Dort erfolgt automatisch eine Überprüfung des Bezahlstatus am EPayment-System. Aus dem Ergebnis dieser Überprüfung ergibt sich das vom System ausgelöste Ereignis. Wenn die Überprüfung ergeben hat, dass die Bezahlung erfolgreich war, wird ein Bezahlung erfolgreich-Ereignis durch das System ausgelöst. In allen anderen Fällen ist es ein Bezahlung nicht erfolgreich Ereignis. 3. Ist die Bezahlung erfolgt, wird in den Status Bezahlt gewechselt und dem Nutzer wird eine entsprechende Abschlussseite angezeigt. 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 wird eine entsprechende Abschlussseite angezeigt.

2.1. Konfigurationsmöglichkeiten des Aktions-Plugins Bestellung übermitteln

Dieses Aktions-Plugin ist für das Erzeugen einer Bezahl-Transaktion im ePay-BL 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 etc.), festgelegt.

Die Konfigurationsoberfläche des Aktions-Plugins ist in einzelne Bereiche unterteilt die nachfolgend kurz beschrieben werden.

Konfiguration AKDB ePayment-Mandant

Konfiguration AKDB EPayment-Mandant

In diesem Bereich können die globalen Einstellungen für den zu verwendenden ePay-BL Mandanten übersteuert werden. Die Einstellungen zum ePay-BL Mandanten sind notwendig, um später die Transaktion auf Seiten von ePay-BL der richtigen Behörde (entspricht der festgelegten Mandant-Nummer), dem Bewirtschafter und der Haushaltsstelle zuzuordnen. In den meisten Fällen sind diese Einstellungen bereits durch einen Plugin-Administrator global hinterlegt worden, sodass an dieser Stelle keine Konfiguration notwendig ist.Die einzelnen Parameter können per Platzhalter oder fest definiert hinterlegt werden. Weiterhin kann über den Button Webservice Erreichbarkeit prüfen die generelle Erreichbarkeit des EPayment Webservice geprüft werden.

Mandant-Nummer

AKDB-Mandantennummer des aufrufenden eShops (FORMCYCLE) (Wird durch ePay-BL-System vorgegeben)

Bewirtschafter-Nummer

Bewirtschafternummer (Wird durch ePay-BL-System vorgegeben)

Haushaltsstelle

Nummer der Haushaltsstelle, welcher die Buchung zugeordnet werden soll. (Wird durch ePay-BL-System vorgegeben)

Objektnummer

Dient der internen Verbuchung im EPayment-System. (Wird durch ePay-BL-System vorgegeben)

Kennzeichen-Mahnverfahren

Einstellung für das Kennzeichen in einem Mahnverfahren. (Mögliche Werte werden durch ePay-BL-System vorgegeben)

Fälligkeitszeitraum

Einstellung für die Berechnung des Fälligkeitszeitraumes der Zahlung (Dauer in Tagen).

2.2. Workflow-Ereignis Bezahlung erfolgreich

Eine Workflow-Verarbeitungskette mit diesem Ereignis wird ausgeführt, wenn eine Rückleitung aus dem ePay-BL Portal erfolgt
und die Bezahlung erfolgreich durchgeführt wurde. Pro Formular-Vorgang kann dieses Ereignis genau einmal eintreten.
Das Ereignis stellt dabei folgende Werte bereit, die per Platzhalter in nachfolgenden Aktionen ausgewertet werden können:

[%$TRIGGER.paymentStatus%]

Bezeichnung des Status, wie er vom ePay-BL Portal zurückgeliefert wird. (Möglicher Wert: INAKTIV)

[%$TRIGGER.paymentStatusText%]

Eine Nachricht, die den zurückgelieferten Status näher beschreibt

2.3. Workflow-Ereignis Bezahlung nicht erfolgreich

Eine Workflow-Verarbeitungskette mit diesem Ereignis wird immer dann ausgeführt, wenn eine Rückleitung aus dem ePay-BL Portal erfolgte
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).
Das Ereignis stellt folgende Werte bereit, die per Platzhalter in nachfolgenden Aktionen ausgewertet werden können:

[%$TRIGGER.paymentStatus%]

Bezeichnung des Status, wie er vom ePay-BL Portal zurückgeliefert wird.

Folgende Werte sind möglich:

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

[%$TRIGGER.paymentStatusText%]

Eine Nachricht, die den zurückgelieferten Status näher beschreibt

[%$TRIGGER.paypageUrl%]

URL zur Paypage mit der aktuellen Transaktionsnummer. Damit ist ein nochmaliges Aufrufen und Bezahlen der offenen Transaktion möglich.

3. Ergebnisanzeige

Die Anzeige des Ergebnisses bzw. des Status einer Bezahl-Transaktion erfolgt standardmäßig mittels einer extra Abschluss-Seite.
Dafür stellt das Plugin 3 HTML-Templates bereit: 

• AKDB ePayment Bezahlung Erfolg: Standard-Template für Anzeige bei erfolgreich abgeschlossener Bezahlung.
• 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
• AKDB ePayment Fehler: Standard-Template für Anzeige bei allgemeinen technischen Fehlern