Wiki-Quellcode von regio iT: Postkorb-Plugin

Verstecke letzte Bearbeiter
awa 11.28 1 {{info}}
awa 18.2 2 The section regarding the plugin configuration is required only for administrators who need to configure the Postkorb web service. See the //Postkorb action// section on how to send a message to the Postkorb.
awa 11.28 3 {{/info}}
4
awa 15.11 5 {{info}}
awa 18.2 6 The Postkorb ("inbox") is a feature offered by the service portal. The Postkorb consists of so-called processes or message threads. Each message thread contains one more messages. This plugin lets you send message to an existing message thread from {{formcycle/}}. You can also create new message threads with an initial message.
awa 15.11 7 {{/info}}
8
awa 3.2 9 {{content/}}
awa 1.1 10
awa 18.2 11 This plugin implements the Porstkorb web service provided by regio iT. It adds a new [[workflow action>>doc:Formcycle.UserInterface.MyForms.WorkflowProcessing.Actions.WebHome]] that lets you send messages to the Postkorb of the [[service portal>>https://servicekonto.nrw/]].
awa 1.1 12
awa 18.2 13 You can install this plugin both as a system plugin as well as a client plugin. Once the plugin is installed, you (or an administrator) needs to configure the connection to the Postkorb web service. Once it is configured, you can start using the Postkorb workflow action.
awa 1.1 14
awa 18.2 15 == Postkorb action ==
awa 7.2 16
awa 18.2 17 {{figure image="plugin_regioit_postkorb_workflow_select_action_en.png" width="400"}}
18 Click on //New action// to add a new Postkorb action to the workflow.
awa 7.2 19 {{/figure}}
20
awa 18.29 21 {{figure image="plugin_regioit_postkorb_workflow_action_base_en.png" width="400"}}
awa 18.2 22 Basic settings for sending a message to a Postkorb message thread. Here you can the recipient and the content of the message.
awa 7.2 23 {{/figure}}
24
awa 18.29 25 {{figure image="plugin_regioit_postkorb_workflow_action_advanced_en.png" width="400"}}
awa 18.2 26 Advanced settings for sending a messag to a Postkorb message thread. Here you can change the metadata of the Postkorb message thread that is created.
awa 7.2 27 {{/figure}}
28
awa 18.29 29 {{figure image="plugin_regioit_postkorb_workflow_action_guest_en.png" width="400"}}
awa 18.2 30 You can also create a new message thread as a guest. This requires you to enter a few details about the guest, such as the name and email address. Please note that creating message threads as guests may be restricted by the web service - please contact your service provider for details.
awa 11.2 31 {{/figure}}
32
awa 18.2 33 Once the plugin is configured correctly, you can select the new workflow action //Create Postkorb message// in the workflow configuration.
awa 7.2 34
awa 18.2 35 === Configuration ===
awa 7.2 36
awa 18.2 37 The configuration for the Postkorb action is similar to the email action and separated into 4 sections. Most settings have a default set that you do not need to change normally - usually you just have to enter a subject and message text.
awa 7.2 38
awa 18.2 39 Most settings allow the use of [[variables>>doc:Formcycle.UserInterface.Variables]] to insert data from the submitted form. All settings that allow variables have a little book icon next to them that opens the variable selection dialog.
awa 7.5 40
awa 18.2 41 In order to send am message to the Postkorb, a few pieces of information about the recipient are required, such as their account number and name. We recommend that you allow users to sign in via the services provided by regio iT (OpenID Connect). This lets you prefill the settings with the data from the registered user via [[variables>>doc:Formcycle.UserInterface.Variables]].
awa 11.4 42
awa 18.2 43 ==== Message type and recipient ====
awa 11.2 44
awa 18.3 45 ; Message type
awa 18.9 46 : The Postkorb service offers two possibilies: You can (a) create a new message thread with an initial message, or (b) send a message to an existing message thread. In case you know for certain whether a message thread exists already, you can select the option //Create new message thread// or //Reply to existing message thread//. Otherwise, if you are uncertain and would like to create a new message thread in case none exists yet, you can select the option //Create message thread if none exists yet//
47 ; Recipient account number
awa 18.14 48 : Here you need to enter the account number of the recipient who should receive the Postkorb message. Usually the user would sign in via the login service provided by regio iT (OpenID Connect). In that case, you do not have to change the default value: //[%$last_user.preferred_username%//] This is a [[variable>>doc:Formcycle.UserInterface.Variables]] that is replace with the account number of the user who submitted the form. This setting corresponds to the parameter //fall.portalkonto// of the Postkorb web service.
awa 18.11 49 ; Send as guest
awa 18.12 50 : The Postkorb also allows you to create a new message thread as a guest, that is, without having an account number. Please note that it is not possible to reply to existing message threads as a guest. When this option is selected, a few more input fields will show up that let you enter the guests' data. Important: Please check with your Postkorb service provider whether they have allowed guests to create message threads.
awa 11.2 51
awa 18.12 52 The following input fields are available when the option //Send as guest// is checked:
awa 11.2 53
awa 18.12 54 ; Guest' email
awa 18.14 55 : The email of the guest. This setting corresponds the the parameter //gast.email// of the Postkorb web service.
awa 18.12 56 ; Guest's form of address
awa 18.14 57 : An optional form of address for the guest. Please note that only certain options such as //Herr// and //Frau// are supported. This setting corresponds the the parameter //gast.anrede// of the Postkorb web service.
awa 18.12 58 ; Guest's title
awa 18.14 59 : An optional title for the guest, such as //Dr. med.//. This setting corresponds the the parameter //gast.titel// of the Postkorb web service.
awa 18.12 60 ; Guest's first name
awa 18.14 61 : The first or given name of the guest. This setting corresponds the the parameter //gast.vorname// of the Postkorb web service.
62 ; Guest's family name
63 : The last of family name of the guest. This setting corresponds the the parameter //gast.familienname// of the Postkorb web service.
awa 11.4 64
awa 18.14 65 ==== Message content ====
awa 11.4 66
awa 18.14 67 The content of the message that is sent to the Postkorb. Optionally you can also send up to 10 files as an attachment. Please note that the Postkorb web service does not support more than 10 files.
awa 11.4 68
awa 18.15 69 ; Sender
70 : The name of the message' sender. By default this is set to the variable //[%last_user.name%]//, which is replaced with the name of the user who submitted the form. This setting corresponds the the parameter //nachricht.absender// of the Postkorb web service.
71 ; Subject
awa 18.16 72 : A single line of text with the subject of the message. This setting corresponds the the parameter //nachricht.betreff// of the Postkorb web service.
awa 18.15 73 ; Message
awa 18.17 74 : The message that is sent to the Postkorb. A few formating options such as bold text and lists are supported by Postkorb. This setting corresponds the the parameter //nachricht.inhalt// of the Postkorb web service.
awa 18.15 75 ; Attachments from previous actions
awa 18.17 76 : Optionally you can also add files produced by previous actions as an attachment. This setting corresponds the the parameters //anhang.[1-10].*// of the Postkorb web service.
awa 18.15 77 ; Attachments from form uploads
awa 18.17 78 : Optionaly you can also add files uploaded by the user as an attachment. This setting corresponds the the parameters //anhang.[1-10].*// of the Postkorb web service.
awa 11.7 79
awa 18.17 80 ==== Postkorb message thread ====
awa 11.7 81
awa 18.17 82 ; New message thread state
awa 18.19 83 : You can optionallt change the status of the message thread. The available status, as defined by the Postkorb, are //open//, //in progress//, //settled// and //canceled//. The default settings does not change the status (new message threads are automatically set to //open//). Please note that the two status //in progress// und //canceled// are available only when repying to an existing message thread, not when creating a new messag e thread. This setting corresponds the the parameter //fall.status// of the Postkorb web service.
awa 18.17 84 ; Message thread external ID
awa 18.30 85 : The external ID of the message thread. Each message thread receives an internal ID used by the Postkorb service internally, as well as an external ID that identifies the form record in {{formcycle/}}. The default settings is //[%$PROCESS_ID%]//. This variable is replace with the form record ID of the {{formcycle/}} form record - this should be sufficient for most use cases. In case you want to use a different external ID, please note that the Postkorb does not allow certain characters such as spaces. This setting corresponds the the parameter //extern.id// of the Postkorb web service.
awa 18.18 86 ; Message thread name
awa 18.23 87 : The name that is shown in the Postkorb for the message thread. This name is also shown in the list of existing message threads. This setting is available only when creating a new message thread. By default this is set to //[%$PROJECT_NAME%] - [%$PROCESS_ID%]//. These variables are replaced with the name of the form and ID of the form record, respectively, which results in message thread names such as //Registration form - 7581f9c5-0ba9-4b9a-b7c1-cfb475eabafd//. To make it easier to identify a message thread in the Postkorb, consider using other data submitted by the user, such as their email address. This setting corresponds the the parameter //extern.titel// of the Postkorb web service.
awa 18.18 88 ; Message thread link
awa 18.24 89 : An optional URL that is shown in the Postkorb. This setting is available only when a new message thread is created. Defaults to //[%$FORM_PROCESS_LINK%]//, which is replaced with the link to the submitted form. This setting corresponds the the parameter //extern.url// of the Postkorb web service.
awa 18.18 90 ; Message thread description
awa 18.25 91 : An optional description for the message thread. This setting is available only when creating a new message thread. This setting corresponds the the parameter //fall.info// of the Postkorb web service.
awa 11.7 92
awa 18.25 93 ==== Global plugin configuration overrides ====
awa 11.7 94
awa 18.25 95 ; Throw hard exception if action fails
awa 18.27 96 : Controls the behavior when the workflow action fails, i.e. when the message could not be sent to the Postkorb. When this option is activated, an exception is thrown, which aborts the workflow processing and returns an error page to the user. You can use the [[error handling settings>>doc:Formcycle.UserInterface.MyForms.WorkflowProcessing.ErrorHandling]] to control that behavior. Otherwise, when this option is deactivated, the Postkorb action is always successful and return an appropriate status code that indicates whether the message could be sent (see below). In that case you can use [[workflow conditions>>doc:Formcycle.UserInterface.MyForms.WorkflowProcessing.ActionConditions]] in combination with action result variables to check the status code and act accordingly.
97 ; Service ID (BIS)
awa 18.28 98 : Lets you override the global value configured in the plugin settings, if neccessary. See the //Service ID (BIS)// option in the plugin configuration for more details.
awa 18.27 99 ; Message thread ID prefix
awa 18.28 100 : Lets you override the global value configured in the plugin settings, if neccessary. See the //Message thread ID prefix// option in the plugin configuration for more details.
awa 11.7 101
awa 18.28 102 Finally, you can also check the availability of the Postkorb service. This only checks the connection details as configured in the plugin settings, not whether the data configured for this Postkorb action is valid. Technically speaking, this sends a so-called //PING// service request to the Postkorb web service.
awa 11.28 103
awa 18.31 104 === Return values ===
105
106 After the plugin action was executed, the following additional action placeholders are available:
107
108 success: true, if the message could be sent to the Postkorb, false otherwise.
109 status: The status code as returned by the Postkorb web service, either SUCCESS or ERROR.
110 messageThreadId: If the request was successful and a new message thread was created: The ID of the newly created message thread, as returned by the Postkorb web service.
111 errorCode: A numerical error code defined by this plugin. See the following list for the available codes.
112 errorType: Technical name of the error code, see below.
113 errorDetails: Localized name of the error code.
114 exceptionMessage: Message of the exception that was thrown by Java, if any.
115
116 === Error codes
117
118
119
awa 18.29 120 == Plugin configuration ==
awa 11.28 121
awa 18.29 122 {{figure image="plugin_regioit_postkorb_settings_en.png" width="600"}}
awa 11.28 123 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.
124 {{/figure}}
125
126 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.
127
128 Die Konfiguration gliedert sich in die folgenden fünf Abschnitte.
129
130 === Verbindungseinstellungen ===
131
132 Diese Einstellung sind notwendig, damit eine Verbindung zur Postkorbschnittstelle aufgebaut werden kann. In der Regel werden diese Informationen von der regio iT mitgeteilt.
133
134 ; Endpunkt-URL für Postkorbschnittstelle
135 : 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//).
136 ; Nutzername
137 : Der Benutzername für die Verbindung zur Postkorbschnittstelle.
138 ; Passwort
139 : Das Passwort für die Verbindung zur Postkorbschnittstelle.
140 ; Connection timeout
tkr 15.13 141 : Verbindungszeitüberschreitung (Connection-Timeout) für das Herstellen der Verbindung zur Postkorbschnittstelle. Die Zeitdauer wird mit Einheit eingetragen, also etwa //10s//, //500ms// oder //2min//.
awa 11.28 142 ; Read timeout
tkr 15.13 143 : Lesezeitüberschreitung (Read-Timeout) für das Auslesen einer Methode der Postkorbschnittstelle. Die Zeitdauer wird mit Einheit eingetragen, also etwa //10s//, //500ms// oder //2min//.
awa 11.28 144 ; Vorher immer PING durchführen
145 : 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.
146
147 === Standardeinstellung für Anfragen ===
148
149 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.
150
151 ; ID der Dienstleistung aus BIS
152 : 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.
153 ; Präfix für die ID des Vorgangs im Postkorb
154 : 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.
155
156 === TLS/SSL-Einstellungen ===
157
158 Diese Einstellungen sind nur erforderlich, falls der Server der Postkorbschnittstelle Zertifikate verwendet, die nicht auf dem FORMCYCLE-Server beziehungsweise im Java-Truststore vorhanden sind.
159
160 ; Zusätzliches Zertifikat für TLS/SSL (Mandantdatei)
161 : Der Name einer Mandantdatei mit einem gültigen X509-Zertifikat.
162 ; Passwort für das Zertifikat
163 : Das Passwort, um das angegebene Zertifikat öffnen zu können.
164
165 === HTTP-Basic-Auth-Einstellungen ===
166
167 Diese Einstellungen sind nur erforderlich, falls der Server der Postkorbschnittstelle eine HTTP-Basic-Authentication erfordert.
168
169 ; Nutzername für HTTP-Basic-Auth
170 : Der zu benutzende Benutzername für HTTP-Basic-Auth.
171 ; Passwort für HTTP-Basic-Auth
172 : Das zu benutzende Passwort für HTTP-Basic-Auth.
173
174 === Proxy-Server-Einstellungen ===
175
176 Diese Einstellungen sind nur erforderlich, falls der FORMCYLE-Server einen Proxy-Server benötigt, um sich mit der Postkorbschnittstelle verbinden zu können.
177
178 ; URL des Proxy-Servers
179 : Die URL des Proxy-Servers.
180 ; Port des Proxy-Servers
181 : Der Port des Proxy-Servers.
182 ; Nutzername für Proxy-Server
tkr 15.13 183 : Nutzername, falls nötig, um eine Verbindung zum Proxy-Server herzustellen.
awa 11.28 184 ; Passwort für den Proxy-Server
tkr 15.13 185 : Nutzername, falls nötig, um eine Verbindung zum Proxy-Server herzustellen.

Navigation

Copyright 2000-2025