4.2.6 User-response wait plug-in

Function

This plug-in enables the operator to select the processing of the succeeding step during the execution of the service. To select the processing, the operator uses the Enter Response window. You can also set up email notification to notify the operator that a task is waiting for a response.

The methods of accessing the Enter Response window are as follows:

Linking from the URL in the response wait notification mail
Using the task list displayed in the Tasks or Debug tab of the Tasks window
Using the Task Details window

Prerequisites for execution

The following information is obtained from shared built-in service properties. Therefore, if you want the operator to be notified when a task is waiting for a response, set the values for these items in advance in the System Settings area of the Administration window.
- Address of the SMTP server
- Port number
- User ID
- Password
- Originator of the notification email

Cautionary notes

The email reporting that a task is waiting for a user response is not sent if any of the following applies:
- No value is set in the shared built-in service property
- SMTP has not been set up
- None of the toAddress, ccAddress, and bccAddress properties are specified
- An invalid email address is specified in any of the toAddress, ccAddress, and bccAddress properties

The mail address to be specified differs from the value of the built-in server share property. Therefore, make sure that you specify at least one of the toAddress, ccAddress, and bccAddress properties.
Do not stop the execution of the user-response wait plug-in while the Respond window is displayed and waiting for operator response. Stopping the execution causes an error even if the operator selects the processing for the subsequent step.
A URL that links to the Respond window is automatically entered in the body of the notification email. If more than one step in a given task is waiting for a response, each step that executes the user-response wait plug-in will have a different URL, with each URL displaying the Respond window for that step.
If you stop a task during plug-in execution, any processing that is in progress is immediately terminated and the task enters the Failed status.
If you forcibly terminate a task while the plug-in is executing, the processing being executed is immediately forcibly terminated and the task enters the Failed status. A return code of 80 appears for this step in the Flow area of the Tasks window. The return code output to the task log depends on the timing with which the task was forcibly terminated.
You cannot change the layout of the Respond window.
Any return code from the properties labelButton1 to labelButton9 is considered an abnormal end, and error information is output to the task log. For the labelButton0 property and the properties labelButton1 to labelButton9, if the output log level is 10 or 20, the details to be output in the task log differ depending on the response result.
If you use machine-dependent characters or characters that are incompatible between character sets in the mailSubject or mailBody property, the characters are replaced with question marks (?) or other characters. In this scenario, either change the characters in the email, or change the encoding.

The following characters might not be converted correctly:
If parallel is specified for the foreachMode property of the repeated execution plug-in, changing the parameter of the service property on the user-response wait plug-in under the repeated execution plug-in sometimes updates the unexpected value, please don't change the contents of the service property (do not specify input tag (<input>)).

Version

01.01.00

Tag

User Interaction

Return codes

Return code	Description
0 to 9	Returns the return code corresponding to the `labelButton1` to `labelButton9` properties. If a timeout occurs while waiting for a response, the value specified in the timeOutDefault property is returned as the return code. Therefore, the meaning of the return code depends on the service template that is using the plug-in.
10 to 63	If a timeout occurs while waiting for a response, the value specified in the `timeOutDefault` property is returned as the return code.
65	The connection with the JP1/AO server failed. For example, the JP1/AO server might have stopped while the plug-in was executing.
66	The following user is mapped to the JP1 user: A user who does not belong to the Administrators group. A user other than the built-in Administrator who belongs to the Administrators group, in an environment with UAC enabled.
68	There is no information about the target job execution ID.
69	An environment variable of the task-processing engine could not be acquired.
80	Task execution has stopped.
81	The plug-in was called in an invalid status.
82	The request message from the task-processing engine could not be correctly parsed.
83	The environment of the JP1/AO server is corrupted.
84	Information about the specified plug-in could not be obtained.
86	The value specified as the mapping parameter in the Response Input dialog box is invalid.
127	Another error has occurred.

Property list

The following table describes the properties.

Property key	Property name	Description	Default value	I/O type	Required
`toAddress`	To Addresses	Specify the email addresses of recipients to enter in the TO attribute, using no more than 1,024 characters. When specifying multiple addresses, separate them with commas.	--	Input	O
`ccAddress`	Cc Addresses	Specify the email addresses of recipients to enter in the CC attribute, using no more than 1,024 characters. When specifying multiple addresses, separate them with commas.	--	Input	O
`bccAddress`	Bcc Addresses	Specify the email addresses of recipients to enter in the BCC attribute, using no more than 1,024 characters. When specifying multiple addresses, separate them with commas.	--	Input	O
`mailSubject`	Subject	Specify the subject line of the email using no more than 256 characters.	--	Input	O
`mailBody`	Body	Specify the body text of the email using no more than 1,024 characters.	--	Input	O
`encodeType`	Encoding	Specify the encoding of the email as one of the following: If you do not specify a value for this property, utf-8 is assumed. `us-ascii` `iso-2022-jp` `shift_jis` `euc-jp` `utf-8`	`utf-8`	Input	O
`dialogText`	Response Input Dialog Box	Specify the information to display in the Respond window using 1,024 characters or less. You can specify the information in text or HTML format.	--	Input	O
`responseTimeOut`	Response Timeout	Specify the time period, between 1 and 9,999 (in minutes), before timeout occurs while waiting for a response.	1440	Input	R
`timeOutDefault`	Default Return Value	Specify the return code to return when a timeout occurs while waiting for a response. When the timeout period has passed, this value is returned as the return code. For example, when `0` is specified and the timeout period elapses, the processing corresponding to the button associated with the `labelButton0` property will be executed. Specify a return code in the range from 0 to 63.	0	Input	R
`labelButton0`	Label Button 0	Specify the button label for the response that generates return code 0, using a maximum of 256 characters. You can display buttons that meets the user's operational needs in the Respond window.	OK	Input	R
`labelButton1`	Label Button 1	Specify the button label for the response that generates return code 1, using a maximum of 256 characters. You can display a button that meets the user's operational needs in the Respond dialog box. If you omit this property, the corresponding button is not displayed.	--	Input	O
`labelButton2`	Label Button 2	Specify the button label for the response that generates return code 2, using a maximum of 256 characters. You can display a button that meets the user's operational needs in the Respond dialog box. If you omit this property, the corresponding button is not displayed.	--	Input	O
`labelButton3`	Label Button 3	Specify the button label for the response that generates return code 3, using a maximum of 256 characters. You can display a button that meets the user's operational needs in the Respond window. If you omit this property, the corresponding button is not displayed.	--	Input	O
`labelButton4`	Label Button 4	Specify the button label for the response that generates return code 4, using a maximum of 256 characters. You can display a button that meets the user's operational needs in the Respond window. If you omit this property, the corresponding button is not displayed.	--	Input	O
`labelButton5`	Label Button 5	Specify the button label for the response that generates return code 5, using a maximum of 256 characters. You can display a button that meets the user's operational needs in the Respond window. If you omit this property, the corresponding button is not displayed.	--	Input	O
`labelButton6`	Label Button 6	Specify the button label for the response that generates return code 6, using a maximum of 256 characters. You can display a button that meets the user's operational needs in the Respond window. If you omit this property, the corresponding button is not displayed.	--	Input	O
`labelButton7`	Label Button 7	Specify the button label for the response that generates return code 7, using a maximum of 256 characters. You can display a button that meets the user's operational needs in the Respond window. If you omit this property, the corresponding button is not displayed.	--	Input	O
`labelButton8`	Label Button 8	Specify the button label for the response that generates return code 8, using a maximum of 256 characters. You can display a button that meets the user's operational needs in the Respond window. If you omit this property, the corresponding button is not displayed.	--	Input	O
`labelButton9`	Label Button 9	Specify the button label for the response that generates return code 9, using a maximum of 256 characters. You can display a button that meets the user's operational needs in the Respond window. If you omit this property, the corresponding button is not displayed.	--	Input	O

HTML tags and attributes that can be specified in the dialogText property

When specifying the display contents in the dialogText property in HTML format, use the tags listed in the following table.

Table 4‒6: List of HTML tags and attributes available in the dialogText property
Specifiable tag	Specifiable attributes	Notes
Anchor tag (<a>)^#1	href	Specify an absolute URL that begins with `http://` or `https://`. You can access the JP1/IM - NP interface from the Respond window by using a single sign-on. To allow single sign-ons, you must specify the link to the JP1/IM - NP interface in the href attribute, and include in the link the placeholder for the JP1 token. The placeholder for the JP1 token is `[JP1TOKEN]` (not case sensitive). `[JP1TOKEN]` is replaced by the JP1 token in the Respond window. However, both of the following conditions must be met for this to take place: The `href` attribute is enclosed by double quotation marks ("). The external authentication linkage function (linkage with the authentication features of JP1/Base) is enabled. The character string `[JP1TOKEN]` can be replaced only once within a given anchor tag. Do not specify `[JP1TOKEN]` more than once. An example of specifying the `dialogText` plug-in property is shown below. Apply the security patch manually by referring to the link below. After applying the security patch, click OK.<br><a href="http://localhost:9999/ucnpBase/portal/screen/Home/action/PLoginUser?jp1token=[JP1TOKEN]" target="_blank">Manual security patch application procedure</a>
Anchor tag (<a>)^#1	target	--
Bold tag (<b>)	--	--
Break tag (<br>)	--	--
Font tag (<font>)	color	Specify the color value in hexadecimal (#000000 to #FFFFFF).
	face	--
	size	--
Italic tag (<i>)	--	--
Underline tag (<u>)	--	--
Form tag (<form>)	--	--
Input tag (<input>)^#2	`name`	If you specify a service property key, you can change the mapping parameters of that service property in the Response Input dialog box when the system is waiting for a response. If you specify `password` for the `type` attribute, specify `password` for the data type of the service property you map. A string printed to entered-value of the KNAE08352-I message written to the task log changes depending on the data type, as follows: `password` type: ******** Not `password` type: The entered value
	`type`	The specifiable values are as follows: `text` `checkbox` `radio` `password`
	`value`	If you specify `checkbox` or `radio` for the `type` attribute, you must also specify a value for the `value` attribute. The values specified for the `value` attributes of the selected check boxes or radio buttons become the mapping parameters of the service property specified for the `name` attribute.
Select tag (<select>)	`name`	If you specify a service property key, you can change the mapping parameters of that service property in the Response Input dialog box when the system is waiting for a response.
option tag (<option>)^#3		The values specified for the `value` attributes of the items selected in a menu or list box become the mapping parameters of the service property specified for the `name` attribute.

Legend:: --: Not applicable.

#1: Link text is not displayed in blue. Specify _blank for the target attribute.

#2: If you change a parameter of the service property for the user-response wait plug-in under the repeated execution plug-in (parallel), you might update an unexpected value. Make sure that you do not change any value of the service property (do not specify an input tag) for the user-response wait plug-in under the repeated execution plug-in (parallel).

#3: Enclose option tags in Select tags.

Related topics

Linking to the JP1/Base authentication function in the JP1/Automatic Operation Configuration Guide
Linking with JP1/Base authentication in the JP1/Automatic Operation Administration Guide
Linking with JP1/IM-NP business content in the JP1/Automatic Operation Administration Guide

To Page Top