Änderungen von Dokument Verwendung


Von Version 6.2
bearbeitet von rth
am 04.10.2021, 10:16
Änderungskommentar: Es gibt keinen Kommentar für diese Version
Auf Version 6.15
bearbeitet von rth
am 04.10.2021, 12:31
Änderungskommentar: Es gibt keinen Kommentar für diese Version

Zusammenfassung

Details

Seiteneigenschaften
Inhalt
... ... @@ -88,16 +88,19 @@
88 88  
89 89  == 2. Workflow für EPayment konfigurieren ==
90 90  
91 -Um eine Bezahl-Transaktion in einen Formularprozess einzubauen werden folgende Workflow Elemente zur Verfügung gestellt:
91 +Um eine Bezahl-Transaktion in einen Formularprozess einzubauen werden folgende Elemente vom Plugin zur Verfügung gestellt:
92 92  
93 93  * Workflow-Aktion **[[Bestellung übermitteln>>doc:||anchor="plugin_epay_init"]]**: Diese erzeugt eine neue Bezahl-Transaktion auf Seiten der AKDB und leitet den Benutzer auf dessen Portalseite weiter.
94 94  * Workflow-Ereignis **[[Bezahlung erfolgreich>>doc:||anchor="plugin_event_epay_success"]]**: Verarbeitet ein Ereignis, welches auf der Rückmeldung über eine erfolgreiche Bezahlung auf dem ePay-BL Portal basiert.
95 95  * Workflow-Ereignis **[[Bezahlung nicht erfolgreich>>doc:||anchor="plugin_event_epay_error"]]**: 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.
96 +* HTML-Template **AKDB ePayment Bezahlung Erfolg**: Standard-Template für Anzeige bei erfolgreich abgeschlossener Bezahlung.
97 +* HTML-Template **AKDB ePayment Bezahlung Fehler**: Standard-Template für Anzeige bei offenen bzw. fehlerhaft beendeten Bezahlvorgang
98 +* HTML-Template **AKDB ePayment Fehler**: Standard-Template für Anzeige bei allgemeinen technischen Fehlern
96 96  
97 97  Ein Workflow für einen einfachen Fall kann folgendermaßen konfiguriert sein:
98 98  
99 99  (% style="background-color:transparent; border:none" %)
100 -|(% style="border-style:none; width:180px" %)[[image:hilfe_workflow.png||alt="Workflow mit EPayment Anbindung"]]|(% style="border-style:none; width:700px" %)(((
103 +|(% style="border-style:none; width:180px" %)[[image:hilfe_workflow.png||alt="Workflow mit EPayment Anbindung"]]|(% style="border-style:none; width:800px" %)(((
101 101  __Kurze Ablaufbeschreibung zum dargestellten Workflow:__
102 102  
103 103  ~1. Durch das Absenden des Bestellformulars wird das Ereignis //Bestellen// aufgerufen und dort das Aktions-Plugin **[[AKDB:Bestellung übermitteln>>doc:||anchor="plugin_epay_init"]]** 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>>https://www.epaybl.de/||rel="noopener noreferrer" target="_blank" title="E-Payment Bund und Länder"]] Portal der AKDB weitergeleitet.
... ... @@ -104,21 +104,21 @@
104 104  
105 105  2. Nach Abschluss des Bezahlvorgangs im ePay-BL Portal wird der Benutzer wieder zu {{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>>doc:||anchor="plugin_event_epay_success"]]**-Ereignis durch das System ausgelöst. In allen anderen Fällen ist es ein **[[Bezahlung nicht erfolgreich>>doc:||anchor="plugin_event_epay_error"]]** Ereignis.
106 106  
107 -3. Im Falle das die Bezahlung erfolgt ist, wird im Beispiel in den Status //Bezahlt// gewechselt und dem Nutzer wird eine entsprechende Abschlussseite angezeigt.
110 +3. Ist die Bezahlung erfolgt, wird in den Status //Bezahlt// gewechselt und dem Nutzer wird eine entsprechende Abschlussseite angezeigt.
108 108  
109 -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 Fall eien E-Mail erzeugt, in der der Benutzer auf die noch ausstehende Zahlung hingewiesen wird. Der Workflow wird in diesem Beispiel mit einem Wechsel in den Status //Nicht bezahlt//
110 -abgeschlossen. Dem Nutzer wird eine entsprechende Abschlussseite angezeigt.
112 +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
113 +wird eine entsprechende Abschlussseite angezeigt.
111 111  
112 112  )))
113 113  
114 114  {{id name="plugin_epay_init"/}}
115 115  
116 -=== 2.1. Konfigurationsmöglichkeiten des Aktions-Plugins //AKDB:EPayment initialisieren// ===
119 +=== 2.1. Konfigurationsmöglichkeiten des Aktions-Plugins //Bestellung übermitteln// ===
117 117  
118 -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.
121 +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 etc.), festgelegt.
119 119  
120 120  {{info}}
121 -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.
124 +Wenn vor der Konfiguration des Plugins bereits mindestens ein **[[EPayment-Artikel>>doc:||anchor="epay_artikel"]]**, sowie die **[[Vorlage>>doc:||anchor="epay_vorlage"]]** für die **persönlichen Daten** im Formular hinterlegt wurden, werden bei einer Neueinrichtung der //Bestellung übermitteln// Plugin-Aktion die notwendigen Pflicht-Konfigurationen bereits mit den ermittelten Daten aus dem Formular vorbelegt.
122 122  
123 123  Es empfiehlt sich deshalb die in diesem Artikel beschriebene [[Konfigurations-Reihenfolge>>doc:||anchor="config_reihenfolge"]] einzuhalten.
124 124  
... ... @@ -127,34 +127,30 @@
127 127  
128 128  Die Konfigurationsoberfläche des Aktions-Plugins ist in einzelne Bereiche unterteilt die nachfolgend kurz beschrieben werden.
129 129  
130 -{{panel title="Konfiguration AKDB EPayment-Mandant" fullwidth="true" initial="visible" triggerable="true"}}
133 +{{panel title="Kundenstammdaten" fullwidth="true" initial="visible" triggerable="true"}}
131 131  
132 -{{figure image="plugin_init_config_akdb_mandant.png"}}
133 -Konfiguration AKDB EPayment-Mandant
135 +{{figure image="plugin_init_config_kundenstammdaten.png"}}
136 +Konfiguration für die Kundenstammdaten
134 134  {{/figure}}
135 135  
136 -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
137 -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,
138 -sofern diese durch einen Plugin-Administrator korrekt hinterlegt wurden.
139 +In diesem Bereich werden die Daten des Benutzers hinterlegt, für den die Bezahl-Transaktion erzeugt werden soll.
140 +Die einzelnen Parameter können per Platzhalter oder fest definiert hinterlegt werden.
139 139  
142 +{{info}}
143 +Über den [[image:icon_update.png]]-Button können diese Felder durch Nutzung der EPayment-Vorlage //Persönliche Daten// vorbelegt werden.
144 +{{/info}}
140 140  
141 -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.
146 +; Anrede
147 +; Titel
148 +; Vorname
149 +; Nachname (Pflichtfeld)
150 +; Geburtsdatum
151 +: Geburtsdatum muss in der Form **dd.MM.yyyy** übermittelt werden.
152 +; E-Mail
153 +: Wird für die Zustellung von Emails an den Kunden in Abhängigkeit von der ePay-BL-Mandantkonfiguration benötigt.
154 +; Telefon
155 +; Mobiltelefon
142 142  
143 -; Mandant-Nummer (Pflichtfeld)
144 -: AKDB-Mandantennummer des aufrufenden eShops (FORMCYCLE) (Wird durch ePay-BL-System vorgegeben)
145 -; Bewirtschafter-Nummer (Pflichtfeld)
146 -: Bewirtschafternummer (Wird durch ePay-BL-System vorgegeben)
147 -; Haushaltsstelle (Pflichtfeld)
148 -: Nummer der Haushaltsstelle, welcher die Buchung zugeordnet werden soll. (Wird durch ePay-BL-System vorgegeben)
149 -; Objektnummer (Pflichtfeld)
150 -: Dient der internen Verbuchung im EPayment-System. (Wird durch ePay-BL-System vorgegeben)
151 -; Kennzeichen-Mahnverfahren (Pflichtfeld)
152 -: Einstellung für das Kennzeichen in einem Mahnverfahren. (Mögliche Werte werden durch ePay-BL-System vorgegeben)
153 -; Fälligkeitszeitraum (Pflichtfeld)
154 -: Einstellung für die Berechnung des Fälligkeitszeitraumes der Zahlung (Dauer in Tagen).
155 -; Währung
156 -: Währung in welcher der Betrag ausgewiesen wird. Ist nichts definiert wird als Wert **EUR** angenommen.
157 -
158 158  {{/panel}}
159 159  
160 160  {{id name="config_paypage"/}}
... ... @@ -161,51 +161,44 @@
161 161  
162 162  {{panel title="Konfiguration für die PayPage" fullwidth="true" initial="visible" triggerable="true"}}
163 163  
164 -Bei der "PayPage" handelt es sich dabei um eine bereits ausgefüllte Bezahlseite zur Online-Bezahlung der vom Gläubiger, r die jeweils erbrachten Leistungen, veranschlagten Gehren, Entgelte etc.
163 +Bei der "PayPage" handelt es sich um eine bereits vorbefüllte Bezahlseite zur Online-Bezahlung. Der Nutzer hat hier noch die Auswahl, mit welchem Bezahl-Dienstleister er bezahlen möchte (Paypal, SEPA-Lastschrift, giropay etc.). Die Art und Anzahl der dem Nutzer zur Auswahl stehenden Bezahl-Dienstleister hängt dabei davon ab, was im Vorfeld vertraglich mit der AKDB verbart wurde.
165 165  
166 166  {{figure image="plugin_init_config_paypage.png"}}
167 167  Konfiguration für die PayPage
168 168  {{/figure}}
169 169  
170 -
171 -; URL zur PayPage (Pflichtfeld)
172 -: 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.
173 173  ; Automatische Weiterleitung zur PayPage verhindern
174 174  : Bei aktivierter Einstellung kann eine automatische Weiterleitung zur PayPage unterbunden werden.
175 -; Status, in welchen nach erfolgreicher Transaktion gewechselt wird (Pflichtfeld)
176 -: Hier muss ein Status festgelegt werden, in welchen gewechselt wird, wenn der Bezahlvorgang auf Seiten des ePay-BL-Systems erfolgreich durchlaufen wurde.
177 -; Status, in welchen nach fehlerhafter oder abgebrochener Transaktion gewechselt wird (Pflichtfeld)
178 -: Hier muss ein Status festgelegt werden, in welchen gewechselt wird, wenn der Bezahlvorgang auf Seiten des ePay-BL-Systems abgebrochen wurde.
179 -; PayPage Buchungstext
180 -: Dieser Buchungstext wird dem Benutzer auf der PayPage angezeigt.
181 181  ; Fälligkeitsdatum
182 -: 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
183 -die Einstellung für den **Fälligkeitszeitraum** wird nicht beachtet.
172 +: 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 globale Einstellung für den **Fälligkeitszeitraum** wird nicht beachtet.
173 +; Buchungstext auf PayPage
174 +: Der hier festgelegte Buchungstext wird dem Benutzer auf der PayPage angezeigt.
184 184  {{/panel}}
185 185  
186 -{{panel title="Kundenstammdaten" fullwidth="true" initial="visible" triggerable="true"}}
177 +{{panel title="Konfiguration AKDB ePayment-Mandant" fullwidth="true" initial="visible" triggerable="true"}}
187 187  
188 -{{figure image="plugin_init_config_kundenstammdaten.png"}}
189 -Konfiguration für die Kundenstammdaten
179 +{{figure image="plugin_init_config_akdb_mandant.png"}}
180 +Konfiguration AKDB EPayment-Mandant
190 190  {{/figure}}
191 191  
192 -In diesem Bereich werden die Daten des Benutzers hinterlegt, für den die Bezahl-Transaktion erzeugt werden soll.
193 -Die einzelnen Parameter können per Platzhalter oder fest definiert hinterlegt werden.
183 +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
184 +der richtigen Behörde (entspricht der festgelegten Mandant-Nummer), dem Bewirtschafter und der Haushaltsstelle zuzuordnen.
185 +In den meisten Fällen sind diese Einstellungen bereits durch einen Plugin-Administrator global hinterlegt worden, sodass an dieser Stelle keine Konfiguration notwendig ist.
194 194  
195 -{{info}}
196 -Ü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.
197 -{{/info}}
187 +Die einzelnen Parameter können per Platzhalter oder fest definiert hinterlegt werden. Weiterhin kann über den Button [[image:icon_update.png]] //Webservice Erreichbarkeit prüfen// die generelle Erreichbarkeit des EPayment Webservice geprüft werden.
198 198  
199 -; Anrede
200 -; Titel
201 -; Vorname
202 -; Nachname (Pflichtfeld)
203 -; Geburtsdatum
204 -: Geburtsdatum muss in der Form **dd.MM.yyyy** übermittelt werden.
205 -; E-Mail
206 -: Wird für die Zustellung von Emails an den Kunden in Abhängigkeit von der ePay-BL-Mandantkonfiguration benötigt.
207 -; Telefon (privat)
208 -; Telefon (dienstlich)
209 -; Mobiltelefon
189 +; Mandant-Nummer
190 +: AKDB-Mandantennummer des aufrufenden eShops (FORMCYCLE) (Wird durch ePay-BL-System vorgegeben)
191 +; Bewirtschafter-Nummer
192 +: Bewirtschafternummer (Wird durch ePay-BL-System vorgegeben)
193 +; Haushaltsstelle
194 +: Nummer der Haushaltsstelle, welcher die Buchung zugeordnet werden soll. (Wird durch ePay-BL-System vorgegeben)
195 +; Objektnummer
196 +: Dient der internen Verbuchung im EPayment-System. (Wird durch ePay-BL-System vorgegeben)
197 +; Kennzeichen-Mahnverfahren
198 +: Einstellung für das Kennzeichen in einem Mahnverfahren. (Mögliche Werte werden durch ePay-BL-System vorgegeben)
199 +; Fälligkeitszeitraum
200 +: Einstellung für die Berechnung des Fälligkeitszeitraumes der Zahlung (Dauer in Tagen).
210 210  
211 211  {{/panel}}
203 +