Using the ActiveBatch Command-line Interface

The commands that follow are divided into two categories: Queue and Job.  Queue commands create and otherwise manage the Queue system itself. Job commands are those necessary for submitting a Job to a Queue for background execution and also for managing those Jobs within the batch system.

 

The commands that follow require the verb ABAT to execute in a CMD console. If you have XLNT (a scripting and command language developed by ASCI) installed, you don’t need to preface the command with "ABAT".

 

ABAT command example using CMD:

ABAT SUBMIT Job-name /QUEUE=test-queue

ABAT command using XLNT:

$ SUBMIT Job-name /QUEUE=test-queue

 

Note: The command qualifiers (with some minor exceptions) use the Queue and Job Policies to establish defaults. See Default Policy for more information.

 

 

 

The CLOSE/QUEUE command prevents further Job submission.

 

Format:

CLOSE/QUEUE queue-name

Parameter:

queue-name

 

This required parameter indicates the specific Queue that is to be closed.

Qualifiers:

/JS_PASSWORD[=password]

This qualifier is used in combination with the /JS_USERNAME and, optionally, /JS_SAVEPASSWORD to specify a password to be used with the value of /JS_USERNAME to form an authentication credential to communicate with the Job Scheduler machine.

 

/[NO]JS_SAVEPASSWORD

This qualifier indicates that the password specified with /JS_PASSWORD is to be stored for future authentication purposes.  You can specify this qualifier only when /JS_PASSWORD is also specified. To delete a stored password specify /NOJS_SAVEPASSWORD.

 

/JS_USERNAME=username

This qualifier is used in combination with ./JS_PASSWORD to form an authentication credential used to communicate with the Job Scheduler machine.

 

/LOG

This qualifier is used to display a message when the operation is successful.

 

/ON=scheduler-machine-name

This qualifier allows the command to be directed to the named Job Scheduler machine.  You may specify any valid machine name, FQDN, or IP address (depending on the protocols your machine supports).

 

Example: This example closes a Queue named TESTQUEUE and prevents further Job submission to the Queue.

ABAT CLOSE/QUEUE TESTQUEUE

 

The DELETE/JOB command aborts or deletes a specific Job or Plan, or in the case of a Job/Plan definition, the definition and its instances can be aborted or deleted.

 

Format:

DELETE/JOB=Job-entry-id/qualifiers

Qualifiers:

/INSTANCE

This qualifier will abort the executing copy of a scheduled Job. A template Job will remain eligible for re-execution at a later time. This qualifier is ignored if /PERMANENT is specified.

 

/JOB=Job-entry-id

This required qualifier indicates the specific Job entry via its unique entry identification that is to be aborted/deleted.

 

/JS_PASSWORD[=password]

This qualifier is used in combination with the /JS_USERNAME and, optionally, /JS_SAVEPASSWORD to specify a password to be used with the value of /JS_USERNAME to form an authentication credential to communicate with the Job Scheduler machine.

 

/[NO]JS_SAVEPASSWORD

This qualifier indicates that the password specified with /JS_PASSWORD is to be stored for future authentication purposes.  You can specify this qualifier only when /JS_PASSWORD is also specified. To delete a stored password specify /NOJS_SAVEPASSWORD.

 

/JS_USERNAME=username

This qualifier is used in combination with ./JS_PASSWORD to form an authentication credential used to communicate with the Job Scheduler machine.

 

/LOG

This qualifier is used to display a message when the operation is successful.

 

/ON=scheduler-machine-name

This qualifier allows the command to be directed to the named Job Scheduler machine.  You may specify any valid machine name, FQDN, or IP address (depending on the protocols your machine supports).

 

/PATH=path

This qualifier allows you to lookup a specific object using the object’s path (for example, “/TestJob” would refer to the object labeled ‘TestJob’).

 

/PERMANENT

This qualifier, if specified, indicates that the Job is to be deleted. By default, Job(s) are aborted and a Job's history can be viewed in the Runbook.

Example: This example aborts a Job with the Job id of 5 on the Job Scheduler machine NTSERVER1.

ABAT DELETE/JOB=5/ON=NTSERVER1

 

The DELETE/QUEUE command deletes a named Queue.

 

Format:

DELETE/QUEUE/qualifiers queue-name

Parameter:

queue-name

 

The name of the Queue which is to be deleted.  ActiveBatch requires that no Jobs be present on the Queue (otherwise you should use the /FLUSH qualifier).

Qualifiers:

/FLUSH

This qualifier indicates that any Jobs which are held or pending are to be deleted prior to deleting the Queue itself. By default, pending Jobs are not deleted.  A Queue cannot be deleted with pending Jobs.

 

/JS_PASSWORD[=password]

This qualifier is used in combination with the /JS_USERNAME and, optionally, /JS_SAVEPASSWORD to specify a password to be used with the value of /JS_USERNAME to form an authentication credential to communicate with the Job Scheduler machine.

 

/[NO]JS_SAVEPASSWORD

This qualifier indicates that the password specified with /JS_PASSWORD is to be stored for future authentication purposes.  You can specify this qualifier only when /JS_PASSWORD is also specified. To delete a stored password specify /NOJS_SAVEPASSWORD.

 

/JS_USERNAME=username

This qualifier is used in combination with ./JS_PASSWORD to form an authentication credential used to communicate with the Job Scheduler machine.

 

/LOG

This qualifier is used to display a message when the operation is successful.

 

/ON=scheduler-machine-name

This qualifier allows the command to be directed to the named Job Scheduler machine.  You may specify any valid machine name, FQDN, or IP address (depending on the protocols your machine supports).

Example: This example deletes a Queue named TESTQUEUE and the /FLUSH Qualifier deletes any Jobs which are held or pending.

ABAT DELETE/QUEUE TESTQUEUE /FLUSH

 

This command will delete all Jobs on a specified Queue.  Jobs can also be deleted by Job state and/or be specifying the user’s username.

 

Format:

FLUSH/QUEUE/qualifiers queue-name

Parameter:

queue-name

The name of the Queue on which the flush operation is to be performed. 

Qualifiers:

/BY_JOB_STATUS=(ABORTING | EXECUTING | PENDING | TIMED_RELEASE |  HOLDING | COMPLETED)

This qualifier indicates which Jobs by “Job state” are to be deleted.  By default, all Jobs are deleted.

 

/JS_PASSWORD[=password]

This qualifier is used in combination with the /JS_USERNAME and, optionally, /JS_SAVEPASSWORD to specify a password to be used with the value of /JS_USERNAME to form an authentication credential to communicate with the Job Scheduler machine.

 

/[NO]JS_SAVEPASSWORD

This qualifier indicates that the password specified with /JS_PASSWORD is to be stored for future authentication purposes.  You can specify this qualifier only when /JS_PASSWORD is also specified. To delete a stored password specify /NOJS_SAVEPASSWORD.

 

/JS_USERNAME=username

This qualifier is used in combination with ./JS_PASSWORD to form an authentication credential used to communicate with the Job Scheduler machine.

 

/LOG

This qualifier is used to display a message when the operation is successful.

 

/ON=scheduler-machine-name

This qualifier allows the command to be directed to the named Job Scheduler machine.  You may specify any valid machine name, FQDN, or IP address (depending on the protocols your machine supports).

 

/USERNAME=username

This qualifier allows the search of Jobs to be narrowed to a specific username. By default, the search is not narrowed to a specific user.

Example: This example will delete all Jobs that are in the Queue named TESTQUEUE.

ABAT FLUSH/QUEUE TESTQUEUE

 

This command will hold a Job or Plan definition.  In other words, the state of the object is changed to “Hold” (or Disabled).

 

Format:

HOLD/JOB=Job-entry-id/qualifiers

Qualifiers:

/JOB=Job-entry-id

This required qualifier indicates the specific Job entry via its unique entry identification is to be set to “Hold” status.  Please note that an active executing Job cannot have its state changed via this command.

 

/JS_PASSWORD[=password]

This qualifier is used in combination with the /JS_USERNAME and, optionally, /JS_SAVEPASSWORD to specify a password to be used with the value of /JS_USERNAME to form an authentication credential to communicate with the Job Scheduler machine.

 

/[NO]JS_SAVEPASSWORD

This qualifier indicates that the password specified with /JS_PASSWORD is to be stored for future authentication purposes.  You can specify this qualifier only when /JS_PASSWORD is also specified. To delete a stored password specify /NOJS_SAVEPASSWORD.

 

/JS_USERNAME=username

This qualifier is used in combination with ./JS_PASSWORD to form an authentication credential used to communicate with the Job Scheduler machine.

 

/LOG

This qualifier is used to display a message when the operation is successful.

 

/ON=scheduler-machine-name

This qualifier allows the command to be directed to the named Job Scheduler machine.  You may specify any valid machine name, FQDN, or IP address (depending on the protocols your machine supports).

 

/PATH=path

This qualifier allows you to lookup a specific Job using the object’s path (for example, “/TestJob” would refer to the object labeled ‘TestJob’).

Example: This example will hold a pending or completed Job with an entry id of 5 on Job Scheduler machine NTSERVER1.

ABAT HOLD/JOB=5/ON=NTSERVER1

 

This command is used to create or initialize a new Queue within the ActiveBatch system.

 

Format:

INITIALIZE/QUEUE/qualifiers queue-name

Parameter:

queue-name

This required parameter represents a unique name for a batch Queue.

Qualifiers:

/BASE_PRIORITY=(IDLE | BELOWNORMAL | NORMAL | ABOVENORMAL | HIGH |REALTIME | number)

This qualifier represents the operating system scheduling priority assigned to the batch process at Job startup. For non-Windows 2000/NT machines, a priority number would be used.

 

/CLOSE

This qualifier indicates whether the initial state of the Queue should be to allow Job submissions. If /CLOSE is specified, Job submissions will not be allowed. By default, the initial Queue state is OPEN. /CLOSE and /OPEN are mutually exclusive.

 

/CLOSE_TIME=(hh:mm-hh:mm)

This qualifier indicates the time of day that the Queue is to remain closed. During the remaining portion the Queue is open. The time specifier hh:mm represents a 24-hour time.  The time range indicates the starting and ending closing time.

 

/DENY=(account:access…,…)

This qualifier is used to deny an account access that the account may also obtain through a group. account refers to the WinNT account name (or group) and access refers to one or more of the following keywords: EXECUTIVE, MANAGE and USER. To specify more than one level of access to be denied, separate each access with a colon. Multiple accounts may be specified by delimiting each account/access string with a comma.

 

/DESCRIPTION=”string”

This qualifier allows a short description to be assigned and stored with the created Queue.

 

/[NO]EVENT_LOG=keyword | \\machine

This qualifier indicates whether the Windows 2000/NT Event Log should be used for start and stop batch Job messages and, if so, which machine’s event log should be used. Available keywords are: Client, JobScheduler and ExecutionMachine. You may also specify a specific machine by prefacing the machine name with a \\ (2 backslashes) notation. To avoid using the Event Log specify /NOEVENT_LOG.

 

/EXEC_ON=machine-name

For an Execution Queue, this qualifier indicates the machine that submitted Jobs are to be executed on.

 

/GENERIC=(ExecQueue1, ExecQueue2,…. ExecQueueN)

This qualifier indicates that the Queue to be created is a Generic Queue. A Generic Queue points to one or more Execution Queues. The values specified with this qualifier are the actual Execution Queue names. If this qualifier is omitted, the Queue is assumed to be an Execution Queue.

 

/GRANT=(account:access,…)

This qualifier is used to associate security permissions to the Queue that is to be created.  By default, the owner and Administrator are given full access to the Queue and the all other users are given Submit level access (this default can be changed with the SET BATCH command). To associate different permissions for this Queue, you may specify one or more accounts and the level of access each account (or group) may have with this Queue.

 

Access is specified using one or more of the following keywords:

 

  • FULL - Complete access

  • EXECUTIVE - Give/Take Ownership

  • MANAGE - Ability to issue Queue management commands

  • USER - Ability to SUBMIT Jobs

 

Each keyword specified must be separated by a colon.  Multiple accounts are separated by a comma.

 

/HOLD_ON_ERROR

This qualifier is used to establish a default for Jobs which are submitted on this Queue. When enabled, the Job will be automatically placed in a Hold state if the Job completes on error.

 

/JOB_LIMIT=number

This qualifier, valid for Execution Queues, indicates the number of simultaneous Jobs that may be executed for this Execution Queue. The valid range is 1 through 10.  By default, one is assumed.

 

/JS_PASSWORD[=password]

This qualifier is used in combination with the /JS_USERNAME and, optionally, /JS_SAVEPASSWORD to specify a password to be used with the value of /JS_USERNAME to form an authentication credential to communicate with the Job Scheduler machine.

 

/[NO]JS_SAVEPASSWORD

This qualifier indicates that the password specified with /JS_PASSWORD is to be stored for future authentication purposes.  You can specify this qualifier only when /JS_PASSWORD is also specified. To delete a stored password specify /NOJS_SAVEPASSWORD.

 

/JS_USERNAME=username

This qualifier is used in combination with ./JS_PASSWORD to form an authentication credential used to communicate with the Job Scheduler machine.

 

/LOG

This qualifier is used to display a message when the operation is successful.

 

/ON=scheduler-machine-name

This qualifier allows the command to be directed to the named Job Scheduler machine.  You may specify any valid machine name, FQDN, or IP address (depending on the protocols your machine supports).

 

/OPEN

This qualifier indicates that the Queue is available for Job submissions. By default, the /OPEN qualifier is assumed.

 

/PRIORITY=number

This qualifier indicates the default Queue Priority to be used when submitting a Job to a Queue and a priority is not specified as part of Job submission. This qualifier should not be mistaken as the scheduling priority of the Job (see /BASE_PRIORITY). The valid range is 1 through 99.  The default is 10.

 

/REMOVE=(account,…)

This qualifier removes the specified accounts permissions.  More than one account may be specified separated by a comma.

 

/SCHEDULING = (SEQUENTIAL | ROUND-ROBIN | BALANCED)

This qualifier indicates the scheduling algorithm which will be used for a Generic Queue. Sequential means that Jobs are submitted to the first Execution Queue listed until that Queue is executing its maximum Job limit. Round-Robin means that each Queue, in turn, is given a Job to execute until its Job limits are met. Balanced indicates that a workload balancing approach be used which determines the best machine to run on based on CPU, memory and other parameters.

 

/[NO]START

This qualifier indicates the initial Queue state after becoming initialized. /START (default) indicates that any pending Jobs which are eligible to become executable should be started. /NOSTART indicates that the Jobs should not be started for execution. Please note that OPEN and CLOSE qualifiers deal with the ability to submit Jobs to a Queue while START and NOSTART deal with the ability to execute those eligible Jobs.

 

/STOP_TIME=(hh:mm-hh:mm)

This qualifier indicates the time of day that the Queue is to remain stopped. During the remaining portion the Queue is started.  The time hh:mm represents a 24-hour time.  The time range indicates the starting and ending stopped time.

 

/USER_CHAR=(char:datatype:value,…)

This qualifier is used to associate user characteristics with an Execution Queue. Char indicates a user characteristic name. This name is free form but cannot contain spaces.  Datatype is either String or Numeric. Value is a string or numeric value based on the characteristic datatype.  You may specify multiple characteristics by separating each with a comma.

 

/WORKING_FOLDER=device-directory-spec

This qualifier indicates the default working directory for Jobs submitted to this Queue in which a directory has not been specified.

Example: This example creates a Queue called TESTQUEUE with a description of "A Test Queue".

ABAT INITALIZE/QUEUE TESTQUEUE /DESCRIPTION="A Test Queue"

 

This command is used to modify a Job’s characteristics on Queue.

 

Format:

MODIFY/JOB=Job-entry-id/qualifiers

Qualifiers:

/[NO]ACTIVEBATCH_EVENT

This qualifier indicates whether the Job can accept an ActiveBatch TRIGGER command. The default is that a Job can accept the command.

 

/[NO]ACCOBJ=user-account-name

This qualifier indicates whether a User Account name object is being referenced for security (username, password) information. Negating this qualifier indicates the object’s reference is to be removed from this Job. User account name objects are highly recommended for security purposes instead of using embedded security credentials within the Job.

 

/AFTER=combination-time

This qualifier is used to defer a Job so that the Job will be executed at some future time. The time specified is any valid combination time (including keywords TODAY and TOMORROW). If /AFTER is specified without a combination time specified the keyword TODAY is assumed. By default, Job execution is assumed to be immediate.

 

/BASE_PRIORITY=(LOW | BELOWNORMAL | NORMAL | ABOVENORMAL | HIGH | REALTIME | number)

This qualifier represents the operating system scheduling priority assigned to the batch Job. For Windows 2000/NT machines the keywords above are used. For non-Windows machines, a priority number must be specified. By default, the base priority is taken from the Queue’s characteristics.

 

/CALENDAR=calendar-name

This qualifier associates a business Calendar with the Job. This allows a Job to be scheduled only on working days.

 

/CATEGORY=”string”

This qualifier indicates the user category or other string value that will be kept with the Job.

 

/CONTACT=(delivery:target[:time],…)

This qualifier is used to denote contact information for those machines/users that are to be notified when a Job starts or completes execution. Delivery represents one of two keywords which indicate how the notification is to be occur. MAIL or MESSENGER are valid delivery keywords. Target represents either a machine name, if the delivery is MESSENGER, or a valid e-mail address if the delivery is MAIL. Time indicates either a START or FINISH Job time criteria that is used to indicate when the notification is to be sent. If  “time” is omitted, then FINISH is assumed. You may specify more than one contact by separating each contact specification with a comma.

 

/DENY=(account:access,…)

This qualifier is used to deny an account access that the account may also obtain through a group. account refers to the WinNT account name (or group) and access refers to one or more of the following keywords: READ, WRITE, DELETE, EXECUTE, TAKEOWNERSHIP, TRIGGER, TRIGGERPARAM and TRIGGERQUEUE. To specify more than one level of access to be denied, separate each access with a colon. Multiple accounts may be specified by delimiting each account/access string with a comma.

 

/DESCRIPTION=”string”

This qualifier is used to set  the pending Job’s description specified at Job submission time.

 

/DOCUMENTATION=”string”

This qualifier is used to associate a documentation reference with the Job.

 

/EVERY=(MINUTE=mm,… , HOUR=hh,… , WEEKDAY=ddd,… , DAY=dd,… , MONTH=mm,…)

Note: This qualifier while supported is obsolete and has been superceded by the /SCHEDULE qualifier. This qualifier indicates that a rescheduled Job entry is to be created. By default, if all keywords are omitted, a Job entry is created that will execute at midnight each day. Valid keywords are as follows.  Specification of multiple values or multiple keywords is supported through the use of comma delimitation.

 

  • MINUTE - valid range of 0 through 59. Default is 0.

  • HOUR - valid range of 0 through 23. Default is 0.

  • WEEKDAY - acceptable values are SUN, MON, TUE, WED, THU, FRI, SAT.

  • DAY - valid range of 1 through 31. A day which is specified as greater than the number of days in the month denotes the last day of the month. Default is every day of a month.

  • MONTH - valid range of 1 through 12. Default is every month.

 

The EVERY and INTERVAL qualifiers are mutually exclusive. When a DAY is specified that exceeds the actual number of days in the month, ActiveBatch will assume that the last day of the month is to be selected.  If multiple DAYs are specified which exceed the actual number of days in the month, the Job will be scheduled once on the last day of the month.

 

/[NO]FAILURESTART=(Job-id,…)

This qualifier indicates one or more Jobs to trigger if the Job completes in failure. One or more Job-id’s are entered in a comma delimited format.

 

/NOFAILURESTART removes all failure Job triggers.

 

/GRANT=(account:access,…)

This qualifier is used to associate security permissions to the Job that is to be created. To associate permissions for this Job, you may specify one or more accounts and the level of access each account (or group) may have. Access is specified using one or more of the following keywords:

 

  • READ - Read access

  • WRITE - Read and Write access

  • DELETE - Delete access

  • TAKEOWNERSHIP - Take Ownership

  • TRIGGER - Trigger access

  • TRIGGERQUEUE - Trigger with Queue change access

  • TRIGGERPARAM - Trigger with Parameters change

  • EXECUTIVE - Security/Take Ownership

  • FULL - Complete access

 

Each keyword specified must be separated by a colon.  Multiple accounts are separated by a comma.

 

/GROUP=name

This qualifier indicates the group name for this Job. A group name may be used to group related Jobs and perform group operations.

 

/[NO]HOLD[=(SUBMIT, ERROR, COMPLETION)]

This qualifier is used to set the “Hold” state. The SUBMIT keyword (the default if only /HOLD is specified) indicates the Job is to enter a “Hold” state immediately upon a successful submission. The COMPLETED keyword indicates the Job is to enter a “Hold” state upon Job completion.  One or both keywords may be specified.

 

/IFACTIVE=(keyword | WAIT[:time])

This qualifier indicates whether more than one instance of a scheduled Job can execute. Possible keywords are: SKIP, MULTIPLE and WAIT. SKIP indicates that the scheduled instance should be skipped if an instance is already executing. MULTIPLE indicates that more than one instance of the Job can run. WAIT indicates that the Job should wait. You may optionally indicate how long to wait before skipping the Job. SKIP is the default.

 

/IMMEDIATE

This qualifier when used with the /SCHEDULE qualifier indicates that the Job is to run immediately.

 

/INTERVAL=delta-time

This qualifier indicates that a rescheduled Job entry should be created. A valid delta time can be specified with the exclusion of the TODAY and YESTERDAY keywords. The delta-time specification allows for a self-relative time specification in days, hours, minutes and seconds which are added to the last submission time of the Job. EVERY and INTERVAL qualifiers are mutually exclusive.

 

/JS_PASSWORD[=password]

This qualifier is used in combination with the /JS_USERNAME and, optionally, /JS_SAVEPASSWORD to specify a password to be used with the value of /JS_USERNAME to form an authentication credential to communicate with the Job Scheduler machine.

 

/[NO]JS_SAVEPASSWORD

This qualifier indicates that the password specified with /JS_PASSWORD is to be stored for future authentication purposes.  You can specify this qualifier only when /JS_PASSWORD is also specified. To delete a stored password specify /NOJS_SAVEPASSWORD.

 

/JS_USERNAME=username

This qualifier is used in combination with ./JS_PASSWORD to form an authentication credential used to communicate with the Job Scheduler machine.

 

/LABEL=label

This qualifier is used to set the Job’s object label. The label portion of an object is used to scripting purposes to uniquely identify the object. If this qualifier is omitted, ActiveBatch will create a unique label using a portion of the Job’s name.

 

/LOG

This qualifier is used to display a message when the operation is successful.

 

/[NO[MANAGE_LOGFILES

This qualifier is used to indicate whether ActiveBatch is to centrally manage the Job’s log files. If enabled, the location and name of the Job’s log files are specified by ActiveBatch (you can programmatically obtain the names). If disabled, you retain the ability to locate and name the log files.

 

/[NO]MAX_RESTARTS=n

This qualifier is used to specify the maximum number of restarts the Job may undergo. /NOMAX_RESTARTS means an unlimited number and a value specified means the Job will be limited to that number of restarts. Please note that this value is applicable until the Job completes.

 

/NAME=Jobname

This qualifier is used to set the name of the submitted Job. By default , the Job name is set to that of the filename portion of the Job file specification.

 

/[NO]NOTIFY[=username]

This qualifier is used to indicate that the user submitting the Job wants to be notified when the Job completes. If a value is set with the NOTIFY qualifier that value is a username specification. By default, NONOTIFY is assumed.

 

/ON=scheduler-machine-name

This qualifier allows the command to be directed to the named Job Scheduler machine.  You may specify any valid machine name, FQDN, or IP address (depending on the protocols your machine supports).

 

/[NO]OUTPUT[=file-specification]

This qualifier is used to indicate whether a log file is to be created with the batch Job and if so the specification of that log file. /NOOUTPUT means that a log file isn’t to be created. By default, a batch log file is produced in the current directory of the created Job. The default batch log file specification is the Job-file-specification with a .LOG extension. When /INTERVAL or /EVERY or /SCHEDULE is specified, the following additional information is automatically appended to the output log filename:  _mmdddyyyy_hhmmss.  This helps keep each individual log file separate and distinct as a batch Job is rescheduled. Note: This qualifier is ignored if the /MANAGE_LOGFILES qualifier is specified.

 

/[NO]PARAMETER=(value1,…value8)

This qualifier is used to set the input parameters associated with a specific Job. Values specified may be strings or numbers.  A maximum of eight (8) values may be specified. NOPARAMETER means that no input parameters are to be associated with the Job (which is the default).

 

/PASSWORD[=”string”]

This qualifier is used to associate a password in conjunction with the current username or a username specified with the /USERNAME qualifier. If specified as a “string” value be sure to enclose the password as a quoted string to prevent the case from being changed. If a password value is not specified, the command will prompt for one (echo is disabled for security purposes).

 

/PATH=path

This qualifier allows you to lookup a specific Job using the object’s path (for example, “/TestJob” would refer to the object labeled ‘TestJob’).

 

/[NO]POST_STEP=file-specification

This qualifier indicates that a post-Job step is to be performed.

 

/[NO]PRE_STEP=file-specification

This qualifier indicates that a pre-Job step is to be performed. The pre-Job step is executed prior to the main Job file.

 

/PRIORITY=number

This qualifier is used to set the Queue insertion priority of a Job. The valid range is 1 through 99. By default, the Queue insertion priority is taken from the Queue’s characteristics.

 

/PROCESSORMASK=n

This qualifier is used, in a multi-processing system, to denote processor affinity. The value specified should be considered a bitmask. For example, a value of 3 means bit 0 and 1 and would denote processors zero and one.

 

/QUEUE_SELECTION=ANY | ALL | EVENT

This qualifier, appropriate to Generic Queues only, allows you to select whether one eligible Execution Queue should be used, all eligible machine Queues should be used or only the machine that generated the event should be used.

 

/[NO]READ_ONLY

This qualifier indicates that the Job’s properties should be set to a “read only” state. The default is /NOREAD_ONLY.

 

/REMOVE=(account,…)

This qualifier removes the specified accounts permissions.  More than one account may be specified separated by a comma.

 

/[NO]RESTART=[WAIT | FAILOVER | TERMINATE]

This qualifier is used to set the restartability of an executing Job. /RESTART indicates that the Job is to be automatically reQueued for execution.

 

/NORESTART indicates that the Job is to be removed from the Queueing system in the event of a system failure.

 

/[NO]RETAIN_HISTORY=days

This qualifier is used to indicate the retention period for a completed Job. The /NORETAIN_HISTORY means that the Job’s history is to be removed when the ActiveBatch Database Purge program runs. A value specified indicates the number of days to save the history information.

 

/[NO]RETAIN_LOGFILES=days

This qualifier is used to indicate the retention period of the Job’s log files. The /NORETAIN_LOGFILES means that the Job’s log files are to be removed when the ActiveBatch Database Purge program runs. A value specified indicates the number of days to save the log files. Please note that this value should not be less than that specified for /RETAIN_HISTORY (otherwise it will be automatically adjusted to the same value).

 

/[NO]REUSE

This qualifier may be used to enable or disable the “Reuse Log File” facility. By default, this property is disabled which means that every instance run results in a new log file. Reuse Log file enabled means that a single log file is created (except OpenVMS in which a new version of the log file is created).

 

/[NO]RUNONCE

This qualifier is used to specify whether the Job is to run once regardless of whether the Job is date/time triggered or event triggered. The default is /NORUNONCE.

 

/[NO]SAVE_PASSWORD

This qualifier, valid on Windows 2000/NT machines only, indicates that the password specified should be saved.

 

/NOSAVE_PASSWORD indicates that a saved password should be removed and any specified password should not be saved.

 

/[NO]SCHEDULE=(name,…)

If specified this qualifier indicates that the named Schedules should be associated with this Job. The Schedules must already exist (if not, you should use the INITIALIZE/SCHEDULE command to create one).

 

/SUCCESSRULE=(n | n-n | ODD | EVEN | LZERO | NTMSG)

This qualifier indicates how ActiveBatch interprets the main Job step’s exit code. The values specified all indicate that the Job completed successfully. You may specify a single value, a range of values and/or a keyword indicating success.

 

/[NO]SUCCESSSTART=(Job-id,…)

This qualifier indicates one or more Jobs to trigger if the Job completes successfully. One or more Job-id’s are entered in a comma delimited format.

 

/TAKE_OWNERSHIP

This qualifier indicates that the current user is requesting ownership of the specified Job.  The user must have Executive or Full access permission in order to successfully take ownership.

 

/[NO]TERMINATE

This qualifier indicates whether children processes should be terminated when the Job exits. On Windows NT V4, children processes are identified as having the same parent id (PID). This technique is not precise. On Windows 2000, a Job with this qualifier enabled, is created as a Job object. OpenVMS and Unix operating systems terminate child or subprocess trees regardless of the setting of this qualifier. By default, /NOTERMINATE is assumed.

 

/TIME_ZONE= CLIENT | JOBSCHED | UTC

This qualifier indicates the time zone which should be used by the Job Scheduler to actually schedule time triggers.  By default the Job Scheduler’s time zone is used.

 

/USERNAME=username

This qualifier is used to set the username that initially submitted the Job for execution. Typically when this qualifier is used, the /PASSWORD qualifier is asserted as well.

 

/WORKING_FOLDER=device-directory-spec

This qualifier indicates the default working directory for this Job.

Example: This example will hold a Job with an entry id of 5 on Queue server machine NTSERVER1 and change the state to ‘Hold” and make the Job non-restartable in the event of a system failure.

ABAT MODIFY/JOB=5/ON=NTSERVER1/HOLD/NORESTART

 

This command is used to change a Queue’s characteristics.

 

Format:

MODIFY/QUEUE/qualifiers queue-name

Parameter:

queue-name

This required parameter represents the name of the batch Queue that is to be modified.

Qualifiers:

/BASE_PRIORITY=(IDLE | BELOWNORMAL | NORMAL | ABOVENORMAL | HIGH |REALTIME | number)

This qualifier represents the operating system scheduling priority assigned to the batch process at Job startup. For non-Windows 2000/NT machines, a priority number would be used. By default, NORMAL priority is used.

 

/CLOSE_TIME=(hh:mm-hh:mm)

This qualifier indicates the time of day that the Queue is to remain closed. During the remaining portion the Queue is open. The time specifier hh:mm represents a 24-hour time.  The time range indicates the starting and ending closing time.

 

/DENY=(account:access,…)

This qualifier is used to deny an account access that the account may also obtain through a group. account refers to the WinNT account name (or group) and access refers to one or more of the following keywords: EXECUTIVE, MANAGE and USER. To specify more than one level of access to be denied, separate each access with a colon. Multiple accounts may be specified by delimiting each account/access string with a comma.

 

/DESCRIPTION=”string”

This qualifier allows a short description to be assigned and stored with the created Queue.

 

/[NO]EVENT_LOG=keyword | \\machine

This qualifier indicates whether the Windows 2000/NT Event Log should be used for start and stop batch Job messages and, if so, which machine’s event log should be used. Available keywords are: Client, JobScheduler and ExecutionMachine. You may also specify a specific machine by prefacing the machine name with a \\ (2 backslashes) notation. To avoid using the Event Log specify /NOEVENT_LOG.

 

/EXEC_ON=machine-name

For an Execution Queue, this qualifier indicates the machine that submitted Jobs are to be executed on.

 

/GENERIC=(ExecQueue1, ExecQueue2,…. ExecQueueN)

This qualifier indicates that the Queue to be created is a Generic Queue.  A Generic Queue points to one or more Execution Queues. The values specified with this qualifier are the actual Execution Queue names. If this qualifier is omitted, the Queue is assumed to be an Execution Queue.

 

/GRANT=(account:access,…)

This qualifier is used to associate security permissions to the Queue that is to be created.  By default, the owner and Administrator are given full access to the Queue and the all other users are given Submit level access (this default can be changed with the SET BATCH command). To associate different permissions for this Queue, you may specify one or more accounts and the level of access each account (or group) may have with this Queue.

 

Access is specified using one or more of the following keywords:

 

  • FULL - Complete access

  • EXECUTIVE - Give/Take Ownership

  • MANAGE - Ability to issue Queue management commands

  • USER - Ability to SUBMIT Jobs

 

Each keyword specified must be separated by a colon.  Multiple accounts are separated by a comma.

 

/JOB_LIMIT=number

This qualifier, valid for Execution Queues, indicates the number of simultaneous Jobs that may be executed for this Execution Queue. The valid range is 1 through 10. By default, one is assumed.

 

/JS_PASSWORD[=password]

This qualifier is used in combination with the /JS_USERNAME and, optionally, /JS_SAVEPASSWORD to specify a password to be used with the value of /JS_USERNAME to form an authentication credential to communicate with the Job Scheduler machine.

 

/[NO]JS_SAVEPASSWORD

This qualifier indicates that the password specified with /JS_PASSWORD is to be stored for future authentication purposes.  You can specify this qualifier only when /JS_PASSWORD is also specified. To delete a stored password specify /NOJS_SAVEPASSWORD.

 

/JS_USERNAME=username

This qualifier is used in combination with ./JS_PASSWORD to form an authentication credential used to communicate with the Job Scheduler machine.

 

/LOG

This qualifier is used to display a message when the operation is successful.

 

/ON=scheduler-machine-name

This qualifier allows the command to be directed to the named Job Scheduler machine.  You may specify any valid machine name, FQDN, or IP address (depending on the protocols your machine supports).

 

/PRIORITY=number

This qualifier indicates the default Queue Priority to be used when submitting a Job to a Queue and a priority is not specified as part of Job submission. This qualifier should not be mistaken as the scheduling priority of the Job (see /BASE_PRIORITY). The valid range is 1 through 99.  The default is 10.

 

/REMOVE=(account,…)

This qualifier removes the specified accounts permissions.  More than one account may be specified separated by a comma.

 

/SCHEDULING = (SEQUENTIAL | ROUND-ROBIN | BALANCED)

This qualifier indicates the scheduling algorithm which will be used for a Generic Queue. Sequential means that Jobs are submitted to the first Execution Queue listed until that Queue is executing its maximum Job limit. Round-Robin means that each Queue, in turn, is given a Job to execute until its Job limits are met. Balanced indicates that a workload balancing approach be used which determines the best machine to run on based on CPU, memory and other parameters.

 

/STOP_TIME=(hh:mm-hh:mm)

This qualifier indicates the time of day that the Queue is to remain stopped. During the remaining portion the Queue is started.  The time hh:mm represents a 24-hour time.  The time range indicates the starting and ending stopped time.

 

/TAKE_OWNERSHIP

This qualifier indicates that the current user is requesting ownership of the specified Queue.  The user must have Executive or Full access permission in order to successfully take ownership.

 

/USER_CHAR=(char:datatype:value,…)

This qualifier is used to associate user characteristics with an Execution Queue.

 

  • Char indicates a user characteristic name. This name is free form but cannot contain spaces. 

  • Datatype is either string or numeric.

  • Value is a string or numeric value based on the characteristic datatype. 

 

You may specify multiple characteristics by separating each with a comma.

 

/WORKING_FOLDER=device-directory-spec

This qualifier indicates the default working directory for Jobs submitted to this Queue in which a directory has not been specified.

Example: This example will modify a Queue named TESTQUEUE and set the O/S priority to HIGH, grant the Everyone Group Manage permissions, set the Job limit to 5.

ABAT MODIFY/QUEUE TESTQUEUE /BASE_PRIORITY=HIGH /GRANT=EVERYONE:MANAGE     /JOB_LIMIT=5

 

The OPEN/QUEUE command allows Job submission.

 

Format:

OPEN/QUEUE queue-name

Parameter: queue-name

This required parameter indicates the specific Queue that is to be opened.

Qualifiers:

/JS_PASSWORD[=password]

This qualifier is used in combination with the /JS_USERNAME and, optionally, /JS_SAVEPASSWORD to specify a password to be used with the value of /JS_USERNAME to form an authentication credential to communicate with the Job Scheduler machine.

 

/[NO]JS_SAVEPASSWORD

This qualifier indicates that the password specified with /JS_PASSWORD is to be stored for future authentication purposes.  You can specify this qualifier only when /JS_PASSWORD is also specified. To delete a stored password specify /NOJS_SAVEPASSWORD.

 

/JS_USERNAME=username

This qualifier is used in combination with ./JS_PASSWORD to form an authentication credential used to communicate with the Job Scheduler machine.

 

/LOG

This qualifier is used to display a message when the operation is successful.

 

/ON=scheduler-machine-name

This qualifier allows the command to be directed to the named Job Scheduler machine.  You may specify any valid machine name, FQDN, or IP address (depending on the protocols your machine supports).

Example: This example opens the Queue named TESTQUEUE and allows new Job submission.

ABAT OPEN/QUEUE TESTQUEUE

 

This command will pause an executing Job instance. Note: On Windows 2000/NT machines, only the primary thread is suspended. For a multi-threaded process this may not necessarily produce the expected results.

 

Format:

PAUSE/JOB=Job-entry-id/qualifiers

Qualifiers:

/JOB=Job-entry-id

This required qualifier indicates the specific Job entry via its unique entry identification that is to be “Paused”. Please note that this command is only applicable to an executing Job.

 

/JS_PASSWORD[=password]

This qualifier is used in combination with the /JS_USERNAME and, optionally, /JS_SAVEPASSWORD to specify a password to be used with the value of /JS_USERNAME to form an authentication credential to communicate with the Job Scheduler machine.

 

/[NO]JS_SAVEPASSWORD

This qualifier indicates that the password specified with /JS_PASSWORD is to be stored for future authentication purposes.  You can specify this qualifier only when /JS_PASSWORD is also specified. To delete a stored password specify /NOJS_SAVEPASSWORD.

 

/JS_USERNAME=username

This qualifier is used in combination with ./JS_PASSWORD to form an authentication credential used to communicate with the Job Scheduler machine.

 

/LOG

This qualifier is used to display a message when the operation is successful.

 

/ON=scheduler-machine-name

This qualifier allows the command to be directed to the named Job Scheduler machine.  You may specify any valid machine name, FQDN, or IP address (depending on the protocols your machine supports).

Example: This example will pause an executing  Job with an entry id of 5 on Queue server NTSERVER1.

ABAT PAUSE/JOB=5/ON=NTSERVER1

 

This command will release a held Job.

 

Format:

RELEASE/JOB=Job-entry=id/qualifiers

Qualifiers:

/JOB=Job-entry-id

This required qualifier indicates the specific Job entry via its unique entry identification that is currently held and will now be released for possible execution.

 

/JS_PASSWORD[=password]

This qualifier is used in combination with the /JS_USERNAME and, optionally, /JS_SAVEPASSWORD to specify a password to be used with the value of /JS_USERNAME to form an authentication credential to communicate with the Job Scheduler machine.

 

/[NO]JS_SAVEPASSWORD

This qualifier indicates that the password specified with /JS_PASSWORD is to be stored for future authentication purposes.  You can specify this qualifier only when /JS_PASSWORD is also specified. To delete a stored password specify /NOJS_SAVEPASSWORD.

 

/JS_USERNAME=username

This qualifier is used in combination with ./JS_PASSWORD to form an authentication credential used to communicate with the Job Scheduler machine.

 

/LOG

This qualifier is used to display a message when the operation is successful.

 

/ON=scheduler-machine-name

This qualifier allows the command to be directed to the named Job Scheduler machine.  You may specify any valid machine name or IP address (depending on the protocols your machine supports).

 

/PATH=path

This qualifier allows you to lookup a specific Job using the object’s path (for example, “/TestJob” would refer to the object labeled ‘TestJob’).

Example: This example will release a held  Job with an entry id of 5 on Queue server machine NTSERVER1.

ABAT RELEASE/JOB=5/ON=NTSERVER1

 

This command will requeue (or move) a Job to another Queue.

 

Format:

RELEASE/JOB=Job-entry=id/qualifiers

Qualifiers:

/JOB=Job-entry-id

This required qualifier indicates the specific Job entry via its unique entry identification that is to be moved to another Queue.

 

/JS_PASSWORD[=password]

This qualifier is used in combination with the /JS_USERNAME and, optionally, /JS_SAVEPASSWORD to specify a password to be used with the value of /JS_USERNAME to form an authentication credential to communicate with the Job Scheduler machine.

 

/[NO]JS_SAVEPASSWORD

This qualifier indicates that the password specified with /JS_PASSWORD is to be stored for future authentication purposes.  You can specify this qualifier only when /JS_PASSWORD is also specified. To delete a stored password specify /NOJS_SAVEPASSWORD.

 

/JS_USERNAME=username

This qualifier is used in combination with ./JS_PASSWORD to form an authentication credential used to communicate with the Job Scheduler machine.

 

/LOG

This qualifier is used to display a message when the operation is successful.

 

/ON=scheduler-machine-name

This qualifier allows the command to be directed to the named Job Scheduler machine.  You may specify any valid machine name, FQDN, or IP address (depending on the protocols your machine supports).

 

/PATH=path

This qualifier allows you to lookup a specific Job using the object’s path (for example, “/TestJob” would refer to the object labeled ‘TestJob’).

 

/QUEUE=new-queue-name

This qualifier indicates the destination Queue that this Job is to be moved to.

Example: This example will requeue Job 15 to Queue EQ1

ABAT REQUEUE/JOB=15/QUEUE=EQ1

 

This command will restart an existing Job or Plan instance.

 

Format:

RESTART/qualifiers

Qualifiers:

/JOB=Job-entry-id

This required qualifier indicates the specific object via its unique object identification number. Note: Only an instance (and not a definition) can be restarted.

 

/JS_PASSWORD[=password]

This qualifier is used in combination with the /JS_USERNAME and, optionally, /JS_SAVEPASSWORD to specify a password to be used with the value of /JS_USERNAME to form an authentication credential to communicate with the Job Scheduler machine.

 

/[NO]JS_SAVEPASSWORD

This qualifier indicates that the password specified with /JS_PASSWORD is to be stored for future authentication purposes.  You can specify this qualifier only when /JS_PASSWORD is also specified. To delete a stored password specify /NOJS_SAVEPASSWORD.

 

/JS_USERNAME=username

This qualifier is used in combination with ./JS_PASSWORD to form an authentication credential used to communicate with the Job Scheduler machine.

 

/LOG

This qualifier is used to display a message when the operation is successful.

 

/ON=scheduler-machine-name

This qualifier allows the command to be directed to the named Job Scheduler machine.  You may specify any valid machine name, FQDN, or IP address (depending on the protocols your machine supports).

Example: This command will abort and then restart the Job with an entry id of 5 on a machine named NTSERVER1.

ABAT RESTART/JOB=5/ON=NTSERVER1

 

This command will resume a paused Job instance.

 

Format:

RESUME/JOB=Job-entry-id/qualifiers

Qualifiers:

/JOB=Job-entry-id

This required qualifier indicates the specific object via its unique object identification number. Note: Only an instance (and not a definition) can be resumed.

 

/JS_PASSWORD[=password]

This qualifier is used in combination with the /JS_USERNAME and, optionally, /JS_SAVEPASSWORD to specify a password to be used with the value of /JS_USERNAME to form an authentication credential to communicate with the Job Scheduler machine.

 

/[NO]JS_SAVEPASSWORD

This qualifier indicates that the password specified with /JS_PASSWORD is to be stored for future authentication purposes.  You can specify this qualifier only when /JS_PASSWORD is also specified. To delete a stored password specify /NOJS_SAVEPASSWORD.

 

/JS_USERNAME=username

This qualifier is used in combination with ./JS_PASSWORD to form an authentication credential used to communicate with the Job Scheduler machine.

 

/LOG

This qualifier is used to display a message when the operation is successful.

 

/ON=scheduler-machine-name

This qualifier allows the command to be directed to the named Job Scheduler machine.  You may specify any valid machine name, FQDN, or IP address (depending on the protocols your machine supports).

Example: This example will resume a paused  Job with an entry id of 5 on Job Scheduler machine NTSERVER1.

ABAT RESUME/JOB=5/ON=NTSERVER1

 

This command allows an Administrator to establish defaults for an ActiveBatch user as well as change ActiveBatch Administrator status.

 

Format:

SET BATCH/qualifiers

Qualifiers:

/DENY=(account:access…,…)

This qualifier is used to deny an account access that the account may also obtain through a group. account refers to the WinNT account name (or group) and access refers to one or more of the following keywords: EXECUTIVE, MANAGE and USER. To specify more than one level of access to be denied, separate each access with a colon. Multiple accounts may be specified by delimiting each account/access string with a comma.

 

/GRANT=(account:access,…)

This qualifier is used to associate security permissions to the Queue that is to be created. By default, the owner and Administrator are given full access to the Queue and the all other users are given Submit level access (this default can be changed with the SET BATCH command). To associate different permissions for this Queue, you may specify one or more accounts and the level of access each account (or group) may have with this Queue.

 

Access is specified using one or more of the following keywords:

 

  • FULL - Complete access

  • EXECUTIVE - Give/Take Ownership

  • MANAGE - Ability to issue Queue management commands

  • USER - Ability to SUBMIT Jobs

 

Each keyword specified must be separated by a colon.  Multiple accounts are separated by a comma.

 

/JS_PASSWORD[=password]

This qualifier is used in combination with the /JS_USERNAME and, optionally, /JS_SAVEPASSWORD to specify a password to be used with the value of /JS_USERNAME to form an authentication credential to communicate with the Job Scheduler machine.

 

/[NO]JS_SAVEPASSWORD

This qualifier indicates that the password specified with /JS_PASSWORD is to be stored for future authentication purposes.  You can specify this qualifier only when /JS_PASSWORD is also specified. To delete a stored password specify /NOJS_SAVEPASSWORD.

 

/JS_USERNAME=username

This qualifier is used in combination with ./JS_PASSWORD to form an authentication credential used to communicate with the Job Scheduler machine.

 

/ON=scheduler-machine-name

This qualifier allows the command to be directed to the named Job Scheduler machine.  You may specify any valid machine name, FQDN, or IP address (depending on the protocols your machine supports).

 

/[NO]QUEUE=queue-name

This qualifier allows you to designate a default Queue to be used when a SUBMIT command is issued.  By default, the /QUEUE qualifier is required to be specified with the SUBMIT command. Negating the qualifier causes the default to be removed.

 

/REMOVE=(account,…)

This qualifier removes the specified accounts permissions.  More than one account may be specified separated by a comma.

 

/[NO]SCHEDULER=machine

This qualifier allows you to designate a default Job Scheduler machine to be used when invoking other command-line utilities. 

By default the local machine is assumed. Negating the qualifier causes the default to be removed.

 

This command will display batch Jobs based on various search parameters.

 

Format:

SHOW JOB/qualifiers

Qualifiers:

/ALL_JOBS

By default, only Jobs submitted by the owner are eligible for display. This qualifier indicates that all batch Jobs, regardless of who submitted the Job, are eligible for possible display.

 

/BRIEF

This qualifier indicates that only very terse information be displayed for each Job. BRIEF is the default.

 

/BY_JOB_STATUS=( DEFERRED | EXECUTING | HELD | PENDING)

This qualifier allows you to further refine the search to those Jobs in the above specified Job states.

 

/EXECUTION_QUEUE

This qualifier allows the search for eligible Jobs to be further refined to those on Execution Queues.

 

/FULL

This qualifier is used to display complete information on all Jobs which are to be displayed. /BRIEF is the default.

 

/GENERIC

This qualifier displays Jobs that are on a Generic Queue. EXECUTION_MACHINE and GENERIC qualifiers are mutually exclusive.

 

/JOB=Job-entry-id

This required qualifier indicates the specific Job entry via its unique entry identification is to be set to “Hold” status.  Please note that an active executing Job cannot have its state changed via this command.

 

/JS_PASSWORD[=password]

This qualifier is used in combination with the /JS_USERNAME and, optionally, /JS_SAVEPASSWORD to specify a password to be used with the value of /JS_USERNAME to form an authentication credential to communicate with the Job Scheduler machine.

 

/[NO]JS_SAVEPASSWORD

This qualifier indicates that the password specified with /JS_PASSWORD is to be stored for future authentication purposes.  You can specify this qualifier only when /JS_PASSWORD is also specified. To delete a stored password specify /NOJS_SAVEPASSWORD.

 

/JS_USERNAME=username

This qualifier is used in combination with ./JS_PASSWORD to form an authentication credential used to communicate with the Job Scheduler machine.

 

/ON=scheduler-machine-name

This qualifier allows the command to be directed to the named Job Scheduler machine.  You may specify any valid machine name, FQDN, or IP address (depending on the protocols your machine supports).

 

/PATH=path

This qualifier allows you to lookup a specific Job using the object’s path (for example, “/TestJob” would refer to the object labeled ‘TestJob’).

 

/OUTPUT=FileSpecification

This qualifier allows the command display to be redirected to a disk file. By default, the output of this command is sent to Standard Out (normally the console window).

 

/USERNAME=username

This qualifier allows the search for eligible Jobs to be further refined to a specific username. By default, the username of this command is used for Job selection. ALL_JOBS and USERNAME are mutually exclusive.

Note: If Job, Name and/or Label are specified the following order of precedence is used: Job, Name and then Label.

 

Example: This example shows a batch Job with an ID of 6 on a machine called TEST and shows all information about that Job.

ABAT SHOW JOB /FULL /JOB=6

 

Job 6 submitted to Queue TESTQUEUE on TEST by XLNTUSER

Job Name : TEST2       Status : Retained : CFFD00B5

Priority : 10          File : C:\TESTXCP\TEST2.XCP

Command Shell : XLNT Log File : C:\TESTXCP\TEST2.LOG

Characteristics : Job Restart disabled, Notification enabled for TEST:XLNTUSER via NT Messenger Service, Log File printing disabled, Log File deleted

 

This command will display batch Jobs based on various search parameters.

 

Format:

SHOW QUEUE/qualifiers [queue-name]

Parameter:

queue-name

 

This optional parameter represents a specific Queue name to display. If omitted, all Queues are eligible for display.

Qualifiers:

/ALL_JOBS

By default, only Jobs submitted by the owner are eligible for display. This qualifier indicates that all batch Jobs, regardless of who submitted the Job, are eligible for possible display.

 

/BRIEF

This qualifier indicates that only very terse information be displayed for each Job. BRIEF is the default.

 

/EXECUTION_MACHINE=machine-name

This qualifier allows the search for eligible Jobs to be further refined to those Execution Queues which are associated with a given machine.

 

/FULL

This qualifier is used to display complete information on all Jobs which are to be displayed. /BRIEF is the default.

 

/GENERIC

This qualifier displays Jobs that are on a Generic Queue. EXECUTION_MACHINE and GENERIC qualifiers are mutually exclusive.

 

/JS_PASSWORD[=password]

This qualifier is used in combination with the /JS_USERNAME and, optionally, /JS_SAVEPASSWORD to specify a password to be used with the value of /JS_USERNAME to form an authentication credential to communicate with the Job Scheduler machine.

 

/[NO]JS_SAVEPASSWORD

This qualifier indicates that the password specified with /JS_PASSWORD is to be stored for future authentication purposes.  You can specify this qualifier only when /JS_PASSWORD is also specified. To delete a stored password specify /NOJS_SAVEPASSWORD.

 

/JS_USERNAME=username

This qualifier is used in combination with ./JS_PASSWORD to form an authentication credential used to communicate with the Job Scheduler machine.

 

/ON=scheduler-machine-name

This qualifier allows the command to be directed to the named Job Scheduler machine.  You may specify any valid machine name, FQDN, or IP address (depending on the protocols your machine supports).

 

/OUTPUT=FileSpecification

This qualifier allows the command display to be redirected to a disk file. By default, the output of this command is sent to Standard Out (normally the console window).

 

/USERNAME=username

This qualifier allows the search for eligible Jobs to be further refined to a specific owner. By default, the username of this command is used for Job selection. ALL_JOBS and OWNER are mutually exclusive.

Example: This example shows the Queue called TESTQUEUE with complete information on all Jobs.

ABAT SHOW QUEUE TESTQUEUE /FULL

 

Execution Queue TESTQUEUE on TEST, owned by XLNTUSER

Status : Started, Opened  Job Retention : Failed Jobs

Base Priority  : NORMAL  Queue Priority : 10

Command Shell : XLNT          Job Limit :  1

Description:         A Test Queue

 

Account Permissions
Administrators Granted: EXECUTIVE, MANAGE, USER
SYSTEM Granted: EXECUTIVE, MANAGE, USER
Everyone Granted: USER
DOMAIN\XLNTUSER Granted: EXECUTIVE, MANAGE, USER

 

Jobs on Queue TESTQUEUE

No Jobs on Queue

 

The START/QUEUE command allows a Queue to be started for Job execution.

 

Format:

START/QUEUE queue-name

Parameter:

queue-name

 

This required parameter indicates the specific Queue that is to be started.

Qualifiers:

/JS_PASSWORD[=password]

This qualifier is used in combination with the /JS_USERNAME and, optionally, /JS_SAVEPASSWORD to specify a password to be used with the value of /JS_USERNAME to form an authentication credential to communicate with the Job Scheduler machine.

 

/[NO]JS_SAVEPASSWORD

This qualifier indicates that the password specified with /JS_PASSWORD is to be stored for future authentication purposes.  You can specify this qualifier only when /JS_PASSWORD is also specified. To delete a stored password specify /NOJS_SAVEPASSWORD.

 

/JS_USERNAME=username

This qualifier is used in combination with ./JS_PASSWORD to form an authentication credential used to communicate with the Job Scheduler machine.

 

/LOG

This qualifier is used to display a message when the operation is successful.

 

/ON=scheduler-machine-name

This qualifier allows the command to be directed to the named Job Scheduler machine.  You may specify any valid machine name, FQDN, or IP address (depending on the protocols your machine supports).

Example: This example starts the Queue named TESTQUEUE for Job execution.

ABAT START/QUEUE TESTQUEUE

 

The STOP/QUEUE command prevents further Job execution on a Queue basis and/or aborts a currently executing Job.

 

Format:

STOP/QUEUE queue-name

Parameter:

queue-name

 

This required parameter indicates the specific Queue that is to be stopped.

Qualifiers:

/AFTER EXECUTION

This qualifier indicates that the currently executing Job should be allowed to complete prior to the Queue being stopped. AFTER_EXECUTION is the default.

 

/CLOSE

This qualifier indicates that the Queue is to be closed for Job submission.

 

/IMMEDIATE

This qualifier indicates that the currently executing Job is to be aborted immediately.  By default, the Job is allowed to complete

(see AFTER_EXECUTION).

 

/JS_PASSWORD[=password]

This qualifier is used in combination with the /JS_USERNAME and, optionally, /JS_SAVEPASSWORD to specify a password to be used with the value of /JS_USERNAME to form an authentication credential to communicate with the Job Scheduler machine.

 

/[NO]JS_SAVEPASSWORD

This qualifier indicates that the password specified with /JS_PASSWORD is to be stored for future authentication purposes.  You can specify this qualifier only when /JS_PASSWORD is also specified. To delete a stored password specify /NOJS_SAVEPASSWORD.

 

/JS_USERNAME=username

This qualifier is used in combination with ./JS_PASSWORD to form an authentication credential used to communicate with the Job Scheduler machine.

 

/LOG

This qualifier is used to display a message when the operation is successful.

 

/ON=scheduler-machine-name

This qualifier allows the command to be directed to the named Job Scheduler machine.  You may specify any valid machine name, FQDN, or IP address (depending on the protocols your machine supports).

Example: This example stops the Queue named TESTQUEUE immediately rather than waiting for the Jobs to execute.

ABAT STOP/QUEUE TESTQUEUE /IMMEDIATE

 

The SUBMIT command is used to submit a Job for batch execution.

 

Format:

SUBMIT/qualifiers Job-file-specification

Parameter:

Job-file-specification

 

This required parameter is a file specification which will represent the Job. The file specification may be an executable (.EXE) or any file which contains a known file association.

Qualifiers:

/[NO]ACTIVEBATCH_EVENT

This qualifier indicates whether the Job can accept an ActiveBatch TRIGGER command. The default is that a Job can accept the command.

 

/[NO]ACCOBJ=user-account-name

This qualifier indicates whether a User Account name object is being referenced for security (username, password) information. Negating this qualifier indicates the object’s reference is to be removed from this Job. User account name objects are highly recommended for security purposes instead of using embedded security credentials within the Job.

 

/AFTER=combination-time

This qualifier is used to defer a Job so that the Job will be executed at some future time. The time specified is any valid combination time (including keywords TODAY and TOMORROW). If /AFTER is specified without a combination time specified the keyword TODAY is assumed. By default, Job execution is assumed to be immediate.

 

/BASE_PRIORITY=(LOW | BELOWNORMAL | NORMAL | ABOVENORMAL | HIGH | REALTIME | number)

This qualifier represents the operating system scheduling priority assigned to the batch Job. For Windows 2000/NT machines the keywords above are used. For non-Windows machines, a priority number must be specified. By default, the base priority is taken from the Queue’s characteristics.

 

/CALENDAR=calendar-name

This qualifier associates a business Calendar with the Job. This allows a Job to be scheduled only on working days.

 

/CATEGORY=”string”

This qualifier indicates the user category or other string value that will be kept with the Job.

 

/CONTACT=(delivery:target[:time],…)

This qualifier is used to denote contact information for those machines/users that are to be notified when a Job starts or completes execution. Delivery represents one of two keywords which indicate how the notification is to be occur. MAIL or MESSENGER are valid delivery keywords. Target represents either a machine name, if the delivery is MESSENGER, or a valid e-mail address if the delivery is MAIL. Time indicates either a START or FINISH Job time criteria that is used to indicate when the notification is to be sent. If  “time” is omitted, then FINISH is assumed. You may specify more than one contact by separating each contact specification with a comma.

 

/COPY=(PRE, POST, MAIN)

This qualifier is used to indicate which batch Job file steps should be copied to the selected Execution Machine. The keywords PRE, POST and MAIN indicate which batch file steps are to be copied. By default, no batch files are copied.

 

/DENY=(account:access,…)

This qualifier is used to deny an account access that the account may also obtain through a group. account refers to the WinNT account name (or group) and access refers to one or more of the following keywords: READ, WRITE, DELETE, EXECUTE, TAKEOWNERSHIP, TRIGGER, TRIGGERPARAM and TRIGGERQUEUE. To specify more than one level of access to be denied, separate each access with a colon. Multiple accounts may be specified by delimiting each account/access string with a comma.

 

/DESCRIPTION=”string”

This qualifier is used to set  the pending Job’s description specified at Job submission time.

 

/DOCUMENTATION=”string”

This qualifier is used to associate a documentation reference with the Job.

 

/EVERY=(MINUTE=mm,… , HOUR=hh,… , WEEKDAY=ddd,… , DAY=dd,… , MONTH=mm,…)

Note: This qualifier while supported is obsolete and has been superceded by the /SCHEDULE qualifier. This qualifier indicates that a rescheduled Job entry is to be created. By default, if all keywords are omitted, a Job entry is created that will execute at midnight each day. Valid keywords are as follows.  Specification of multiple values or multiple keywords is supported through the use of comma delimitation.

 

  • MINUTE - valid range of 0 through 59. Default is 0.

  • HOUR - valid range of 0 through 23. Default is 0.

  • WEEKDAY- acceptable values are SUN, MON, TUE, WED, THU, FRI, SAT.

  • DAY - valid range of 1 through 31. A day which is specified as greater than the number of days in the month denotes the last day of the month. Default is every day of a month.

  • MONTH - valid range of 1 through 12. Default is every month.

 

The EVERY and INTERVAL qualifiers are mutually exclusive. When a DAY is specified that exceeds the actual number of days in the month, ActiveBatch will assume that the last day of the month is to be selected. If multiple DAYs are specified which exceed the actual number of days in the month, the Job will be scheduled once on the last day of the month.

 

/FAILURESTART=(Job-id,…)

This qualifier indicates one or more Jobs to trigger if the Job completes in failure. One or more Job-id’s are entered in a comma delimited format.

 

/GRANT=(account:access,…)

This qualifier is used to associate security permissions to the Job that is to be created. To associate permissions for this Job, you may specify one or more accounts and the level of access each account (or group) may have. Access is specified using one or more of the following keywords:

 

  • READ - Read access

  • WRITE - Read and Write access

  • DELETE - Delete access

  • TAKEOWNERSHIP - Take Ownership

  • TRIGGER - Trigger access

  • TRIGGERQUEUE - Trigger with Queue change access

  • TRIGGERPARAM - Trigger with Parameters change

  • EXECUTIVE - Security/Take Ownership

  • FULL - Complete access

 

Each keyword specified must be separated by a colon.  Multiple accounts are separated by a comma.

 

/GROUP=name

This qualifier indicates the group name for this Job. A group name may be used to group related Jobs and perform group operations.

 

/HOLD[=(SUBMIT, ERROR, COMPLETION)]

This qualifier is used to set the initial “Hold” state of a Job. If this qualifier is not specified, the Job will become eligible for execution based on its position in an Execution Queue. The SUBMIT keyword (the default if only /HOLD is specified) indicates the Job is to enter a “Hold” state immediately upon a successful submission. The ERROR keyword indicates that the Job is to enter a “Hold” state if the Job completes in error. The COMPLETION keyword indicates the Job is to enter a “Hold” state upon Job completion (regardless of whether the Job was successful or not).  One or more keywords may be specified.

 

/IFACTIVE=(keyword | WAIT[:time])

This qualifier indicates whether more than one instance of a scheduled Job can execute. Possible keywords are: SKIP, MULTIPLE and WAIT. SKIP indicates that the scheduled instance should be skipped if an instance is already executing. MULTIPLE indicates that more than one instance of the Job can run. WAIT indicates that the Job should wait. You may optionally indicate how long to wait before skipping the Job. SKIP is the default.

 

/IMMEDIATE

This qualifier when used with the /SCHEDULE qualifier indicates that the Job is to run immediately.

 

/INTERACTIVE=(NORMAL | MAXIMIZED | MINIMIZED)

This qualifier indicates that the Job is to be executed interactively on the desktop. The keywords NORMAL,  MAXIMIZED and MINIMIZED indicate the starting state of the visible window. If the qualifier is specified and the keyword is omitted, NORMAL is assumed.

 

/INTERVAL=delta-time

This qualifier indicates that a rescheduled Job entry should be created. A valid delta time can be specified with the exclusion of the TODAY and YESTERDAY keywords. The delta-time specification allows for a self-relative time specification in days, hours, minutes and seconds which are added to the last submission time of the Job. EVERY and INTERVAL qualifiers are mutually exclusive.

 

/JS_PASSWORD[=password]

This qualifier is used in combination with the /JS_USERNAME and, optionally, /JS_SAVEPASSWORD to specify a password to be used with the value of /JS_USERNAME to form an authentication credential to communicate with the Job Scheduler machine.

 

/[NO]JS_SAVEPASSWORD

This qualifier indicates that the password specified with /JS_PASSWORD is to be stored for future authentication purposes.  You can specify this qualifier only when /JS_PASSWORD is also specified. To delete a stored password specify /NOJS_SAVEPASSWORD.

 

/JS_USERNAME=username

This qualifier is used in combination with ./JS_PASSWORD to form an authentication credential used to communicate with the Job Scheduler machine.

 

/LABEL=label

This qualifier is used to set the Job’s object label. The label portion of an object is used to scripting purposes to uniquely identify the object. If this qualifier is omitted, ActiveBatch will create a unique label using a portion of the Job’s name.

 

/LOG

This qualifier is used to display a message when the operation is successful.

 

/[NO[MANAGE_LOGFILES

This qualifier is used to indicate whether ActiveBatch is to centrally manage the Job’s log files. If enabled, the location and name of the Job’s log files are specified by ActiveBatch (you can programmatically obtain the names). If disabled, you retain the ability to locate and name the log files.

 

/[NO]MAX_RESTARTS=n

This qualifier is used to specify the maximum number of restarts the Job may undergo. /NOMAX_RESTARTS means an unlimited number and a value specified means the Job will be limited to that number of restarts. Please note that this value is applicable until the Job completes.

 

/NAME=Jobname

This qualifier is used to set the name of the submitted Job. By default , the Job name is set to that of the filename portion of the Job file specification.

 

/[NO]NOTIFY[=username]

This qualifier is used to indicate that the user submitting the Job wants to be notified when the Job completes. If a value is set with the NOTIFY qualifier that value is a username specification. By default, NONOTIFY is assumed. Note: This qualifier has been made obsolete by the /CONTACT qualifier. The equivalent syntax is /CONTACT=machine-name:MESSENGER:FINISH.

 

/ON=scheduler-machine-name

This qualifier allows the command to be directed to the named Job Scheduler machine.  You may specify any valid machine name, FQDN, or IP address (depending on the protocols your machine supports).

 

/[NO]OUTPUT[=file-specification]

This qualifier is used to indicate whether a log file is to be created with the batch Job and if so the specification of that log file. /NOOUTPUT means that a log file isn’t to be created. By default, a batch log file is produced in the current directory of the created Job. The default batch log file specification is the Job-file-specification with a .LOG extension. When /INTERVAL or /EVERY or /SCHEDULE is specified, the following additional information is automatically appended to the output log filename:  _mmdddyyyy_hhmmss.  This helps keep each individual log file separate and distinct as a batch Job is rescheduled. Note: This qualifier is ignored if the /MANAGE_LOGFILES qualifier is specified.

 

/[NO]PARAMETER=(value1,…value8)

This qualifier is used to set the input parameters associated with a specific Job. Values specified may be strings or numbers.  A maximum of eight (8) values may be specified. NOPARAMETER means that no input parameters are to be associated with the Job (which is the default).

 

/PASSWORD[=”string”]

This qualifier is used to associate a password in conjunction with the current username or a username specified with the

 

/USERNAME qualifier. If specified as a “string” value be sure to enclose the password as a quoted string to prevent the case from being changed. If a password value is not specified, the command will prompt for one (echo is disabled for security purposes).

 

/POST_STEP=file-specification

This qualifier indicates that a post-Job step is to be performed.

 

/PRE_STEP=file-specification

This qualifier indicates that a pre-Job step is to be performed. The pre-Job step is executed prior to the main Job file.

 

/PRIORITY=number

This qualifier is used to set the Queue insertion priority of a Job. The valid range is 1 through 99. By default, the Queue insertion priority is taken from the Queue’s characteristics.

 

/PROCESSORMASK=n

This qualifier is used, in a multi-processing system, to denote processor affinity. The value specified should be considered a bitmask. For example, a value of 3 means bit 0 and 1 and would denote processors zero and one.

 

/QUEUE=queue-name

This qualifier is used to indicate the Queue that the Job is to be submitted on.  This qualifier is required unless a default Queue has been established using the SET BATCH command.

 

/QUEUE_SELECTION=ANY | ALL | EVENT

This qualifier, appropriate to Generic Queues only, allows you to select whether one eligible Execution Queue should be used, all eligible machine Queues should be used or only the machine that generated the event should be used.

 

/[NO]READ_ONLY

This qualifier indicates that the Job’s properties should be set to a “read only” state. The default is /NOREAD_ONLY.

 

/REMOVE=(account,…)

This qualifier removes the specified accounts permissions.  More than one account may be specified separated by a comma.

 

/[NO]RESTART=[WAIT | FAILOVER | TERMINATE]

This qualifier is used to set the restartability of an executing Job. /RESTART indicates that the Job is to be automatically requeued for execution.

 

/NORESTART indicates that the Job is to be removed from the queuing system in the event of a system failure.

 

/[NO]RETAIN_HISTORY=days

This qualifier is used to indicate the retention period for a completed Job. The /NORETAIN_HISTORY means that the Job’s history is to be removed when the ActiveBatch Database Purge program runs. A value specified indicates the number of days to save the history information.

 

/[NO]RETAIN_LOGFILES=days

This qualifier is used to indicate the retention period of the Job’s log files. The /NORETAIN_LOGFILES means that the Job’s log files are to be removed when the ActiveBatch Database Purge program runs. A value specified indicates the number of days to save the log files. Please note that this value should not be less than that specified for /RETAIN_HISTORY (otherwise it will be automatically adjusted to the same value).

 

/[NO]REUSE

This qualifier may be used to enable or disable the “Reuse Log File” facility. By default, this property is disabled which means that every instance run results in a new log file. Reuse Log file enabled means that a single log file is created (except OpenVMS in which a new version of the log file is created).

 

/[NO]RUNONCE

This qualifier is used to specify whether the Job is to run once regardless of whether the Job is date/time triggered or event triggered. The default is /NORUNONCE.

 

/[NO]SAVE_PASSWORD

This qualifier, valid on Windows 2000/NT machines only, indicates that the password specified should be saved. /NOSAVE_PASSWORD indicates that a saved password should be removed and any specified password should not be saved.

 

/SCHEDULE=(name,…)

If specified this qualifier indicates that the named Schedules should be associated with this Job. The Schedules must already exist (if not, you should use the INITIALIZE/SCHEDULE command to create one).

 

/SUCCESS_RULE=(n | n-n | ODD | EVEN | LZERO | NTMSG,…)

This qualifier indicates how ActiveBatch interprets the main Job step’s exit code. The values specified all indicate that the Job completed successfully. You may specify a single value, a range of values and/or a keyword indicating success.

 

/SUCCESS_START=(Job-id,…)

This qualifier indicates one or more Jobs to trigger if the Job completes successfully. One or more Job-id’s are entered in a comma delimited format.

 

/TAKE_OWNERSHIP

This qualifier indicates that the current user is requesting ownership of the specified Job.  The user must have Executive or Full access permission in order to successfully take ownership.

 

/[NO]TERMINATE

This qualifier indicates whether children processes should be terminated when the Job exits. On Windows NT V4, children processes are identified as having the same parent id (PID). This technique is not precise. On Windows 2000, a Job with this qualifier enabled, is created as a Job object. OpenVMS and Unix operating systems terminate child or subprocess trees regardless of the setting of this qualifier. By default, /NOTERMINATE is assumed.

 

/TIME_ZONE= CLIENT | JOBSCHED | UTC

This qualifier indicates the time zone which should be used by the Job Scheduler to actually schedule time triggers. By default the Job Scheduler’s time zone is used.

 

/USERNAME=username

This qualifier is used to set the username that initially submitted the Job for execution.  Typically when this qualifier is used, the /PASSWORD qualifier is asserted as well.

 

/WORKING_FOLDER=device-directory-spec

This qualifier indicates the default working directory for this Job.

Example: This example will submit a batch Job with a procedure name of C:\TEST\TEST.XCP, to a Queue named TESTQUEUE, with a Jobname of "TESTJOB" and will not send the output to a Logfile. It will also submit it under a username of XLNTUSER and a password of 12345.

 

ABAT SUBMIT C:\TEST\TEST.XCP /QUEUE=TESTQUEUE /NAME=TESTJOB /NOOUTPUT /USERNAME="XLNTUSER" /PASSWORD="12345" 

 

The Synchronize command allows the issuer to wait for the completion of an identified and running batch Job.

 

Format:

SYNCHRONIZE/qualifiers

Qualifiers:

/JOB=entry-identification

This qualifier identifies a Job through its unique Job entry identification number assigned when the Job is submitted to a Queue. If you specify both /JOB and the Job-name parameter, /JOB will be used.

 

/JS_PASSWORD[=password]

This qualifier is used in combination with the /JS_USERNAME and, optionally, /JS_SAVEPASSWORD to specify a password to be used with the value of /JS_USERNAME to form an authentication credential to communicate with the Job Scheduler machine.

 

/[NO]JS_SAVEPASSWORD

This qualifier indicates that the password specified with /JS_PASSWORD is to be stored for future authentication purposes.  You can specify this qualifier only when /JS_PASSWORD is also specified. To delete a stored password specify /NOJS_SAVEPASSWORD.

 

/JS_USERNAME=username

This qualifier is used in combination with ./JS_PASSWORD to form an authentication credential used to communicate with the Job Scheduler machine.

 

/LOG

This qualifier is used to display a message when the operation is successful.

 

/ON=scheduler-machine-name

This qualifier allows the command to be directed to the named Job Scheduler machine.  You may specify any valid machine name, FQDN, or IP address (depending on the protocols your machine supports).

Example: This example causes the issuer to wait for the completion of batch Job entry id number 6.

ABAT SYNCHRONIZE /JOB=6

 

The Trigger command allows the issuer to trigger an existing Job or Plan for immediate execution. You must have “Trigger” access permission to use this command.

 

Format:

TRIGGER/qualifiers

Qualifiers:

/IGNORE=(DEPENDENCIES, CALENDAR, EXCLUSION)

This qualifier indicates that the Job is to ignore certain associated restrictions. The keyword restrictions are: DEPENDENCIES, CALENDAR and EXCLUSION.  You may specify one or more qualifiers. By default, all restrictions are enforced.  This qualifier is intended to be used when an operator or someone knowledgeable about the Job and system intentionally wants to force the Job to execute.

 

/JOB=entry-identification

This qualifier identifies a Job or Plan through its unique entry identification number assigned when the Job/Plan is created. If you specify /JOB, /NAME and/or /PATH,  /JOB will be used.

 

/JS_PASSWORD[=password]

This qualifier is used in combination with the /JS_USERNAME and, optionally, /JS_SAVEPASSWORD to specify a password to be used with the value of /JS_USERNAME to form an authentication credential to communicate with the Job Scheduler machine.

 

/[NO]JS_SAVEPASSWORD

This qualifier indicates that the password specified with /JS_PASSWORD is to be stored for future authentication purposes.  You can specify this qualifier only when /JS_PASSWORD is also specified. To delete a stored password specify /NOJS_SAVEPASSWORD.

 

/JS_USERNAME=username

This qualifier is used in combination with ./JS_PASSWORD to form an authentication credential used to communicate with the Job Scheduler machine.

 

/LOG

This qualifier is used to display a message when the operation is successful.

 

/NAME=Job-name

This qualifier represents a unique Job name that is to be triggered for execution. If /JOB is also specified, this qualifier is ignored.

 

/ON=scheduler-machine-name

This qualifier allows the command to be directed to the named Job Scheduler machine.  You may specify any valid machine name, FQDN, or IP address (depending on the protocols your machine supports).

 

/PARAMETERS=(param1,…,param8)

This qualifier allows you to set input parameters when the Job instance is created. You must hold  “Trigger with Parameters” Job access permissions to specify this qualifier.

 

/PATH=path

This qualifier allows you to lookup a specific Job using the object’s path (for example, “/TestJob” would refer to the object labeled ‘TestJob’).

 

/QUEUE=queue-name

This qualifier is used to explicitly create a Job instance on the specified Queue. You must hold “Trigger with Queue” Job access permission to set this qualifier.

 

/SYNCHRONIZE

This qualifier allows you to combine the functions of triggering a Job or Plan instance and then waiting for the instance to complete (by synchronizing on the newly created instance).

 

/VARIABLES=(var1=value1, …)

This qualifier allows you to pass variables and their values to the Plan or Job that you are about to trigger. If the variable currently exists within the target object, that variable’s value will be replaced. If the variable does not exist a new variable (and it’s value) will be created.

Example: This example triggers a Job with an object ID of 1760 and passes in one parameter with a value of P1.

 

ABAT TRIGGER /JOB=1760 /PARAMETERS=P1

 

Certain commands and qualifiers accept date and time values. You can specify these values in one of the following formats:

 

Absolute Time

 

An absolute time is a specific date or time of day. The format for an absolute time is as follows: “[dd-mmm-yyyy][:hh:mm:ss]”

 

The fields are:

 

dd - Day of month (range from 1 to 31, depending on month)

mmm - Month (JAN...DEC)

yyyy - Year

hh - Hour (range from 0 to 23)

mm  -  Minute (range from 0 to 59)     

ss - Second (range from 0 to 59)

 

The following rules apply to an absolute time:

  • You can truncate the date or the time from the right.

  • The date must contain at least one hyphen.

  • You can omit any of the fields (other than month if a date is specified) as long as you include the punctuation marks that separate the fields.

  • A truncated or omitted date field defaults to the corresponding fields for the current date.

  • A truncated or omitted time field defaults to zero.

Examples:

 

1-DEC-2023 - Midnight, December 1, 2023

15-DEC-2023:13:00 - 1:00 PM, December 15, 2023

20-DEC::30 - 12:30 AM, December 20, 2023

16:30 -   4:30 PM today

 

Delta Time

 

A delta time is an offset from the current date and time to a future time.  The format of a delta time is: “+[dddd-][hh:mm:ss]”

 

The fields are as follows:

 

dddd - Number of days (range from 0 to 9999)

hh - Hours (range from 0 to 23)

mm - Minutes (range from 0 to 59)

ss - Seconds (range from 0 to 59)

 

The following rules apply to a delta time:

 

  • You must specify a plus (+) sign.

  • You can truncate a delta time on the right.

  • If you specify the number of days, include a hyphen.

  • You can omit fields within the time as long as you include the punctuation that separates the fields.

  • If you omit the time field, the default is zero.

 

Examples:

 

"+5-" is 5 days from now

"+3" is 3 hours from now

"+:30" is 30 minutes from now

 

Combination Time

 

To combine absolute and delta times, specify an absolute time followed by a delta time.

 

“[absolute time][+delta time]”

 

“[absolute time][-delta time]”

 

The following rules apply:

 

  • Precede the delta time value by a plus sign for future time or a minus sign for past time.

  • Enclose the entire specification in quotation marks if a plus or minus sign precedes the delta time value.

  • Omit the absolute time value if you want to offset the delta time from the current date and time.

  • Remember that the rules for absolute and delta time values still apply.

 

You can also specify TODAY, TOMORROW or YESTERDAY (the time is always midnight (00:00:00.000)) as well as MONDAY, TUESDAY, WEDNESDAY, THURSDAY, FRIDAY, SATURDAY or SUNDAY (which calculate a forward date to the next day/date, the time is always midnight).

 

Examples:

 

“+5” is 5 hours from now.

“-1” is current time minus 1 hour. (Note that the 1 is interpreted as an hour and not a day because it is not followed by a hyphen.)

“-3-“ is current time minus 3 days. (Note the hyphen.)

“+:5” is 5 minutes from now.

“-:5” is Current time minus 5 minutes.