4.2.5 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 Respond dialog box. You can also set up email notification to notify the operator that a task is waiting for a response.
The methods of accessing the Respond dialog box are as follows:
-
Linking from the URL in the response wait notification mail
-
Linking from the Tasks view
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 Service Share Properties view.
-
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 dialog box 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 dialog box 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 dialog box for that step.
-
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 -1 appears for the step in the Task Details dialog box. 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 dialog box.
-
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:
-
![[Figure]](GRAPHICS/SR010001.GIF)
Version
01.00.00
Category
Hitachi/Basic
Return codes
|
Return code |
Description |
|---|---|
|
-1 |
The task was forcibly terminated while the plug-in was executing. -1 appears as the return code of the step in the Task Details dialog box. |
|
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:
|
|
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. |
|
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.
|
utf-8 |
Input |
O |
|
dialogText |
Response Input Dialog Box |
Specify the information to display in the Respond dialog box 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 dialog box. |
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 dialog box. 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 dialog box. 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 dialog box. 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 dialog box. 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 dialog box. 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 dialog box. 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 dialog box. 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.
|
Specifiable tag |
Specifiable attributes |
|---|---|
|
Anchor tag (<a>)#1 |
|
|
Bold tag (<b>) |
-- |
|
Break tag (<br>) |
-- |
|
Font tag (<font>) |
|
|
Italic tag (<i>) |
-- |
|
Underline tag (<u>) |
-- |
- Legend:
-
--: Not applicable.
- #1
-
Link text is not displayed in blue. Specify _blank for the target attribute.
- #2
-
You can access the JP1/IM - NP interface from the Respond dialog box 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 dialog box.
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>
-
- #3
-
Specify the color value in hexadecimal (#000000 to #FFFFFF).
Related topics
-
Linking to the JP1/Base authentication function in the Job Management Partner 1/Automatic Operation Configuration Guide
-
Linking with JP1/Base authentication in the Job Management Partner 1/Automatic Operation Administration Guide
-
Linking with JP1/IM-NP business content in the Job Management Partner 1/Automatic Operation Administration Guide