Web Services Job

Control-M for Web Services enables you to schedule standard Web services, servlets and RESTful Web services.

The following table describes the Web Services job type attributes:

Attribute

Description

Connection Profile

Defines the Control-M for Web Services connection profile.

Rules:

  • 1-50 characters (only capital letters)
  • Integers between 0 and 9
  • _ (underscore)
  • - (dash, hyphen)
  • A-Z characters

No special characters can be included with the name definition.

Variable Names:

  • %%WS-ACCOUNT

  • %%JAVA-PROFILE

  • %%MSG-ACCOUNT

URL/WSDL

Defines a URL or fully qualified filename pointing to the WSDL of the web service.

Rules:

  • Up to 214 characters
  • Alphanumeric string. Cannot begin with a number and blank spaces are not permitted.

Variable Names

  • REST: %%WS-URL

  • Local File System and Web Service URL: %%WS-WSDL

Service

Defines a service provided by the company or business.

Rules:

  • Up to 214 characters
  • Case sensitive

Variable Name: %%WS-SERVICE

Method (REST)

Determines the HTTP method used when executing the REST Job.

Rules:

  • Up to 214 characters

  • Case sensitive

  • GET

  • POST

  • PUT

  • DELETE

  • HEAD

  • OPTIONS

Variable Name: %%WS-SERVICE

Path

Defines a path available for the method specified in the Method field.

Rules:

  • Up to 214 characters
  • Case sensitive

Variable Name: %%WS-OPERATION

Operation

Defines an operation available for the service specified in the service field.

Rules:

  • Up to 214 characters
  • Case sensitive

Variable Name: %%WS-OPERATION

Use parameters from input file

Enables you to invoke the target web service with predefined SOAP message from the specified input file.

Rules:

  • Up to 214 characters
  • Any character string representing the file name including the file path.

Variable Name: %%WS-INPUTPUTFILE

Edit SOAP Request/Edit Body Request

Enables you to generate your own SOAP request for REST web services.

WS-SOAPREQUEST-Pxxx-STR

Represents part of the SOAP request string. xxx in Pxxx represents the xxxth part of the SOAP request string divided in numerical order.

Add SOAP Header from file

Adds a predefined SOAP Header to the invocation of the target web service SOAP message, taken from a file specified in the Header File field.

Rules:

  • Up to 212 characters
  • Any character string representing the file name including the file path.

Variable Name: %%WS-SOAPHEADERFILE

Input parameters

Defines values for each selected parameter.

Rules:

  • Up to 212 characters
  • Case sensitive

Variable Name: %%WS-PARMS-P00n-NAME

Where n refers to the nth parameter of the corresponding method. For example, if there were two parameters for a particular method, the first parameter would use P001(%%WS-PARMS-P001-NAME), and the second parameter would use P002 (%%WS-PARMS-P002-NAME).

HTTP Code

Enables you to enter the different Job output data based on the HTTP return status code.

Variable Name: %%WS-OUTPARMS-Pxxx-HTTPCODE

Array Size

Defines a number of items in an input parameter array applicable to the Input parameters of the web services invocation when necessary.

Rules:

  • Up to 2 digits
  • Any integer up to 99

Variable Name: %%WS-ARRAYSIZE

Output parameters

Defines the outcome of selected output parameters.

Rules:

  • Up to 212 characters
  • Case sensitive

Variable Name: %%WS-PARMS-P001-VALUE

P001 represents the number of the parameter for the chosen method. For example, if there were two parameters for a particular method, the second parameter would use P002 instead of P001 (%%WS-PARMS-P002-VALUE)

Exclude Job Output

Excludes information about Job output from the Output at the end of a Job execution.

Variable Name: %%WS-SYSOUTSKIP

No Output Banner

Defines whether an Output banner is written to the Output at the end of a Job execution.

Variable Name: %%WS-NOSYSOUTBANNER

Jobs only end NOTOK when an exception occurs from the Java method. If this happens, the job end status is set to NOTOK and the exception is printed into the output. If a system.exit() command is executed, Control-M for Java converts the call into an exception. This means that the job ends NOTOK, and the detailed exception is displayed in the Output. In all other cases, jobs end OK.

Override URL Endpoint

Defines the URL endpoint at the Job definition level. Upon Job submission Control-M for Web Services uses Job definition's Endpoint URL rather than the URL. Case sensitive.

Variable Name: %%WS-URLENDPOINT

Preemptive authentication

Enables you to enter the HTTP Basic Authentication information in the format of <user>@<realm> that matches the information in HTTP Basic Authentication field in the Control-M for Web Services Connection Profile Management (CCM).

Variable Name: %%BPI-PREAUTH

Override CONTENT-TYPE

Defines a preferred HTTP header Content-Type to be used to execute the Job. Case sensitive

Variable Name: %%WS-CONTENTTYPE

Override connection timeout (sec)

Limits the connection time when waiting for the web service to respond before disconnecting.

Variable Name: %%WS-CONNECTIONTIMEOUT