Top
Systemwalker Runbook Automation Reference Guide
Systemwalker

3.14.5 Delete Schedule Definitions

Description

Deletes specified scheduled definitions

Options

Basic Options

(1) schedule_definition_id

Specifies the Schedule Definitions ID to be deleted. If the Schedule Definition ID is omitted, an argument error will occur. An argument error will also occur if a nonexistent Schedule Definition ID is specified.

Only Schedule Definitions registered by the startup user for the process instance deployed by this operation component can be deleted. If any other Schedule Definition ID is specified, an error will occur.

Advanced Options

(1) timeout

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.

(2) retry

Retry count for the execution of operation components.

If the operation component terminates with a return value of 161 or 172, 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

(3) retry_interval

Retry interval (seconds) for operation components.

If the operation component ends with a return value of 161 or 172, 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 "Definition File for Operation Components" for details.

Return Values

Icon

Name

Return value

Description

Success

0

Schedule Definitions successfully deleted.

Description: C:\Documents and Settings\workspace\MANUAL\02_doc\ref\img\intermediate-error-20.gif

Failure

161

Failed to delete Schedule Definitions. Retry if a retry count has been specified.

171

Failed to delete Schedule Definitions. You do not have permission to delete the specified Schedule Definitions.

172

Failed to delete Schedule Definitions. There is a process instance during the startup process. Retry if a retry count has been specified.

173

Failed to delete Schedule Definitions. Specified Schedule Definitions do not exist.

197

There is an error in the option content.

200

Failed to delete Schedule Definitions.

-

-

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 Operation Server environment.

205

The operation component was not executed. There is a problem in the input information of the operation components.

206

The operation component was not executed normally. There is a problem in the setting to execute operation components.

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 deletion of Schedule Definitions is successful, set the following message:

The operation component was successful.

If Schedule Definitions deletion failed, the content of the error is set as a string.

result

Set the Schedule Definition ID and Schedule Definition name as a result of deletion.

Output example:

schedule_definition_id:1 schedule_definition_name:schedule_def_name

scheduledef_id

Set the deleted Schedule Definitions ID.

scheduledef_name

Set the deleted Schedule Definition name.

returnCode

Set the return value.

Notes