Job qualifiers

Job qualifiers specify the attributes of jobs to be acted on by a command. They can be prefixed by + or ~. If a job qualifier is preceded by + then the jobs containing that specific attribute are selected for running the command. If a job qualifier is preceded by ~ then the jobs containing that specific attribute are excluded from running the command.

Job qualifier keywords can be abbreviated to as few leading characters as needed to uniquely distinguish them from each other.

at[=time | lowtime, | ,hightime | lowtime,hightime ]

Selects or excludes jobs based on the time specified in the at dependency.

time

Specifies the time as follows:

hhmm[+n days | date] [timezone|tz tzname]

where:

hhmm: The hour and minute.
+n days: The next occurrence of hhmm in n number of days.
date: The next occurrence of hhmm on date, expressed as mm/dd[/yy].
timezone|tz tzname: The name of the time zone of the job. See Managing time zones for valid names.

time conforms to the following rules:

When hhmm is earlier than the current time, the start time is tomorrow; when hhmm is later than the current time, the start time is today.
When hhmm is greater than 2400, it is divided by 2400. Of the division result, the whole part represents the number of + days, while the decimal part represents the time.

lowtime

Specifies the lower limit of a time range, expressed in the same format as time. Jobs are selected that are scheduled to start after this time.

hightime

Specifies the upper limit of a time range, expressed in the same format as time. Jobs are selected that are scheduled to start before this time.

If at is used alone and it is preceded by + then the jobs selected are those containing an at dependency.

If at is used alone and it is preceded by ~ then the jobs selected are those not containing an at dependency.

confirmed

Selects or excludes jobs that were scheduled using the confirm keyword.

critical

Selects or excludes jobs that were flagged with the critical keyword in a job stream definition.

critnet

Selects or excludes jobs that are flagged as critical or are predecessors of critical jobs. Hence, it applies to all the jobs that have a critical start time set.

The critical start time of a critical job is calculated by subtracting its estimated duration from its deadline. The critical start time of a predecessor is calculated by subtracting its estimated duration from the critical start time of its successor. Within a critical network, critical start times are calculated starting from the critical job and working backwards along the line of its predecessors.

deadline[=time | lowtime, | ,hightime | lowtime,hightime]

Specifies the time within which a job must complete.

hhmm[+n days | date] [timezone|tz tzname]

hhmm: The hour and minute.
+n days: An offset in days from the scheduled deadline time.
date: The next occurrence of hhmm on date, expressed as mm/dd[/yy].
timezone|tz tzname: Specifies the time zone to be used when computing the deadline. See Managing time zones for time zone names. The default is the time zone of the workstation on which the job or job stream is launched.
lowtime: Specifies the lower limit of a time range, expressed in the same format as time. Selected jobs have a scheduled deadline not earlier than this time.
hightime: Specifies the upper limit of a time range, expressed in the same format as time. Selected jobs have a scheduled deadline not later than this time.

every[=rate | lowrate, | ,highrate | lowrate,highrate]

Selects or excludes jobs based on whether or not they have a repetition rate.

rate: Specifies the scheduled run rate, expressed as hours and minutes (hhmm).
lowrate: Specifies the lower limit of a rate range, expressed in the same format as rate. Jobs are selected that have repetition rates equal to or greater than this rate.
highrate: Specifies the upper limit of a rate range, expressed in the same format as rate. Jobs are selected that have repetition rates less than or equal to this rate.

If every is used alone and it is preceded by + then the jobs selected are those containing any repetition rate.

If every is used alone and it is preceded by ~ then the jobs selected are those not containing any repetition rate.

finished[=time | lowtime, | ,hightime | lowtime,hightime]

Selects or excludes jobs based on whether or not they have finished.

time

Specifies the exact time the job finished, expressed as follows:

hhmm [date] [timezone|tz tzname]

hhmm: The hour and minute.
date: The next occurrence of hhmm on date, expressed as mm/dd[/yy].
timezone|tz tzname: The name of the time zone of the job. See Managing time zones for valid names.

lowtime

Specifies the lower limit of a time range, expressed in the same format as time. Jobs are selected that finished at or after this time.

hightime

Specifies the upper limit of a time range, expressed in the same format as time. Jobs are selected that finished at or before this time.

If finished is used alone and it is preceded by + then the jobs selected are the jobs that have finished running.

If finished is used alone and it is preceded by ~ then the jobs selected are the jobs that have not finished running.

follows=[netagent::][workstation#][folder/]{jobstreamname(hhmm [mm/dd[/yy]])[.job | @] | jobstream_id.job;schedid}| job[;nocheck][,...]

Selects or excludes jobs based on whether or not they have a follows dependency.

netagent: Specifies the name of the HCL Workload Automation network agent that interfaces with the remote HCL Workload Automation network containing the prerequisite job. Wildcard characters are permitted. For more information refer to Managing internetwork dependencies.
workstation: Specifies the name of the workstation on which the prerequisite job runs. Wildcard characters are permitted.
[folder/]: Specifies the name of the folder where the prerequisite job runs. If no folder is specified, the root folder ("/") is used by default.
jobstreamname: Specifies the name of the job stream in which the prerequisite job runs. Wildcard characters are permitted. If you enter jobstreamname.@, you specify that the target job follows all jobs in the job stream.
job: Specifies the name of the prerequisite job. When entered without a jobstreamname, it means that the prerequisite job is in the same job stream as the target job. Do not specify the job name using wildcard characters for a follows dependency.
jobstream_id: Specifies the unique job stream identifier. See Arguments for more information on job stream identifiers.
schedid: This keyword, if present, applies to all the job streams identifiers specified in the clause and indicates that for all the job streams specified you are using the jobstream_ids and not the jobstreamnames. If you want to select some job streams using the jobstream_id and some job streams using the jobstreamname, you must use two different follows clauses, one containing the job streams identified by the jobstreamname without the schedid keywords, and the other containing the job streams identified by the jobstream_id with the schedid keyword.
nocheck: Is valid only for the submission commands and used in conjunction with theschedid keyword. The nocheck keyword indicates that conman does not have to check for the existence of the prerequisite job jobstream_id.job in the Symphony file. It is assumed that jobstream_id.job exists, in case it does not exist batchman prints a warning message in the stdlist.

If follows is used alone and it is preceded by + then the jobs are selected if they contain follows dependencies.

If follows is used alone and it is preceded by ~ then the jobs are selected if they contain no follows dependency.

logon=username

Select jobs based on the user names under which they run. If username contains special characters it must be enclosed in quotes ("). Wildcard characters are permitted.

needs[=[workstation#]resourcename]

Selects or excludes jobs based on whether or not they have a resource dependency.

workstation: Specifies the name of the workstation on which the resource is defined. Wildcard characters are permitted.
resourcename: Specifies the name of the resource. Wildcard characters are permitted.

If needs is used alone and it is preceded by + then the jobs are selected if they contain resource dependencies.

If needs is used alone and it is preceded by ~ then the jobs are selected if they contain no resource dependency.

opens[=[workstation#]filename[(qualifier)]]

Select jobs based on whether or not they have a file dependency. A file dependency occurs when a job or job stream is dependent on the existence of one or more files before it can begin running.

workstation: Specifies the name of the workstation on which the file exists. Wildcard characters are permitted.
filename: Specifies the name of the file. The name must be enclosed in quotes (") if it contains special characters other than the following: alphanumerics, dashes (-), slashes (/), backslashes (\), and underscores (_). Wildcard characters are permitted.
qualifier: A valid test condition. If omitted, jobs are selected or excluded without regard to a qualifier.

If opens is used alone and it is preceded by + then the jobs are selected if they contain file dependencies.

If opens is used alone and it is preceded by ~ then the jobs are selected if they contain no file dependency.

priority=pri | lowpri, | ,highpri | lowpri,highpri

Selects or excludes jobs based on their priorities.

pri: Specifies the priority value. You can enter 0 through 99, hi or go.
lowpri: Specifies the lower limit of a priority range. Jobs are selected with priorities equal to or greater than this value.
highpri: Specifies the upper limit of a priority range. Jobs are selected with priorities less than or equal to this value.

prompt[=promptname | msgnum]

Selects or excludes jobs based on whether or not they have a prompt dependency.

promptname: Specifies the name of a global prompt. Wildcard characters are permitted.
msgnum: Specifies the message number of a local prompt.

If prompt is used alone and it is preceded by + then the jobs are selected if they contain prompt dependencies.

If prompt is used alone and it is preceded by ~ then the jobs are selected if they contain no prompt dependency.

recovery=recv-option

Selects or excludes jobs based on their recovery options.

recv-option: Specifies the job recovery option as stop, continue, or rerun.

scriptname=filename

Selects or excludes jobs based on their executable file names.

filename: Specifies the name of an executable file. The name must be enclosed in quotes (") if it contains special characters other than the following: alphanumerics, dashes (-), slashes (/), backslashes (\), and underscores (_). Wildcard characters are permitted.

started[=time | lowtime, | ,hightime | lowtime,hightime]

Selects or excludes jobs based on whether or not they have started.

time

Specifies the exact time the job started, expressed as follows:

hhmm [date] [timezone|tz tzname]

hhmm: The hour and minute.
date: The next occurrence of hhmm on date, expressed as mm/dd[/yy].
timezone|tz tzname: The name of the time zone of the job. See Managing time zones for valid names.

lowtime

Specifies the lower limit of a time range, expressed in the same format as time. Only jobs that started at or after this time are selected.

hightime

Specifies the upper limit of a time range, expressed in the same format as time. Only jobs that started at or before this time are selected.

If started is used alone and it is preceded by +, then only the jobs that have started running at this time are selected.

If started is used alone and it is preceded by ~, then only the jobs that have started running at or after this time and that are still running are selected.

state=state[,...]

Selects or excludes jobs based on their states.

state

Specifies the current state of the job. Valid job states are as follows:

ABEND: The job ended with a nonzero exit code.
ABENP: An abend confirmation was received, but the job has not completed.
ADD: The job is being submitted.
CANCL: For internetwork dependencies only. The remote job or job stream has been cancelled.
DONE: The job completed in an unknown state.
ERROR: For internetwork dependencies only, an error occurred while checking for the remote status.
EXEC: The job is running. The + flag written beside the EXEC status means that the job is managed by the local batchman process.
EXTRN: For internetwork dependencies only, the status is unknown. An error occurred, a rerun action was just performed on the job in the EXTERNAL job stream, or the remote job or job stream does not exist.
FAIL: Unable to launch the job.
FENCE: The job's priority value is below the fence.
HOLD: The job is awaiting dependency resolution.
INTRO: The job is introduced for launching by the system. The + flag written beside the INTRO status means that the job is managed by the local batchman process.
PEND: The job completed, and is awaiting confirmation.
READY: The job is ready to launch, and all dependencies are resolved.
SCHED: The job's at time has not arrived.
SUCC: The job completed with an exit code of zero.
SUCCP: A succ confirmation was received, but the job has not completed.
WAIT: The job is in the WAIT state (extended agent only).

until[=time | lowtime, | ,hightime | lowtime,hightime ]

Selects or excludes jobs based on their scheduled end time.

time

Specifies the scheduled end time expressed as follows:

hhmm[+n days | date] [timezone|tz tzname]

hhmm: The hour and minute.
+n days: The next occurrence of hhmm in n number of days.
date: The next occurrence of hhmm on date, expressed as mm/dd[/yy].
timezone|tz tzname: The name of the time zone of the job. See Managing time zones for valid names.

lowtime

Specifies the lower limit of a time range, expressed in the same format as time. Jobs are selected that have scheduled end times on or after this time.

hightime

Specifies the upper limit of a time range, expressed in the same format as time. Jobs are selected that have scheduled end times on or before this time.

To select a list of expected objects, hightime requires the date option with the operating system time. It does not work if the current operating system time is set later than the until hightime value. To display job streams in the ready or hold state with until set to 12:00, you must add the date value to until=,1200.

If until is used alone and it is preceded by + then the jobs are selected if they have an until time specified.

If until is used alone and it is preceded by ~ then the jobs are selected if they have no until time specified.