Workflow Protocol

Interface Syntax

Workflow Execution or Save

Client:

WFEXECUTE (WFSAVE)
<Name of Workflow> 
<e-mail address> 
    (Toolflow Information) 
<General Information>    (such as prioroty, max cost, etc.) 
<Number of tools> 
      (for each tool) 
<Tool Name> 
<Tool (Workflow) Number> 
<Tool Machine Name> 
<Tool Port Number> 
<Parameter of Tool> 
<Data for Tool> 
<User Comment> 
<Successors>  (each number separated by a space;
                          number of parameters to follow, then actual parameters
                          -1 represents no successors,
                          -2 indicates last tool)

Each successor will be followed by the output number of the current tool that is to be used in the following tool. Negative numbers, however, do not come in pairs. The number of parameters is = to [# of pairs] + [# of neg numbers].

The data for tool field specifies which tool inputs are actually used by the tool - basically, this indicates whether the parent tool generated data that the child needed, or whether it was just a condition that had to be met before the child could run. The format for this field is
<#args> <#arg * argument pairs>

where the argument pairs consist of <Node number> <Y/N>,and spaces separate the fields (as well as the pairs). The order of the pairs indicates the order in which the output of the parents should be sent to the child (tool server).

Server:

<XXX> (Three digit response code) 

Workflow Load

(Resource) Client:

WFLOAD 
<Name of Workflow> 

Server:

<XXX> (Three digit response code) 
<Toolflow Information> (Same as WFSAVE) 

Workflow Status

Client:

WFSTATUS 
<Name of Workflow> 

Server:

<OK code>  <Tool status> (code for each tool, separated by space)  N: not yet run, I: in-progress, D: Done, F: Failed)

<FAILED code>  <Tool status> <Information>

<DONE code>  <Result>

Workflow Close Session

Client:

WFCLOSE 
<Name of Workflow> 

Server:

<XXX> (Three digit status code) 

Workflow Tool Info

Client:

WFTOOLINFO 
<Tool Name> 
<Tool Machine Name> 
<Port Number> 

Server:

<XXX> (Three digit status code) 
<Time running in this session (only if session active)> 
<Number of times run (since registered)> 
<Number of times failed (since registered)> 
<Average run time>  (integer, seconds)
<Time since tool registered>  (integer, seconds)
<Status of last 10 jobs (string of 10 chars, F,S,or N (Fail, Success, N/A)> 
<Number of arguments that the tool takes>  (either # or #-#, ie 1, 1-4)
<Number of outputs>  (either # or #-#, ie 1, 1-4)
<List of other workflows using this tool> 
<List of possible input types> 
<List of possible output types> 

The last three arguments are all of the form:
#strings string#1 string#2 ...
(separator is the space character).
It should be noted that the largest (= most interesting flows) using the
specified tools will be the ones returned here.

Workflow Intermediate Tool Data

Client:

WFGETRESULT 
<Workflow Name> 
<Tool Number> 

Server:

<XXX> (Three digit status code) 
<Data>