Zusammenfassung

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

Details

Seiteneigenschaften

Inhalt

...	...	@@ -18,15 +18,15 @@
18	18	Click on //New action// to add a new Postkorb action to the workflow.
19	19	{{/figure}}
20	20
21		-{{figure image="plugin_regioit_postkorb_workflow_action_base_de.png" width="400"}}
	21	+{{figure image="plugin_regioit_postkorb_workflow_action_base_en.png" width="400"}}
22	22	Basic settings for sending a message to a Postkorb message thread. Here you can the recipient and the content of the message.
23	23	{{/figure}}
24	24
25		-{{figure image="plugin_regioit_postkorb_workflow_action_advanced_de.png" width="400"}}
	25	+{{figure image="plugin_regioit_postkorb_workflow_action_advanced_en.png" width="400"}}
26	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.
27	27	{{/figure}}
28	28
29		-{{figure image="plugin_regioit_postkorb_workflow_action_guest_de.png" width="400"}}
	29	+{{figure image="plugin_regioit_postkorb_workflow_action_guest_en.png" width="400"}}
30	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.
31	31	{{/figure}}
32	32
...	...	@@ -82,7 +82,7 @@
82	82	; New message thread state
83	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.
84	84	; Message thread external ID
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 {{formycle/}}. 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.
	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.
86	86	; Message thread name
87	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.
88	88	; Message thread link
...	...	@@ -101,9 +101,50 @@
101	101
102	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.
103	103
104		-== Konfiguration des Plugins ==
	104	+=== Return values ===
105	105
106		-{{figure image="plugin_regioit_postkorb_settings_de.png" width="600"}}
	106	+After the plugin action was executed, the following additional [[action variables>>doc:Formcycle.UserInterface.Variables]] are available:
	107	+
	108	+; success
	109	+: //true// if the message could be sent to the Postkorb, //false// otherwise.
	110	+; status
	111	+: The status code as returned by the Postkorb web service, either //SUCCESS// or //ERROR//.
	112	+; messageThreadId
	113	+: 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.
	114	+; errorCode
	115	+: A numerical error code defined by this plugin. See the following list for the available codes.
	116	+; errorType
	117	+: Technical name of the error code, see below.
	118	+; errorDetails
	119	+: Localized name of the error code.
	120	+; exceptionMessage
	121	+: Message of the exception that was thrown by Java, if any.
	122	+
	123	+=== Error codes ===
	124	+
	125	+The following error codes are currently defined by this plugin:
	126	+
	127	+0 - SERVICE_COULD_NOT_BE_CREATED
	128	+The connection to the Postkorb web service could not be established.
	129	+10 - PING_REQUEST_FAILED
	130	+The PING request preceding the actual request failed (only if enabled in the configuration).
	131	+20 - INVALID_SERVICE_REQUEST
	132	+The request to the Postkorb web service contains invalid data and cannot be sent. Check the configuration of the plugin and the workflow action.
	133	+30 - POSTKORB_SERVICE_ERROR
	134	+The Postkorb web service did not return any response to the request. Check whether the web service is available and can be reached from your network.
	135	+40 - INVALID_SERVICE_RESPONSE
	136	+The response returned by the Postkorb web service is invalid and could not be parsed. Check the version of the web service and this plugin, you may have to update this plugin.
	137	+50 - SERVICE_REQUEST_FAILED
	138	+The Postkorb web service returned a response, but the status of that response was ERROR.
	139	+200 - INTERNAL_ERROR
	140	+A unexpected error occurred that cannot be specified further.
	141	+
	142	+
	143	+
	144	+
	145	+== Plugin configuration ==
	146	+
	147	+{{figure image="plugin_regioit_postkorb_settings_en.png" width="600"}}
107	107	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.
108	108	{{/figure}}
109	109