Description
Registers the scheduled definition that will start the automated operation process. With this operation component, you can check and update registered scheduled definitions from the scheduled definition screen. Also, from the process status screen, performance management of the execution status is possible.
Options
Basic Options
Name of the automated startup operation process. Specify up to 64 characters. Only automated operation processes within the same process group can be specified.
In the following cases, an error will occur:
If the automated operation process is omitted
If there is not the permission to start the specified automated operation process
If a nonexistent automated operation process has been specified
Schedule Definition name. Specify up to 50 characters.
The following characters, whitespace, and user defined characters cannot be included. Also, # cannot be specified as the first character:
? \ * " < > | / : ; , ' .
In the following cases, an error will occur:
If the same Schedule Definition or Schedule Pattern as the specified Schedule Definition name already exists in the process group
If invalid characters are specified
If a Schedule Definition name of more than 50 characters is specified
Specifies startup day. Specify using the format yyyymmdd. A date up to three years into the future from the process instance startup date can be specified.
In the following cases, an error will occur:
If the startup day is omitted
If an incorrect format is specified
If an incorrect date is specified
Startup time. Specify using the format hhmm. The valid range is from 0000 to 2359. Startup will occur on the date set in (3) at the time set in (4). If specified in an incorrect format, an error will occur.
Advanced Options
The value set for the UDA at the startup time of the automated operation process. Set in the format uda name=value. If carrying out multiple settings, set in CSV format. For input formats and cautions, refer to "3.17 Notes on Specifying Multiple Input Parameters".
Explanations for the Schedule Definitions. Specify up to 128 characters. If the limit of 128 bytes is exceeded, an error will occur.
Execution estimation time. The valid range is from 1 to 9999 (minutes). If this is omitted, the value will be set to 15 (minutes). If a value other than 1 to 9999 is set, an error will occur.
Completion timeout (in seconds) for the execution of operation components.
The valid range is from 300 to 86,400 (1 day).
For example, this is the completion timeout for 10 minutes: 600
If the execution of the operation component is not completed even after the specified time is exceeded, the operation component process will be suspended with a return value of 201.
Retry count for the execution of operation components.
If the operation component terminates with a return value of 161, it specifies the number of times startup is to be retried. Values between 0 and 5 can be specified.
As a result of retrying, if the operation components ended with return values other than 161, the execution of the operation component ends even if it doesn't reach the specified retry count. The return values of the operation component become the value executed at the end.
For example: When retries are to be performed twice: 2
Retry interval (seconds) for operation components.
If the operation component ends with a return value of 161, the startup retry interval is specified. Values between 1 and 14400 can be specified.
For example: When retrying in 300 seconds: 300
If specification of 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 | Schedule Definitions successfully registered. |
| Failure | 161 | Schedule Definitions registration failed. Retry if a retry count has been specified. |
171 | You do not have the permissions to start the specified process definition. | ||
172 | A schedule or Schedule Pattern with the same name already exists. | ||
173 | The specified process definition does not exist or is not public. | ||
197 | There is an error in the option content. | ||
200 | Schedule Definitions registration failed. | ||
- | - | 201 | Execution of the operation component timed out. |
202 | The operation component was not executed. There is a problem in the setting to execute operation components. | ||
203 | Failed to execute the operation component. There is a problem in the Management Server environment. | ||
205 | The operation component was not executed. There is a problem in the operation component input information specification. | ||
206 | The operation component was not executed normally. There is a problem in the operation component output information specification. | ||
207 | The operation component was not executed. There is a possibility that the operation components are not registered in the Management Server. | ||
208 | The Automated Operation Process has been cancelled because the Automated Operation Process was recovered while the operation component was executing. |
Output Information
Variable | Description |
|---|---|
message | If registration of Schedule Definitions is successful, set the following message: The operation component was successful. If Schedule Definition registration failed, the error content is set as a string. |
result | Set the Schedule Definition ID and Schedule Definition name as a result of registration. Output example: schedule_definition_id:1 schedule_definition_name:schedule_def_name |
scheduledef_id | Set the registered Schedule Definition ID. |
scheduledef_name | Set the registered Schedule Definition name. |
returnCode | Set the return value. |
Notes
Return value checks are carried out on the Web console. Refer to "Confirming the Operation Component Execution Status/Execution Results" in the Systemwalker Runbook Automation Operation Guide for details.
If a return value from 201 to 208 is output, the automated operation process is cancelled or an error condition occurs, and error messages are output to the following locations:
Management Server event log (if Management Server is running on Windows (R))
Management Server sys log (if Management Server is running on Linux)
BMPN custom message
Check messages at the locations noted above and take appropriate remedial action. Refer to the Systemwalker Runbook Automation Message Guide for details.
