Page History

 Horizontal Navigation Bar

 Button Group
 Button Hyperlink
titlePrevious
typestandard
urlhttps://confluence.ecmwf.int/display/ECFLOW/Add+an+event
 Button Hyperlink
titleUp
typestandard
urlhttps://confluence.ecmwf.int/display/ECFLOW/Going+Further
 Button Hyperlink
titleNext
typestandard
urlhttps://confluence.ecmwf.int/display/ECFLOW/Add+a+meter

Sometimes a task should not be run when a certain condition is met.
The condition can be signalled by an event. For example, event t2:b
might indicate that task t2 did not manage to produce the expected result, so
we do not need to run task t4.

In this case, you can use the complete expression keyword.
This has a similar syntax to the trigger keyword but sets a task
complete rather than running it.

When ecflow_server tries to start a task, it evaluates the trigger
and complete expression s. If the complete expression condition is correct,
the task will set itself complete.

complete expression evaluation takes precedence over the trigger.

Completes can be between tasks, between families, or both.

It can be used in conjunction with a trigger. For example:

Text

Code Block
#

...

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 f1
     edit SLEEP 20
     task t1
     task t2
         trigger t1 eq complete

...

   # task t2 will only start when task t1

...

is

...

complete
         event

...

task t2

...

 will set an event a

...

  event b

...

# task t2

...

 will set an event b

...

 task t3
         trigger t2:a             # task t3 will start when event a is set in task t2
     task t4
         trigger t2 eq complete   # task t4 will start when task t2 is complete
         complete t2:b            # task t4 will complete if event b is set in task t2
   endfamily
endsuite

Python

Code Block

language	py
title	$HOME/course/test.py

import os
from ecflow import Defs,Suite,Family,Task,Edit,Trigger,Complete,Event

def create_family_f1():
    return Family("f1",
                Edit(SLEEP= 20),
                Task("t1"),
                Task("t2",
                    Trigger("t1 == complete"),
                    Event("a"), 
                    Event("b")),
                Task("t3",
                    Trigger("t2:a")),
                Task("t4",
                    Trigger("t2 == complete"), 
                    Complete("t2:b")))
        
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_f1()))
print(defs) 

print("Checking job creation: .ecf -> .job0")  
print(defs.check_job_creation())

print("Saving definition to file 'test.def'")
defs.save_as_defs("test.def")

What to do

Update test.def or test.py to add a complete expression to task t4
Replace the suite
python: python3 test.py; python3 client.py
text: ecflow_client --suspend=/test ; ecflow_client --replace=/test test.def
Observe the tasks in ecflow_ui
See the triggers by selecting t4
See the trigger relation by clicking on the arrow
See the triggers in the tree, using the Show menu
Note the icon indicating that the task has not run
To check the triggers modify task t2 so that event b is not triggered; task t4 should run when t2 completes.

Horizontal Navigation Bar

Button Group

Button Hyperlink

title	Previous
type	standard
url	https://confluence.ecmwf.int/display/ECFLOW/Add+an+event

Button Hyperlink

title	Up
type	standard
url	https://confluence.ecmwf.int/display/ECFLOW/Going+Further

Button Hyperlink

title	Next
type	standard
url	https://confluence.ecmwf.int/display/ECFLOW/Add+a+meter

would be: <div ><div ><pre>#!/usr/bin/env python2.5 import os import ecflow def create_family_f1(): f1 = ecflow.Family("f1") f1.add_variable("SLEEP",20) f1.add_task("t1") t2 = f1.add_task("t2") t2.add_trigger("t1 eq complete") t2.add_event("a") t2.add_event("b") t3 = f1.add_task("t3") t3.add_trigger("t2:a") t4 = f1.add_task("t4") t4.add_trigger("t2 eq complete") t4.add_complete("t2:b") return f1 defs = ecflow.Defs("test.def") suite = defs.add_suite("test") suite.add_variable("ECF_INCLUDE",os.getenv("HOME") + "/course") suite.add_variable("ECF_HOME ",os.getenv("HOME") + "/course") suite.add_family( create_family_f1() ) </pre></div> </div> <div > <div >Completes are used to declare dependencies between two tasks.</div> <div >For instance, complete t2:b might indicate that a specific</div> <div >event has not occurred so we do not need to run task t4.</div> </div> <div > <div >When <a href="/wiki/display/ECFLOW/Glossary#term-ecf-server">ecf_server</a> tries to start a <a href="/wiki/display/ECFLOW/Glossary#term-task">task</a>, it evaluates the <a href="/wiki/display/ECFLOW/Glossary#term-trigger">trigger</a></div> <div >and <a href="/wiki/display/ECFLOW/Glossary#term-complete-trigger">complete trigger</a> expressions. If the <a href="/wiki/display/ECFLOW/Glossary#term-complete-trigger">complete trigger</a> condition is correct,</div> <div >the task will set itself <a href="/wiki/display/ECFLOW/Glossary#term-complete">complete</a>.</div> </div> <a href="/wiki/display/ECFLOW/Glossary#term-complete-trigger">complete trigger</a> evaluation takes precedence over the <a href="/wiki/display/ECFLOW/Glossary#term-trigger">trigger</a>. Completes can be between tasks, between families, or both. What to do: <ol > <li>Edit the <a href="/wiki/display/ECFLOW/Glossary#term-suite-definition">suite definition</a> file or python to add a complete to task t4</li> <li>Load the definition again</li> <li>Observe the tasks in <a href="/wiki/display/ECFLOW/Glossary#term-ecflowview">ecFlowview</a></li> <li>See the triggers by selecting t4 and clicking on the <img alt="triggers" src="/wiki/download/attachments/7373012/triggers.jpg" /> icon</li> <li>See the trigger relation by clicking on the arrow</li> <li>See the triggers in the tree, using the Show menu</li> <li>Note the icon indicating that the task has not run</li> <li>You can modify task t2 to check that task t4 will run when the event is not set</li> </ol> </div>

Space shortcuts

Page tree

Versions Compared

Old Version 9

New Version Current

Key

Text

Python

What to do