| ... |
... |
@@ -93,14 +93,13 @@ |
| 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 |
| 99 |
99 |
|
| 100 |
100 |
Ein Workflow für einen einfachen Fall kann folgendermaßen konfiguriert sein: |
| 101 |
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" %)((( |
|
99 |
+{{figure image="hilfe_workflow.png"}} |
|
100 |
+Workflow mit EPayment Anbindung |
|
101 |
+{{/figure}} |
|
102 |
+ |
| 104 |
104 |
__Kurze Ablaufbeschreibung zum dargestellten Workflow:__ |
| 105 |
105 |
|
| 106 |
106 |
~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. |
| ... |
... |
@@ -111,8 +111,6 @@ |
| 111 |
111 |
|
| 112 |
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 |
113 |
wird eine entsprechende Abschlussseite angezeigt. |
| 114 |
|
- |
| 115 |
|
-))) |
| 116 |
116 |
|
| 117 |
117 |
{{id name="plugin_epay_init"/}} |
| 118 |
118 |
|
| ... |
... |
@@ -180,26 +180,111 @@ |
| 180 |
180 |
Konfiguration AKDB EPayment-Mandant |
| 181 |
181 |
{{/figure}} |
| 182 |
182 |
|
| 183 |
|
-In diesem Bereich können die zu verwendenden Einstellungen des ePay-BL Mandanten hinterlegt. Diese sind notwendig, um später die Transaktion auf Seiten von ePay-BL |
| 184 |
|
-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, |
| 185 |
|
-sofern diese durch einen Plugin-Administrator korrekt hinterlegt wurden. |
|
180 |
+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 |
|
181 |
+der richtigen Behörde (entspricht der festgelegten Mandant-Nummer), dem Bewirtschafter und der Haushaltsstelle zuzuordnen. |
|
182 |
+In den meisten Fällen sind diese Einstellungen bereits durch einen Plugin-Administrator global hinterlegt worden, sodass an dieser Stelle keine Konfiguration notwendig ist. |
| 186 |
186 |
|
| 187 |
|
-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. |
|
184 |
+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. |
| 188 |
188 |
|
| 189 |
|
-; Mandant-Nummer (Pflichtfeld) |
|
186 |
+; Mandant-Nummer |
| 190 |
190 |
: AKDB-Mandantennummer des aufrufenden eShops (FORMCYCLE) (Wird durch ePay-BL-System vorgegeben) |
| 191 |
|
-; Bewirtschafter-Nummer (Pflichtfeld) |
|
188 |
+; Bewirtschafter-Nummer |
| 192 |
192 |
: Bewirtschafternummer (Wird durch ePay-BL-System vorgegeben) |
| 193 |
|
-; Haushaltsstelle (Pflichtfeld) |
|
190 |
+; Haushaltsstelle |
| 194 |
194 |
: Nummer der Haushaltsstelle, welcher die Buchung zugeordnet werden soll. (Wird durch ePay-BL-System vorgegeben) |
| 195 |
|
-; Objektnummer (Pflichtfeld) |
|
192 |
+; Objektnummer |
| 196 |
196 |
: Dient der internen Verbuchung im EPayment-System. (Wird durch ePay-BL-System vorgegeben) |
| 197 |
|
-; Kennzeichen-Mahnverfahren (Pflichtfeld) |
|
194 |
+; Kennzeichen-Mahnverfahren |
| 198 |
198 |
: Einstellung für das Kennzeichen in einem Mahnverfahren. (Mögliche Werte werden durch ePay-BL-System vorgegeben) |
| 199 |
|
-; Fälligkeitszeitraum (Pflichtfeld) |
|
196 |
+; Fälligkeitszeitraum |
| 200 |
200 |
: Einstellung für die Berechnung des Fälligkeitszeitraumes der Zahlung (Dauer in Tagen). |
| 201 |
|
-; Währung |
| 202 |
|
-: Währung in welcher der Betrag ausgewiesen wird. Ist nichts definiert wird als Wert **EUR** angenommen. |
| 203 |
203 |
|
| 204 |
204 |
{{/panel}} |
| 205 |
205 |
|
|
201 |
+{{id name="plugin_event_epay_success"/}} |
|
202 |
+ |
|
203 |
+=== 2.2. Workflow-Ereignis //Bezahlung erfolgreich// === |
|
204 |
+ |
|
205 |
+Eine Workflow-Verarbeitungskette mit diesem Ereignis wird ausgeführt, wenn eine Rückleitung aus dem ePay-BL Portal erfolgt |
|
206 |
+und die Bezahlung erfolgreich durchgeführt wurde. Pro Formular-Vorgang kann dieses Ereignis genau einmal eintreten. |
|
207 |
+Das Ereignis stellt dabei folgende Werte bereit, die per Platzhalter in nachfolgenden Aktionen ausgewertet werden können: |
|
208 |
+ |
|
209 |
+; **[%$TRIGGER.paymentStatus%]** |
|
210 |
+: Bezeichnung des Status, wie er vom ePay-BL Portal zurückgeliefert wird. (Möglicher Wert: INAKTIV) |
|
211 |
+; **[%$TRIGGER.paymentStatusText%]** |
|
212 |
+: Eine Nachricht, die den zurückgelieferten Status näher beschreibt |
|
213 |
+ |
|
214 |
+{{id name="plugin_event_epay_error"/}} |
|
215 |
+ |
|
216 |
+=== 2.3. Workflow-Ereignis //Bezahlung nicht erfolgreich// === |
|
217 |
+ |
|
218 |
+Eine Workflow-Verarbeitungskette mit diesem Ereignis wird immer dann ausgeführt, wenn eine Rückleitung aus dem ePay-BL Portal erfolgte |
|
219 |
+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). |
|
220 |
+Das Ereignis stellt folgende Werte bereit, die per Platzhalter in nachfolgenden Aktionen ausgewertet werden können: |
|
221 |
+ |
|
222 |
+; **[%$TRIGGER.paymentStatus%]** |
|
223 |
+: Bezeichnung des Status, wie er vom ePay-BL Portal zurückgeliefert wird. |
|
224 |
+: Folgende Werte sind möglich: |
|
225 |
+: **AKTIV**: Die Bezahlung über die PayPage ist noch nicht erfolgt. |
|
226 |
+: **MANDANT_NICHT_GEFUNDEN**: Der Mandant wurde im ePayment-System nicht gefunden. |
|
227 |
+: **MANDANT_INAKTIV**: Der Mandant ist im ePayment-System derzeit als inaktiv gekennzeichnet. |
|
228 |
+: **VERBINDUNG_OHNE_HTTPS**: Die Verbindung zum Webservice erfolgte nicht über HTTPS mit Client-Zertifikaten. |
|
229 |
+: **VERBINDUNG_ZERTIFIKAT_FEHLER**: Das für die Verbindung verwendete Client-Zertifikat darf nicht für den gewählten Mandanten verwendet werden. |
|
230 |
+: **KASSENZEICHEN_NICHT_VORHANDEN**: Das gewählte Kassenzeichen ist nicht vorhanden. |
|
231 |
+: **KASSENZEICHEN_NICHT_GEFUNDEN**: Das gewählte Kassenzeichen konnte nicht gefunden werden. |
|
232 |
+: **INTERNER_EPAYMENT_FEHLER**: Interner nicht dokumentierter Fehler im ePayment-System. |
|
233 |
+: **UNDEFINIERT**: Ein im System nicht bekannter Status |
|
234 |
+; **[%$TRIGGER.paymentStatusText%]** |
|
235 |
+: Eine Nachricht, die den zurückgelieferten Status näher beschreibt |
|
236 |
+; **[%$TRIGGER.paypageUrl%]** |
|
237 |
+: URL zur Paypage mit der aktuellen Transaktionsnummer. Damit ist ein nochmaliges Aufrufen und Bezahlen der offenen Transaktion möglich. |
|
238 |
+ |
|
239 |
+== 3. Ergebnisanzeige == |
|
240 |
+ |
|
241 |
+Die Anzeige des Ergebnisses bzw. des Status einer Bezahl-Transaktion erfolgt standardmäßig mittels einer extra Abschluss-Seite. |
|
242 |
+Dafür stellt das Plugin 3 HTML-Templates bereit: |
|
243 |
+ |
|
244 |
+* **AKDB ePayment Bezahlung Erfolg**: Standard-Template für Anzeige bei erfolgreich abgeschlossener Bezahlung. |
|
245 |
+* **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. |
|
246 |
+* **AKDB ePayment Fehler**: Standard-Template für Anzeige bei allgemeinen technischen Fehlern. Der genaue Fehler wird mittels enthaltener Platzhalter ausgewiesen. |
|
247 |
+ |
|
248 |
+{{info}} |
|
249 |
+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. |
|
250 |
+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. |
|
251 |
+{{/info}} |
|
252 |
+ |
|
253 |
+== Versionshistorie == |
|
254 |
+ |
|
255 |
+=== 3.1.4 === |
|
256 |
+ |
|
257 |
+* Formatierung des Rückgabewertes für den Gesamtbetrag auf #0,00 € |
|
258 |
+ |
|
259 |
+=== 3.1.3 === |
|
260 |
+ |
|
261 |
+* Fehlerbehebung: Es wurden Problem behoben, welche beim Öffnen von EPayment-Formularen im Designe aufgetreten sind. |
|
262 |
+ |
|
263 |
+=== 3.1.2 === |
|
264 |
+ |
|
265 |
+* Neuer Pluginparameter *epayment.webservice.timeout* zum Konfigurieren des Timeouts zum Webservice in Sekunden. |
|
266 |
+ |
|
267 |
+=== 3.1.1 === |
|
268 |
+ |
|
269 |
+* Fehlerbehebung: Bei EPayment-Artikel Objekt werden bei fehlenden Werten, Defaultwerte angenommen. |
|
270 |
+ |
|
271 |
+=== 3.1.0 === |
|
272 |
+ |
|
273 |
+* Neue Eigenschaften am EPayment-Artikel Objekte hinzugefügt: |
|
274 |
+** 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 |
|
275 |
+** Maximale Bestellmenge: Die durch den Nutzer maximal auswählbare Bestellmenge lässt sich begrenzen |
|
276 |
+ |
|
277 |
+=== 3.0.1 === |
|
278 |
+ |
|
279 |
+* Plugin benötigt mindestens {{formcycle/}} in der Version {{version major="7" minor="0" patch="1"}}{{/version}} |
|
280 |
+** Anpassungen der Validierungen im Designer für EPayment-Artikel Objekte |
|
281 |
+ |
|
282 |
+=== 3.0.0 === |
|
283 |
+ |
|
284 |
+* Plugin benötigt mindestens {{formcycle/}} in der Version {{version major="7" minor="0" patch="0"}}{{/version}} |
|
285 |
+** Neue Workflow-Aktion für Initialisierung der Bezahl-Transaktion |
|
286 |
+** Einführung Ereignisse für Absenden der Bestellung, sowie Verifizierung der erfolgreichen / nicht erfolgreichen Bezahltransaktion |
|
287 |
+ |
