| ... |
... |
@@ -84,3 +84,131 @@ |
| 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 |
86 |
|
|
87 |
+{{id name="config_process"/}} |
|
88 |
+ |
|
89 |
+== 2. Workflow für EPayment konfigurieren == |
|
90 |
+ |
|
91 |
+Um eine Bezahl-Transaktion in einen Formularprozess einzubauen werden folgende Elemente vom Plugin zur Verfügung gestellt: |
|
92 |
+ |
|
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 |
+* 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 |
+* 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 |
+ |
|
100 |
+Ein Workflow für einen einfachen Fall kann folgendermaßen konfiguriert sein: |
|
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" %)((( |
|
104 |
+__Kurze Ablaufbeschreibung zum dargestellten Workflow:__ |
|
105 |
+ |
|
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. |
|
107 |
+ |
|
108 |
+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. |
|
109 |
+ |
|
110 |
+3. Ist die Bezahlung erfolgt, wird in den Status //Bezahlt// gewechselt und dem Nutzer wird eine entsprechende Abschlussseite angezeigt. |
|
111 |
+ |
|
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. |
|
114 |
+ |
|
115 |
+))) |
|
116 |
+ |
|
117 |
+{{id name="plugin_epay_init"/}} |
|
118 |
+ |
|
119 |
+=== 2.1. Konfigurationsmöglichkeiten des Aktions-Plugins //Bestellung übermitteln// === |
|
120 |
+ |
|
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. |
|
122 |
+ |
|
123 |
+{{info}} |
|
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. |
|
125 |
+ |
|
126 |
+Es empfiehlt sich deshalb die in diesem Artikel beschriebene [[Konfigurations-Reihenfolge>>doc:||anchor="config_reihenfolge"]] einzuhalten. |
|
127 |
+ |
|
128 |
+Es ist aber auch möglich das Formular im Nachhinein anzupassen und anschließend die Daten innerhalb des Aktions-Plugins zu aktualisieren. |
|
129 |
+{{/info}} |
|
130 |
+ |
|
131 |
+Die Konfigurationsoberfläche des Aktions-Plugins ist in einzelne Bereiche unterteilt die nachfolgend kurz beschrieben werden. |
|
132 |
+ |
|
133 |
+{{panel title="Kundenstammdaten" fullwidth="true" initial="visible" triggerable="true"}} |
|
134 |
+ |
|
135 |
+{{figure image="plugin_init_config_kundenstammdaten.png"}} |
|
136 |
+Konfiguration für die Kundenstammdaten |
|
137 |
+{{/figure}} |
|
138 |
+ |
|
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. |
|
141 |
+ |
|
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}} |
|
145 |
+ |
|
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 |
|
156 |
+ |
|
157 |
+{{/panel}} |
|
158 |
+ |
|
159 |
+{{id name="config_paypage"/}} |
|
160 |
+ |
|
161 |
+{{panel title="Konfiguration für die PayPage" fullwidth="true" initial="visible" triggerable="true"}} |
|
162 |
+ |
|
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) |
|
164 |
+ |
|
165 |
+{{figure image="plugin_init_config_paypage.png"}} |
|
166 |
+Konfiguration für die PayPage |
|
167 |
+{{/figure}} |
|
168 |
+ |
|
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. |
|
172 |
+; Automatische Weiterleitung zur PayPage verhindern |
|
173 |
+: 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. |
|
180 |
+; Fälligkeitsdatum |
|
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. |
|
183 |
+{{/panel}} |
|
184 |
+ |
|
185 |
+{{panel title="Konfiguration AKDB EPayment-Mandant" fullwidth="true" initial="visible" triggerable="true"}} |
|
186 |
+ |
|
187 |
+{{figure image="plugin_init_config_akdb_mandant.png"}} |
|
188 |
+Konfiguration AKDB EPayment-Mandant |
|
189 |
+{{/figure}} |
|
190 |
+ |
|
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. |
|
194 |
+ |
|
195 |
+ |
|
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) |
|
199 |
+: AKDB-Mandantennummer des aufrufenden eShops (FORMCYCLE) (Wird durch ePay-BL-System vorgegeben) |
|
200 |
+; Bewirtschafter-Nummer (Pflichtfeld) |
|
201 |
+: Bewirtschafternummer (Wird durch ePay-BL-System vorgegeben) |
|
202 |
+; Haushaltsstelle (Pflichtfeld) |
|
203 |
+: Nummer der Haushaltsstelle, welcher die Buchung zugeordnet werden soll. (Wird durch ePay-BL-System vorgegeben) |
|
204 |
+; Objektnummer (Pflichtfeld) |
|
205 |
+: Dient der internen Verbuchung im EPayment-System. (Wird durch ePay-BL-System vorgegeben) |
|
206 |
+; Kennzeichen-Mahnverfahren (Pflichtfeld) |
|
207 |
+: Einstellung für das Kennzeichen in einem Mahnverfahren. (Mögliche Werte werden durch ePay-BL-System vorgegeben) |
|
208 |
+; Fälligkeitszeitraum (Pflichtfeld) |
|
209 |
+: 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. |
|
212 |
+ |
|
213 |
+{{/panel}} |
|
214 |
+ |
