|
|
In the section we show alternative to time based attributes using time triggers.
The following suite based generated variables are available for time based triggers.
Here are examples of time attributes and the corresponding trigger examples
time 23:00 # trigger TIME 2300 |
In the last example we have task that runs every five minutes, however what happens if the task takes longer ?
When this happens, the time slot, is missed.
Cron dependencies can be specified using the cron keyword. Cron differs from time as when the node is complete it queues again immediately. Cron also only works with a real time clock (not a hybrid clock).
cron 23:00 # every day at 23:00 cron 08:00 12:00 01:00 # every hour between 8 and 12 cron -w 0,2 11:00 # every sunday and tuesday at 11 am cron -d 1,15 02:00 # every 1st and 15th of each month at 2 am cron -m 1 -d 1 14:00 # every first of January at 2 pm cron -w 5L 23:00 # run on *last* Friday(5L) of each month at 23pm cron -d 1,L 23:00 # Run on the first and last of the month at 23pm |
When a time has expired, the associated node is free to run. The time will stay expired, until the node is re-queued. |
Date dependencies can be specified using the date or the day keyword.
Date dependencies are always absolute, but wild cards can be used.
date 31.12.2012 # the 31st of December 2012 date 01.*.* # every first of the month date *.10.* # every day in October date 1.*.2008 # every first of the month, but only in 2008 day monday # every monday |
A task can have several time and date dependencies. For example:
task tt day monday # Here Day/date acts like a guard over the time. i.e. time is not considered until Monday time 10:00 # run on Monday at 10 am |
task tt day sunday # On the same node, Day/date act like a guard over the time attributes. day wednesday date 01.*.* # The first of every month and year date 10.*.* # The tenth of every month and year time 01:00 # The time is only set free *if* we are on one of the day/dates time 16:00 |
The task will run on Sunday’s and Wednesday’s at 1am and 4pm, but only if the day is the 1st or the 10th of the month.
With multiple time dependencies on the same node, the dependencies of the same type are or'ed together, then and'ed with the different types. |
When time dependencies are placed on different nodes in the hierarchy, the results may seem surprising. Notice the difference between ecflow 4 and ecflow 5
|
|
|---|
family fam2
time 10:00
task tt
day monday # This will run on Monday morning at 00:00 and Monday at 10 am |
The example above assumes we have suite, with an infinite repeat loop. So why does the task run on Monday morning at 00:00 ?
This is because time dependencies on different nodes act independently of each other. In this case time attribute was set free on Sunday at 10 am ( and once free it stays free until it is re-queued). Hence task tt is free to run on Monday morning. After task has run and re-queued. It will then run on Monday at 10 am.
Like trigger‘s, date and time dependencies can be set for a family. In this case, the tasks of this family will only run according to these dependencies.
All time related dependencies(like cron, time, today, date and day) are relative to the clock of the suite. For more information, see Dates and Clocks |
Let us modify the definition file to add a family f2.
For brevity we have omitted the previous family f1
# Definition of the suite test
suite test
edit ECF_INCLUDE "$HOME/course" # replace '$HOME' with the path to your home directory
edit ECF_HOME "$HOME/course"
family f2
edit SLEEP 20
task t1
time 00:30 23:30 00:30 # start(hh:mm) end(hh:mm) increment(hh:mm)
task t2
day thursday
time 13:00
task t3
date 1.*.* # Date(day,month,year) - * means every day,month,year
time 12:00 # Time is not considered until date is free
task t4
time +00:02. # + means realative to suite begin/requeue time
task t5
time 00:02 # 2 minutes past midnight
endfamily
endsuite |
For brevity we have left out family f1. In python this would be:
import os
from ecflow import Defs,Suite,Family,Task,Edit,Trigger,Complete,Event,Meter,Time,Day,Date,Edit
def create_family_f2():
return Family("f2",
Edit(SLEEP=20),
Task("t1", Time("00:30 23:30 00:30")), # start(hh:mm) end(hh:mm) increment(hh:mm)
Task("t2", Day("thursday"),Time("13:00")),
Task("t3", Date("1.*.*"), Time("12:00")), # Date(day,month,year) - * means every day,month,year
Task("t4", Time("+00:02")), # + means realative to suite begin/requeue time
Task("t5", Time("00:02"))) # 2 minutes past midnight
print("Creating suite definition")
home = os.path.join(os.getenv("HOME"), "course")
defs = Defs(
Suite("test",
Edit(ECF_INCLUDE=home,ECF_HOME=home),
create_family_f2()
))
print(defs)
print("Checking job creation: .ecf -> .job0")
print(defs.check_job_creation())
print("Checking trigger expressions")
errors = defs.check()
assert len(errors) == 0,errors
print("Saving definition to file 'test.def'")
defs.save_as_defs("test.def") |
|