Sometime it is very useful to see task specific information in ecflow_ui
For this we can define a label. A label is a string that is attached to a task
and that can be updated using the child command ecflow_client –label
   

Ecf Script

We will create new family f3 with a task t1.
Create ecf script $HOME/course/test/f3/t1.ecf

 

%include <head.h>
n=1
while [[ $n -le 5 ]]                  # Loop 5 times
do
   msg="The date is now $(date)"
   ecflow_client --label=info "$msg"  # Set the label
   sleep 60                           # Wait a one minute
   (( n = $n + 1 ))
done

ecflow_client --label=info "I have now finished my work."

%include <tail.h>

 

Text

# Definition of the suite test. Note Family f1,f2 from previous pages are omitted
suite test
 edit ECF_INCLUDE "$HOME/course"
 edit ECF_HOME    "$HOME/course"
 family f3
     task t1
         label info ""
 endfamily
endsuite

 

Python

The following section shows how to add a ecflow.Label in python:

#!/usr/bin/env python2.7
import os
import ecflow 
 
print "Creating suite definition"   
defs = ecflow.Defs()
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("f3").add_task("t1").add_label("info","") 
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

  1. Modify the suite definition file or python script
  2. Create the new ecf script file $HOME/course/test/f3/t1.ecf
  3. Replace the suite definition
  4. Watch in ecflow_ui