create/job

Create a new job definition.

The CREATE command will add a new job definition to the database.

General Format

create/job job_name [/qualifiers]

Alternate

mkjob job_name [-qualifiers]

Qualifier Summary

/resources=

[no]disk_space : (disk,number_of_blocks)

[no]file : file_spec

measured : (cpu_time,elapse_time,io_count, num_count)

estimated : (cpu_time,elapse_time,io_count)

/notify=

after_delay : delta_time

[no]submitted : ([username(s)][,mail (default)] [,broadcast])

[no]started

[no]delayed

[no]completed

[no]failed

[no]all : (modify all of the above together)

/process=

cli : text

node : node_name

characteristics : number

cputime : delta_time

[no]hold

[no]keep

[no]restart

[no]retain

[no]delete

[no]log_file : file_spec

queue : queue_name

[no]printer : queue_name

name : text

parameter : (p1,p2,...p8)

priority : queue_priority

account : text

user : username

variable : (var1=value, var2=value etc.)

wsdefault : number

wsextent : number

wsquota : number

/general=

comment : text

next_submit : date

last_start : date

last_submit : date

last_completed : date

restart_count : number

up_count : number

down_count : number

flags : [no]history,[no]fixed_set_id,[no]blocked, open_vms|unix|windowsnt,[no]delete_upon_completion

owner : uic

protection : (s:rwed,o:rwed,g:rwed,w:rwed)

acl : (ace's...)

status : number

[no]job_tag : text

startup_window : delta_time

execute_window : delta_time

[no]pre_com_file : file_spec|"I myfile.com"|$ command

[no]post_com_file : file_spec|"I myfile.com"|$ command

/rescheduling=

interval : delta_time

marked : letter_mark

monthly : (january...december,ordinal_number,day_of_week)

named : (monday...sunday,445...544,month_start...year_end)

none

calendar : calendar_name

time_of_day : []delta_time

general qualifiers:

/[no]log

/[no]confirm

/from = prototype_name

/node = target_node

C:\> schedule create /job monthly_accounting /resch=(interval=0:10,calendar=standard)

Qualifiers

/general=comment:"any text string"

The COMMENT field is any useful description that you may want to add. This is an 80 character option.

/confirm

/noconfirm

CONFIRM requests that the user be prompted prior to any operation to verify that the selected entry is the correct one.

/node=node_name

The NODE qualifier specifies what node (either local or remote) you want the operation performed on.

/from=prototype_name

The FROM qualifier specifies the name of a job prototype that the new job will be based on. The properties of the prototype job will be adopted by the new job in the Windows client. The prototype job must be in the search path that traverses the local folder, the user's DEFAULT folder and the DEFAULT folder of the system.

/general=down_count:number

The DOWN_COUNT field indicates the remaining number of times a job is to be executed. This is automatically updated. When zero is reached no further jobs will be submitted automatically.

/general=execute_window:delta_time

The EXECUTE_WINDOW specifies the interval in which a job is allowed to have all requirements met and execute. This is the time it takes a job to move from scheduling queue C or D to M. Any job that exceeds this interval will have none of its initiates activated. This interval is designed to prevent a run away catch up mode from happening if the system is down for a long period. The interval time check is suppressed if this field is set to zero (i.e. the window is infinite).

/general=flags:[no]history|fixed_set_id|[no]blocked|[no]delete_upon_completion|OpenVMS|Windows|UNIX

The HISTORY flag indicates whether or not history data is to be recorded for this job. A job that runs very frequently generates a lot of history data. To reduce the growth of this history file specify the NOHISTORY flag.

The FIXED_SET_ID flag forces a job to always use a constant set id.

The operating system flags determine the operating system the job was created to run on: OPEN_VMS for an Open VMS job, UNIX for a UNIX job or NT for a Windows NT job.

The BLOCKED flag is used to block a job from running. The job will not run until this flag is set to the default noblocked.

The DELETE_UPON_COMPLETION flag is used to delete a job once it has completed and is removed from the P queue. The interval that it will remain in the P queue is normally 15 hours. When that time elapses, the job will be deleted from the database.

/general=job_tag:text

The JOB_TAG field specifies the initial value for the SET_TAG value when the job is first entered into the scheduling queues.

/general=last_completed:date

The LAST_COMPLETED field indicates when a job was last completed. This is automatically updated.

/general=last_start:date

The LAST_START field indicates the last time a job was started. This is automatically updated.

/general=last_submit:date

The LAST_SUBMIT field indicates when a job was last submitted. This is automatically updated.

/general=next_submit:date

The NEXT_SUBMIT field allows the user to specify the next job start date. A job will start on its own only if this date and time are set.

/general=owner:uid[,gid]

The OWNER field indicates the owner UIC code for the job.

/general=post_com_file:file_spec | "I myfile.com"

/general=nopost_com_file

The POST_COM_FILE field indicates that a COM file is to be executed after the scheduled job has run to completion. The COM file and the job are run in the same batch job.

The "I" indicates that the contents of "myfile.com" will be included into the temporary COM file that is submitted.

/general=pre_com_file:file_spec | "I myfile.com"

/general=nopre_com_file

The PRE_COM_FILE field indicates that a COM file is to be executed prior to running the scheduled job. The COM file and the job are run in the same batch job.

The "I" indicates that the contents of "myfile.com" will be included into the temporary COM file that is submitted.

/general=protection:(s:rwed,o:rwed,g:rwed, w:rwed)

The PROTECTION field specifies the UIC based access rights for the file.

/general=restart_count:number

A nonzero RESTART_COUNT allows the job to be restarted (up to the specified number of times) if it is terminated with a failure status code.

/general=startup_window:delta_time

The STARTUP_WINDOW specifies the interval after which a job in schedule queue B will not be initiated. This only occurs if the system is down when a job would have had a time based start. If the system comes up within this interval then the job will start immediately. After this interval this immediate initial run is not done.

The interval time check is suppressed if this field is set to zero (i.e. the window is infinite).

/general=status:number

The STATUS field is a full 32 bit integer status code that indicates the success (odd) or failure (even) of a job execution. This field is automatically updated each time a job completes.

/general=up_count:number

The UP_COUNT field indicates how many times a job has been submitted for execution. This is automatically updated.

/log

/nolog

The LOG qualifier causes each completed operation to issue a note to the user.

/notify=after_delayed:delta_time

The AFTER_DELAYED datum specifies a time limit so that any job that has waited longer than this interval for prerequisites, disk space, or a file is considered delayed. At this time a notification is sent.

/notify=all:([user(s)] [,mail(def)] [,broadcast])

/notify=noall

The ALL sets and the NOALL clears all other NOTIFY commands. Thus ALL will cause the creator of the job to be notified when the job is submitted, started, delayed, completed, or if and when a job failed. If BROADCAST is set then a logged in user will get a broadcast message. Use NOBROADCAST to disable this. If MAIL is set a mail message is sent. Use NOMAIL to disable this. If more then one user name is specified surround the names with parentheses and separate with commas.

/notify=completed:([user(s)] [,mail(def)] [,broadcast])

/notify=nocompleted

The COMPLETED field will notify the creator of a job when the job is completed. If BROADCAST is set then a logged in user will get a broadcast message. Use NOBROADCAST to disable this. If MAIL is set a mail message is sent. Use NOMAIL to disable this. If more then one user name is specified surround the names with parentheses and separate with commas.

/notify=delayed:([user(s)] [,mail(def)] [,broadcast])

/notify=nodelayed

The DELAYED field will notify the creator of a job if and when the job is delayed. If BROADCAST is set then a logged in user will get a broadcast message. Use NOBROADCAST to disable this function. If MAIL is set a mail message is sent. Use NOMAIL to disable this function. If more then one user name is specified surround the names with parentheses and separate with commas.

/notify=failed:([user(s)] [,mail(def)] [,broadcast])

/notify=nofailed

The FAILED field will notify the creator of a job if and when the job failed. If BROADCAST is set then a logged in user will get a broadcast message. Use NOBROADCAST to disable this. If MAIL is set a mail message is sent. Use NOMAIL to disable this. If more then one user name is specified surround the names with parentheses and separate with commas.

/notify=started:([user(s)] [,mail(def)] [,broadcast])

/notify=nostarted

The STARTED field will notify the creator of a job when the job is started. If BROADCAST is set then a logged in user will get a broadcast message. If MAIL is set a mail message is sent. If more then one user name is specified surround the names with parentheses and separate with commas.

/notify=submitted:([user(s)][,mail(def)] [,broadcast])

/notify=nosubmitted

The SUBMITTED field will notify the creator of a job when the job is submitted. If BROADCAST is set then a logged in user will get a broadcast message. Use NOBROADCAST to disable this function. If MAIL is set a MAIL message is sent. Use NOMAIL to disable this function. If more then one user name is specified surround the names with parentheses and separate with commas.

/resources=disk_space:(disk,number_of_blocks)

/resources=nodisk_space

The DISK_SPACE resource specifies how many blocks must be available before the job is submitted for execution.

/resources=estimated:(cpu,elapse,io)

The ESTIMATED datum allows for establishing an initial estimate of cpu_time, elapse_time, and io_count. These estimated values are not used¹ for any computation. Their purpose is to assist in planning and initially setting up the job.

/resources=file:file_spec

/resources=nofile

The FILE datum indicates which file, if any, must be present prior to a job being submitted for execution.

/resources=measured:(cpu,elapse,io,count)

The MEASURED datum displays information about cpu_time, elapse_time, io_count, and num_count. It is usually modified automatically as a job completes.

/rescheduling=calendar:calendar_name

The CALENDAR datum specifies which calendar to use when evaluating a rescheduling method. An example of a calendar is one that specifies which days are holidays.

/rescheduling=interval:delta_time

The INTERVAL datum allows the user to specify how often or at what interval the job is run. The INTERVAL datum is mutually exclusive of the MARKED, NAMED, or NONE datum.

/rescheduling=marked:letter_mark

The MARKED datum allows the user to run a job on days that are "marked" with the indicated letter. The MARKED datum is mutually exclusive of the NAMED, INTERVAL, or NONE datum. The TIME_OF_DAY datum is used to specify the time the job is to run on the specified day(s).

/rescheduling=monthly:months,ordinal_number,day_of_week

The MONTHLY datum allows the user to specify a month, several months or ALL for all months that the job will run in. The months are separated by commas followed by a comma then by an ordinal number (FIRST, SECOND, THIRD, FOURTH), followed by a comma then the day of the week.

/rescheduling=named:date

The NAMED datum allows the user to specify a particular date or sequence of dates on which a job is to run by its name. The NAMED datum is mutually exclusive of the MARKED, INTERVAL, or NONE datum. The TIME_OF_DAY datum is used to specify the time the job is to run on the specified day(s).

/rescheduling=none

The NONE datum indicates that the job is not to start based on time. Such jobs will only start if initiated by another job or manually submitted.

/rescheduling=time_of_day:[]delta_time

The TIME_OF_DAY field allows the user to specify what time of day to run a job. This command is used with the MARKED and NAMED qualifier s. The interval specified here is added to the selected day. The interval specified can be of any length, from seconds to days. The job must be on either named day or marked calendar rescheduling.

/resources

Create a generalized resource and add to RESOURCE list. The list is where the bulk of advanced job programming occurs. Here IF-THEN and SET statements are processed that can check or alter the value of a variable, supress a job run or cause a wait to occur.

It is recommended that resources be listed in the RESOURCE list using the editor as opposed to this method.

/submit=account:text

The ACCOUNT field will specify which account to charge the batch job to when submitted. This is an eight-character field. The privilege CMKRNL is required to use this qualifier .

/process=characteristics:number

The CHARACTERISTICS field will specify the number of a characteristic to be associated with the job.

/job=shell:name

The CLI .

/process=cputime:delta_time

CPUTIME will define a CPU time limit for the batch job. Time can be specified as delta time, or as 0 or NONE (no limit on the time). If the queue on which the job will execute has a defined CPUMAXIMUM value, the smaller of the PROCESS command and queue values is used.

/process=delete

/process=nodelete

The DELETE field will control whether or not command files are deleted after processing. The default setting is NODELETE.

/process=hold

/process=nohold

The HOLD field will place the job into a queue in the HOLD state. The default setting is NOHOLD.

/process=keep

/process=nokeep

The KEEP field will indicate that the log file produced by the execution of the job is to be kept and not deleted. The default setting is KEEP.

/process=log_file:file_spec

/process=nolog_file

The LOG_FILE field specifies the name of the job log file. By default the file is placed in the user's login directory. The default name is the job name and the default type is .LOG.

/process=name:text

The NAME field allows a different name (from that of the job itself) to be used when the job is entered into an execution queue.

/process=node:node_name

The NODE field indicates which node is to process the job. In a cluster, it is assumed that any node can process a job for execution on behalf of any cluster member.

/process=parameter:(p1,p2,...p8)

The PARAMETER datum will provide the values of up to eight optional parameters (p1,p2,...p8) for each command procedure in the job. The symbols are local to the specified command procedure. Characters other than alphanumeric characters must be included in quotation marks.

/process=printer:queue_name

/process=noprinter

The PRINTER datum will queue the job log file for printing when the job is completed. PRINTER allows the user to specify a particular print queue. The default print queue is SYS$PRINT.

/process=priority:queue_priority

The PRIORITY field will specify what queue priority level to use when entering the job into an execution queue.

/process=queue:queue_name

The QUEUE field will identify the batch queue on which the job will be entered. The default queue is SYS$BATCH.

/process=restart

/process=norestart

The RESTART field will mark the created job as being restartable. Thus, if the job is restarted during execution, the DCL symbol $RESTART is set to true. Then the user provided command procedure will check this value and continue execution as needed. The default setting is NORESTART.

/process=retain

/process=noretain

The RETAIN flag determines whether the job will be retained if delete_upon_completion is ON and the job fails.

/process=user:username

The USER field indicates on who's behalf the job is to be processted for execution. Normally this user name is the same as person who owns the job. To change this field requires CMKRNL privilege.

/process=variable:(var1=value, var2=value etc.)

The VARIABLE qualifier creates or modifies one or more existing job variables. If the job variable exists in the Notes section of the job it will be modified, if not it will be created.

/process=wsdefault:number

The WSDEFAULT field will define for a batch job a working set default, the default number of physical pages that the job can use. If the queue on which the job is executed has a nonzero working set default, the smaller of the specified job and queue values is used. If the default set is 0, the smaller of the specified job and user authorization file (UAF) values is used.

/process=wsextent:number

The WSEXTENT field will define for a batch job a working set extent, the maximum amount of physical memory that the job can use. The job uses the maximum amount of physical memory only when the system has excess free pages. If the queue on which the job is executed has a nonzero working set extent, the smaller of the specified job and queue values is used. If the default set is 0, the smaller of the specified job and user authorization file (UAF) values is used.

/process=wsquota:number

The WSQUOTA field will define for a batch job a working set quota, the amount of physical memory that the job is guaranteed. If the queue on which the job is executed has a nonzero working set quota, the smaller of the specified job and queue values is used. If the default set is 0, the smaller of the specified job and user authorization file (UAF) values is used.