Top
Systemwalker Runbook Automation Reference Guide
Systemwalker

3.6.5 Execute Web service

Description

This operation component connects to a host that provides the Web service and executes the service using Web Service Definition Language (WSDL).

Options

Basic Options

(1) wsdlpath

This is the URL address of the WSDL which executes the Web service.

The maximum length of the string for the URL address is 1,024 characters. An argument error occurs if this is exceeded.

An argument error will occur if the URL address is omitted.

Example For IPv4: http:// 192.0.2.0/webservice?wsdl

Example For IPv6: http:// [2001:db8:20:3:1000:100:20:3]/webservice?wsdl

(2) methodname

This is the method name for the Web service which is executed.

The maximum length of the method name for the Web service is 1,024 characters. An argument error occurs if this is exceeded.

An argument error will occur if the method name for the Web service is omitted.

The specified parameter value is converted to the UTF-8 character encoding before communications are performed.

Example: getServerInfo

Advanced Options

(1) parametername

This is the parameter for the method which is executed.

Multiple parameters can be specified.

The maximum number of parameters is 100.An argument error occurs if this is exceeded.

The specified parameter value is converted to the UTF-8 character encoding before communications are performed.

The specification is in CSV format. Refer to "3.17 Notes on Specifying Multiple Input Parameters" for examples of multiple specifications.

If this option is specified, the parametervalue option must also be specified. An argument error occurs if the parametervalue option is omitted.

Specify the parameters as below.

Example: serverURL,serverPort,serverUserName,serverPassword

(2) parametervalue

This is the parameter value for the method which is executed.

Multiple parameter values can be specified. The order in which they are specified is the same as for parametername.

The maximum number of parameter values is 100.An argument error occurs if this is exceeded.

The specified parameter value is converted to the UTF-8 character encoding before communications are performed.

The specification is in CSV format. Refer to "3.17 Notes on Specifying Multiple Input Parameters" for examples of multiple specifications.

If this option is specified, the parametername option must also be specified. An argument error occurs if the parametername option is omitted.

Specify the parameter values as below.

Example: 192.0.2.0,8080,RBA_ADMIN,systemwalker1

(3) returnpropname

This is the property name for the execution results of the executed Web service.

Multiple property names can be specified.

If the property name for the execution results of the Web service is omitted, the execution result target are returned directly.

The maximum number of property names is 100.An argument error occurs if this is exceeded.

The specification is in CSV format. Refer to "3.17 Notes on Specifying Multiple Input Parameters" for examples of multiple specifications.

Specify the property names as below.

Example: driverName,memoryInfo,diskInfo

(4) timeout

This is the completion timeout (seconds) for the execution of operation components.

Values between 300 and 86400 (1 day) can be specified.

Example) If the completion timeout is 10 minutes: 600

If the operation component has not finished executing even though the specified time has passed, the processing for the operation component will be interrupted with return value 201.

(5) retry

This is the retry count for the execution of operation components.

Specify the number of retry attempts to be used when operation components terminate with return value 161. Values between 0 and 5 can be specified.

If an operation component terminates with a return value other than "161" as a result of being re-executed from a retry, execution of the operation component will terminate even if the specified number of retries has not been reached. The return value for the operation component will be the value from the last time the operation component was executed.

Example) To retry the operation component twice: 2

(6) retry_interval

This is the retry interval (seconds) for operation components.

Specify the time to wait before a retry is attempted if operation components terminate with return value 161. Values between 1 and 14400 can be specified.

Example) To retry at 300 second intervals: 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

The Web service has executed successfully.

Failure

161

The Web service failed to execute. If a retry count has been specified, retries will be attempted.

177

There is a problem with the WSDL file.

180

An attempt to acquire the execution result property failed.

188

Communications closed during execution.

189

An attempt to connect to the server failed.

197

There is an error with the input information.

200

Execution of the Web service terminated abnormally.

-

-

201

Execution of the operation component timed out.

202

The operation component has not been executed. There is a problem with the settings for executing the operation component.

203

The operation component has not been executed normally. There is a problem with the Management Server environment.

205

The operation component has not been executed. There is a problem with the input information specification of the operation component.

206

The operation component has not been executed normally. There is a problem with the output information specification of the operation component.

207

The operation component has not been executed. The operation component may not have been registered on 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 the Web service is executed successfully.

The operation component was successful.

If the Web service fails to execute, the content of the error will be output as a string.

web_service_result

This variable is set to the execution results of the Web service, using the following format.

[propname1],[propvalue1]
[propname2],[propvalue2]
[propname3],[propvalue3]

Example: If the "returnpropname" option is "driverName,memoryInfo,diskInfo"

"driverName","MS2000Driver"
"memoryInfo","4000MB"
"diskInfo","500GB"

returnCode

This variable is set to the return value.

Notes

Check for messages in these locations and take the appropriate action. Refer to the Systemwalker Runbook Automation Message Guide for details.