Description
This operation component executes an operation process and waits for the process to terminate. Operation process is executed by the number of parameters passed to the specified operation process up to 16 multiplicities. (Default: a multiplicity of 1)
For example, if you specify a multiplicity of 4 and 10 parameters, Runbook Automation runs 10 operation processes up to 4 multiplicities.
Options
Basic Options
The name of executed operation process.
The name specified here should specify the name of the operation process registered in the Management Server of Systemwalker Runbook Automation.
When the operation process corresponding to the specified name does not exist, it becomes an argument error.
To judge whether the specified operation process ends through a normal route or an error route, it is necessary to divide the Exit node that reaches normally and the Exit node that reaches abnormally.
The parameter passed to the executed operation process is specified.
It is necessary to specify the value in the form of the following.
Tag | Description | Remarks | ||
|---|---|---|---|---|
ParameterSet | Tag that shows sets of the entire parameters passed to operation process. | Number of occurrences:1 | ||
Parameter | Tag that shows parameter passed when operation process of one degree is executed. | Number of occurrences:1-128 | ||
Attribute name: ID Describe the number of the parameter by the sequential number from one. The value of ID is added to the end of the process instance name of the executed operation process. | Appearance: Essential | |||
Attribute name: ProcessInstanceID It is not necessary to specify it here. It is disregarded even if it specifies it. | Appearance: Optional | |||
Attribute name: Result The execution result of the operation process is stored. It is not necessary to specify it here. It is disregarded even if it specifies it. | Appearance: Optional | |||
Attribute name: ExitNodeName The name of the Exit node that reaches the operation process is stored. It is not necessary to specify it here. It is disregarded even if it specifies it. | Appearance: Optional | |||
TargetUDA | Tag corresponding to user definition attribute on executed operation process. | Number of occurrences: One or more | ||
Attribute name: Name Specify the name of the user definition attribute on the executed operation process. | Appearance: Essential *This version, the type supports only the user definition attribute of STRING | |||
Attribute name: Value Specify the value set to the user definition attribute on the executed operation process. | Appearance: Essential | |||
For example:
<?xml version="1.0" encoding="UTF-8"?>
<ParameterSet>
<Parameter ID="1">
<TargetUDA Name="hostname" Value="serverA"/>
<TargetUDA Name="patchId" Value="T999999XX-99,T888888XX-88"/>
</Parameter>
<Parameter ID="2">
<TargetUDA Name="hostname" Value="serverB"/>
<TargetUDA Name="patchId" Value="T999999XX-99"/>
</Parameter>
. . .
<Parameter ID="N">
<TargetUDA Name="hostname" Value="serverZ"/>
<TargetUDA Name="patchId" Value="T999999XX-99"/>
</Parameter>
</ParameterSet> |
Advanced Options
Specify the execution concurrency of operation processes.
It is possible to specify it within the range from 1 to 16.
If execution concurrency is omitted, 1 is specified.
This is the completion timeout (seconds) for the execution of operation components.
Values between 300 and 86400 (1 day) can be specified.
For example: When timeout is to occur every 10 minutes: 600
When the execution of the operation components is not completed even if the specified time passes, the processing of the operation components is interrupted in return value 201.
This is the retry count for the execution of operation components.
When the operation components end in return value 161, the retry count is specified. Values between 0 and 5 can be specified.
As a result of retrying, if the operation components ended by the return values other than 161, the execution of the operation components ends even if it does not reach the specified retry count. The return values of the operation components become the value executed at the end.
For example: When retries are to be performed twice: 2
This is the retry interval (seconds) for operation components.
When the operation components end in return value 161, the retry interval is specified. Values between 1 and 14400 can be specified.
For example: When retrying in 300 seconds: 300
If the specification of the timeout, retry and retry_interval is omitted and a value beyond the limits of the above-mentioned is input, the value specified with the operation components definition file becomes effective. Refer to "2.5 Definition File for Operation Components" for details.
Return Values
Icon | Name | Return value | Description |
|---|---|---|---|
| Success | 0 | Processing terminated normally. |
| Failure | 1-128 | The number of operation processes that ended without reaching the Exit node is returned. |
197 | There is an error in the option content. | ||
200 | Processing terminated abnormally. | ||
- | - | 201 | Execution of operation component timed out. |
202 | The operation component was not executed. | ||
203 | Failed to execute the operation component. There is a problem in the Operation Automation Server environment. | ||
205 | The operation components were not executed. There is a problem with the input information specification of the operation component. | ||
206 | The operation component was not executed normally. There is a problem with the output information specification of the operation component. | ||
207 | The operation components were not executed. There is a possibility that the operation components are not registered in the Management Server. | ||
208 | The Automated Operation Process has been canceled because the Automated Operation Process was recovered while the operation component was executing. |
Output information
Variable | Description |
|---|---|
message | This variable will be set to the following message if multiple operation processes are executed successfully. The operation component was successful. If multiple operation processes fail to execute, the content of the error will be output as a string. |
plural_designation_result | If multiple operation processes execute successfully, the execution results will be output as an XML format string. See below for details. |
non_arrival_number | This variable is set to the number of operation processes that executed but then terminated without reaching their Exit nodes. |
returnCode | This variable is set to the return value. |
plural_designation_result format
The execution result is output by the following formats.
Tag | Description | Remarks | ||
|---|---|---|---|---|
ParameterSet | Tag that shows sets of the entire parameters passed to operation process. | Number of occurrences:1 | ||
Parameter | Tag that shows parameter passed when operation process of one degree is executed. | Number of occurrences: One or more | ||
Attribute name: ID The value input before the operation process is executed enters. | Appearance: Essential | |||
Attribute name: ProcessInstanceID Process instance ID of the executed operation process is stored. | Appearance: Essential | |||
Attribute name: Result The execution result of the operation process is stored. When the operation process reaches the Exit node, "SUCCESS" is stored. When the error occurs, "ERROR" is stored. When the operation process is interrupted, "ABORTED" is stored. | Appearance: Essential | |||
Attribute name:ExitNodeName The name of the Exit node that reaches the operation process is stored. When not reaching the Exit node, the value is not set. | Appearance: Optional | |||
TargetUDA | Tag corresponding to user definition attribute on executed operation process. | Number of occurrences: One or more | ||
Attribute name:Name The value input before the operation process is executed enters. | Appearance: Essential | |||
Attribute name:Value The value stored in the user definition attribute corresponding to Name enters after the operation process is executed. | Appearance: Essential | |||
For example:
<?xml version="1.0" encoding="UTF-8"?>
<ParameterSet>
<Parameter ID="1" ProcessInstanceID="1010" Result="SUCCESS" ExitNodeName="Exit1">
<TargetUDA Name="hostname" Value="serverA"/>
<TargetUDA Name="patchId" Value="T888888XX-88"/>
</Parameter>
<Parameter ID="2" ProcessInstanceID="1020" Result="SUCCESS" ExitNodeName="Exit2">
<TargetUDA Name="hostname" Value="serverB"/>
<TargetUDA Name="patchId" Value="T999999XX-99"/>
</Parameter>
<Parameter ID="3" ProcessInstanceID="1030" Result="ERROR">
<TargetUDA Name="hostname" Value="serverC"/>
<TargetUDA Name="patchId" Value="T999999XX-99"/>
</Parameter>
...
<Parameter ID="N" ProcessInstanceID="1040" Result="ABORTED">
<TargetUDA Name="hostname" Value="serverZ"/>
<TargetUDA Name="patchId" Value="T999999XX-99"/>
</Parameter>
</ParameterSet>
|
Notes
The specified operation process (operation process specified with subflowname) should be stored in the same process group as the operation process including this operation component, and be put into the state to open the operation process specified with subflowname to the public.
The return value is confirmed with the Web console. Refer to "Confirming the Operation Component Execution Status/Execution Results" of Systemwalker Runbook Automation Operation Guide for details.
When the return value of 201-208 is output, the Automated Operation Process enters an abort or error state, and the error message is output to the following places.
Event log of Management Server (when the Management Server is Windows(R))
System log of Management Server (when the Management Server is Linux)
Custom message of BPMN
Confirm the message in either of the above-mentioned place, and take an appropriate action. Refer to the Systemwalker Runbook Automation Message Guide for details.
If the Automated Operation Process which executed by this operation component is paused or aborted, the operation process which executed by this operation component is not paused or not aborted. As necessary, execute to pause or abort operation process which executed by this operation component.
If the Automated Operation Process which executed by this operation component is paused, and if the operation process which executed by this operation component is paused, restart operation is required to execute in the following order.
Restarting operation process which executed by this operation component.
Restarting Automated Operation Process which run this operation component.
