Flow Element

A flow element is

Attributes

Attribute Description Example
Name a name to identify the flow. As a naming convention, all flow elements start with a capital and carry the same name as the data element on which they operate Invoice
Package name the package name in which the flow element will be incorporated be.uantwerpen.ee
Target class the data element on which the flow is operating, structured as [package name].[DataElement] be.uantwerpen.ee.Invoice
Status field field of the data element in which the status of the flow is stored, typically called “status”. In case the field “Status” is specified here but not present as a field in the concerning data element, a status field will automatically be created and set during expansion (cf. infra) Status
Workflow name the name of the flow on the data element, typically structured as DataElementFlow InvoiceFlow
Archive name only required when using old version of EJB, may be left empty in all other cases
Description optional
Component   tutorialComp

A status field (if missing) can also be generated by the Prime Radiant itself. Note that in the specification of the flow, “Status” is starting with a capital but the automatically generated field will be “status”, starting with a lower case letter. As several settings are automatically set to the appropriate values in this way, this option is currently recommended. However, in case a status field is created manually upfront, the field should be a value field of the value field type String, having two field options (one with option type “isExposedField” and one with option type “isStatusField”) defined onto it, and a findByStatusEq finder.

Options

Generating TesterTask as an example for a flow

When generating a typical first version prototype (in which the tasks themselves are “empty” and having no real implementation), it is advised to let the Prime Radiant generate a “tester task” for each flow (see flowElement:includeTesterTask).

Automatic Configuration

After a flow is defined in this way, one should choose the Perform tasks tab while the respective component is still selected, and click the “Create flow environment” button. This will

  1. create a status field if required
  2. create an additional data element ([DataElement]TaskStatus)
  3. create a tester task (DataElementTesterTask) if specified (see flowElement:includeTesterTask).