Site Manager Developer Manual / 5.2.7 Configuring the Workflow

Site Manager Developer Manual / Version 2301

5.2.7 Configuring the Workflow

Using these elements, the appearance of the worklist in the workflow window can be configured.

<Workflow>

Child elements: <TableDefinition>

Parent elements: <Editor>

<Editor>
        <Workflow>
                <TableDefinition>
                        <ColumnDefinition 
  class="hox.corem.editor.workflow.columns.WorklistDetailColumn"/>
                        .
                        .
                </TableDefinition>
        </Workflow>
</Editor>

Example 5.50. Example of the Workflow element

This element is used to define, which information should be shown in the columns of the workflow list at the left side of the workflow window.

<TableDefinition>

See the description in "Configuring windows with table views".

<ColumnDefinition>

See the description in "Configuring windows with table views" and in Section 5.1.4, “Column Classes”.

<Processes>

Child elements: <Process>*, <Predicate>?, <Comparator>?

Parent elements: <Editor>

<Editor>
        <Processes>
                <Process name="Publication"/>
                        .
                        .
                </Process>
                .
                .
        </Processes>
</Editor>

Example 5.51. Example for the Processes element

This element is used to group the elements which define the view of the workflow variables.

<Comparator>

See the description in the section "Configuring document types".

<Predicate>

See the description in the section "Configuring document types".

<Process>

Child elements: <View>?, <Task>*, <WorkflowStartup>?

Parent elements: <Processes>

<Processes>
                <Process name="Publication"/>
                        <View>
                                .
                                .
                        </View>
                        .
                </Process>
                .
                .
</Processes>

Example 5.52. Example for the Process element

This element is used for the configuration of the variable editors for the process variable view (in the <View> element) and for each task (in the <Task> element).

Attribute	Description
`name`	Name of the process, for which the view should be configured.
`openWorkflowWindow`	Flag to control whether the workflow window should be opened on process creation. By default, "true" is used.

Table 5.71. Attribute of element <Process>

<View>

Child elements: <Variable>*, <AggregationVariable>*

Parent elements: <Process>

<Process name="FourEyesProcess">
   .
   .
   <View>
           <Variable name="User" editorClass="UserChooserEditor"/>
           .
           .
           .
   </View>
</Process>

Example 5.53. Example for the Code element

This element is used to group the elements which define the look of the workflow variables of a process. That is, with which editor the variables defined in the workflow XML file should be shown in the workflow window.

<Task>

Child elements: <Variable>*, <AggregationVariable>*

Parent elements: <Process>

<Process name="FourEyesProcess">
        .
        .
        <Task name="approve">
                <Variable name="comment" editorClass="StringEditor"/>
                .

                .
        </Task>
</Process>

Example 5.54. Example for the Task element

This element is used to group the elements which define the look of the variables of a task. That is, with which editor the variables defined in the workflow XML file for the task should be shown in the workflow window.

Attribute	Description
name	Name of the task for which the definitions should be valid.

Table 5.72. Attribute of the <Task> element

<WorkflowStartup>

Child elements:

Parent elements: <Process>

<Process name="MyWorkflow">
        <WorkflowStartup class="MyWorkflowStarter"/>
        .
        .
</Process>

Example 5.55. Example for the WorkflowStartup element

This element is used to define, how the workflow should be started. That is, how the variables should be filled.

Attribute	Description
class	This attribute defines the class which manages the startup of the workflow. Own classes must implement the interface hox.corem.editor.workflow.WorkflowStartup. As a default, the class hox.corem.editor.generic.GenericWorkflowStartup is used. It sets the resource variable with the selected resource(s) and opens a window for setting the other workflow variables.

Attribute

Description

class

This attribute defines the class which manages the startup of the workflow. Own classes must implement the interface hox.corem.editor.workflow.WorkflowStartup.

As a default, the class hox.corem.editor.generic.GenericWorkflowStartup is used. It sets the resource variable with the selected resource(s) and opens a window for setting the other workflow variables.

Table 5.73. Attribute of <WorkflowStartup> element

<Variable>

Child elements:

Parent elements: <View>, <Task>

<Task name="approve">
       <Variable name="comment" editorClass="StringEditor"/>
       .
       .
       .
 </Task>

Example 5.56. Example for the Variable element

This element is used to define with which editor a workflow variable should be shown in the workflow window.

Attributes	Description
`editorClass`	Editor class to be used for showing the variable. See Section 5.1.1, “Property Editors” for a listing of the editor classes.
`name`	Name of the variable to be shown, as defined in the workflow definition.

Table 5.74. Attributes of element <Variable>

<AggregationVariable>

Child elements:

Parent elements: <View>, <Task>

        <Task name="approve">
                <AggregationVariable name="Resources" 
                editorClass="ResourceChooserEditor"/>
                .

                .
        </Task>

Example 5.57. Example for the AggregationVariable element

This element is used to define with which editor a workflow aggregation variable should be shown in the workflow window.

Attributes	Description
`editorClass`	Editor class to be used for showing the variable. See Section 5.1.1.1, “Workflow Editors” for a listing of the editor classes.
`name`	Name of the aggregation variable to be shown, as defined in the workflow definition.

Table 5.75. Attributes of <AggregationVariable> element

Search Results

Table Of Contents

Filter

Site Manager Developer Manual / Version 2301

5.2.7 Configuring the Workflow

Search Results