Web Services Jobs
The following topics describe job attributes that work with Web Services jobs:
Web Services JobLink copied to clipboard
Control-M for Web Services enables you to schedule standard web services, servlets, and RESTful web services.
A web service is XML-based software that enables electronic devices to communicate via intranet or the internet. Servlets are small, Java-based programs that run on web servers, can access databases in response to user input, and add dynamic content to web sites. RESTful web services conform to the Representational State Transfer (REST) software architectural model and are used to create APIs for web-based applications.
To create a Web Services job, see Creating a Job.
The following table describes the Web Services job attributes.
Attribute |
Description |
---|---|
Connection Profile |
Determines the authorization credentials that are used to connect Control-M to Web Services. Rules:
Special characters cannot be included with the name definition. Variable Names:
For more information about creating a local connection profile for this job, see Creating a Local Connection Profile. |
URL/WSDL |
Defines a URL or fully qualified filename pointing to the WSDL, which is an XML-based notation that describes the web service. Rules:
Variable Names
|
Service |
Defines a service provided by the company or business. Rules:
Variable Name: %%WS-SERVICE |
Method (REST) |
Determines which of the following HTTP methods are used to execute the REST job:
Rules:
Variable Name: %%WS-SERVICE |
Path |
Defines a path available for the method specified in the Method (REST) field. Rules:
Variable Name: %%WS-OPERATION |
Operation |
Defines an operation available for the service specified in the Service field. Rules:
Variable Name: %%WS-OPERATION |
Use Parameters from Input File |
Defines an input file name and path, which enables you to invoke the target web service with a predefined SOAP message. Rules:
Variable Name: %%WS-INPUTPUTFILE |
Edit SOAP Request/Edit Body Request |
Enables you to generate your own SOAP request for REST web services, in the following format: 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 |
Defines the filename and path of a predefined SOAP Header, which is added to the invocation of the target web service SOAP message. Rules:
Variable Name: %%WS-SOAPHEADERFILE |
Input Parameters |
Defines details of the input parameters required by the web service. Rules:
Variable Name: %%WS-PARMS-P00n-NAME 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:
Variable Name: %%WS-ARRAYSIZE |
Output Parameters |
Defines the outcome of selected output parameters. Rules:
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 Not OK when an exception occurs from the Java method. If this happens, the job end status is set to Not OK and the exception is printed into the output. If a |
Override URL Endpoint |
Defines the URL endpoint at the job definition level. Upon job submission, Control-M for Web Services uses the job definition endpoint URL rather than the URL. Rule: Case-sensitive. Variable Name: %%WS-URLENDPOINT |
Preemptive Authentication |
Defines HTTP Basic Authentication information in the format of <user>@<realm>. This information must match the 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. Rule: Case-sensitive. Variable Name: %%WS-CONTENTTYPE |
Override Connection Timeout (sec) |
Determines the maximum number of seconds to wait for the web service to respond before disconnecting. Variable Name: %%WS-CONNECTIONTIMEOUT |
Web Services REST JobLink copied to clipboard
Web Services REST jobs enable you to design and execute single REST API calls.
To create a Web Services REST job, see Creating a Job. For more information about this plug-in, see Control-M for Web Services REST.
The following table describes the Web Services REST job attributes.
Attribute |
Description |
---|---|
Connection Profile |
Determines the authorization credentials that are used to connect Control-M to Web Services REST, as described in Web Services REST Connection Profile Parameters. Rules
|
Endpoint URL |
Defines the endpoint base URL, which is the common resource prefix that the API uses to navigate. https://batch.eu-west-2.amazonaws.com |
URL Request Path |
Defines the URL request path. /v1/submitjob |
Method |
Determines one of the following HTTP methods to run the REST job:
Rules:
Variable Name: %%WS-SERVICE |
URL Parameters |
Defines optional URL parameters, as Key:Value pairs. Key: Filter Value: Untitled Workflow |
HTTP Headers |
Defines optional HTTP headers, as Key:Value pairs.
If you created a connection profile that authenticates with OAuth2, as described in Web Services REST Connection Profile Parameters, you must define the following HTTP header key name and value:
|
Request Definition |
Determines whether to define a REST request body, and how to do so:
|
Body |
Defines the request body as textual input, in JSON format. |
filename |
Defines the full path to a local file that contains a predefined request body. /home/jobdefs/request-body.txt |
Output Parameters |
(Optional) Defines output handling that extracts values from the service response in either JSON or XML. The attribute consists of the following:
Rules:
|
Connection Timeout |
Determines the number of seconds to wait after Control-M initiates a connection request before a timeout occurs. Default: 50 |
Append Request |
Determines whether to append the API request to the output |
Append Response |
Determines whether to append the API response to the output. |
Web Services SOAP JobLink copied to clipboard
Web Services SOAP jobs enable you to design and execute single SOAP API calls.
To create a Web Services SOAP job, see Creating a Job. For more information about this plug-in, see Control-M for Web Services SOAP.
The following table describes the Web Services SOAP job attributes.
Attribute |
Description |
---|---|
Connection Profile |
Determines the authorization credentials that are used to connect Control-M to Web Services SOAP, as described in Web Services SOAP Connection Profile Parameters. Rules
|
Endpoint URL |
Defines the endpoint base URL, which is the common resource prefix that the API uses to navigate. https://batch.eu-west-2.amazonaws.com |
SOAP Action |
Defines a single SOAP action (operation), which you must take from the WSDL file. In the WSDL file, copy the SOAP action http://tempuri.org/SOAP.Demo.AddInteger from the body of the following operation and paste it in the SOAP Request field: CopyCopied to clipboard
|
Request Definition |
Determines one of the following requests to perform:
|
SOAP Request |
Defines the SOAP request. CopyCopied to clipboard
|
HTTP Headers |
(Optional) Defines HTTP header key names and values.
|
Output Parameters |
(Optional) Defines the following output parameters:
Rules:
|
Connection Timeout |
Determines the number of seconds to wait after Control-M initiates a connection request before a timeout occurs. Default: 50 |
Append Request |
Determines whether to append the API request to the output |
Append Response |
Determines whether to append the API response to the output. |