HCL Workload Automation, Version 9.4

Variable Table jobs

A Variable Table job adds or modifies a variable in a specified variable table.

Use the Variable Table job type to add or modify a variable in a specified variable table. The Variable Table job type enables variable passing from one job to another, in the same job stream or in a different job stream.

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 Variable Table jobs. Required attributes can be specified either at job definition time, or in the job plug-in properties file. Each job definition has the following format and attributes:

Table 1. Required and optional attributes for the definition of a Variable Table job
Attribute	Description and value	Required
hostname	The host name of the workstation where the HCL Workload Automation master server is installed, on which you want to add or modify a variable.	✓
port	The TCP/IP port number of the workstation where the HCL Workload Automation master server is installed.	✓
protocol	The protocol for connecting the dynamic agent running the Variable Table job and the HCL Workload Automation master server. Supported values are http and https.	✓
user name	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.
keystore file path	The fully qualified path of the keystore file containing the private key that is used to make the connection.
keystore file password	The password that protects the private key and is required to make the connection.
number of retries	The number of times that the program retries when connecting to the HCL Workload Automation master server. Default value is 0.
retry interval (in seconds)	The number of seconds that the program waits before retrying to connect to the HCL Workload Automation master server. Default value is 30 seconds.
variable table	The name of the variable table on the HCL Workload Automation master server where you want to add or modify a variable.	✓
variable list	The list of variables and related values, in the selected variable table, that you want to add or modify. Specify at least one variable.	✓

The following example shows the job definition for a Variable Table job:

<?xml version="1.0" encoding="UTF-8"?>
<jsdl:jobDefinition xmlns:jsdl="http://www.ibm.com/xmlns/prod/scheduling/1.0/jsdl" 
xmlns:jsdlvariabletable="http://www.ibm.com/xmlns/prod/scheduling
/1.0/jsdlvariabletable"
  name="VARIABLETABLE">
  <jsdl:application name="variabletable">
    <jsdlvariabletable:variabletable>
    <jsdlvariabletable:VariableTableParameters>
     <jsdlvariabletable:Connection>
           <jsdlvariabletable:connectionInfo>
               <jsdlvariabletable:hostname>nx000140.xxxxlab.yy.zzz.com
                 </jsdlvariabletable:hostname>
                   <jsdlvariabletable:port>35116</jsdlvariabletable:port>
                   <jsdlvariabletable:protocol>https</jsdlvariabletable:protocol>
                   <jsdlvariabletable:credentials> 
                        <jsdl:userName>tws_user</jsdl:userName>
                        <jsdl:password>{aes}
                        /2GNMAY8Z2pSx6JXHqcbKwd2xxxxxkyKXD/WNgthhnw=
                        </jsdl:password>
                   </jsdlvariabletable:credentials>
                   <jsdlvariabletable:CertificateGroup>
                        <jsdlvariabletable:keyStoreFilePath/>
                        <jsdlvariabletable:keyStorePassword/>
                   </jsdlvariabletable:CertificateGroup>
           </jsdlvariabletable:connectionInfo>
           <jsdlvariabletable:retryOptions>
                   <jsdlvariabletable:NumberOfRetries>0
                   </jsdlvariabletable:NumberOfRetries>
                   <jsdlvariabletable:RetryIntervalSeconds>30</jsdlvariabletable:
                     RetryIntervalSeconds>
           </jsdlvariabletable:retryOptions>
     </jsdlvariabletable:Connection> 
     <jsdlvariabletable:Action>
         <jsdlvariabletable:actionInfo>
              <jsdlvariabletable:varTable>TABLE1</jsdlvariabletable:varTable>
              <jsdlvariabletable:varListValues>
                 <jsdlvariabletable:varListValue key="DB2Name">HCLDB
                  </jsdlvariabletable:varListValue>
              </jsdlvariabletable:varListValues>
         </jsdlvariabletable:actionInfo>
     </jsdlvariabletable:Action>                                                        
    </jsdlvariabletable:VariableTableParameters>
    </jsdlvariabletable:variabletable>
  </jsdl:application>
</jsdl:jobDefinition>

Scheduling a job in HCL Workload Automation

You schedule Variable Table 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 Variable Table job are not supported.

Variable TableJobExecutor.properties file

The properties file is automatically generated either when you run a "Test Connection" from the Dynamic Workload Console in the job definition panels, or when you submit the job to run the first time. Once the file has been created, you can customize it. This is especially useful when you need to schedule several jobs of the same type. You can specify the values in the properties file and avoid having to provide information such as credentials and other information, for each job. You can override the values in the properties files by defining different values at job definition time.

The TWS_INST_DIR\TWS\JavaExt\cfg\VariableTableJobExecutor.properties file contains the following properties:

#Variable Table properties
hostname=
port=
protocol=http
user=
password=
keyStoreFilePath=
keyStorePassword=
HostnameVerifyCheckbox=false
NumberOfRetries=0
RetryIntervalSeconds=30
varTable=
#add here the variables in the format 
VARLISTPROPERTY.<variable_name>=<variable_value>
#For example VARLISTPROPERTY.queueName=default

Job properties

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

Job log content