Previous Topic

Next Topic

Book Contents

Book Index

Web Services parameters

The following table describes the parameters for a Web Services Job.

NOTE: Take into consideration that some parameters might not appear in your properties pane, if they were not specified in the User View you applied. Use Control-M rules if the parameter rules were not specified by the Site Standard.

Parameter

Description

Connection Profile

Defines the Control-M for Web Services connection profile.

Control-M rules:

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

NOTE: No special characters can be included with the name definition.

URL/WSDL

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

Control-M rules:

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

Service

Defines a service provided by the company or business. Control-M rules:

  • Up to 214 characters
  • Case sensitive

Method (REST)

Defines the HTTP method used when executing the REST Job.

Control-M rules:

  • Up to 214 characters
  • Case sensitive
  • GET
  • POST
  • PUT
  • DELETE
  • HEAD
  • OPTIONS

Path

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

Control-M rules:

  • Up to 214 characters
  • Case sensitive

Operation

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

Control-M rules:

  • Up to 214 characters
  • Case sensitive

Use parameters from input file

Enables you to invoke the target web service with predefined SOAP message from the specified input file. Control-M rules:

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

Edit SOAP Request/Edit Body Request

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

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. Control-M rules:

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

Input parameters

Specifies values for each selected parameter.

Control-M rules:

  • Up to 212 characters
  • Case sensitive

HTTP Code

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

Array Size

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

Control-M rules:

  • Up to 2 digits
  • Any integer up to 99

Output parameters

Specifies the outcome of selected output parameters. Control-M rules:

  • Up to 212 characters
  • Case sensitive

Exclude Job Output

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

No Output Banner

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

Override URL Endpoint

Specifies 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.

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).

Override CONTENT-TYPE

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

Override connection timeout (sec)

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

Parent Topic

Job types