Änderungen von Dokument ePayBL Setup

Von 15.1 nach 16.1 Von 35.1 nach 36.1

Von Version 16.1

bearbeitet von fse
am 27.02.2023, 13:43

Änderungskommentar: Es gibt keinen Kommentar für diese Version

Auf Version 35.1

bearbeitet von fse
am 24.03.2023, 14:00

Änderungskommentar: Es gibt keinen Kommentar für diese Version

Rohform
Im Layout

Zusammenfassung

Seiteneigenschaften (1 geändert, 0 hinzugefügt, 0 gelöscht)

Details

Seiteneigenschaften

Inhalt

@@ -20,15 +20,54 @@
  Falls Sie bereits das [[**AKDB: EPayment-Plugin** >>url:https://help.formcycle.de/xwiki/bin/view/Formcycle/PluginDocumentation/AkdbEPaymentPlugin/]] in Ihren Mandanten installiert haben, können Sie wie folgt vorgehen:
--; Notieren Sie sich Ihre bisherigen Angaben
--: Mandant-Nummer, Bewirtschafter-Nummer, Haushaltsstelle, Objektnummer und Kennzeichen-Mahnverfahren sowie Angaben Ihres Proxy falls vorhanden.
--; Stellen Sie Zertifikat und Passwort sicher, dieses wird auch für Ihr Testsystem benötigt.
--; Prüfen Sie die URL Ihres ePayBL-Providers
--: Für das Testsystem war dies bisher **//infra-pre.buergerserviceportal.de//**.
--: Für das Livesystem war dies bisher **//epay.akdb.de//**.
++=== Vorbereitung ===
--Nun muss das alte //AKDB: EPayment-Plugin// im Mandanten deaktiviert werden. Ansonsten ist der Menüpunkt //ePayBL Setup// im Mandanten nicht sichtbar. Das neue //ePayBL: EPayment-Plugin// wird nur ausgeführt, wenn das alte //AKDB: EPayment-Plugin// deaktiviert wurde. Die Umstellung auf das neue Plugin kann sukzessiv erfolgen, das heißt das alte //AKDB: EPayment-Plugin// muss nicht sofort in jedem Mandanten deaktiviert werden. Somit kann die Installation erst einmal in einem (Test-)Mandanten erfolgen.
++Um die neue ePayBL Schnittstelle anzubinden, benötigen Sie ein Zertifikat von der AKDB. Wenn Sie es für die Produktivumgebung noch nicht haben, wenden Sie sich an Ihren Ansprechpartner bei der AKDB.
++=== Migration ===
++
++1. Datensicherung
++1.1 Gehen Sie im {{formcycle/}} Hauptmenü auf **AKDB ePay Setup**.
++1.2 Klicken Sie auf **Zur Anbindung ePay-BL Umgebung**.
++1.3 Notieren Sie die Informationen für Mandant-Nummer, Bewirtschafter-Nummer, Haushaltsstelle, Objektnummer, Kennzeichen-Mahnverfahren, Fälligkeitszeitraum (in Tagen) und Buchungstext für die PayPage.
++1. Bestimmen der URL Ihres ePayBL Providers
++2.1 Wenn unter "Anzubindende Umgebung" der Wert "TEST" ausgewählt ist, verwenden Sie in Zukunft die Adresse "https://infra-pre.buergerserviceportal.de" zur Anbindung.
++2.2 Wenn unter "Anzubindende Umgebung" der Wert "LIVE" ausgewählt ist, verwenden Sie in Zukunft die Adresse "https://epay.akdb.de" zur Anbindung.
++1. Deaktivieren des AKDB: EPayment-Plugin
++3.1 Gehen Sie im {{formcycle/}} Hauptmenü auf "Mandant" -> "Plugin".
++3.2 Fahren Sie mit der Maus über den Eintrag //plugin-bundle-akdb-epayment.jar//. Es erscheint das Symbol zum Deaktivieren des Plugins.
++3.3 Klicken Sie auf das Symbol, um das Plugin zu deaktivieren.
++3.4 Das Plugin wird nun durchgestrichen dargestellt.
++1. Löschen der Datei //epay_wf_result.js//
++4.1 Gehen Sie im {{formcycle/}} Hauptmenü auf "Dateien & Templates" -> "Dateien".
++4.2 Wählen Sie den Eintrag //epay_wf_result.js// aus indem Sie das Kästchen links davon anhaken.
++4.3 Klicken Sie auf das löschen Symbolüberhalb der Auflistung.
++1. Installation des //plugin-bundle-epaybl.jar//
++5.1 Melden Sie sich als Systemadministrator (sadmin) am {{formcycle/}} Backend an.
++5.2 Gehen Sie im {{formcycle/}} Hauptmenü auf "System" -> "Systemplugins".
++5.3 Klicken Sie auf den Plus-Button, um die Datei //plugin-bundle-epaybl.jar// hinzuzufügen.
++1. Einrichten mit ePayBL Setup
++6.1 Im {{formcycle/}} Hauptmenü steht Ihnen nun ein neuer Punkt **ePayBL Setup** zur Verfügung. Eventuell müssen Sie sich erneut anmelden um diesen zu sehen.
++6.2 Klicken Sie auf dem Menüpunk **ePayBL Setup**
++6.3 Tragen Sie die URL aus Schritt 2 ein.
++6.4 Geben Sie nun die Informationen für Mandant-Nummer, Bewirtschafter-Nummer, Haushaltsstelle, Objektnummer, Kennzeichen-Mahnverfahren, Fälligkeitszeitraum (in Tagen) und Buchungstext für die PayPage ein, die für alle Mandanten gelten sollen.
++6.5 Laden Sie das Zertifikat hoch, das Sie von der AKDB erhalten haben, und geben Sie das dazugehörige Passwort ein.
++6.6 Klicken Sie auf „Speichern“.
++6.7 Alle Angaben, die Sie als Systemadministrator in den Systemeinstellungen hinterlegen, sind optional und sind als Standardeinstellungen, die für alle Mandanten in Ihrer {{formcycle/}} Umgebung gelten zu verstehen.
++6.8 Informationen, die nicht durch den Systemadministrator hinterlegt wurden, werden im Mandanten als Pflichtangabe angezeigt und müssen später dort angegeben werden.
++1. Vervollständigung des Setups im Mandanten
++7.1 Melden Sie sich beim Mandanten an, in dem Sie zuvor das AKDB: EPayment-Plugin deaktiviert haben.
++7.2 Klicken Sie auf dem Menüpunk **ePayBL Setup**
++7.3 Ergänzen Sie ggf. noch fehlende Informationen.
++7.4 Klicken Sie auf **Verbindung prüfen**. Es sollten nun entsprechende Erfolgsmeldungen angezeigt werden.
++7.5 Klicken Sie auf „Speichern“.
++
++==== Checklist ====
++
++1. Testen Sie die Anbindung durch Auslösen einer Testzahlung.
++1. Überprüfen Sie, ob die Testzahlung erfolgreich durchgeführt wurde.
++1. Wenn alles funktioniert hat, können Sie nun die ePayBL Schnittstelle produktiv nutzen.
++
  {{info}}
  Es müssen keine Änderungen am Formular, weder Designer noch Workflow, durchgeführt werden. Jedoch gibt es keine Unterstützung für Formulare mit altem {{formcycle/}} Workflow.
  {{/info}}
@@ -44,7 +44,7 @@
  === Obligatorische Installationsschritte ===
--* Anmeldung als **sadmin **am FORMCYCLE-System.
++* Anmeldung als **sadmin **am {{formcycle/}}-System.
  * Registrierung des **//plugin-bundle-epaybl.jar//** Plugins im Bereich der System-Plugins.
  === Fakultative Installationsschritte ===
@@ -51,8 +51,8 @@
  * Jetzt ist ein neuer Menüpunkt **ePayBL Setup** vorhanden, welcher aufgerufen werden kann.
  {{info}}Hinweis: Sollte der Menüpunkt nicht sofort ersichtlich sein, ist ein Abmelden und anschließendes Anmelden als sadmin notwendig.{{/info}}
--* Hier kann der Xima® Formcycle-Administrator Default-Werte hinterlegen, welche den Mandanten als Platzhalter angezeigt werden und jenes Feld nicht ausfüllen müssen.
--* Für genauere Informationen zu den einzelnen Eingabefeldern siehe //ePayBL Setup - Mandant//.
++* Hier kann der {{formcycle/}} Systemadministrator Default-Werte hinterlegen, welche den Mandanten als Platzhalter angezeigt werden und jenes Feld nicht ausfüllen müssen.
++* Für genauere Informationen zu den einzelnen Eingabefeldern siehe //Eingabefelder//.
  == ePayBL Setup - Mandant ==
@@ -60,6 +60,8 @@
  Der Mandant muss hier alle weiteren Felder ausfüllen, um das Setup zu speichern.
  {{/figure}}
++Der Mandant vervollständigt das **ePayBL Setup**.
++
  === Obligatorische Installationsschritte ===
  * Anmeldung in den FORMCYCLE-Mandanten, welcher eine Anbindung erhalten soll.
@@ -66,33 +66,6 @@
  * Jetzt ist ein neuer Menüpunkt **ePayBL Setup** vorhanden, welcher aufgerufen werden muss.
  * Nun müssen alle Werte hinterlegt werden, außer es existieren bereits Default-Werte:
--; URL des Providers
--: Die URL der anzubindenen Umgebung. Default-Wert wird als Platzhalter angezeigt. Änderungen des Default-Wertes durch den Xima® Formcycle-Administrator werden im Platzhalter sichtbar.
--; Mandant-Nummer
--: 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.
--; Bewirtschafter-Nummer
--: 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.
--; Haushaltsstelle
--: 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.
--; Objekt-Nummer
--: 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.
--; Kennzeichen-Mahnverfahren
--: 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.
--; Fälligkeitszeitraum (in Tagen)
--: 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.
--; Buchungstext auf der PayPage
--: 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.
--; Unterstütze Zahlverfahren
--: 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.
--; Zertifikat
--: 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.
--; Passwort
--: 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.
--; Hostname oder IP des zu verwenden Proxy-Servers
--: Default-Wert wird als Platzhalter angezeigt. Änderungen des Default-Wertes durch den Xima® Formcycle-Administrator werden im Platzhalter sichtbar.
--; Port
--: Der Port zum Proxy-Host. Default-Wert wird als Platzhalter angezeigt. Änderungen des Default-Wertes durch den Xima® Formcycle-Administrator werden im Platzhalter sichtbar.
--
  {{info}}
  Hinweis: Nur wenn sowohl Hostname als auch Port angegeben sind, wird die Verbindung darüber aufgebaut.
  {{/info}}
@@ -116,14 +116,47 @@
  Die URL der anzubindenden Umgebung muss **vom FORMCYCLE Master-Server aus erreichbar** sein.
  {{/warning}}
--== Anpassungen zum späteren Zeitpunkt ==
--=== Aktualisierung des Zugriffszertifikats für den ePayBL ePayment LIVE-Service ===
++== Eingabefelder ==
--==== Vorbedingung ====
++Falls bereits eine Eingabe durch den {{formcycle/}} Systemadministrator getätigt wurde, ist das Eingabefeld für den Mandanten kein Pflichtfeld mehr und der Default-Wert wird als Platzhalter angezeigt. Jeder Mandant kann die Default-Werte überschreiben, indem das entsprechende Eingabefeld ausgefüllt wird.
--Sie haben ein neues Zertifikat für den Zugriff auf den ePayBL Webservice erhalten, da ihr altes Zertifikat abgelaufen ist
++; URL des Providers
++: Die URL der anzubindenen Umgebung. Default-Wert wird als Platzhalter angezeigt.
++; Mandant-Nummer
++: Die Mandant-Nummer ist den ePayBL Vertragsdaten zu entnehmen. Default-Wert wird als Platzhalter angezeigt.
++; Bewirtschafter-Nummer
++: Die Bewirtschafter-Nummer ist den ePayBL Vertragsdaten zu entnehmen. Default-Wert wird als Platzhalter angezeigt.
++; Haushaltsstelle
++: Die Haushaltsstelle ist den ePayBL Vertragsdaten zu entnehmen. Default-Wert wird als Platzhalter angezeigt.
++; Objekt-Nummer
++: Die Objekt-Nummer ist den ePayBL Vertragsdaten zu entnehmen. Default-Wert wird als Platzhalter angezeigt.
++; Kennzeichen-Mahnverfahren
++: Das Kennzeichen-Mahnverfahren ist den ePayBL Vertragsdaten zu entnehmen. Default-Wert wird als Platzhalter angezeigt.
++; Fälligkeitszeitraum (in Tagen)
++: Der Fälligkeitszeitraum ist frei wählbar. Default-Wert wird als Platzhalter angezeigt.
++; Buchungstext auf der PayPage
++: Der Buchungstext ist frei wählbar. Default-Wert wird als Platzhalter angezeigt.
++; Unterstütze Zahlverfahren
++: Eingrenzung der Zahlverfahren nötig. Default-Auswahl wird initial übernommen.
++; Zertifikat
++: Dieses muss im Format **//p12//** sein. Name des Default-Zertifikats wird angezeigt.
++; Passwort
++: Passwort zum entschlüsseln des Zertifikats. Default-Passwort wird initial übernommen.
++; Hostname oder IP des zu verwenden Proxy-Servers
++: Default-Wert wird als Platzhalter angezeigt.
++; Port
++: Der Port zum Proxy-Host. Default-Wert wird als Platzhalter angezeigt.
--==== Vorgehen ====
++=== Zahlverfahren ===
--Folgen Sie der Anleitung unter dem Punkt **ePayBL Setup** - Schritt 2: [[Installationsschritte>>doc:]] und aktualisieren Sie ihr Zertifikat.
++In {{formcycle/}} müssen die verfügbaren Zahlverfahren ausgewählt werden, welche von Ihrem ePayBL-System unterstützt werden. Aktuell werden folgende Zahlverfahren unterstützt:
++
++; Giropay
++; Kreditkarte
++; PayPal
++; PayDirekt
++; Überweisung
++; Lastschrift ohne Einzugsermächtigung
++
++Sobald in {{formcycle/}} Zahlverfahren angegeben werden, welche nicht im ePayBL-System erlaubt sind, kommt eine Fehlermeldung. Sie können die Zahlverfahren auf ein Minimum von einem Zahlverfahren eingrenzen.