Wiki-Quellcode von Plugin Setup
Zeige letzte Bearbeiter
| author | version | line-number | content |
|---|---|---|---|
| 1 | ~-~- IN BEARBEITUNG ~-~- | ||
| 2 | |||
| 3 | {{content/}} | ||
| 4 | |||
| 5 | == Vertragliche Voraussetzungen == | ||
| 6 | |||
| 7 | Damit das ePayment der AKDB in FORMCYCLE eingerichtet werden kann, muss zuvor ein Vertrag mit der AKDB geschlossen werden. Der Antrag kann dabei formlos von der AKDB, über die Mail-Adresse** BayernID@akdb.de**, angefordert werden. Dabei sollte angegebenen werden, ob das Test- oder Live-ePayment-System der AKDB angebunden werden soll. | ||
| 8 | |||
| 9 | Ist bereits ein Vertrag über das ePayment mit der AKDB vorhanden, so kann dieser herangezogen werden und mit dem Schritt der Initialen Installation fortgesetzt werden. | ||
| 10 | |||
| 11 | |||
| 12 | = Initiale Installation = | ||
| 13 | |||
| 14 | == AKDB ePay Setup - Schritt 1 == | ||
| 15 | |||
| 16 | === Voraussetzungen === | ||
| 17 | |||
| 18 | * Es wurde ein Vertrag über das ePayment mit der AKDB geschlossen und die notwendigen Daten (AKDB-EPayment-Mandant) liegen vor. | ||
| 19 | * Bei Anbindung des **ePayment Live-Systems** muss zusätzlich ein Zertifikat für den Zugriff auf den Payment-Webservice von der AKDB vorhanden sein. | ||
| 20 | ** Sollte bereits das Live-System vom **AKDB Bürgerkonto-Service / Postkorb** angebunden sein, so kann dieses Zertifikat für den Zugriff verwendet werden. | ||
| 21 | ** Ist der vorherige Punkt nicht gegeben, so muss dies explizit bei der AKDB angefordert werden. | ||
| 22 | * Das Plugin-Bundle //**plugin-bundle-akdb-epayment.jar**// ist vorhanden und kompatibel mit der installierten FORMCYCLE-Version. | ||
| 23 | |||
| 24 | === Installationsschritte === | ||
| 25 | |||
| 26 | * Anmeldung als **sadmin **am FORMCYCLE-System. | ||
| 27 | * Wechsel in den FORMCYCLE-Mandanten, welcher eine Anbindung an das AKDB-Bürgerkonto erhalten soll. | ||
| 28 | Sollte ein Auswahl des Mandanten nicht möglich sein, dann muss dies als Mandant-Administrator noch freigebeben werden. Die Einstellung finden Sie unter Mandant > [[Einstellungen>>doc:Formcycle.UserInterface.Client.SupportAccess.WebHome||target="_blank"]]. | ||
| 29 | * Registrierung des **//plugin-bundle-akdb-epayment.jar//** Plugins im Bereich des FROMCYCLE-Mandanten (Menüpunkt: Mandant > [[Plugins>>doc:Formcycle.UserInterface.Client.Plugins||target="_blank"]]). | ||
| 30 | * Jetzt ist ein neuer Menüpunkt **AKDB ePay Setup** vorhanden, welcher aufgerufen werden muss. | ||
| 31 | {{info}}Hinweis: Sollte der Menüpunkt nicht sofort ersichtlich sein, ist ein Abmelden und anschließendes Anmelden als sadmin mit Wechsel in den Mandanten notwendig.{{/info}} | ||
| 32 | * Beim Aufruf des Setups muss jetzt der Punkt **Zur Anbindung ePay-BL Umgebung** ausgeführt werden. | ||
| 33 | Zu Beginn müssen Sie sich entscheiden, ob Sie die Test- oder Liveumgebung des AKDB EPayment Dienstes anbinden möchen. Liegt ein Vertrag bereits vor, so können auch alle weiteren Daten zum AKDB ePayment Mandanten hinterlegt und gespeichert werden. | ||
| 34 | * Nach dem Speichern werden die Daten in den Properties des Plugins entsprechend hinterlegt. | ||
| 35 | |||
| 36 | {{warning}} | ||
| 37 | **Hinweise zur Erreichbarkeit notwendiger System-URLs** | ||
| 38 | |||
| 39 | Bitte konfigurieren Sie gegebenenfalls ihre Firewall hinsichtlich der Erreichbarkeit der nachfolgenden URL(s). | ||
| 40 | \\Folgende URL(s) müssen von **Extern erreichbar** sein, damit eine Rückmeldung vom ePay-BL-Portal korrekt verarbeitet werden kann: | ||
| 41 | |||
| 42 | * https:~/~/<//Domain-Adresse des Master-Servers//>/formcycle/plugin (Master-Server) | ||
| 43 | ODER | ||
| 44 | * https:~/~/<//Domain-Adresse des Frontend-Servers//>/frontend-server/plugin (Frontend-Server) | ||
| 45 | |||
| 46 | Folgende URL muss **vom FORMCYCLE Master-Server aus erreichbar** sein: | ||
| 47 | |||
| 48 | * Testsystem: https:~/~/infra-pre.buergerserviceportal.de/soap/servlet/rpcrouter | ||
| 49 | ODER | ||
| 50 | * Livesystem: https:~/~/buergerserviceportal.de/soap/servlet/rpcrouter | ||
| 51 | {{/warning}} | ||
| 52 | |||
| 53 | Damit ist der 1. Schritt der Einrichtung abgeschlossen. Bei Anbindung des Testsystem ist die Einrichtung hiermit abgeschlossen. | ||
| 54 | |||
| 55 | == AKDB ePay Setup - Schritt 2 == | ||
| 56 | |||
| 57 | === Vorbedingungen === | ||
| 58 | |||
| 59 | * Dieser Installationsschritt muss nur ausgeführt werden, wenn das ePayment Live-System angebunden werden soll. | ||
| 60 | * Bei Anbindung des ePayment Test-Systems ist kein Zugriffs-Zertifikat notwendig und kann deshalb auch nicht hinterlegt werden. | ||
| 61 | |||
| 62 | === Installationsschritte === | ||
| 63 | |||
| 64 | * Aufruf des Menüpunkt **AKDB ePay Setup** und dort **Zur Zertifikats-Registrierung und Verbindungsprüfung** ausführen. | ||
| 65 | * Das von der AKDB erhaltene Zertifikat muss hochgeladen und das Zertifikats-Passwort hinterlegt werden. | ||
| 66 | * Anschließend kann der Button **Prüfen und Speichern** geklickt werden. | ||
| 67 | Damit wird das Zertifikat im System gespeichert und an den Plugin-Einstellungen registriert. | ||
| 68 | Weiterhin wird versucht mit dem hinterlegten Passwort auf das Zertifikat zuzugreifen und bei Erfolg wird das Gültigkeitsdatum des Zertifikats angezeigt. | ||
| 69 | * Mit dem Button **Verbindung zu ePay-BL prüfen** kann jetzt testweise eine Verbindungsprüfung stattfinden. Dabei wird ebenfalls im Vorfeld eine Zertifikatsprüfung durchgeführt. | ||
| 70 | 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). | ||
| 71 | {{info}}Hinweis: Für eine vollständige Prüfung des Webservice-Zugriffs muss im Vorfeld die EPayment-MandantNr konfiguriert sein. Ansonst findet an dieser Stelle nur eine generelle Verbindungsprüfung statt.{{/info}} | ||
| 72 | |||
| 73 | Damit ist die Konfiguration abgeschlossen. | ||
| 74 | |||
| 75 | |||
| 76 | = Anpassungen zum späteren Zeitpunkt = | ||
| 77 | |||
| 78 | == Aktualisierung des Zugriffszertifikats für den AKDB ePayment LIVE-Service == | ||
| 79 | |||
| 80 | === Vorbedingung === | ||
| 81 | |||
| 82 | Sie haben ein neues Zertifikat für den Zugriff auf den AKDB-ePayment Webservice erhalten, da ihr altes Zertifikat abgelaufen ist | ||
| 83 | |||
| 84 | === Vorgehen === | ||
| 85 | |||
| 86 | Folgen Sie der Anleitung unter dem Punkt **AKDB ePay Setup** - Schritt 2: [[Installationsschritte>>doc:]] und aktualisieren Sie ihr Zertifikat. |