Page Comparison

{alias:workflow}
h2. Name

*workflow* — Manage workflows

h2. Syntax
{panel:|borderStyle=solid|borderWidth=1|bgColor=#FFFFAA}
*workflow open* _filename_ 
*workflow close* _workflow_ 
*workflow execute* _workflow_ 
*workflow createtoolbar* _workflow_ 
*workflow hide* _workflow_ 
*workflow show* _workflow_ 

{panel}

h2. Description

The *workflow* provides a Tcl interface to manage Geocap workflows. Typical tasks involve opening and executing a workflow programmatically. 

h2. Arguments

*open* _filename_ 
{indent}
Open workflow from file. Returns a workflow as a tcl object. This workflow object is used in subsequent workflow calls to identity the workflow. 
{indent}
*close* _workflow_ 
{indent}
Close workflow. The _workflow_ argument is the object returned from the call to *workflow open*. 
{indent}

*execute* _workflow_ 
{indent}
Execute workflow, starting from the first element that has execution enabled. The workflow argument is the object returned from the call to *workflow open*. 
{indent}

*createtoolbar* _workflow_ 
{indent}
Create a toolbar associated with the given workflow. The toolbar provides controls for executing the workflow. This way you can manage the workflow execution without having the workflow view visible. This enables efficient use of screen area. 

The workflow argument is the object returned from the call to *workflow open*. 
{indent}

*show* _workflow_ 
{indent}
Show the workflow view. The view may have been hidden using the hide argument. 

The workflow argument is the object returned from the call to *workflow open*. 
{indent}

*hide* _workflow_ 
{indent}
Hide the workflow view. This makes the workflow view invisible. It does not close the workflow. Use the *show* argument to show the workflow view. 

The _workflow_ argument is the object returned from the call to *workflow open*. 
{indent}

h2. Examples: Opening and executing a workflow

{noformat:|borderWidth=1|bgColor=#eeeeee}
set mywflow [workflow open workflow.gwf]
workflow execute $mywflow

{noformat}

{pagebreak}