HCL Workload Automation, Version 9.4

Job Stream Submission jobs

A Job Stream Submission job submits a job stream for processing.

The Job Stream Submission job is one of the Automation Utilities that facilitate specific HCL Workload Automation operations. Use the Job Stream Submission job type to automate the submission of a job stream for processing.

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 Stream Submission 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 Stream Submission 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}
 
HostnameVerify
Checkbox
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.  
specifyjobstream To define the job stream that you want to submit for processing.  
workstation The name of the workstation on which the job stream was defined.
jobstreamname The name of the job stream.
alias A unique name to be assigned to the job stream in place of jobstreamname.  
resubcurrjobstream To resubmit the current job stream. This attribute is alternative to specifyjobstream.  
startafter To define an offset in hours for the start time.  
delayforhours The offset is calculated from the time of the submission of the Job Stream Submission job. Possible values can range from 00:00 to 23:59. The default value is '00:00'.  
startat To define the time of day before which the job stream must not start. This attribute is alternative to startafter.  
time The time of day before which the job stream must not start. Possible values can range from 00:00 to 23:59.  
delayfordays You can specify an offset in days for the start time. The offset is calculated from the day of the submission of the Job Stream Submission job. The default value is '0'.  
variabletablename The name of the variable table to be used by the job stream.  
variablelistValues The list of variables in the variable table, and related values.  
The following example shows the job definition for a Job Stream Submission job:
<?xml version="1.0" encoding="UTF-8"?>
<jsdl:jobDefinition xmlns:jsdl="http://www.ibm.com/xmlns/prod/scheduling/1.0/jsdl" 
       xmlns:jsdljobstreamsubmission="http://www.ibm.com/xmlns/prod/
scheduling/1.0/jsdljobstreamsubmission" 
       name="JOBSTREAMSUBMISSION">
	<jsdl:application name="jobstreamsubmission">
	<jsdljobstreamsubmission:jobstreamsubmission>
		<jsdljobstreamsubmission:JobstreamSubmissionParameters>
		<jsdljobstreamsubmission:Connection>
		   <jsdljobstreamsubmission:connectionInfo>
			<jsdljobstreamsubmission:Url>${agent-config:master-address}
                       </jsdljobstreamsubmission:Url>
			<jsdljobstreamsubmission:credentials>
			      <jsdl:userName>twsuser</jsdl:userName>
			      <jsdl:password>{aes}FKFBcQTNuxyPMye+hqRGdXC2Ya7chYe8rk2Ia8OJDNY=
                            </jsdl:password>
			</jsdljobstreamsubmission:credentials>
			<jsdljobstreamsubmission:CertificateGroup>
			  <jsdljobstreamsubmission:keyStoreFilePath>
                         </jsdljobstreamsubmission:keyStoreFilePath>
			     <jsdljobstreamsubmission:keyStorePassword>
                          </jsdljobstreamsubmission:keyStorePassword>
			  <jsdljobstreamsubmission:HostnameVerifyCheckbox/>
		      </jsdljobstreamsubmission:CertificateGroup>
		  </jsdljobstreamsubmission:connectionInfo>
		  <jsdljobstreamsubmission:retryOptions>
		    <jsdljobstreamsubmission:NumberOfRetries>0
                  </jsdljobstreamsubmission:NumberOfRetries>
		    <jsdljobstreamsubmission:RetryIntervalSeconds>30
                         </jsdljobstreamsubmission:RetryIntervalSeconds>
		  </jsdljobstreamsubmission:retryOptions>
		</jsdljobstreamsubmission:Connection>
		<jsdljobstreamsubmission:Action>
			<jsdljobstreamsubmission:method>
			  <jsdljobstreamsubmission:specifyjobstream>
			     <jsdljobstreamsubmission:workstation>LAPTOP-E0DIBP1_3 
				    </jsdljobstreamsubmission:workstation>
			     <jsdljobstreamsubmission:jobstreamname>JS1
                          </jsdljobstreamsubmission:jobstreamname>
                        <jsdljobstreamsubmission:alias>JSalias
                        </jsdljobstreamsubmission:alias>
			  </jsdljobstreamsubmission:specifyjobstream>
			</jsdljobstreamsubmission:method>
			<jsdljobstreamsubmission:earlieststart>
			    <jsdljobstreamsubmission:timeoptions>
			      <jsdljobstreamsubmission:startafter>
			      <jsdljobstreamsubmission:delayforhours>00:10
                           </jsdljobstreamsubmission:delayforhours>
			      </jsdljobstreamsubmission:startafter>
			    </jsdljobstreamsubmission:timeoptions>
			</jsdljobstreamsubmission:earlieststart>
			<jsdljobstreamsubmission:managevariabletable>
				<jsdljobstreamsubmission:variablename></jsdljobstreamsubmission:variablename>
			</jsdljobstreamsubmission:managevariabletable>
		</jsdljobstreamsubmission:Action>
		</jsdljobstreamsubmission:JobstreamSubmissionParameters>
		</jsdljobstreamsubmission:jobstreamsubmission>
	</jsdl:application>
</jsdl:jobDefinition>

Scheduling a job in HCL Workload Automation

You schedule Job Stream Submission 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 Stream Submission job are not supported.

Job properties

For information about how to display the job properties from the various supported interfaces, see Analyzing the job log . For example, you can see the job properties by running conman sj <job_name>;props, where<job_name> is the Job Stream Submission job name.

You can export some of the Job Stream Submission 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 19.

Job log content

You can see the job log content by running conman sj <job_name>;stdlist, where <job_name> is the Job Stream Submission 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.