

1.
----------------------------------------------------------------------------
| Command     : show_flow
----------------------------------------------------------------------------
| Description : shows the flow
----------------------------------------------------------------------------
| Response    : none                                                       |
============================================================================
| Parameter           | Legal values                 | Comment             |
----------------------------------------------------------------------------
| job                 | Name of the job              |                     |
----------------------------------------------------------------------------
| flow                | Name of the flow             |                     |
----------------------------------------------------------------------------
| updonly             | Yes - only update (if displayed)                   |
|                     | No  - Displays always                              |
----------------------------------------------------------------------------


2.
----------------------------------------------------------------------------
| Command     : close_flow                                                 |
----------------------------------------------------------------------------
| Description : closes a given flow                                        |
----------------------------------------------------------------------------
| Response    : None                                                       |
============================================================================
| Parameter           | Legal values                 | Comment             |
----------------------------------------------------------------------------
| job                 | Name of the job              |                     |
----------------------------------------------------------------------------
| flow                | Name of the flow             |                     |
----------------------------------------------------------------------------


3.
----------------------------------------------------------------------------
| Command     : edit_flow                                                  |
----------------------------------------------------------------------------
| Description : Changes a given flow                                       |
----------------------------------------------------------------------------
| Response    : None                                                       |
============================================================================
| Parameter           | Legal values                 | Comment             |
----------------------------------------------------------------------------
| job                 | Name of the job              |                     |
----------------------------------------------------------------------------
| flow                | Name of the main flow        |                     |
----------------------------------------------------------------------------
| stage               | Name of the stage            |When there are subfl-|
|                     |                              |ows, this should be  |
|                     |                              |the full path to the |
|                     |                              |stage that needs to  |
|                     |                              |be edited.           |
|                     |                              |e.g. stage=f1/f2/s1  |
|                     |                              |where s1 is a stage  |
|                     |                              |in subflow f2 which  |
|                     |                              |is in subflow f1     |
|                     |                              |which is in main flow|
----------------------------------------------------------------------------
| value               | Value of the element         |if type = switch :   |
|                     |                              |  switch val         |
|                     |                              |if type = cond :     |
|                     |                              |  Y/N                |
|                     |                              |if type = stage :    |
|                     |                              |START - 'set start'  |
|                     |                              |END   - 'set end'    |
|                     |                              |NOSTART-'unset start'|
|                     |                              |NOEND - 'unset end'  |
----------------------------------------------------------------------------


4.
----------------------------------------------------------------------------
| Command     : flow_info                                                  |
----------------------------------------------------------------------------
| Description : Get info of a stage                                        |
----------------------------------------------------------------------------
| Response    : None                                                       |
============================================================================
| Parameter           | Legal values                 | Comment             |
----------------------------------------------------------------------------
| job                 | Name of the job              |                     |
----------------------------------------------------------------------------
| flow                | Name of the main flow        |                     |
----------------------------------------------------------------------------
| stage               | Name of the stage            |When there are subfl-|
|                     |                              |ows, this should be  |
|                     |                              |the full path to the |
|                     |                              |stage that needs to  |
|                     |                              |be edited.           |
|                     |                              |e.g. stage=f1/f2/s1  |
|                     |                              |where s1 is a stage  |
|                     |                              |in subflow f2 which  |
|                     |                              |is in subflow f1     |
|                     |                              |which is in main flow|
----------------------------------------------------------------------------
| outfile             | file to place output in      |The following output |
|                     |                              |is generated :       |
|                     |                              |                     |
|                     |                              |stACTIVE = YES/NO    |
|                     |                              |stTYPE = stage       |
|                     |                              |         condition   |
|                     |                              |         switch      |
|                     |                              |         subflow     |
|                     |                              |stNAME = <stage name>|
|                     |                              |stTEXT = <stage text>|
|                     |                              |stVALUE              |
|                     |                              |  (cond/switch) = val|
|                     |                              |  (stage/subflow) =  |
|                     |                              |   NOSTART/START/END |
|                     |                              |stFORM = <stage form>|
|                     |                              |stHELP = <stage help>|
|                     |                              |stTIMESTART = start T|
|                     |                              |stUSERSTART = user   |
|                     |                              |stTIMEEND   = end T  |
|                     |                              |stUSEREND   = user   |
|                     |                              |stTIMESTAGE = time of|
|                     |                              | stage in seconds    |    
|                     |                              |stTIMETOTAL = time of|
|                     |                              | flow to stage in s  |    
----------------------------------------------------------------------------


5.
----------------------------------------------------------------------------
| Command     : create_flow                                                |
----------------------------------------------------------------------------
| Description : Creates a new flow in the job                              |
----------------------------------------------------------------------------
| Response    : none                                                       |
============================================================================
| Parameter           | Legal values                 | Comment             |
----------------------------------------------------------------------------
| flow                | Name of the flow             |                     |
----------------------------------------------------------------------------


6.
----------------------------------------------------------------------------
| Command     : copy_flow                                                  |
----------------------------------------------------------------------------
| Description : Copies flows between jobs                                  |
----------------------------------------------------------------------------
| Response    : None                                                       |
============================================================================
| Parameter           | Legal values                 | Comment             |
----------------------------------------------------------------------------
| src_job             | Job to copy from             |                     |
----------------------------------------------------------------------------
| src_flow            | flow to copy from            |                     |
----------------------------------------------------------------------------
| dst_job             | Job to copy to               |                     |
----------------------------------------------------------------------------
| dst_flow            | flow to copy to              |                     |
----------------------------------------------------------------------------


7.
----------------------------------------------------------------------------
| Command     : delete_flow                                                |
----------------------------------------------------------------------------
| Description : Deletes a flow from the job                                |
----------------------------------------------------------------------------
| Response    : none                                                       |
============================================================================
| Parameter           | Legal values                 | Comment             |
----------------------------------------------------------------------------
| job                 | Name of the job              |                     |
----------------------------------------------------------------------------
| flow                | Name of the flow             |                     |
----------------------------------------------------------------------------


8.
----------------------------------------------------------------------------
| Command     : rename_flow                                                |
----------------------------------------------------------------------------
| Description : Renames a flow within the job                              |
----------------------------------------------------------------------------
| Response    : none                                                       |
============================================================================
| Parameter           | Legal values                 | Comment             |
----------------------------------------------------------------------------
| job                 | Name of the job              |                     |
----------------------------------------------------------------------------
| flow                | Name of the flow             |                     |
----------------------------------------------------------------------------
| new_flow            | New name of the flow         |                     |
----------------------------------------------------------------------------
