Wiki source code of ePayBL Setup
Hide last authors
| author | version | line-number | content |
|---|---|---|---|
| |
2.1 | 1 | [[**Plugin download**>>url:https://customer.formcycle.eu/index.php/apps/files/?dir=/FORMCYCLE%20-%20Plugins%20Customer/ePayBL%3A%20Epayment%20Plugin%20(plugin-bundle-epaybl)&fileid=50473||rel="noopener noreferrer" target="_blank"]] (Anmeldung erforderlich) |
| 2 | |||
| 3 | {{content/}} | ||
| 4 | |||
| 5 | == Vertragliche Voraussetzungen == | ||
| 6 | |||
| 7 | Damit das ePayment in FORMCYCLE eingerichtet werden kann, muss zuvor ein Vertrag mit dem ePayBL Anbieter geschlossen werden. | ||
| 8 | |||
| |
7.1 | 9 | Ist bereits ein Vertrag über das ePayment mit dem ePayBL Anbieter vorhanden, so kann dieser herangezogen werden und mit dem Schritt der Installation als Systemadministrator fortgesetzt werden. |
| |
2.1 | 10 | |
| 11 | |||
| |
7.1 | 12 | === Voraussetzungen === |
| |
2.1 | 13 | |
| 14 | * Die notwendigen Daten des ePayBL-EPayment Mandanten liegen vor. | ||
| 15 | * Ein Zertifikat für den Zugriff auf den ePayment-Webservice ist vorhanden. | ||
| 16 | ** Sollte bereits das Live-System vom **AKDB Bürgerkonto-Service / Postkorb** angebunden sein, so kann dieses Zertifikat für den Zugriff verwendet werden. | ||
| 17 | * Das Plugin-Bundle //**plugin-bundle-epaybl.jar**// ist vorhanden und kompatibel mit der installierten FORMCYCLE-Version. | ||
| 18 | |||
| 19 | |||
| |
7.1 | 20 | == Migration einer bestehenden Installation == |
| |
2.1 | 21 | |
| |
7.1 | 22 | {{info}} |
| 23 | Bei einem Update von einem bestehenden [[**AKDB: EPayment-Plugin** >>url:https://help.formcycle.de/xwiki/bin/view/Formcycle/PluginDocumentation/AkdbEPaymentPlugin/]] muss vorher dieses in allen Mandanten deaktiviert werden. Ansonsten kann das Setup im Mandanten nicht abgeschlossen werden, da der Menüpunkt nicht sichtbar ist. | ||
| 24 | {{/info}} | ||
| |
2.1 | 25 | |
| |
7.1 | 26 | |
| 27 | == Installation als Systemadministrator == | ||
| 28 | |||
| 29 | {{figure image="epaybl-system.png"}} | ||
| 30 | Der **sadmin** gibt hier URL des Providers, Zertifikat sowie Passwort und Proxy vor. | ||
| 31 | {{/figure}} | ||
| 32 | |||
| 33 | Das Plugin wird als System-Plugin installiert. | ||
| 34 | |||
| 35 | |||
| 36 | === Obligatorische Installationsschritte === | ||
| 37 | |||
| |
2.1 | 38 | * Anmeldung als **sadmin **am FORMCYCLE-System. |
| 39 | * Registrierung des **//plugin-bundle-epaybl.jar//** Plugins im Bereich der System-Plugins. | ||
| 40 | |||
| 41 | |||
| |
8.1 | 42 | === Fakultative Installationsschritte === |
| 43 | |||
| |
2.1 | 44 | * Jetzt ist ein neuer Menüpunkt **ePayBL Setup** vorhanden, welcher aufgerufen werden kann. |
| 45 | {{info}}Hinweis: Sollte der Menüpunkt nicht sofort ersichtlich sein, ist ein Abmelden und anschließendes Anmelden als sadmin notwendig.{{/info}} | ||
| 46 | * Hier kann der Xima® Formcycle-Administrator Default-Werte hinterlegen, welche den Mandanten als Platzhalter angezeigt werden und jenes Feld nicht ausfüllen müssen. | ||
| 47 | * Für genauere Informationen zu den einzelnen Eingabefeldern siehe //ePayBL Setup - Mandant//. | ||
| 48 | |||
| 49 | |||
| |
8.1 | 50 | == ePayBL Setup - Mandant == |
| 51 | |||
| |
2.1 | 52 | {{figure image="epaybl-client.png"}} |
| 53 | Der Mandant muss hier alle weiteren Felder ausfüllen, um das Setup zu speichern. | ||
| 54 | {{/figure}} | ||
| 55 | |||
| |
8.1 | 56 | === Obligatorische Installationsschritte === |
| |
2.1 | 57 | |
| 58 | * Anmeldung in den FORMCYCLE-Mandanten, welcher eine Anbindung erhalten soll. | ||
| 59 | * Jetzt ist ein neuer Menüpunkt **ePayBL Setup** vorhanden, welcher aufgerufen werden muss. | ||
| 60 | * Nun müssen alle Werte hinterlegt werden, außer es existieren bereits Default-Werte: | ||
| 61 | |||
| 62 | ; URL des Providers | ||
| 63 | : Die URL der anzubindenen Umgebung. Default-Wert wird als Platzhalter angezeigt. Änderungen des Default-Wertes durch den Xima® Formcycle-Administrator werden im Platzhalter sichtbar. | ||
| 64 | ; Mandant-Nummer | ||
| 65 | : Die Mandant-Nummer ist den ePayBL Vertragsdaten zu entnehmen. Default-Wert wird als Platzhalter angezeigt. Änderungen des Default-Wertes durch den Xima® Formcycle-Administrator werden im Platzhalter sichtbar. | ||
| 66 | ; Bewirtschafter-Nummer | ||
| 67 | : Die Bewirtschafter-Nummer ist den ePayBL Vertragsdaten zu entnehmen. Default-Wert wird als Platzhalter angezeigt. Änderungen des Default-Wertes durch den Xima® Formcycle-Administrator werden im Platzhalter sichtbar. | ||
| 68 | ; Haushaltsstelle | ||
| 69 | : Die Haushaltsstelle ist den ePayBL Vertragsdaten zu entnehmen. Default-Wert wird als Platzhalter angezeigt. Änderungen des Default-Wertes durch den Xima® Formcycle-Administrator werden im Platzhalter sichtbar. | ||
| 70 | ; Objekt-Nummer | ||
| 71 | : Die Objekt-Nummer ist den ePayBL Vertragsdaten zu entnehmen. Default-Wert wird als Platzhalter angezeigt. Änderungen des Default-Wertes durch den Xima® Formcycle-Administrator werden im Platzhalter sichtbar. | ||
| 72 | ; Kennzeichen-Mahnverfahren | ||
| 73 | : Das Kennzeichen-Mahnverfahren ist den ePayBL Vertragsdaten zu entnehmen. Default-Wert wird als Platzhalter angezeigt. Änderungen des Default-Wertes durch den Xima® Formcycle-Administrator werden im Platzhalter sichtbar. | ||
| 74 | ; Fälligkeitszeitraum (in Tagen) | ||
| 75 | : Der Fälligkeitszeitraum ist frei wählbar. Default-Wert wird als Platzhalter angezeigt. Änderungen des Default-Wertes durch den Xima® Formcycle-Administrator werden im Platzhalter sichtbar. | ||
| 76 | ; Buchungstext auf der PayPage | ||
| 77 | : Der Buchungstext ist frei wählbar. Default-Wert wird als Platzhalter angezeigt. Änderungen des Default-Wertes durch den Xima® Formcycle-Administrator werden im Platzhalter sichtbar. | ||
| 78 | ; Unterstütze Zahlverfahren | ||
| 79 | : Eingrenzung der Zahlverfahren nötig. Default-Auswahl wird initial übernommen. Änderungen der Default-Auswahl durch den Xima® Formcycle-Administrator überschreibt keine bestehende Auswahl der Zahlverfahren in Mandanten. | ||
| 80 | ; Zertifikat | ||
| 81 | : Dieses muss im Format **//p12//** sein. Default-Zertifikat wird initial übernommen. Änderungen des Default-Zertifikats durch den Xima® Formcycle-Administrator überschreibt kein bestehendes Zertifikat in Mandanten. | ||
| 82 | ; Passwort | ||
| 83 | : Passwort zum entschlüsseln des Zertifikats. Default-Passwort wird initial übernommen. Änderungen des Default-Passwortes durch den Xima® Formcycle-Administrator überschreibt kein bestehendes Passwort in Mandanten. | ||
| 84 | ; Hostname oder IP des zu verwenden Proxy-Servers | ||
| 85 | : Default-Wert wird als Platzhalter angezeigt. Änderungen des Default-Wertes durch den Xima® Formcycle-Administrator werden im Platzhalter sichtbar. | ||
| 86 | ; Port | ||
| 87 | : Der Port zum Proxy-Host. Default-Wert wird als Platzhalter angezeigt. Änderungen des Default-Wertes durch den Xima® Formcycle-Administrator werden im Platzhalter sichtbar. | ||
| 88 | |||
| 89 | {{info}} | ||
| 90 | Hinweis: Nur wenn sowohl Hostname als auch Port angegeben sind, wird die Verbindung darüber aufgebaut. | ||
| 91 | {{/info}} | ||
| 92 | |||
| 93 | * Abschließend kann ein Verbindungstest durchgeführt werden. Dabei wird auch das Zertifikat geprüft, weswegen auch das Passwort stimmen muss. | ||
| 94 | * Wenn der ePayment-Webservice nicht erreicht werden kann, so sind gegebenenfalls Firewall-Einstellungen zu prüfen. Die konkrete URL zum Webservice wird dabei in der Fehlermeldung angezeigt. Der Aufbau der Webservice-Verbindung muss dabei vom FORMCYCLE Master-Server oder Frontend-Server aus möglich sein (siehe Hinweis oben). | ||
| 95 | |||
| 96 | Damit ist die Konfiguration abgeschlossen. | ||
| 97 | |||
| 98 | |||
| 99 | {{warning}} | ||
| 100 | **Hinweise zur Erreichbarkeit notwendiger System-URLs** | ||
| 101 | |||
| 102 | Bitte konfigurieren Sie gegebenenfalls ihre Firewall hinsichtlich der Erreichbarkeit der nachfolgenden URL(s). | ||
| 103 | \\Folgende URL(s) müssen von **Extern erreichbar** sein, damit eine Rückmeldung vom ePayBL-Portal korrekt verarbeitet werden kann: | ||
| 104 | |||
| 105 | * https:~/~/<//Domain-Adresse des Master-Servers//>/formcycle/plugin (Master-Server) | ||
| 106 | ODER | ||
| 107 | * https:~/~/<//Domain-Adresse des Frontend-Servers//>/frontend-server/plugin (Frontend-Server) | ||
| 108 | |||
| 109 | Die URL der anzubindenden Umgebung muss **vom FORMCYCLE Master-Server aus erreichbar** sein. | ||
| 110 | {{/warning}} | ||
| 111 | |||
| 112 | == Anpassungen zum späteren Zeitpunkt == | ||
| 113 | |||
| 114 | === Aktualisierung des Zugriffszertifikats für den ePayBL ePayment LIVE-Service === | ||
| 115 | |||
| 116 | ==== Vorbedingung ==== | ||
| 117 | |||
| 118 | Sie haben ein neues Zertifikat für den Zugriff auf den ePayBL Webservice erhalten, da ihr altes Zertifikat abgelaufen ist | ||
| 119 | |||
| 120 | ==== Vorgehen ==== | ||
| 121 | |||
| 122 | Folgen Sie der Anleitung unter dem Punkt **ePayBL Setup** - Schritt 2: [[Installationsschritte>>doc:]] und aktualisieren Sie ihr Zertifikat. |