until
Depending on the object definition the until keyword belongs to, specifies the latest time a job stream must be completed or the latest time a job can be launched. This keyword is mutually exclusive with the jsuntil keyword. For more information about the jsuntil keyword, see jsuntil.
Syntax
[until time [timezone|tz tzname][+n day[s]][onuntil action]]
Arguments
- time
- Specifies the time of day. The possible values are 0000 through 2359.
- timezone tzname
- Specifies the time zone to be used when computing the time. See Managing time zones for time
zone names. The default is the time zone of the workstation on which
the job or job stream is launched. Note: If an until time and an at or deadline time are specified, the time zones must be the same.
- day n
- Specifies an offset, in days, from the scheduled date and time.
- onuntil action
- Depending on the object definition the until keyword
belongs to, specifies:
- The action to be taken on a job whose until time has expired but the job has not yet started.
- The action to be taken on a job stream whose until time has expired but the job stream is not yet completed in SUCC state.
- suppr
- The job or job stream and any dependent job or job stream do not
run. This is the default behavior.
Once the until time expired on a job stream, the status for the job stream is calculated following the usual rules; suppressed jobs are not considered in the calculation. In case the job stream contains at least one every job its status is HOLD.
When the until time expires for a job, the job moves to HOLD status or keeps any previous status which is a final status.
If the until time is passed together with the onuntil suppr and the carryforward options, the job stream is carry forwarded by JnextPlan only if the until date is equal to the date when JnextPlan runs. If the until and the JnextPlan run dates are not the same, the job stream is not carry forwarded.
- cont
- The job or job stream runs when all necessary conditions are met
and a notification message is written to the log when the until time
elapses.
If the until time is passed together with the onuntil cont and the carryforward options, the job stream is always carry forwarded by JnextPlan.
- canc
- A job or job stream is cancelled when the until time specified
expires. When using onuntil canc on jobs, the
cancel operation on the job is issued by the FTA on which the job
runs. Any job or job stream that was dependent on the completion of
a job or job stream that was cancelled, runs because the dependency
no longer exists.
If the until time is passed together with the onuntil canc and the carryforward options, the job stream is not carry forwarded by JnextPlan because it is already canceled.
Note: When using onuntil canc at job stream level, define as owner of the job stream the workstation highest in the hierarchy of the scheduling environment, among all workstations that own jobs contained in the job stream.
- Both the keyword until and deadline can be used in the same definition but they must be expressed using the same time zone setting.
- The untilDays global option can only apply to a jobstream when the jobstream is added to the plan. If the untilDays was set to 0 when a jobstream was added to the plan changing the untilDays parameter after the jobstream is in the plan can have no impact on that jobstream.
- If an until time (latest start time) is not specified for a job stream, then a default until time can be set using the untilDays global option. The until time is calculated adding the value of the untilDays global option, expressed in number of days, to the scheduled time for the job stream. If the enCarryForward option is set to all, and the number of days specified for untilDays is reached, then any job stream instances in the plan that ended in error are automatically removed from the plan and are not added to the new production plan. If the default value for untilDays is maintained (0), then no default time is set for the until time.
Examples
sked1
from
launching after 5:00 p.m. on Tuesdays: schedule sked1 on tu until 1700 :
sked1
at 5:00 p.m., when
its until time is reached: schedule sked1 until 1700 onuntil cont
job1
between 1:00 p.m.
and 5:00 p.m. on weekdays: schedule sked2 on weekdays :
job1 at 1300 until 1700
end
joba
every
15 minutes between 10:30 p.m. and 11:30 p.m. on Mondays: schedule sked3 on mo :
joba at 2230 every 0015 until 2330
end
sked4
on
Sundays between 8:00 a.m. and 1:00 p.m. The jobs are to be launched
within this interval: schedule sked4 on fr at 0800 + 2 days
until 1300 + 2 days
:
job1
job2 at 0900 <<launched on sunday>>
job3 follows job2 at 1200 <<launched on sunday>>
end
sked8
on
weekdays at 4:00 p.m. and should complete running by 5 p.m. If the
job stream is not completed by 5 p.m., it is considered a late job
stream. The jobs are to be launched as follows: job1
runs
at 4 p.m., or at the latest, 4:20 p.m., at which time, if job1
has
not yet started, a notification message is written to the log and
it starts running. job2
runs at 4:30 p.m. or at the
latest 4:50 p.m., at which time, if job2
has not
yet started, it is cancelled. schedule sked8 on weekdays at 1600 deadline 1700 :
job1 at 1600 until 1620 onuntil cont
job2 at 1630 until 1650 onuntil canc
end
sked01
.
When the until event occurs, the job stream sked02
is
run because the job stream sked01
is placed in SUCC
state. The job stream sked03
, instead, is not run
because it has a punctual time dependency on job job01
and
this dependency has not been released. SCHEDULE sked01 on everyday:
job01 until 2035 onuntil suppr
end
SCHEDULE sked02 on everyday follows sked01.@
:
job02
end
SCHEDULE sked03 on everyday follows sked01.job01
:
job03
END