AngeliaSchedulerTM - On-Line Help - Batch Task Submission Utility
The Batch Task Submission Utility - (AngeliaSchedBTS.exe) – is a 32 bit Windows console application that
provides a mechanism for an executing task to schedule one or more follow on tasks programmatically without further user
intervention.
The AngeliaScheduler Batch Task Submission Utility (not included in all product editions) adds the ability to submit a new
task (or tasks) from any task executed by the AngeliaScheduler Service. The Batch Task Submission Utility has no form
and its only user interface is via command line parameters.
It has the following syntax: pathname\AngeliaSchedBTS.Exe scriptfilenameorpath [/D] [/Pnnnnn]
where:
- "pathname" is the folder in which the AngeliaSchedBTS executable is located (by default
"C:\Program Files\AngeliaScheduler")
- "scriptfilenameorpath" identifies the script file that contains information about the task(s)
to be submitted
- "/D" is an optional parameter that when present specifies that the scriptfile is to be deleted
on successful termination of the Batch Task Submission Utility
- "/Pnnnnn" is an optional parameter that specifies the TCP Port to be used to communicate with
the AngeliaScheduler Service (if the default port of 8080 is used this parameter is not required).
The Batch Task Submission Utility may only be run in a command window that was created by the AngeliaScheduler Service and
may only run on the AngeliaScheduler Service host system. The Batch Task Submission Utility authenticates using the
credentials of the user that originally submitted the task from which the Utility is run, and as such is subject to the
same access rights restrictions as that original user.
The "scriptfilenameorpath" is resolved as follows:
- First, if the file specified exists as specified (ie – it is either a full path name or a relative path name from the
current directory of the BTS Utility) then it is used as is.
- Second, the Batch Task Submission Utility looks in the Queue Task Folder of the queue that submitted the parent
(currently executing) task.
- And finally, the Default Queue Task Folder is checked.
- If the script file is not found then the BTS Utility aborts.
The Batch Task Submission Utility's Script File consists of one or more name-value pairs, the first of which must be a
"Task=commandname" line where "commandname" is a valid command file name that must exist in the
Queue Task Folder of the queue to which "Task" will be submitted. Queue defaults to the queue of the
parent task unless overridden in the script. The following Script Name-Value pair lines are supported:
- TASK=commandname – required. Each TASK= line begins a new task definition.
Any number of tasks may be submitted in a single Script file.
- TITLE=title – optional title – if omitted one will be formed by the command name
preceded by "Batch Run Of".
- PARAMS=command line parameters – optional - any command line parameters that are needed.
- RUNQUEUE=n – optional – "n" specifies a Queue Id # onto which the task is to
be submitted – the default is the queue of the parent task.
- PRIORITY=n – optional – n may be from 1 to 9 – defaults to 5
- RUNSTAT=HELD – optional – if present it causes the task to be submitted in
"Held" status. The default is "Ready" status.
- RUNDATE=mm/dd/yyyy or "mon dd, yyyy" or yyyymmdd – optional – may be used to
defer execution until a later date – if omitted the default is the current date.
- RUNTIME=hh:mm[:ss] – optional – may be used to defer execution until a later time on
RUNDATE – if omitted the default is the current time.
- RUNPATH=pathname – optional – may be used to defer execution until the file specified
by pathname exists.
SAMPLE Script File: this one runs three tasks (TestTask.Bat, SampleTask.Bat, and
ExampleTask.Bat).
- TASK=TestTask.Bat
- TITLE=Test Batch Utility
- PARAMS=/A /B “/PC:\Program Files\Kamradt And Hill”
- PRIORITY=3
- RUNQUEUE=2
- TASK=SampleTask.Bat
- TASK=ExampleTask.Bat
- TITLE=Another BTS Test
- RUNDATE=MAR 2, 2008
- RUNTIME=16:30:01