You are viewing an old version of this page. View the current version.
Compare with Current View Page History
« Previous Version 47 Next »
Workflow supports a set of activities of various types to configure the process fitting your needs.
To define variables in your activities via the administrative interface if necessary, please complete the steps below:
- Navigate to Workflow → Activities.
- Open the activity record you need to edit or click New to create a new activity.
- Fill in the fields and click Save.
Basic activities
Begin activity
This activity, along with the End activity, is initial and appears when a new workflow is created. It is a logical start of every workflow.
End activity
This activity, along with the Begin activity, is initial and appears when a new workflow is created. It is a logical conclusion of every workflow.
Utilities
Run Script activity
The Run Script activity executes the defined script.
Activity fields
Field | Mandatory | Description |
---|---|---|
Name | N | Activity name. A good practice is to make the name descriptive for clarity. |
Run Script | N | The script to execute. |
Description | N | Type a brief description of the activity. It is displayed on the activity block on the canvas if provided. |
Join activity
The Join activity combines several activity exit transitions so that they turn into one transition. This activity is useful for synchronizing several activities so that the next activity does not start until previous ones are finished.
In the example below, the Join activity waits for If, Subflow, and Wait activities to complete processing. If all three transitions from these activities lead to the Join activity, the path of the Complete exit is taken (to the activity named Insert). If one of the activities bypassed the Join activity (in this case, it is No exit of the If activity), then the Incomplete exit is taken.
How to use the Join activity
- In the left side menu, open the Utilities tab and drag-and-drop Join activity.
- Connect the exits of the activities you need to join to the Join activity.
- Then create transitions from the Join activity exits (Complete and Incomplete) to the next activities.
Activity fields
Field | Mandatory | Description |
---|---|---|
Name | N | Activity name. A good practice is to make the name descriptive for clarity. |
Description | N | Type a brief description for the activity. It is displayed on the activity block on the canvas if provided. |
Activity exits
Result | Description |
---|---|
Complete | This exit is taken when all joined activities were completed and proceeded to this join activity. |
Incomplete | This exit is taken when all joined activities were completed, but at least one of them did not proceed to this join activity, i.e., another path was taken bypassing the join activity. Example: In this case, the If activity bypassed the Join activity, therefore the Incomplete exit was taken. |
Set Values activity
The Set Values activity sets certain values on the current record. These values determine the activity behavior when the workflow freezes or ends.
Activity fields
Field | Mandatory | Description |
---|---|---|
Name | N | Activity name. A good practice is to make the name descriptive for clarity. |
Description | N | Type a brief description of the activity. It is displayed on the activity block on the canvas if provided. |
Table | Y | A table to be affected by this activity. This field is populated automatically. |
Set Values | N | Select the field the value of which you want to change when the workflow freezes or ends and define the new value. Click on the leftmost field to see the drop-down list of available fields. Click on the rightmost field to see the drop-down list or enter the value (depending on the type of the selected field). |
Record Generator activity
The Record Generator activity creates records in any table extending from the Task table.
If both the Wait For Condition Complete and Advanced checkboxes are selected, then they both must be evaluated for this activity to proceed with the transition.
Activity fields
Field | Mandatory | Description |
---|---|---|
Name | N | Activity name. A good practice is to make the name descriptive for clarity. |
Description | N | Type a brief description of the activity. It is displayed on the activity block on the canvas if provided. |
Task Type | Y | Select the task type. You can make a selection from the corresponding task table. Click the magnifier icon |
Task Values from | N | The source of values for a task to be created. Available options:
|
Set Values | N | Specify an existing template related to the selected task table. This fiels appears when the Task Values from field value is equal Values. |
Task Template | Y | Specify an existing template related to the selected task table. This fiels appears when the Task Values from field value is equal Template. |
Wait for Condition Complete | N | Select this checkbox to display Completion Conditions. When selected, the task will not be completed until all conditions are met. |
Completion Conditions | Y | Specify the conditions to be met before continuing the operation. The field is displayed when the Wait for Condition Complete is 'true'. |
Advanced | N | Select this checkbox to specify a script to be performed. When you select this checkbox, the Script text field appears. |
Script | N | Set values for the task in this script. Use the variable 'new_task' when setting additional values. A script runs after the task values are set (defined in the Task Template or Set Values fields). For example: This field is displayed when the Advanced is 'true'. |
Create Event activity
The Create Event activity establishes an event from the Event Register (sys_event_register) table in a queue. Later this event can execute certain scripts. When the Create Event action is executed, a new event record is created in the Event (sys_event) table. In parallel, the event processor handles the event within the period specified in the system properties.
Activity fields
Field | Mandatory | Description |
---|---|---|
Name | N | Activity name. A good practice is to make the name descriptive for clarity. |
Event | Y | Choose the event instance on the basis of which the activity will create events. All the event instances (or event registers) are listed in the Event Registers (sys_event_register) table. Click the magnifier icon |
Parameter 1 | N | Specify the first event parameter. If this parameter is a string value, then it must be put in quotation marks (" "). To check if the script requires a parameter, perform the following steps:
|
Parameter 2 | N | Specify the second event parameter. If this parameter is a string value, then it must be put in quotation marks (" "). To check if the script requires a parameter, perform the following steps:
|
Description | N | Type a brief description of the activity. It is displayed on the activity block on the canvas if provided. |
Conditions
Wait Condition activity
The Wait Condition activity pauses the workflow until the defined conditions are met. The activity checks if the record meets the conditions after every record update.
Activity fields
Field | Mandatory | Description |
---|---|---|
Name | N | Activity name. A good practice is to make the name descriptive for clarity. |
Description | N | Type a brief description of the activity. It is displayed on the activity block on the canvas if provided. |
Table | N | A table to be affected by this activity. This field is populated automatically. |
Condition | Y | The workflow is paused at this activity until the record meets the defined conditions. |
Advanced | N | Select this checkbox to specify a script to evaluate. When you select this checkbox, a text box appears where you can enter the script. |
Script | N | If specified, the workflow is paused at this activity until this script sets the answer variable to true. This field appears when the Advanced is 'true'. |
If both Condition and Script are specified, then both of them must execute successfully to transition to the next activity. The workflow will stay paused until the Condition is met and the Script returns 'true'.
If activity
This activity checks a condition to determine if a Yes or No transition should be taken.
If both the Condition and Advanced checkboxes are selected, then they both must be evaluated for this activity to choose the Yes transition; otherwise, the No transition is chosen.
Activity fields
Field | Mandatory | Description |
---|---|---|
Name | N | Activity name. A good practice is to make the name descriptive for clarity. |
Description | N | The activity description. It is displayed on the activity block on the canvas if provided. |
Table | Y | A table to be affected by this activity. This field is populated automatically. |
Condition | Y | A condition to meet in order to proceed with the Yes transition. |
Advanced | N | Select this checkbox to specify a script to evaluate. |
Script | N | Enter a script to evaluate in this field. This field is displayed when the Advanced is 'true'. |
Switch activity
The Switch activity manages transitions checking the field values against the defined case values (one or more). This activity is performed like the switch statement in Java.
The activity checks against conditions specified in the Column field or in manually defined exits and, basing on the outcome, selects the next transition.
Activity fields
Field | Mandatory | Description |
---|---|---|
Workflow Version | Y | The workflow version to which this activity is related. By default, it is populated with the current workflow name. |
Table | N | A table to be affected by this activity. This table should contain columns for which you need to set new values. By default, it is populated with the name of the table for which this workflow is created. |
Name | N | Activity name. A good practice is to make the name descriptive for clarity. |
Type | Y | Select the source of exits options for this activity. The workflow will perform check values against these conditions. Available options:
|
Column | Y | Specify a column containing options for the condition. These options will become exits of the activity. Click the magnifier icon This field appears when Field option is selected in the Type field. In the example below, the Switch activity takes options from the Type field. You can change conditions of the exits or add new conditions by editing them. |
Fields specific for activity exits | ||
Name | N | The option name. If the Type field is equal to Field, the name is taken from the Column. If the Type field is equal to Custom, specify the name you like. |
Table | N | A table to be affected by this activity. This field is populated automatically. |
Activity | Y | The activity to which this exit is related. This field is populated automatically. |
Description | N | Type a brief description of the activity exit. |
Condition | Y | Conditions to be met in order to proceed with this specified transition. |
Advanced | N | Select this checkbox to specify a script to be performed. When selected, the Script text field appears. |
Script | Y | In there, you can specify the exit script. This field appears when the Advanced is 'true'. |
If both Condition and Script are specified, then both of them must execute successfully to transition to the next activity. The workflow will stay paused until the Condition is met and the Script returns 'true'.
In case of the Switch activity, every exit can be configured with individual scripts. So the Advanced checkbox appears only when the activity has more than one exit. The checkbox appears only on exit forms.
Approvals
User Approval activity
This activity creates user approvals when executed, one or more, depending on the parameters specified.
Error rendering macro 'excerpt-include' No link could be created for 'User approval'.
Subflows
Subflow activity
The Subflow activity performs an existing workflow as part of the current workflow.
Activity fields
Field | Mandatory | Description |
---|---|---|
Name | N | Activity name. A good practice is to make the name descriptive for clarity. |
Workflow | N | The published workflow to be prformed by the activity. Click the magnifier icon |
Description | N | Type a brief description for the activity. It is displayed on the activity block on the canvas if provided. |
Timers
Timer activity
The Timer activity defines a period of time during which the current workflow does not run.
Activity fields
Field | Mandatory | Description |
---|---|---|
Name | N | Activity name. A good practice is to make the name descriptive for clarity. |
Description | N | Type a brief description for the activity. It is displayed on the activity block on the canvas if provided. |
Timer, based on | Y | The way the timer duration is calculated. Available options:
|
Duration | Y | Specify the duration of time to wait in days, hours, minutes and seconds to wait before proceeding to the next activity. This field appears when the A User Specified Duration option is selected in the Timer, based on field. |
Script | Y | Evaluate a script implementing duration calculation logic. For develop, use native JS extended with SimpleOne API methods if needed. This field appears when the Script option is selected in the Timer, based on field. |
Schedule tab | ||
Timezone, based on | N | Specify a timezone source for this activity. Available options:
|
Timezone | Y | Select a timezone from the list. Click the magnifier icon This field appears when the Timezone, based on option is A Specific Time Zone. |
Schedule, based on | N | Specify a schedule source for this activity. Available options:
|
Schedule | Y | Select a schedule from the list. Click the magnifier icon This field appears when the Timezone, based on option is A Specific Time Zone. |
- No labels