HCL Workload Automation, Version 9.4

editSubmitJobStreamWithVarSub

Describes the editSubmitJobStreamWithVarSub Web service for IBM Workload Scheduler for z/OS.

Description

Use this service to submit a job stream (application) in the IBM Workload Scheduler for z/OS plan and to perform some or all of the following actions:

Assign values to any variables present in the jobs included in the job stream
Add, modify, or delete jobs, and their internal dependencies, in the job stream

The variable substitution is performed only on promptable variables that are substituted at job set up phase. The other variables are substituted at submission time.

Note: The job stream must include no setup jobs. If it does, the following message is displayed:

EQQM229E 
   JCL BROWSE/EDIT CAN ONLY BE SELECTED FOR PROCESSOR WORKSTATIONS.

Input parameters

engineName

The name of the IBM Workload Scheduler for z/OS engine.

jsKey

The key identifying the job stream in the IBM Workload Scheduler for z/OS database. The valid format is jobStreamName.

schedTime

The input arrival time for the job stream.

deadlineTime

The completion dead line time for the job stream.

priority

The job stream priority value.

description

The job stream description. Maximum 24 characters.

groupName

The job stream group name. Maximum 16 characters.

ownerName

The job stream owner name. Maximum 16 characters.

ownerDescription

The job stream owner description. Maximum 24 characters.

authorityGroup

The job stream authority group. Maximum 8 characters.

dependenciesResolution

Specifies which type of dependencies are to be resolved. The value can be:

Y: Resolve both predecessor and successor dependencies.
N: Ignore all dependencies.
P: Resolve only predecessor dependencies.
S: Resolve only successor dependencies.

If no value is entered, the default is N.

variableTable

The name of the variable table associated with the job stream. Maximum 16 characters.

jobsList

An array of ZOSJob statements specifying the jobs that will be added, edited, and deleted in the job stream. The ZOSJob type is defined and documented in the TWS-Types.xsd file and in Add, modify, or delete jobs in the job stream you are submitting

dependencyList

An array of Dependency statements specifying the dependencies that will be added and deleted in the job stream. The Dependency type is defined and documented in the TWS-Types.xsd file and in Add or delete internal dependencies in the plan

variablesToBeSubstituted

An array of Property statements specifying the variables that will be substituted in the job stream. The Property statement is defined and documented in the TWS-Types.xsd file, and has the following form:

value: An array of values for the dataType.
dataType: A string identifying the variable for which you are supplying the value or values, and which can be found in the defined variable table.

Output

The service returns an array of the identifiers of the job streams that were actually submitted in the plan. Note that the plan object identifiers returned contain the '\0' character. This is not a valid character and must be replaced by a blank.