Skip to content

workflow.status file

coleslaw481 edited this page Oct 9, 2014 · 20 revisions

The workflow.status file lets the workflow developer inform the service of the current status of the workflow.

Put the file in $CWS_outputdir directory

This file follows the java properties file format:

KEY=VALUE

The workflow developer can set values for the following KEYS

  • time

  • Current time of update in seconds since epoch since 1969

  • estimated.total.cpu.seconds & .help

  • If known estimated amount of CPU in seconds this job will consume. The .help field lets caller set information about the estimate that can be displayed to the user.

Example:

#Time this file was updated
time = # unix time of event ie seconds since 1969 aka `date +%s`

# This is the wall time the workflow will take to run
estimated.total.cpu.seconds = # seconds this workflow will take
estimated.total.cpu.seconds.help =

# Estimated total disk space for job.  
estimated.total.diskspace =
estimated.total.diskspace.help =

# If applicable, this sets the total number of subjobs to run for this job
total.number.subjobs =
total.number.subjobs.help =

# If applicable, this sets the current number of running subjobs
number.subjobs.running =
number.subjobs.running.help =

# If applicable, this sets the number of sub jobs remaining
number.subjobs.remaining =
number.subjobs.remaining.help =

# Total number of seconds consumed on any cluster
# for workflow
cpu.seconds.consumed =
cpu.seconds.consumed.help =

# Estimated completion of job as percentage 100 means 100% 0 equals 0% done
percent.complete =
percent.complete.help =

# Denotes current phase of processing, should be a phase in phase.list below
phase =
phase.help =

# Lists the phases that this workflow runs through
phase.list =
phase.list.help =

#
# the format of this field is clustername:seconds,clustername:seconds
#
cpu.seconds.consumed.per.cluster.list=
cpu.seconds.consumed.per.cluster.list.help=

disk.space.consumed =
disk.space.consumed.help =