1. opensymphony
  2. osworkflow


osworkflow / docs / Workflow_Definition.html

<html><head><title>OSWorkflow Workflow Definition</title></head><body>
<ul class="star">
<li>Up to <a href="Documentation.html">Documentation</a></li>
<li>Back to <a href="Integration_with_Other_Modules.html">Integration with Other Modules</a></li>
<li>Forward to <a href="Workflow_Concepts.html">Workflow Concepts</a></li>
</ul><p class="paragraph"></p>At the heart of OSWorkflow is the workflow definition descriptor. The descriptor is an XML file (although it doesn't have to be, but XML is the format supported out of the box).<p class="paragraph"></p>This descriptor describes all the steps, states, transitions, and functionality for a given workflow.
<ul class="minus">
<li>A workflow consists of multiple steps to represent the flow.</li>
<li>For the current step, there may be multiple actions. An action may be set to run automatically or be selected to be run programmatically through user interaction.</li>
<li>Each action has at least one unconditional result and zero or more conditional results.</li>
<li>If multiple conditional results are specified, the first result for which all conditions are met is executed. If no conditional results are specified, or if no conditions are satisfied, then the unconditional result is executed.</li>
<li>A result might remain in the current step, reference a new step, reference a split, or reference a join. In all cases, the state of the workflow can also change (example workflow states are Underway, Queued, and Finished).</li>
<li>If a result causes a split, the result specifies a split attribute which points to a split element that defines the splits.</li>
<li>A split may have one or more unconditional results, but no conditional results. The unconditional results reference the steps coming from the split.</li>
<li>A register is a global variable, that is resolved for every workflow invocation and is always available to all functions and conditions.</li>
<li>A propertyset is a map of persistent data that is available globally.</li>
<li>A map called 'transientVars' is a map of transient data that is available to all functions and conditions that includes all registers, user inputs, as well as the current workflow context and state. It exists only during the lifetime of a workflow invocation.</li>