HCL Workload Automation, Version 9.4

Job Management jobs

A Job Management job runs actions on a job in a job stream.

Use the Job Management job type to run actions on a job in a job stream.

Actions that you can run on a job are:
  • Rerun
  • Rerun the job and all its successor jobs
  • Rerun the job and its successor jobs in the same job stream
  • Release
  • Release Dependencies
  • Cancel
  • Cancel Pending
  • Hold
  • Kill
  • Confirm ABEND
  • Confirm SUCC

For more information about the actions that you can run on a job, by using the Dynamic Workload Console, see

Controlling job and job stream processing.

For more information about the actions that you can run on a job, by using conman command line, see

Managing objects in the plan - conman.

A description of the job properties and valid values are detailed in the context-sensitive help in the Dynamic Workload Console by clicking the question mark (?) icon in the top-right corner of the properties pane.
This section describes the required and optional attributes for Job Management jobs. Required attributes must be specified at job definition time. No properties file is available for this plug-in. Each job definition has the following format and attributes:
Table 1. Required and optional attributes for the definition of a Job Management job
Attribute Description and value Required
Url A variable that specifies the web address of HCL Workload Automation master server. You can override this variable with the web address of the master server and any HCL Workload Automation backup master (in case the master is not available). Use a comma or a semicolon to separate the different addresses that you specify.

If you do not override this variable at job definition time, the variable is resolved automatically at job execution time. In this case, if the connection to the master server is not available, the plug-in tries to connect automatically to any of the backup masters.

 ✓
userName The user to be used for accessing the HCL Workload Automation master server.  
password The password to be used for accessing the HCL Workload Automation master server. Required if you specify a user name.
keyStoreFilePath The fully qualified path of the keystore file containing the private key that is used to make the connection.
Note: For Workload Automation on Cloud users, this attribute must be equal to: 
${agent-config:keystore-file}
As an alternative, you can specify this attribute in the following format:
[<key-store-type>::]<key-store-path>
  
keyStorePassword The password that protects the private key and is required to make the connection.
Note: For Workload Automation on Cloud users, this attribute must be equal to: 
${agent-config:keystore-file-password}
  
HostnameVerifyCheckbox Use this attribute to require that the syntax of the HCL Workload Automation master server name, as featured in the keystore file, must match exactly the URL. If they do not match, no authorization is granted to access the server. If this attribute is not specified, the control is not enforced.
Note: For Workload Automation on Cloud users, this attribute cannot be specified.
 
NumberOfRetries The number of times that the program retries when connecting to the HCL Workload Automation master server. Default value is 0.  
RetryIntervalSeconds The number of seconds that the program waits before retrying to connect to the HCL Workload Automation master server. Default value is 30 seconds.  
jobname The name of the job on which you want to run the action. ✓
workstation A variable that specifies the name of the workstation on which the job runs. You can override this variable with a workstation name. If you do not override this variable at job definition time, the variable is resolved automatically at job execution time. ✓
jobstreamid A variable that specifies the name of the job stream containing the job. You can override this variable with a job stream name. If you do not override this variable at job definition time, the variable is resolved automatically at job execution time. ✓
method The action that you want to run on the job. Valid values are:
  • rerun
  • rerunsuccessors
  • reruninternalsuccessors
  • release
  • releasedependencies
  • cancel
  • cancelpending
  • hold
  • kill
  • confirm_abend
  • confirm_succ
 ✓
sameworkstation Specify this parameter only for the rerun action. Use this parameter if you want to rerun the job on the same workstation where it ran previously. This parameter is applicable only to pool and dynamic pool workstations.  
condition The condition name to confirm the SUCC or ABEND status for the specified output conditions. Any conditions not specified are set to not satisfied.  
The following example shows the job definition for a Job Management job that runs the rerun action:
<?xml version="1.0" encoding="UTF-8"?>
<jsdl:jobDefinition xmlns:jsdl="http://www.abc.com/xmlns/prod/scheduling/1.0/jsdl" 
xmlns:jsdljobmanagement="http://www.abc.com/xmlns/prod/
scheduling/1.0/jsdljobmanagement" 
name="JOBMANAGEMENT">
<jsdl:application name="jobmanagement">
<jsdljobmanagement:jobmanagement>
  <jsdljobmanagement:JobManagementParameters>
    <jsdljobmanagement:Connection> 
	<jsdljobmanagement:connectionInfo>
		<jsdljobmanagement:Url>${agent-config:master-address}</jsdljobmanagement:Url>
		<jsdljobmanagement:credentials>
		  <jsdl:userName>twsuser1</jsdl:userName>
		  <jsdl:password>{aes}ywIpc7ISIQSq9xb7xrzqxoYJn04rNj/d1IfLa20r7Rg=
                </jsdl:password>
		</jsdljobmanagement:credentials>
		<jsdljobmanagement:CertificateGroup>
		  <jsdljobmanagement:keyStoreFilePath></jsdljobmanagement:keyStoreFilePath>
		  <jsdljobmanagement:keyStorePassword></jsdljobmanagement:keyStorePassword>
                      <jsdljobmanagement:HostnameVerifyCheckbox/>
		</jsdljobmanagement:CertificateGroup>
	</jsdljobmanagement:connectionInfo>
	<jsdljobmanagement:retryOptions>
		<jsdljobmanagement:NumberOfRetries>0</jsdljobmanagement:NumberOfRetries>
		<jsdljobmanagement:RetryIntervalSeconds>30
              </jsdljobmanagement:RetryIntervalSeconds>
	</jsdljobmanagement:retryOptions>
    </jsdljobmanagement:Connection>
    <jsdljobmanagement:Action>
	<jsdljobmanagement:informations>
		<jsdljobmanagement:jobname>JOBDIR</jsdljobmanagement:jobname>
		<jsdljobmanagement:workstation>LAPTOP-E0DIBP1_2 (type: Agent, version: 9.4.0.01)
             </jsdljobmanagement:workstation>
		<jsdljobmanagement:jobstreamid>${tws.jobstream.id}
              </jsdljobmanagement:jobstreamid>
	</jsdljobmanagement:informations>
	<jsdljobmanagement:actions>
		<jsdljobmanagement:method>rerun</jsdljobmanagement:method>
	</jsdljobmanagement:actions>
	<jsdljobmanagement:options>
		<jsdljobmanagement:sameworkstation/>
		<jsdljobmanagement:condition></jsdljobmanagement:condition>
	</jsdljobmanagement:options>
    </jsdljobmanagement:Action>
  </jsdljobmanagement:JobManagementParameters>
</jsdljobmanagement:jobmanagement>
</jsdl:application>
</jsdl:jobDefinition>
The following example shows the job definition for a Job Management job that runs the rerunsuccessors action:
<?xml version="1.0" encoding="UTF-8"?>
<jsdl:jobDefinition xmlns:jsdl="http://www.abc.com/xmlns/prod/scheduling/1.0/jsdl" 
xmlns:jsdljobmanagement="http://www.abc.com/xmlns/prod/
scheduling/1.0/jsdljobmanagement" 
name="JOBMANAGEMENT">
<jsdl:application name="jobmanagement">
<jsdljobmanagement:jobmanagement>
  <jsdljobmanagement:JobManagementParameters>
    <jsdljobmanagement:Connection> 
	<jsdljobmanagement:connectionInfo>
		<jsdljobmanagement:Url>https://localhost:31116</jsdljobmanagement:Url>
		<jsdljobmanagement:credentials>
		  <jsdl:userName>twsuser1</jsdl:userName>
		  <jsdl:password>{aes}ywIpc7ISIQSq9xb7xrzqxoYJn04rNj/d1IfLa20r7Rg=
                </jsdl:password>
		</jsdljobmanagement:credentials>
		<jsdljobmanagement:CertificateGroup>
		  <jsdljobmanagement:keyStoreFilePath></jsdljobmanagement:keyStoreFilePath>
		  <jsdljobmanagement:keyStorePassword></jsdljobmanagement:keyStorePassword>
                      <jsdljobmanagement:HostnameVerifyCheckbox/>
		</jsdljobmanagement:CertificateGroup>
	</jsdljobmanagement:connectionInfo>
	<jsdljobmanagement:retryOptions>
		<jsdljobmanagement:NumberOfRetries>0</jsdljobmanagement:NumberOfRetries>
		<jsdljobmanagement:RetryIntervalSeconds>30
              </jsdljobmanagement:RetryIntervalSeconds>
	</jsdljobmanagement:retryOptions>
    </jsdljobmanagement:Connection>
    <jsdljobmanagement:Action>
	<jsdljobmanagement:informations>
		<jsdljobmanagement:jobname>JOBDIR</jsdljobmanagement:jobname>
		<jsdljobmanagement:workstation>LAPTOP-E0DIBP1_2 
              (type: Agent, version: 9.4.0.01)
             </jsdljobmanagement:workstation>
		<jsdljobmanagement:jobstreamid>${tws.jobstream.id}
              </jsdljobmanagement:jobstreamid>
	</jsdljobmanagement:informations>
	<jsdljobmanagement:actions>
		<jsdljobmanagement:method>rerunsuccessors</jsdljobmanagement:method>
	</jsdljobmanagement:actions>
	<jsdljobmanagement:options>
	  <jsdljobmanagement:condition></jsdljobmanagement:condition>
	</jsdljobmanagement:options>
   </jsdljobmanagement:Action>
  </jsdljobmanagement:JobManagementParameters>
</jsdljobmanagement:jobmanagement>
</jsdl:application>
</jsdl:jobDefinition>
The following example shows the job definition for a Job Management job that runs the confirm_succ action:
<?xml version="1.0" encoding="UTF-8"?>
<jsdl:jobDefinition xmlns:jsdl="http://www.ibm.com/xmlns/prod/scheduling/1.0/jsdl" 
xmlns:jsdljobmanagement="http://www.ibm.com/xmlns/prod/
scheduling/1.0/jsdljobmanagement" 
name="JOBMANAGEMENT">
<jsdl:application name="jobmanagement">
<jsdljobmanagement:jobmanagement>
  <jsdljobmanagement:JobManagementParameters>
    <jsdljobmanagement:Connection>
	<jsdljobmanagement:connectionInfo>
		<jsdljobmanagement:Url>https://localhost:31116</jsdljobmanagement:Url>
		<jsdljobmanagement:credentials>
  		<jsdl:userName>twsuser1</jsdl:userName>
  		<jsdl:password>{aes}ywIpc7ISIQSq9xb7xrzqxoYJn04rNj/d1IfLa20r7Rg=
                </jsdl:password>
		</jsdljobmanagement:credentials>
		<jsdljobmanagement:CertificateGroup>
  		<jsdljobmanagement:keyStoreFilePath></jsdljobmanagement:keyStoreFilePath>
  		<jsdljobmanagement:keyStorePassword></jsdljobmanagement:keyStorePassword>
		</jsdljobmanagement:CertificateGroup>
	</jsdljobmanagement:connectionInfo>
	<jsdljobmanagement:retryOptions>
		<jsdljobmanagement:NumberOfRetries>0</jsdljobmanagement:NumberOfRetries>
		<jsdljobmanagement:RetryIntervalSeconds>30
              </jsdljobmanagement:RetryIntervalSeconds>
	</jsdljobmanagement:retryOptions>
    </jsdljobmanagement:Connection>
    <jsdljobmanagement:Action>
	<jsdljobmanagement:informations>
		<jsdljobmanagement:jobname>JOBDIR</jsdljobmanagement:jobname>
		<jsdljobmanagement:workstation>LAPTOP-E0DIBP1_2 (type: Agent, version: 9.4.0.01)
             </jsdljobmanagement:workstation>
		<jsdljobmanagement:jobstreamid>${tws.jobstream.id}
              </jsdljobmanagement:jobstreamid>
	</jsdljobmanagement:informations>
	<jsdljobmanagement:actions>
	      <jsdljobmanagement:method>confirm_succ</jsdljobmanagement:method>
	</jsdljobmanagement:actions>
	<jsdljobmanagement:options>
		<jsdljobmanagement:condition>CONF_SUCC_CONDITION</jsdljobmanagement:condition>
	</jsdljobmanagement:options>
    </jsdljobmanagement:Action>
  </jsdljobmanagement:JobManagementParameters>
</jsdljobmanagement:jobmanagement>
</jsdl:application>
</jsdl:jobDefinition>

Scheduling a job in HCL Workload Automation

You schedule Job Management jobs by defining them in job streams. Add the job to a job stream with all the necessary scheduling arguments and submit it.

You can submit jobs by using the Dynamic Workload Console, Application Lab, or the conman command line.

Stopping and restarting a job

Stopping and restarting a Job Management job are not supported.

Job properties

You can see the job properties by running conman sj <job_name>;props, where<job_name> is the Job Management job name.

You can export some of the Job Management job properties that you see in the Extra Information section of the output command, to a successive job in the same job stream or in a different job stream. For more information about the list of job properties that you can export, see Table 18.

Job log content

You can see the job log content by running conman sj <job_name>;stdlist, where <job_name> is the Job Management job name.

See also

From the Dynamic Workload Console you can perform the same task as described in

Creating job definitions.

For more information about how to create and edit scheduling objects, see

Designing your Workload.