HCL Workload Automation, Version 9.4

Driving HCL Workload Automation with the Web services interface

Use the Web Services interface to perform a subset of HCL Workload Automation and IBM Workload Scheduler for z/OS functions to manage jobs and job streams in the plan, from your own web client application. Neither database actions nor other plan actions can be implemented and invoked using this interface.

Whenever you install an HCL Workload Automation component that includes the WebSphere Application Server, the following WSDL files are automatically installed:
SchedulingFactory.wsdl
Use these services to submit jobs or job streams to the plan and identify jobs and job streams in the plan that match defined criteria.
JobService.wsdl
Use these services to view the properties of jobs in the plan, view the job output, set selected properties, release all dependencies, cancel, and kill jobs in the plan.
JobStreamService.wsdl
Use these services to view the properties of job streams in the plan, view the job stream output, set selected properties, release all dependencies, and cancel job streams in the plan.
They are installed in the following path:
<WAS_profile_path>/installedApps/DefaultNode/<component_path>
where the default value of <WAS_profile_path> is <TWA_home>/WAS/TWSprofile and <component_path> depends on which components are installed:
z/OS® connector
ZConnector.ear/PlanServicesWeb.war/WEB-INF/wsdl
Other HCL Workload Automation components
TWSEngineModel.ear/PlanServicesWeb.war/WEB-INF/wsdl
If you have both the z/OS Connector and a HCL Workload Automation component installed, the files will be present twice (but have the same content).
Open these WSDL files with a Web Services development tool. They provide you with:
  • The server part interfacing the master domain manager to perform the supported subset of scheduling operations against jobs and job streams in production.
  • A means of creating your own client interface from where service requesters can request to perform a subset of operations from any system in your environment

The same set of services is delivered for both HCL Workload Automation and IBM Workload Scheduler for z/OS environments. However, some can be used in only one environment, and many of them have different parameters in the different environments, so they are documented separately for the two environments.

The Web Services interface is described in the following topics: