| ... |
... |
@@ -83,7 +83,8 @@ |
| 83 |
83 |
=== 1.3. Bestellung an den Server übermitteln: === |
| 84 |
84 |
|
| 85 |
85 |
Um eine Bestellung auszulösen und die bestellten Artikel zum Server zu übertragen muss dem Formular eine //Senden//-Schaltfläche hinzugefügt werden. |
| 86 |
|
-\\{{id name="config_process"/}} |
|
86 |
+ |
|
87 |
+{{id name="config_process"/}} |
| 87 |
87 |
|
| 88 |
88 |
== 2. Workflow für EPayment konfigurieren == |
| 89 |
89 |
|
| ... |
... |
@@ -92,13 +92,14 @@ |
| 92 |
92 |
* 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. |
| 93 |
93 |
* 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. |
| 94 |
94 |
* 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 |
| 95 |
95 |
|
| 96 |
96 |
Ein Workflow für einen einfachen Fall kann folgendermaßen konfiguriert sein: |
| 97 |
97 |
|
| 98 |
|
-{{figure image="hilfe_workflow.png"}} |
| 99 |
|
-Workflow mit EPayment Anbindung |
| 100 |
|
-{{/figure}} |
| 101 |
|
- |
|
102 |
+(% style="background-color:transparent; border:none" %) |
|
103 |
+|(% style="border-style:none; width:180px" %)[[image:hilfe_workflow.png||alt="Workflow mit EPayment Anbindung"]]|(% style="border-style:none; width:800px" %)((( |
| 102 |
102 |
__Kurze Ablaufbeschreibung zum dargestellten Workflow:__ |
| 103 |
103 |
|
| 104 |
104 |
~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. |
| ... |
... |
@@ -109,6 +109,8 @@ |
| 109 |
109 |
|
| 110 |
110 |
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 |
| 111 |
111 |
wird eine entsprechende Abschlussseite angezeigt. |
|
114 |
+ |
|
115 |
+))) |
| 112 |
112 |
|
| 113 |
113 |
{{id name="plugin_epay_init"/}} |
| 114 |
114 |
|
| ... |
... |
@@ -156,136 +156,55 @@ |
| 156 |
156 |
|
| 157 |
157 |
{{panel title="Konfiguration für die PayPage" fullwidth="true" initial="visible" triggerable="true"}} |
| 158 |
158 |
|
| 159 |
|
-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. |
|
163 |
+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. |
| 160 |
160 |
|
| 161 |
161 |
{{figure image="plugin_init_config_paypage.png"}} |
| 162 |
162 |
Konfiguration für die PayPage |
| 163 |
163 |
{{/figure}} |
| 164 |
164 |
|
|
169 |
+ |
|
170 |
+; URL zur PayPage (Pflichtfeld) |
|
171 |
+: 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. |
| 165 |
165 |
; Automatische Weiterleitung zur PayPage verhindern |
| 166 |
166 |
: Bei aktivierter Einstellung kann eine automatische Weiterleitung zur PayPage unterbunden werden. |
|
174 |
+; Status, in welchen nach erfolgreicher Transaktion gewechselt wird (Pflichtfeld) |
|
175 |
+: Hier muss ein Status festgelegt werden, in welchen gewechselt wird, wenn der Bezahlvorgang auf Seiten des ePay-BL-Systems erfolgreich durchlaufen wurde. |
|
176 |
+; Status, in welchen nach fehlerhafter oder abgebrochener Transaktion gewechselt wird (Pflichtfeld) |
|
177 |
+: Hier muss ein Status festgelegt werden, in welchen gewechselt wird, wenn der Bezahlvorgang auf Seiten des ePay-BL-Systems abgebrochen wurde. |
|
178 |
+; PayPage Buchungstext |
|
179 |
+: Dieser Buchungstext wird dem Benutzer auf der PayPage angezeigt. |
| 167 |
167 |
; Fälligkeitsdatum |
| 168 |
|
-: 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. |
| 169 |
|
-; Buchungstext auf PayPage |
| 170 |
|
-: Der hier festgelegte Buchungstext wird dem Benutzer auf der PayPage angezeigt. |
|
181 |
+: 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 |
|
182 |
+die Einstellung für den **Fälligkeitszeitraum** wird nicht beachtet. |
| 171 |
171 |
{{/panel}} |
| 172 |
172 |
|
| 173 |
|
-{{panel title="Konfiguration AKDB ePayment-Mandant" fullwidth="true" initial="visible" triggerable="true"}} |
|
185 |
+{{panel title="Konfiguration AKDB EPayment-Mandant" fullwidth="true" initial="visible" triggerable="true"}} |
| 174 |
174 |
|
| 175 |
175 |
{{figure image="plugin_init_config_akdb_mandant.png"}} |
| 176 |
176 |
Konfiguration AKDB EPayment-Mandant |
| 177 |
177 |
{{/figure}} |
| 178 |
178 |
|
| 179 |
|
-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 |
| 180 |
|
-der richtigen Behörde (entspricht der festgelegten Mandant-Nummer), dem Bewirtschafter und der Haushaltsstelle zuzuordnen. |
| 181 |
|
-In den meisten Fällen sind diese Einstellungen bereits durch einen Plugin-Administrator global hinterlegt worden, sodass an dieser Stelle keine Konfiguration notwendig ist. |
|
191 |
+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 |
|
192 |
+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, |
|
193 |
+sofern diese durch einen Plugin-Administrator korrekt hinterlegt wurden. |
| 182 |
182 |
|
| 183 |
|
-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. |
| 184 |
184 |
|
| 185 |
|
-; Mandant-Nummer |
|
196 |
+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. |
|
197 |
+ |
|
198 |
+; Mandant-Nummer (Pflichtfeld) |
| 186 |
186 |
: AKDB-Mandantennummer des aufrufenden eShops (FORMCYCLE) (Wird durch ePay-BL-System vorgegeben) |
| 187 |
|
-; Bewirtschafter-Nummer |
|
200 |
+; Bewirtschafter-Nummer (Pflichtfeld) |
| 188 |
188 |
: Bewirtschafternummer (Wird durch ePay-BL-System vorgegeben) |
| 189 |
|
-; Haushaltsstelle |
|
202 |
+; Haushaltsstelle (Pflichtfeld) |
| 190 |
190 |
: Nummer der Haushaltsstelle, welcher die Buchung zugeordnet werden soll. (Wird durch ePay-BL-System vorgegeben) |
| 191 |
|
-; Objektnummer |
|
204 |
+; Objektnummer (Pflichtfeld) |
| 192 |
192 |
: Dient der internen Verbuchung im EPayment-System. (Wird durch ePay-BL-System vorgegeben) |
| 193 |
|
-; Kennzeichen-Mahnverfahren |
|
206 |
+; Kennzeichen-Mahnverfahren (Pflichtfeld) |
| 194 |
194 |
: Einstellung für das Kennzeichen in einem Mahnverfahren. (Mögliche Werte werden durch ePay-BL-System vorgegeben) |
| 195 |
|
-; Fälligkeitszeitraum |
|
208 |
+; Fälligkeitszeitraum (Pflichtfeld) |
| 196 |
196 |
: Einstellung für die Berechnung des Fälligkeitszeitraumes der Zahlung (Dauer in Tagen). |
|
210 |
+; Währung |
|
211 |
+: Währung in welcher der Betrag ausgewiesen wird. Ist nichts definiert wird als Wert **EUR** angenommen. |
| 197 |
197 |
|
| 198 |
198 |
{{/panel}} |
| 199 |
199 |
|
| 200 |
|
-{{id name="plugin_event_epay_success"/}} |
| 201 |
|
- |
| 202 |
|
-=== 2.2. Workflow-Ereignis //Bezahlung erfolgreich// === |
| 203 |
|
- |
| 204 |
|
-Eine Workflow-Verarbeitungskette mit diesem Ereignis wird ausgeführt, wenn eine Rückleitung aus dem ePay-BL Portal erfolgt |
| 205 |
|
-und die Bezahlung erfolgreich durchgeführt wurde. Pro Formular-Vorgang kann dieses Ereignis genau einmal eintreten. |
| 206 |
|
-Das Ereignis stellt dabei folgende Werte bereit, die per Platzhalter in nachfolgenden Aktionen ausgewertet werden können: |
| 207 |
|
- |
| 208 |
|
-; **[%$TRIGGER.paymentStatus%]** |
| 209 |
|
-: Bezeichnung des Status, wie er vom ePay-BL Portal zurückgeliefert wird. (Möglicher Wert: INAKTIV) |
| 210 |
|
-; **[%$TRIGGER.paymentStatusText%]** |
| 211 |
|
-: Eine Nachricht, die den zurückgelieferten Status näher beschreibt |
| 212 |
|
- |
| 213 |
|
-{{id name="plugin_event_epay_error"/}} |
| 214 |
|
- |
| 215 |
|
-=== 2.3. Workflow-Ereignis //Bezahlung nicht erfolgreich// === |
| 216 |
|
- |
| 217 |
|
-Eine Workflow-Verarbeitungskette mit diesem Ereignis wird immer dann ausgeführt, wenn eine Rückleitung aus dem ePay-BL Portal erfolgte |
| 218 |
|
-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). |
| 219 |
|
-Das Ereignis stellt folgende Werte bereit, die per Platzhalter in nachfolgenden Aktionen ausgewertet werden können: |
| 220 |
|
- |
| 221 |
|
-; **[%$TRIGGER.paymentStatus%]** |
| 222 |
|
-: Bezeichnung des Status, wie er vom ePay-BL Portal zurückgeliefert wird. |
| 223 |
|
-: Folgende Werte sind möglich: |
| 224 |
|
-: **AKTIV**: Die Bezahlung über die PayPage ist noch nicht erfolgt. |
| 225 |
|
-: **MANDANT_NICHT_GEFUNDEN**: Der Mandant wurde im ePayment-System nicht gefunden. |
| 226 |
|
-: **MANDANT_INAKTIV**: Der Mandant ist im ePayment-System derzeit als inaktiv gekennzeichnet. |
| 227 |
|
-: **VERBINDUNG_OHNE_HTTPS**: Die Verbindung zum Webservice erfolgte nicht über HTTPS mit Client-Zertifikaten. |
| 228 |
|
-: **VERBINDUNG_ZERTIFIKAT_FEHLER**: Das für die Verbindung verwendete Client-Zertifikat darf nicht für den gewählten Mandanten verwendet werden. |
| 229 |
|
-: **KASSENZEICHEN_NICHT_VORHANDEN**: Das gewählte Kassenzeichen ist nicht vorhanden. |
| 230 |
|
-: **KASSENZEICHEN_NICHT_GEFUNDEN**: Das gewählte Kassenzeichen konnte nicht gefunden werden. |
| 231 |
|
-: **INTERNER_EPAYMENT_FEHLER**: Interner nicht dokumentierter Fehler im ePayment-System. |
| 232 |
|
-: **UNDEFINIERT**: Ein im System nicht bekannter Status |
| 233 |
|
-; **[%$TRIGGER.paymentStatusText%]** |
| 234 |
|
-: Eine Nachricht, die den zurückgelieferten Status näher beschreibt |
| 235 |
|
-; **[%$TRIGGER.paypageUrl%]** |
| 236 |
|
-: URL zur Paypage mit der aktuellen Transaktionsnummer. Damit ist ein nochmaliges Aufrufen und Bezahlen der offenen Transaktion möglich. |
| 237 |
|
- |
| 238 |
|
-== 3. Ergebnisanzeige == |
| 239 |
|
- |
| 240 |
|
-Die Anzeige des Ergebnisses bzw. des Status einer Bezahl-Transaktion erfolgt standardmäßig mittels einer extra Abschluss-Seite. |
| 241 |
|
-Dafür stellt das Plugin 3 HTML-Templates bereit: |
| 242 |
|
- |
| 243 |
|
-* **AKDB ePayment Bezahlung Erfolg**: Standard-Template für Anzeige bei erfolgreich abgeschlossener Bezahlung. |
| 244 |
|
-* **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 und einen Link zum Wiederaufruf des noch ausstehenden Bezahlvorgangs. |
| 245 |
|
-* **AKDB ePayment Fehler**: Standard-Template für Anzeige bei allgemeinen technischen Fehlern. Der genaue Fehler wird mittels enthaltener Platzhalter ausgewiesen. |
| 246 |
|
- |
| 247 |
|
-{{info}} |
| 248 |
|
-Die durch das Plugin bereitgestellten HTML-Templates können bearbeitet werden. Änderungen haben dabei auf alle Formulare mit Bezahl-Workflow Auswirkungen, wenn Sie diese Standard-Templates nutzen. |
| 249 |
|
-Möchte man in einem einzelnen Bezahl-Workflow ein eigenes Abschluss-Seiten Template verwenden, so kann man dies über eine Aktion //HTML-Abschlussseite// in der jeweiligen Verarbeitungskette realisieren. |
| 250 |
|
-{{/info}} |
| 251 |
|
- |
| 252 |
|
-== Versionshistorie == |
| 253 |
|
- |
| 254 |
|
-(% class="wikigeneratedid" %) |
| 255 |
|
-=== 3.2.0 === |
| 256 |
|
- |
| 257 |
|
-* Erweiterung EPayment Bestellartikel: Am Element ist der Gesamtpreis (Anzahl * Einzelpreis) als verstecktes Element verfügbar. Dieser kann über die CSS-Klasse 'CXOrderItemTotalPrice' eingeblendet werden. |
| 258 |
|
-* Erweiterung Anzahl-Eingabe-Element am EPayment Bestellartikel: Bei einer direkten Werteingabe wird diese sofort gegen die definierte untere und obere Wertgrenze validiert. |
| 259 |
|
- |
| 260 |
|
-=== 3.1.4 === |
| 261 |
|
- |
| 262 |
|
-* Formatierung des Rückgabewertes für den Gesamtbetrag auf #0,00 € |
| 263 |
|
- |
| 264 |
|
-=== 3.1.3 === |
| 265 |
|
- |
| 266 |
|
-* Fehlerbehebung: Es wurden Problem behoben, welche beim Öffnen von EPayment-Formularen im Designe aufgetreten sind. |
| 267 |
|
- |
| 268 |
|
-=== 3.1.2 === |
| 269 |
|
- |
| 270 |
|
-* Neuer Pluginparameter *epayment.webservice.timeout* zum Konfigurieren des Timeouts zum Webservice in Sekunden. |
| 271 |
|
- |
| 272 |
|
-=== 3.1.1 === |
| 273 |
|
- |
| 274 |
|
-* Fehlerbehebung: Bei EPayment-Artikel Objekt werden bei fehlenden Werten, Defaultwerte angenommen. |
| 275 |
|
- |
| 276 |
|
-=== 3.1.0 === |
| 277 |
|
- |
| 278 |
|
-* Neue Eigenschaften am EPayment-Artikel Objekte hinzugefügt: |
| 279 |
|
-** Pflicht-Artikel: Ein Artikel kann als Pflicht definiert werden und wird dadurch automatisch der Bestellung hinzugefügt, egal ob dieser durch Manipulation vor dem Absenden aus der Bestellung entfernt wurde |
| 280 |
|
-** Maximale Bestellmenge: Die durch den Nutzer maximal auswählbare Bestellmenge lässt sich begrenzen |
| 281 |
|
- |
| 282 |
|
-=== 3.0.1 === |
| 283 |
|
- |
| 284 |
|
-* Plugin benötigt mindestens {{formcycle/}} in der Version {{version major="7" minor="0" patch="1"}}{{/version}} |
| 285 |
|
-** Anpassungen der Validierungen im Designer für EPayment-Artikel Objekte |
| 286 |
|
- |
| 287 |
|
-=== 3.0.0 === |
| 288 |
|
- |
| 289 |
|
-* Plugin benötigt mindestens {{formcycle/}} in der Version {{version major="7" minor="0" patch="0"}}{{/version}} |
| 290 |
|
-** Neue Workflow-Aktion für Initialisierung der Bezahl-Transaktion |
| 291 |
|
-** Einführung Ereignisse für Absenden der Bestellung, sowie Verifizierung der erfolgreichen / nicht erfolgreichen Bezahltransaktion |
