HCL Workload Automation, Version 9.4

jobstore command - Managing job definitions

Use the jobstore command to manage job definitions.

Syntax

jobstore ?

jobstore [-usr user_name -pwd password]{[ -create jsdl_file ] | [ -update jsdl_file ] | [-del job_definition_name ] | [ -get job_definition_name ] | [-queryall ] | [[ -queryname job_definition_name…] [ -querydesc job_definition_desc…] [-queryowner job_definition_owner… ]]} [ -configFile configuration_file }

Description

This command saves and updates JSDL files in the Job Repository. JSDL files are saved in the database as job definitions with unique names. After saving JSDL files in the database, you can perform the following operations on job definitions:

Delete job definitions
Print job definitions to standard output or save them to a file
Perform queries on job definitions based on several attributes

You can submit job definitions using the jobsubmit command. For more information about the jobsubmit command, see jobsubmit command - Submitting jobs.

Options

?: Displays help information.
-usr username: Specifies the user name for a user authorized to perform operations on the command line. This parameter is required when security is enabled and the user name 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).
-create jsdl_file: Specifies the name and path to a JSDL file to be saved in the Job Repository database. The JSDL file is saved as a job definition. The name for the job definition is saved within the JSDL file and can be only modified by editing the JSDL file. Delete and retrieve (get) operations are performed on the job definition.
-update jsdl_file: Specifies the name and path to a JSDL file to be updated in the Job Repository database. The JSDL file must be existing in the database.
-del job_definition_name: Deletes a job definition from the Job Repository database.
-get job_definition_name: Prints the JSDL file contained in the job definition to standard output or to a file you specify. You can use this command for performing minor editing on job definitions.
-queryall: Performs a query without any filters. This query returns all job definitions stored in the HCL Workload Automation database.
-queryname job_definition_name: Performs a search on job definitions based on the job definition name. The job definition name is unique. This parameter is case-sensitive. Wildcards (*, ?) are supported.
-querydesc job_definition_desc: Performs a search on job definitions based on the job definition description. Wildcards are supported.
-queryowner job_definition_owner: Performs a search on job definitions based on the user who created the job definition.
-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 about 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 setting defined in this file, you can enter the user name and password when typing the command. For more information about the CLIConfig.properties file, see Command-line configuration file.

Return Values

The jobstore command returns one of the following values:

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

Examples

To retrieve all jobs created by user Administrator, type the following command:
```
jobstore -queryuser Administrator
```
To update the job branch_update already stored in the Job repository database, type the following command:
```
jobstore -update ../jsdl/branch_update.xml
```