Effector 6.3 developer manual

XML reference 6.3

Effector Studio 6.3 summary

Effector Studio 6.3 manual

Effector 6.2 developer manual

XML reference 6.0

Effector Studio 3.2 summary

Effector Studio 3.2 manual

WorkFlow

This chapter deals with the parameterization of workflows.

The list of the workflows and the individual workflow steps are described by the XML files in the Workflow directory.

WorkFlows.xml

This file contains the list of the workflows defined in the system. The file needs to exist, even if there is no workflow defined in the given Effector system.

/Workflows

Root element, collection. If there is no workflow defined in the system, it needs to be left empty.

/Workflows/Workflow

A workflow within the system. We can define any number of workflows within the system.

/Workflows/Workflow/ObjectType (String)

The type of the workflow. The system will look for a WorkFlow[name].[version].xml file for this value where the [version] is an ordinal number beginning at 1 (see below).

/Workflows/Workflow/Caption (String)

It's an important setting for Effector Studio, this is the name of the workflow that will appear in the editor.

<?xml version="1.0" encoding="utf-8"?>
<Workflows xmlns="http://effector.hu/schema/ns/workflows">
    <Workflow>
        <ObjectType>Sample</ObjectType>
        <Caption>Test workflow</Caption>
    </Workflow>
</WorkFlows>

WorkFlowSample.1.xml

The 1. version of the “Sample” type workflow specified in the Workflows.xml file. Workflow description files are stored in Workflow subdirectory.

The system is capable of versioning, which means that if a modification is asked for in a live system's already existing workflow, the already started workflows will run according to the previous version, however the newly started workflows will run according to the new version.

Upon commencing the workflow, a new record is created in the Workflow table of the database. The ObjectType setting of the WorkFlow tag will be in the ObjectType column. The created WorkFlowId value is added to the WorkflowId column of the participating objects. These objects are principally the BusinessObjectEvent ("Event" table) and the BusinessObjectProject ("Project" table) BusinessObject.

/Workflow

Root element. Collection of workflow steps.

/Workflow/Guid (GUID)

It's an important setting for Effector Studio, therefore you should not modify, delete, or manually add to a file.

/Workflow/IsSubWorkflow (Boolean)

It specifies whether the process is a subprocess.

/Workflow/Steps

Collection node listing the steps of the workflow.

/Workflow/Steps/Step

Workflow step within the workflow. The following attributes are protected, so modifying, deleting, or manually creating them is not recommended: subStart, subprocessguid, subEnd, isStart and isStop. These settings are important for Effector Studio.

The listing order of the workflow steps can be anything, it doesn't represent the real running order of the workflow. Nevertheless, it is useful to list them in the same order to achieve easier readability (if it's possible).

Example

<?xml version="1.0" encoding="utf-8"?>
<Workflow xmlns="http://effector.hu/schema/ns/Workflow">
    <Steps>
        <Step>
            <BusinessObject>BusinessObjectProjectSample</BusinessObject>
            <Caption>Test workflow</Caption>
        </Step>
        <Step>
            <BusinessObject>BusinessObjectEventFirstStep</BusinessObject>
            <Caption>First step</Caption>
        </Step>
    </Steps>
</Workflow> 

/Workflow/Steps/Step/BusinessObject (String)

The business object that belongs to the workflow step. It needs to be unique in the whole system. Its value is BusinessObject{BOType}{ObjectType}, where

  • {BOType} is either Project or Event depending if the type is project or event
  • {ObjectType} is the type of the object. The name of the XML file that belongs to this workflow step must match this.

/Workflow/Steps/Step/Caption (String)

The short name of the workflow step. Currently only used by the Effector Studio, it doesn't appear on the UI.

/Workflow/ExitPoints

The collection node used by Effector Studio. It defines exit points for a subprocess.

/Workflow/ExitPoints/ExitPoint

It defines exit points for a subprocess.

Attributes:

  • businessObject (String) : object of the exit point
  • objectType (String) : type of the exit point

/Workflow/ExitPoints/ExitPoint/Caption (String)

It's the label of the exit point.

/Workflow/ExitPoints/ExitPoint/Condition (RuleValueType)

It's the condition of the exit point.

/Workflow/Graphs

This setting used by Effector Studio and contains a description of the process diagram. Therefore, it must not be modified or deleted.

/Workflow/Meta

This option will contain metadata for the process. Modifying them directly is not recommended.

/Workflow/Meta/Attribute (String)

It contains metadata, you must specify the name (key) of the meta information in the name attribute.

Example

<Meta>
    <Attribute name="Version">1</Attribute>
    <Attribute name="Description">short description</Attribute>
</Meta>

  • Last update: 2 weeks 4 days ago
  • Effector