Workflow supports a set of activities of various types to configure the process fitting your needs.
Info |
---|
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
Note |
Please keep in mind that all mandatory fields should be populated in order for a workflow element to work fine.
Begin activity
This activity, along with the End activity, is initial and appears when a new workflow is created. It 's 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's . It is a logical conclusion of every workflow.
Info |
---|
To define variables in your activities via the administrative interface if necessary, please complete the steps below: - Navigate to Workflow → Activities.
- Choose the activity you are going to edit and click on it (or click New to create a new activity);
- Fill in the fields and click Save.
|
Create Event activity
Utilities
Run Script activity
The Run Script activity executes the defined script.The Create Event activity primary function is to add events in the event queue that may later perform a trigger function for any action or notification or something else. After creating an event, it is written down into the Event (sys_event) table. In parallel, the event processor handling the event within the period specified in the system properties.
Activity fields
Field | Mandatory | Description |
---|
Name | N |
Descriptive activity name displayed on a canvas. | Event | Y | Choose the event instance on the basis of which the activity will create events. All the event instances (they also can be called event registers are listed in the Event Registers (sys_event_register) table). |
Parameter 1 | N | Specify the first event parameter if it is required for this event. If this parameter is a string value, then it must be within quotes (" "). |
Parameter 2 | N | Specify the second event parameter if it is required for this event. If this parameter is a string value, then it must be within quotes (" "). |
Description | N | The activity description. |
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 evaluate for this activity to choose the Yes transition; otherwise, the No transition is chosenActivity 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. |
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.
Image Added
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 |
Descriptive activity name displayed on a canvasActivity name. A good practice is to make the name descriptive for clarity. |
Description | N | Type a brief description for the activity. |
Activity exits
TableY | TA table to be affected by this activity. This table should contain columns for which you need to set new values. 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 set true. |
Join activity
This activity joins multiple execution paths from several activities exits into one transition.
The possible case to use this activity is when you need to cause a workflow to wait for more than one activity in multiple paths to finish before continuing.
How to use the Join activity
Add it to the canvas using the Workflow Editor.Connect the exits of the activities you need to join to the Join activity.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. Image Added
|
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
Then connect its exits to the exit activities: Complete and Incomplete.
Activity fields
Field | Mandatory | Description |
---|
Name | N |
Descriptive activity name displayed on a canvasActivity name. A good practice is to make the name descriptive for clarity. |
Description | N | Type a brief description |
for Activity exits
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) |
Result | Description |
---|
Complete | The Join activity moves along this path when the system has determined that all activities joined have completed and transitioned to the Join. |
Incomplete | The Join activity moves along this path when the system has determined at least one activity joined have completed but transitioned along a path not followed by the JoinRecord Generator activity
This The Record Generator activity creates records on in any of the tables table extending from the Task table.
Info |
---|
If both the Wait For Condition Complete and Advanced checkboxes are selected, then they both must |
evaluate be evaluated for this activityto |
choose Yes ; otherwise, the No transition is chosenActivity fields
Field | Mandatory | Description |
---|
Name | N |
Descriptive activity name displayed on a canvasActivity name. A good practice is to make the name descriptive for clarity. |
Description | N | Type a brief description |
for of the activity. |
Task Type | Y | |
to create. You can make a selection from the corresponding task table. Click the magnifier icon Image Added to see the list or start typing the table name in the field. |
Task Values |
Fromfrom | N | The source of values |
used to create the task may either come fromfor a task to be created. Available options: |
- values - – values that you specify in the appropriate choice list.
- Template
|
- an - – an existing template related to the selected task table.
|
Set Values | N | Specify an existing template related to the selected task table. Info |
---|
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. Info |
---|
This fiels appears when the Task Values from field value is equal Template. |
|
Wait for Condition Complete | N |
If Select this checkbox to display Completion Conditions. When selected, |
then the activity waits for condition to be met (and the task to be completed) before continuing. You can specify more than one condition; in this case, all of them have to be met before continuingtask will not be completed until all conditions are met. |
Completion Conditions |
NY | Specify the conditions to |
meet before completing.be met before continuing the operation. Info |
---|
The field is displayed when the Wait for Condition Complete is |
|
set |
Advanced | N | Select this checkbox to specify a script to |
evaluatebe performed. When you select this checkbox, |
a box appears where you can enter the scriptfield appears. |
Script | N | Set values for the task in this script. Use the variable 'new_task' when setting additional values. |
Note: This script is run A script runs after the task values are set |
|
using (defined in the Task Template or Set Values |
|
you have specifiedFor example: new_task.short_description = current.short_description; Info |
---|
This field is displayed when the Advanced is |
|
set true.Task Values From group |
Task Template | Y | This field appears only when the Template option is selected in the Task Values From field. In there, you can specify an existing template related to the selected task table. |
Set Values | N | This field appears only when the Values option is selected in the Task Values From field. In there, you can specify an existing template related to the selected task table. |
Run Script activity
The Run Script activity runs a script in the scope of the workflow version.
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 Image Added to see the list or start typing the event name in the field. |
Parameter 1 | N | Specify the first event parameter. If this parameter is a string value, then it must be put in quotation marks (" "). Info |
---|
To check if the script requires a parameter, perform the following steps: - Select the event you need in the Event field.
- Click on the event and select Open Record.
- Scroll down to the Related Lists area, select the Event Script Action tab.
- Open the available record if there is one.
- Look through the script to find 'param' text.
- If there is, for example, 'event.param_1' line, specify the relevant parameter in the Parameter 1 field.
- If there is no such text, you do not need to specify the Parameter 1 field.
|
|
Parameter 2 | N | Specify the second event parameter. If this parameter is a string value, then it must be put in quotation marks (" "). Info |
---|
To check if the script requires a parameter, perform the following steps: - Select the event you need in the Event field.
- Click on the event and select Open Record.
- Scroll down to the Related Lists area, select the Event Script Action tab.
- Open the available record if there is one.
- Look through the script to find 'param' text.
- If there is, for example, 'event.param_2' line, specify the relevant parameter in the Parameter 2 field.
- If there is no such text, you do not need to specify the Parameter 2 field
|
|
Field | Mandatory | Description |
---|
Name | N | Displayed activity name. |
Script | N | The script to execute |
Description | N | Type a brief description |
for
Conditions
Set Values
Wait Condition activity
The
Set Values activity set values on the current record when the workflow freezes or ends. These values determine the activity behavior 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 |
Descriptive activity name displayed on a canvasActivity name. A good practice is to make the name descriptive for clarity. |
Description | N | Type a brief description |
for YN | A table to be affected by this activity. This |
table should contain columns for which you need to set new values. This field is populated automatically |
.For example, if you need to set new values for the Master Incident field using this activity, then select the Incident table.
Set Values | N | From the list on the left, select the current record field whose value you want to set when the workflow freezes or ends. In the input field to the right, enter the value to set. You can choose more than one parameter, in this case, all of them are applied. |
Switch activity
This activity checks the passed field values if they are equivalent to one or several case values. Its behavior is similar to a switch statement in Java.
. |
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. Info |
---|
This field appears when the Advanced is 'true'. |
|
Note |
---|
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.
Info |
---|
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. |
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. Info |
---|
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 transitionWhen creating this activity, specify a Field or Custom value in the Type field to perform the check against the conditions for a matching value. When the field matches the value defined, the workflow progresses through the condition.
Activity fields
Field | Mandatory | Description |
---|
Workflow Version | Y |
This field indicates the The workflow version to which this activity |
instance to.By default, it is populated with the current workflow name |
value that you are working on. |
Table | N | A table to be affected by this activity. This table should contain columns for which you need to set new values. |
This field is populated automatically By default, it is populated with the name of the table for which this workflow is created. |
Name | N |
Descriptive activity name displayed on a canvasActivity name. A good practice is to make the name descriptive for clarity. |
Type | Y | Select |
Field or Custom as type of the value to check against for.If you select the Custom option in the Type field you can customize your activity exits in the following ways:
source of exits options for this activity. The workflow will perform check values against these conditions. Available options: - Field – the exits are equal to the options of the field specified in the Column field.
- Custom – create the set of exits with the conditions you need
|
specify a custom condition to meetadd more activity exitsspecify a Condition script in addition to a regular conditionThis field appears when you have selected the Field option. In there, you can specify Specify a column containing options for |
a the condition. These options will become exits of the activity |
.For example: if you build your workflow basing on the Incident table and you have chosen the State column, your Switch activity may look like this:
. Click the magnifier icon Image Added to see the list or start typing the column name in the field. Info |
---|
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. Image Added
Tip |
---|
You can change conditions of the exits or add new conditions by editing them. |
|
Image Removed |
Fields specific for activity exits Anchor |
---|
| create custom exits for switch |
---|
| create custom exits for switch |
---|
|
|
---|
Name |
Y column name of the table specified in the Table fieldoption 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 |
An The activity to which this |
activity exit is related. This field is populated automatically. |
Description | N | Type a brief description |
for of the activity exit. |
Condition | Y |
A condition meet in be met in order to proceed with this specified transition. |
Advanced | N | Select this checkbox to specify a script to |
evaluate you select this checkbox, a text box appears where you can enter the scriptselected, the Script text field appears. |
Script | Y |
This field appears when your have checked the Advanced checkbox. In there, you can specify the exit script. Info |
---|
This field appears when the Advanced is 'true'. |
|
Note |
---|
If both Condition and |
Condition script Script are specified, then both of them must execute successfully to transition to the next activity |
; otherwise, if the Condition does not meet or the Condition Script does not return true, the workflow will stay paused. The workflow will stay paused until the Condition is met and the Script returns 'true'. |
Note |
---|
In case of the Switch activity, every exit can be configured with a separate individual scripts. So the Advanced checkbox appears only when an the activity has more that one exit, and it is displayed on exits only.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. For full information please refer to the User approval article.
Excerpt Include |
---|
| User approval |
---|
| User approval |
---|
|
Subflows
Subflow activity
This activity allows running workflow from the parent The Subflow activity performs an existing workflow as part of the current workflow.
Activity fields
Field | Mandatory | Description |
---|
Name | N |
Descriptive activity name displayed on a canvasActivity name. A good practice is to make the name descriptive for clarity. |
Workflow | N |
This field indicates the workflow version to which this activity instance related toThe published workflow to be prformed by the activity. Click the magnifier icon Image Added to see the list or start typing the workflow name in the field. |
Description | N | Type a brief description for the activity. |
Timers
Timer activity
This activity pauses the workflow execution for the specified The Timer activity defines a period of time during which the current workflow does not run.
Activity fields
Field | Mandatory | Description |
---|
Name | N | Descriptive activity name displayed on a canvasActivity name. A good practice is to make the name descriptive for clarity. |
Description | N | Type a brief description for the activity. |
Timer, based on | Y | This is how The way the timer duration is calculated. Available options: - A User Specified Duration - duration based on the Duration fields populated by user, such as days and hours – specify the duration of time to wait before proceeding to the next activity.
- Script – specify Script - specify a script for duration calculation.
|
Duration | Y | YThis field appears when the A User Specified Duration Option is selected in the Timer, based on field. In this field you can specify time time to wait in days, hours, minutes and seconds to wait before proceeding to the next activity (from days to seconds) | Script | Info |
---|
This field appears when |
| the Script the A User Specified Duration option is selected in |
| the the Timer, based on field. |
|
Script | Y | In this field, you can evaluate a script implementing duration calculation logic. For develop, use native JS extended with SimpleOne API methods if needed. Info |
---|
This field appears when the Script option is selected in the Timer, based on field. |
|
The Schedule tab |
---|
Timezone, based on | N | Specify a timezone source for this activity. Available options: - (No Time Zone)
- A Specific Time Zone.
|
Timezone | Y | Select a timezone from the list. |
Schedule, based on | N | Specify a schedule source for this activity. |
Schedule | Y | Select a schedule from the list. |
User Approval activity
This activity creates user approval(s) when executed, one or more, depending on the parameters specified. For full information please refer to the User approval article.Wait Condition activity
This activity causes the workflow to wait until the record meets the condition specified. The workflow evaluates this activity each time the record updated. Use it to hold a workflow execution until a particular criteria is met by a record update.
Activity fields
Field | Mandatory | Description |
---|
Name | N | Descriptive activity name displayed on a canvas. |
Description | N | Type a brief description for the activity. |
Table | N | A table to be affected by this activity. |
Condition | Y | The workflow is paused at this activity until the record meets the condition specified. |
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. Select the Advanced checkbox to show this field. |
Note |
If both Condition and Condition script are specified, then both of them must execute successfully to transition to the next activity; otherwise, if the Condition does not meet or the Condition Script does not return true, the Clik the magnifier icon Image Added to see the list or start typing the schedule name in the field. Info |
---|
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: - (No Schedule)
- A Specific Schedule.
|
Schedule | Y | Select a schedule from the list. Click the magnifier icon Image Added to see the list or start typing the schedule name in the field. Info |
---|
This field appears when the Timezone, based on option is A Specific Time Zone |
|
workflow will stay paused