Workflow Targets

The Cúram Workflow Reference Guide provides an introduction to the support for workflow in Cúram. A workflow process definition is the fundamental structure which describes the workflow process within a Cúram application. Workflow process definitions are stored on the database, but can also be represented as .xml files and loaded onto the database as needed. A number of targets exist to allow for the validation of workflow process definition .xml files:

Prerequisites for validating workflow process definition files: Workflow process definitions can make reference to rule sets (see Cúram Rules Codification Guide) and Cúram events (See Events and Event Handlers) in the process xml files. Therefore, all rule sets and events that are referenced in workflow process definitions being validated must already be loaded onto the database before the associated workflow process definition files can be validated using the targets outlined below.

validateworkflows - supports validation of the workflow process definition files in the specified directory. The property 'workflow.dir' has to be specified when invoking the target.
workflow.dir - This parameter denotes the directory within which workflow process definition files are to be validated.

validate.schema.only - This optional parameter, if set to true, only performs schema validation on the workflow xml files and bypasses the full semantic validation that would otherwise be performed.

For example:
```
ant validateworkflows
   -Dworkflow.dir=
      <SERVER_DIR>/path to workflow directory
```
validateallworkflows - performs validation of all workflow process definitions files in the Cúram application.
validate.schema.only - This optional parameter, if set to true, only performs schema validation on the workflow xml files and bypasses the full semantic validation that would otherwise be performed.

For example:
```
ant validateallworkflows
```
validateworkflow - supports validation of the specified workflow process definition file. The property 'workflow.file' has to be specified when invoking this target.
workflow.file - This parameter denotes the full path to the workflow process definition file that is to be validated.

validate.schema.only - This optional parameter, if set to true, only performs schema validation on the workflow xml file and bypasses the full semantic validation that would otherwise be performed.

For example:
```
ant validateworkflow
   -Dworkflow.file=
      <SERVER_DIR>/path to workflow file to be validated
```
importworkflow - Import a workflow process definition (use -Dworkflow.file= -Doverwrite=).
workflow.file - This parameter denotes the full path to the workflow process definition file that is to be imported.

overwrite (Optional) - This is an optional flag with the default value as false, indicating whether the database should be overwritten if the workflow process definition already exists.
importworkflows - Import the workflow definitions in the specified directory (use -Dworkflow.dir= -Doverwrite=).
workflow.dir - This parameter denotes the directory from which the workflow definitions should be imported.

overwrite (Optional) - This is an optional flag with the default value as false, indicating whether the database should be overwritten if the workflow process definitions already exist.
listworkflows - List all process definitions available in the database.