Template Programming Interface Guide › AUTOCAT Job Template Files

AUTOCAT Job Template Files

This chapter describes the structure of AUTOCAT job template files created using TPI. It then explains each record that AUTOCAT job template files can include. The records are listed in alphabetical order.

Note: AUTOCAT jobs are only available through TPI.

This section contains the following topics:

AUTOCAT Job Template File Structure

* Record

COMMENT Record

JOB Record

JOBOPTIONS Record

AUTOCAT Job Template File Structure

The following table outlines the structure of an AUTOCAT job template file. The table lists the records in the order you might use them in a file.

Sample AUTOCAT Template File

The following example shows an AUTOCAT job template file.

JOB AUTOCAT
COMMENT Delete and condense expired catalogs
JOBOPTIONS HOLD NO PRIORITY NO EXCLUSIVE NO
JOBOPTIONS JOBEND QUIET ONETIME NO

* Record

OPTIONAL

Use the * record to add comments to job template files in addition to the comment specified on the COMMENT record. When you manage job template files through the CA VM:Backup screens, CA VM:Backup displays the comment on the COMMENT record on the screen; comments on * records are not displayed on the screen.

You can use * records with the COMMENT record or by themselves, and you can include as many as you need. You can place * records anywhere in the file after the JOB record; however, when the file is exported, CA VM:Backup places all * records in order after the COMMENT record or, if no COMMENT record exists, after the JOB record.

* [text]

Definitions

text

Can include up to 80 characters of comment text; any additional text is truncated. You must type the asterisk in column 1 of the record. You can use uppercase and lowercase letters; when you import or export the file, text case is preserved.

COMMENT Record

OPTIONAL

Use the COMMENT record to specify a comment in a file.

You can include only one COMMENT record in a file. When you want to specify more than one comment, use * records. When managing the template using CA VM:Backup screens, the comment specified on the COMMENT record is displayed on the screen; comments specified on * records are not displayed on the screen.

COMMENT [text]

Definitions

text

Can include up to 50 characters of comment text; any additional text is truncated. You can use uppercase and lowercase letters; when you import or export the file, text case is preserved.

More information:

* Record

JOB Record

REQUIRED

Use the JOB record to identify the type of job that is set up in the file.

This record is required as the first record in the file. A file can include only one JOB record. If the JOB record is missing, invalid, or not the first record in the file, CA VM:Backup does not import the file.

JOB AUTOCAT

Definitions

AUTOCAT

Identifies the job as an AUTOCAT job.

JOBOPTIONS Record

REQUIRED

Use the JOBOPTIONS record to specify job processing options for the job.

A file can include multiple JOBOPTIONS records. Each record can specify more than one parameter; however, a file can include only one of each parameter.

You can override parameter values specified on this record when you submit the job.

JOBOPTIONS {“Parms”}...

Parms:

EXCLUSIVE {YES | NO}
HOLD {YES | NO}
JOBEND {NOTIFY | QUIET}
ONETIME {YES | NO}
PRIORITY {YES | NO}

Definitions

EXCLUSIVE {YES | NO}

Specifies whether CA VM:Backup is to prevent other jobs from running while this job runs. CA VM:Backup will not start an exclusive job until all running jobs have completed and will not allow other jobs to start until the exclusive job has completed.

HOLD {YES | NO}

Specifies whether CA VM:Backup is to place the job in the job queue in hold status. To run a held job, the operator or system administrator must release it using the Manage System Activity operator screen or the RELEASE command.

JOBEND {NOTIFY | QUIET}

Specifies whether CA VM:Backup is to issue the JOBEND command to the submitting user ID to inform it that the job completed or was canceled. NOTIFY tells CA VM:Backup to notify the submitting user ID. QUIET tells CA VM:Backup not to notify the submitting user ID.

ONETIME {YES | NO}

Specifies whether CA VM:Backup is to erase the job template file and any associated exception and exclusion files from the CA VM:Backup 191 minidisk when the job either runs successfully or is canceled.

PRIORITY {YES | NO}

Specifies whether to submit the job at the top of the job queue, after any existing priority jobs. CA VM:Backup runs priority jobs before any other job in the queue. The only way another job can run ahead of a priority job is when the jobs are reordered using the ORDER command.