HCL Workload Automation, Version 9.4

jobsubmit command - Submitting jobs

Use the jobsubmit command to submit jobs to the Job Dispatcher.

Syntax

jobsubmit ?

jobsubmit [-usr user_name -pwd password] {-jsdl jsdl_file | -jdname job_definition_name} [-alias job_alias] [-var variable=value…] [-affinity {jobid=job_id | alias=alias}] [-configFile configuration_file]

Description

This command submits a job to the Job Dispatcher. When the job is submitted, it is assigned a unique ID, which can be used for retrieving information on and canceling jobs.

You can use this command to submit jobs saved locally on the HCL Workload Automation server or saved in the Job Repository. To submit a local job, use the -jsdl option and specify the path to the JSDL file. To submit a job saved in the Job Repository, use the -jdname option and specify the job definition name.

When submitting jobs, you can also define an alias to be used as an alternative to the job ID when performing queries on the job, or for defining subsequent jobs as affine. To define affinity between two or more jobs, use the -affinity option when submitting the subsequent jobs. You define jobs as affine when you want them to run on the same resource, for example when the second job must use the results generated by the previous job.

Options

?: Displays help information.
-usr user_name: Specifies the username for a user authorized to perform operations on the command line. This parameter is required when security is enabled and the username is not defined in the CLIConfig.properties configuration file (with the tdwb_user keyword).
-pwd password: Specifies the password for a user authorized to perform operations on the command line. This parameter is required when security is enabled and the password is not defined in the CLIConfig.properties configuration file (with the tdwb_pwd keyword).
-jsdl jsdl_file: Specifies the name and path to a local JSDL file which provides the parameters for a job when it is submitted. This parameter is required when the jdname parameter is not specified.
-jdname job_definition_name: Specifies the name of a job definition stored in the Job Repository database. The job definition name is defined within the JSDL file and can be modified only by editing the JSDL file. This parameter is required when the jsdl parameter is not specified. To obtain this name, you can use the Definitions > Jobs task from the Dynamic Workload Console console navigation tree, or the jobstore command specifying one or more of the query options. For more information on the jobstore command, see jobstore command - Managing job definitions.
-alias job_alias: Indicates that an alias must be generated for the job being submitted. You can use the alias as a user-friendly alternative to the job ID when performing queries on the job. You can also use the alias when submitting new jobs so that the new job is affine to the job having this alias. To define affinity between two or more jobs, use the -affinity option when submitting the new jobs. You define jobs as affine when you want them to run on the same resource. On Windows systems, the maximum length for the alias is 200 characters, if you used the default installation paths for WebSphere Application Server and HCL Workload Automation.
-var variable=value: Specifies a variable and the associated value. You can also specify a list of variables by separating them with a comma. This value overrides the value specified when creating the JSDL file. You can also specify new variables without previously defining them in the JSDL file.
-affinity jobid=job_id: Specifies that the current job is affine to a previously submitted job. To establish the affinity relationship, specify the job ID for the previous job. The job ID is automatically generated at submission time.
-affinity alias=alias: Specifies that the current job is affine to a previously submitted job. To establish the affinity relationship, specify the job alias for the previous job. The job alias is generated at submission time when you specify the -alias option.
-configFile configuration_file: Specifies the name and path of a custom configuration file. This parameter is optional. If this parameter is not specified, the default configuration file is assumed. For more information on the configuration file, see Command-line configuration file.

Authorization

The user name and password for the command are defined in the CLIConfig.properties file. To override the settings defined in this file, you can enter the user name and password when typing the command. For more information on the CLIConfig.properties file, see Command-line configuration file.

Return Values

The jobsubmit command returns one of the following values:

0: Indicates that jobsubmit completed successfully.
< > 0: Indicates that jobsubmit failed.

Examples

To submit the local job test_job located in the /staging_area/accounts/ path using the configuration parameters specified in the custom_config.properties configuration file, type the following command:
```
jobsubmit -jsdl /staging_area/accounts/test_job -configFile
 /opt/test/custom_config.properties
```
To submit the job definition domestic_accounts saved in the Job Repository, type the following command:
```
jobsubmit -jdname domestic_accounts
```