Previous Topic: Job Management Manager Logical Names

Next Topic: Writing Job Events to a Log File

Run Time Global Symbols Available to Jobs

The following table shows the run time global symbols created by the manager each time it runs a job. You can reference these global symbols in your command procedures when a job needs information about itself.

For example, a job may want to read its comments (which can be specified in the RUN command), its job name within the command procedure, or its job number so that it can change its own operation.

Symbol

Definition

BATCH$RESTART

The restart value set by the last SCHEDULE SET RESTART command within the job’s command procedure if the system failed while the job was running.

NSCHED_COMMAND

The job’s main OpenVMS command, created or modified by the job’s owner. For example:

@SYS$DEVICE:[DOE.PROJ-C]WKLY-COPY.COM

NSCHED_COMMENT

The job’s text comment string, created or modified by the job’s owner. This is one way to pass information to a job at run time. For example:

Check for weekly lists.

NSCHED_GROUPNAME

The job’s group, created or modified by the job’s owner. Examples:

DAILY, WEEKLY, MONTHLY

NSCHED_JOBNAME

The job’s name, created or modified by the job’s owner. For example:

WEEKLY-REPORT

NSCHED_JOBNUM

The job’s unique job number, automatically assigned by the manager when the job was created or copied into the job database. For example:

JOB 747

NSCHED_OUTFILE

The file specification for this job’s SYS$OUTPUT and SYS$ERROR output. For example:

SYS$DEVICE:[DOE.PROJ-C]WKLY-REPORT.LOG

NSCHED$RETRY_COUNT

The number of times the job has been retried since it last failed.

NSCHED$RETRY_MAX_ATTEMPTS

The maximum number of retries allowed for the job.

 

NSCHED_SEVERITY

The severity element of the exit status of the job’s prefunction (if any) when checked from the job’s main procedure, or of the exit status of the job’s main procedure, when checked from the job’s postfunction.

The value range and purpose are identical to those of the DCL symbol $SEVERITY. The value consists of the low order 3 bits of the job exit status. As per OpenVMS condition values conventions, even values signal a fatal error, an error, or a warning. Odd values represent either success or informational conditions.

See also the symbol NSCHED_STATUS below.

NSCHED_STATUS

The exit status of the job’s primary OpenVMS command when last run by the manager. This status is used by the jobs that depend on that job and by the job’s postfunction (if any). Refer to Prefunctions and Postfunctions in Chapter 2, "How Job Management Manager Works," for a discussion of prefunctions and postfunctions.

NSCHED_STEP

Symbol defined for a job when it is run (similar to NSCHED_COMMAND or NSCHED_JOBNAME). It has one of the five following values, indicating the current step of job execution from the manager perspective:

NSCHED_PRE_START

NSCHED_PRE_RUN

NSCHED_MAIN_START

NSCHED_MAIN_RUN

NSCHED_POST_RUN

NSCHED_TYPENAME

The job’s type, created or modified by the job’s owner. For example:

PROGRAM, DOCUMENTATION, BACKUP, PROJECT-COSTS

NSCHED_VERSION

Symbol defined for a job when it is run (similar to NSCHED_COMMAND or NSCHED_JOBNAME). It is an 8-character string that indicates the version number of the manager.

$VSSRESTART

The job’s current restart flag, set by the manager. This flag’s setting is TRUE only if the job is set for RESTART. Otherwise, the setting is FALSE.

Refer to the /RESTART qualifier for the SCHEDULE CREATE command for more details about job restarts.