RegioItPostkorbPlugin - FORMCYCLE Wiki

author	version	line-number	content
1	{{content/}}
2
3	Dieses Plugin ermöglicht die Anbindung der Postkorbschnittstelle von der regio iT. Über eine Workflow-Aktion können dann Nachrichten an den Postkorb des [[Serviceportals>>https://servicekonto.nrw/]] geschickt werden.
4
5	Das Plugin kann sowohl als System- als auch als Mandantplugin installiert werden. Nach Installation des Plugins müssen in der Plugin-Konfiguration die Verbindungsdaten zur Postkorbschnittstelle eingetragen werden.
6
7	== Konfiguration des Plugins ==
8
9	{{figure image="plugin_regioit_postkorb_settings_de.png" width="600"}}
10	Konfiguration des Postkorb-Plugins. Erforderlich sind nur die URL zur Postkorbschnittstelle sowie Benutzername, Passwort und die Service-ID. Weitere Einstellungen zu Proxy-Server und Zertifikaten sind optional.
11	{{/figure}}
12
13	Nach dem das Plugin installiert wurde, muss hier die URL auf die Postkorbschnittstelle sowie Nutzername und Passwort eingetragen werden. Weitere Einstellungen zu Proxy-Servern und SSL-Zertifikaten sind optional und nur notwendig, falls ein Proxy-Server benutzt wird beziehungsweise Zertifikate genutzt werden, die nicht im Java-Truststore enthalten sind. Bei allen Einstellungen erscheint ein Tooltip, wenn man mit der Maus darüber fährt.
14
15	Die Konfiguration gliedert sich in fünf Abschnitte:
16
17	=== Verbindungseinstellungen
18
19	Diese Einstellung sind notwendig, damit eine Verbindung zur Postkorbschnittstelle aufgebaut werden kann. In der Regel werden diese Informationen von der regio iT mitgeteilt.
20
21	; Endpunkt-URL für Postkorbschnittstelle
22	: Hier wird die URL zur Postkorbschnittstelle eingetragen. Es ist zu beachten, dass hier nicht die URL zur WSDL-Datei eingetragen werden darf (diese endet meist auf //wsdl//).
23	; Nutzername
24	: Der Benutzername für die Verbindung zur Postkorbschnittstelle.
25	; Passwort
26	: Das Passwort für die Verbindung zur Postkorbschnittstelle.
27	; Connection timeout
28	: Verbindungszeitüberschreitung (Connection-Timeout) für das Herstellen der Verbindung zur Postkorbschnittstelle. Die Zeitdauer wird mit Einheit eingetragen, also etwa //10s//, //500 ms// oder //2 min//.
29	; Read timeout
30	: Lesezeitüberschreitung (Read-Timeout) für das Auslesen einer Methode der Postkorbschnittstelle. Die Zeitdauer wird mit Einheit eingetragen, also etwa //10s//, //500 ms// oder //2 min//.
31	; Vorher immer PING durchführen
32	: Entweder //true// oder //false//. In der Spezifikation der Postkorbschnittstelle wird empfohlen, vor jeder Anfrage eine sogenannte PING-Anfrage durchzuführen, um die Verfügbarkeit der Schnittstelle zu prüfen. In der Regel kann diese Einstellung aber deaktiviert werden.
33
34	=== Standardeinstellung für Anfragen
35
36	Diese Einstellungen betreffen grundlegende Daten, die bei jeder Anfrage an die Postkorbschnittstelle mitgesendet werden müssen. In der Regel werden diese Informationen von der regio iT mitgeteilt.
37
38	; ID der Dienstleistung aus BIS
39	: Das Dienstleistungs-ID, welche benutzt wird, um neue Nachrichten im Postkorb zu erstellen. Dies ist in der Regel eine 5-stellige Zahl. Meist sollte diese Einstellung für das gesamte System gleich sein, bei Bedarf kann diese Einstellung aber pro Workflow-Aktion auch überschrieben werden. Diese Einstellung entspricht dem Parameter //fall.dienstleistung// der Postkorbschnittstelle.
40	; Präfix für die ID des Vorgangs im Postkorb
41	: Das Präfix wird als erster Teil der ID (vor dem Doppelpunkt) des externen Fachverfahrens verwendet. Meist sollte diese Einstellung für das gesamte System gleich sein, bei Bedarf kann diese Einstellung aber pro Workflow-Aktion auch überschrieben werden. Diese Einstellung entspricht dem ersten Teil des Parameters //extern.id// der Postkorbschnittstelle.
42
43	=== TLS/SSL-Einstellungen
44
45	Diese Einstellungen sind nur erforderlich, falls der Server der Postkorbschnittstelle Zertifikate verwendet, die nicht auf dem FORMCYCLE-Server beziehungsweise im Java-Truststore vorhanden sind.
46
47	; Zusätzliches Zertifikat für TLS/SSL (Mandantdatei)
48	: Der Name einer Mandantdatei mit einem gültigen X509-Zertifikat.
49	; Passwort für das Zertifikat
50	: Das Passwort, um das angegebene Zertifikat öffnen zu können.
51
52	=== HTTP-Basic-Auth-Einstellunen
53
54	Diese Einstellungen sind nur erforderlich, falls der Server der Postkorbschnittstelle eine HTTP-Basic-Authentication erfordert.
55
56	; Nutzername für HTTP-Basic-Auth
57	: Der zu benutzende Benutzername für HTTP-Basic-Auth.
58	; Passwort für HTTP-Basic-Auth
59	: Das zu benutzende Passwort für HTTP-Basic-Auth.
60
61	=== Proxy-Server-Einstellungen
62
63	Diese Einstellungen sind nur erforderlich, falls der FORMCYLE-Server einen Proxy-Server benötigt, um sich mit der Postkorbschnittstelle verbinden zu können.
64
65	; URL des Proxy-Servers
66	: Die URL des Proxy-Servers.
67	; Port des Proxy-Servers
68	: Der Port des Proxy-Servers.
69	; Nutzername für Proxy-Server
70	: Nutzername, falls nötig, um eine Verbindungs zum Proxy-Server herzustellen.
71	; Passwort für den Proxy-Server
72	: Nutzername, falls nötig, um eine Verbindungs zum Proxy-Server herzustellen.
73
74	== Konfiguration der Workflow-Aktion ==

Dieses Plugin ermöglicht die Anbindung der Postkorbschnittstelle von der regio iT. Über eine Workflow-Aktion können dann Nachrichten an den Postkorb des [[Serviceportals>>https://servicekonto.nrw/]] geschickt werden.

4

5

Das Plugin kann sowohl als System- als auch als Mandantplugin installiert werden. Nach Installation des Plugins müssen in der Plugin-Konfiguration die Verbindungsdaten zur Postkorbschnittstelle eingetragen werden.

6

7

== Konfiguration des Plugins ==

8

9

{{figure image="plugin_regioit_postkorb_settings_de.png" width="600"}}

10

Konfiguration des Postkorb-Plugins. Erforderlich sind nur die URL zur Postkorbschnittstelle sowie Benutzername, Passwort und die Service-ID. Weitere Einstellungen zu Proxy-Server und Zertifikaten sind optional.

11

12

13

Nach dem das Plugin installiert wurde, muss hier die URL auf die Postkorbschnittstelle sowie Nutzername und Passwort eingetragen werden. Weitere Einstellungen zu Proxy-Servern und SSL-Zertifikaten sind optional und nur notwendig, falls ein Proxy-Server benutzt wird beziehungsweise Zertifikate genutzt werden, die nicht im Java-Truststore enthalten sind. Bei allen Einstellungen erscheint ein Tooltip, wenn man mit der Maus darüber fährt.

14

15

Die Konfiguration gliedert sich in fünf Abschnitte:

16

17

=== Verbindungseinstellungen

18

19

Diese Einstellung sind notwendig, damit eine Verbindung zur Postkorbschnittstelle aufgebaut werden kann. In der Regel werden diese Informationen von der regio iT mitgeteilt.

20

21

; Endpunkt-URL für Postkorbschnittstelle

22

: Hier wird die URL zur Postkorbschnittstelle eingetragen. Es ist zu beachten, dass hier nicht die URL zur WSDL-Datei eingetragen werden darf (diese endet meist auf //wsdl//).

23

; Nutzername

24

: Der Benutzername für die Verbindung zur Postkorbschnittstelle.

25

; Passwort

26

: Das Passwort für die Verbindung zur Postkorbschnittstelle.

27

; Connection timeout

28

: Verbindungszeitüberschreitung (Connection-Timeout) für das Herstellen der Verbindung zur Postkorbschnittstelle. Die Zeitdauer wird mit Einheit eingetragen, also etwa //10s//, //500 ms// oder //2 min//.

29

; Read timeout

30

: Lesezeitüberschreitung (Read-Timeout) für das Auslesen einer Methode der Postkorbschnittstelle. Die Zeitdauer wird mit Einheit eingetragen, also etwa //10s//, //500 ms// oder //2 min//.

31

; Vorher immer PING durchführen

32

: Entweder //true// oder //false//. In der Spezifikation der Postkorbschnittstelle wird empfohlen, vor jeder Anfrage eine sogenannte PING-Anfrage durchzuführen, um die Verfügbarkeit der Schnittstelle zu prüfen. In der Regel kann diese Einstellung aber deaktiviert werden.

33

34

=== Standardeinstellung für Anfragen

35

36

Diese Einstellungen betreffen grundlegende Daten, die bei jeder Anfrage an die Postkorbschnittstelle mitgesendet werden müssen. In der Regel werden diese Informationen von der regio iT mitgeteilt.

37

38

; ID der Dienstleistung aus BIS

39

: Das Dienstleistungs-ID, welche benutzt wird, um neue Nachrichten im Postkorb zu erstellen. Dies ist in der Regel eine 5-stellige Zahl. Meist sollte diese Einstellung für das gesamte System gleich sein, bei Bedarf kann diese Einstellung aber pro Workflow-Aktion auch überschrieben werden. Diese Einstellung entspricht dem Parameter //fall.dienstleistung// der Postkorbschnittstelle.

40

; Präfix für die ID des Vorgangs im Postkorb

41

: Das Präfix wird als erster Teil der ID (vor dem Doppelpunkt) des externen Fachverfahrens verwendet. Meist sollte diese Einstellung für das gesamte System gleich sein, bei Bedarf kann diese Einstellung aber pro Workflow-Aktion auch überschrieben werden. Diese Einstellung entspricht dem ersten Teil des Parameters //extern.id// der Postkorbschnittstelle.

42

43

=== TLS/SSL-Einstellungen

44

45

Diese Einstellungen sind nur erforderlich, falls der Server der Postkorbschnittstelle Zertifikate verwendet, die nicht auf dem FORMCYCLE-Server beziehungsweise im Java-Truststore vorhanden sind.

46

47

; Zusätzliches Zertifikat für TLS/SSL (Mandantdatei)

48

: Der Name einer Mandantdatei mit einem gültigen X509-Zertifikat.

49

; Passwort für das Zertifikat

50

: Das Passwort, um das angegebene Zertifikat öffnen zu können.

51

52

=== HTTP-Basic-Auth-Einstellunen

53

54

Diese Einstellungen sind nur erforderlich, falls der Server der Postkorbschnittstelle eine HTTP-Basic-Authentication erfordert.

55

56

; Nutzername für HTTP-Basic-Auth

57

: Der zu benutzende Benutzername für HTTP-Basic-Auth.

58

; Passwort für HTTP-Basic-Auth

59

: Das zu benutzende Passwort für HTTP-Basic-Auth.

60

61

=== Proxy-Server-Einstellungen

62

63

Diese Einstellungen sind nur erforderlich, falls der FORMCYLE-Server einen Proxy-Server benötigt, um sich mit der Postkorbschnittstelle verbinden zu können.

64

65

; URL des Proxy-Servers

66

: Die URL des Proxy-Servers.

67

; Port des Proxy-Servers

68

: Der Port des Proxy-Servers.

69

; Nutzername für Proxy-Server

70