Wiki source code of ePayBL Setup

Hide last authors

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
7.1	19	== Migration einer bestehenden Installation ==
2.1	20
9.1	21	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:
	22
25.1	23	1. Gehen Sie in den Menüpunkt //AKDB ePay Setup//
22.1	24	1. Notieren Sie sich Ihre bisherigen Angaben
24.1	25	1.1 Mandant-Nummer
	26	1.2 Bewirtschafter-Nummer
	27	1.3 Haushaltsstelle
	28	1.4 Objektnummer
	29	1.5 Kennzeichen-Manverfahren
	30	1.6 Proxy (falls vorhanden)
	31	1. Ermitteln Sie die URL Ihres ePayBL Providers
	32	1. Stellen Sie Zertifikat und Zertifikatspasswort sicher
	33	1. Ermitteln Sie die erlaubten Zahlverfahren Ihres ePayBL Providers
	34	1. Deaktivieren Sie das //AKDB: EPayment-Plugin// in Ihrem Mandanten
	35	1. Loggen Sie sich als Systemadministrator an
	36	1. Hinterlegen Sie das //ePayBL: EPayment-Plugin// in den Systemplugins
	37	1. Gehen Sie in den neuen Menüpunkt //ePayBL Setup//
25.1	38	1. Hinterlegen Sie Ihre notierten Angaben, nähere Informationen sind unter.
21.1	39
7.1	40	{{info}}
16.1	41	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.
7.1	42	{{/info}}
2.1	43
7.1	44	== Installation als Systemadministrator ==
	45
	46	{{figure image="epaybl-system.png"}}
	47	Der sadmin gibt hier URL des Providers, Zertifikat sowie Passwort und Proxy vor.
	48	{{/figure}}
	49
	50	Das Plugin wird als System-Plugin installiert.
	51
	52
	53	=== Obligatorische Installationsschritte ===
	54
2.1	55	* Anmeldung als sadmin am FORMCYCLE-System.
	56	* Registrierung des //plugin-bundle-epaybl.jar// Plugins im Bereich der System-Plugins.
	57
8.1	58	=== Fakultative Installationsschritte ===
	59
2.1	60	* Jetzt ist ein neuer Menüpunkt ePayBL Setup vorhanden, welcher aufgerufen werden kann.
	61	{{info}}Hinweis: Sollte der Menüpunkt nicht sofort ersichtlich sein, ist ein Abmelden und anschließendes Anmelden als sadmin notwendig.{{/info}}
18.1	62	* Hier kann der {{formcycle/}} Systemadministrator Default-Werte hinterlegen, welche den Mandanten als Platzhalter angezeigt werden und jenes Feld nicht ausfüllen müssen.
	63	* Für genauere Informationen zu den einzelnen Eingabefeldern siehe //Eingabefelder//.
2.1	64
8.1	65	== ePayBL Setup - Mandant ==
	66
2.1	67	{{figure image="epaybl-client.png"}}
	68	Der Mandant muss hier alle weiteren Felder ausfüllen, um das Setup zu speichern.
	69	{{/figure}}
	70
18.1	71	Der Mandant vervollständigt das ePayBL Setup.
	72
8.1	73	=== Obligatorische Installationsschritte ===
2.1	74
	75	* Anmeldung in den FORMCYCLE-Mandanten, welcher eine Anbindung erhalten soll.
	76	* Jetzt ist ein neuer Menüpunkt ePayBL Setup vorhanden, welcher aufgerufen werden muss.
	77	* Nun müssen alle Werte hinterlegt werden, außer es existieren bereits Default-Werte:
	78
	79	{{info}}
	80	Hinweis: Nur wenn sowohl Hostname als auch Port angegeben sind, wird die Verbindung darüber aufgebaut.
	81	{{/info}}
	82
	83	* Abschließend kann ein Verbindungstest durchgeführt werden. Dabei wird auch das Zertifikat geprüft, weswegen auch das Passwort stimmen muss.
	84	* 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).
	85
	86	Damit ist die Konfiguration abgeschlossen.
	87
	88
	89	{{warning}}
	90	Hinweise zur Erreichbarkeit notwendiger System-URLs
	91
	92	Bitte konfigurieren Sie gegebenenfalls ihre Firewall hinsichtlich der Erreichbarkeit der nachfolgenden URL(s).
	93	\\Folgende URL(s) müssen von Extern erreichbar sein, damit eine Rückmeldung vom ePayBL-Portal korrekt verarbeitet werden kann:
	94
	95	* https:~/~/<//Domain-Adresse des Master-Servers//>/formcycle/plugin (Master-Server)
	96	ODER
	97	* https:~/~/<//Domain-Adresse des Frontend-Servers//>/frontend-server/plugin (Frontend-Server)
	98
	99	Die URL der anzubindenden Umgebung muss vom FORMCYCLE Master-Server aus erreichbar sein.
	100	{{/warning}}
	101
	102
18.1	103	== Eingabefelder ==
2.1	104
18.1	105	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.
2.1	106
18.1	107	; URL des Providers
	108	: Die URL der anzubindenen Umgebung. Default-Wert wird als Platzhalter angezeigt.
	109	; Mandant-Nummer
	110	: Die Mandant-Nummer ist den ePayBL Vertragsdaten zu entnehmen. Default-Wert wird als Platzhalter angezeigt.
	111	; Bewirtschafter-Nummer
	112	: Die Bewirtschafter-Nummer ist den ePayBL Vertragsdaten zu entnehmen. Default-Wert wird als Platzhalter angezeigt.
	113	; Haushaltsstelle
	114	: Die Haushaltsstelle ist den ePayBL Vertragsdaten zu entnehmen. Default-Wert wird als Platzhalter angezeigt.
	115	; Objekt-Nummer
	116	: Die Objekt-Nummer ist den ePayBL Vertragsdaten zu entnehmen. Default-Wert wird als Platzhalter angezeigt.
	117	; Kennzeichen-Mahnverfahren
	118	: Das Kennzeichen-Mahnverfahren ist den ePayBL Vertragsdaten zu entnehmen. Default-Wert wird als Platzhalter angezeigt.
	119	; Fälligkeitszeitraum (in Tagen)
	120	: Der Fälligkeitszeitraum ist frei wählbar. Default-Wert wird als Platzhalter angezeigt.
	121	; Buchungstext auf der PayPage
	122	: Der Buchungstext ist frei wählbar. Default-Wert wird als Platzhalter angezeigt.
	123	; Unterstütze Zahlverfahren
	124	: Eingrenzung der Zahlverfahren nötig. Default-Auswahl wird initial übernommen.
	125	; Zertifikat
	126	: Dieses muss im Format //p12// sein. Name des Default-Zertifikats wird angezeigt.
	127	; Passwort
	128	: Passwort zum entschlüsseln des Zertifikats. Default-Passwort wird initial übernommen.
	129	; Hostname oder IP des zu verwenden Proxy-Servers
	130	: Default-Wert wird als Platzhalter angezeigt.
	131	; Port
	132	: Der Port zum Proxy-Host. Default-Wert wird als Platzhalter angezeigt.