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 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 a logical conclusion of every workflow.
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
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 chosen.
Activity fields
| Field | Mandatory | Description |
|---|---|---|
| Name | N | Descriptive activity name displayed on a canvas. |
| Description | N | Type a brief description for the activity. |
| Condition | N | 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. |
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;
- Then connect its exits to the exit activities: Complete and Incomplete.
Activity fields
| Field | Mandatory | Description |
|---|---|---|
| Name | N | Descriptive activity name displayed on a canvas. |
| Description | N | Type a brief description for the activity. |
Activity exits
| 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 Join. |
Record Generator activity
This activity creates records on any of the tables extending the Task table.
If both the Wait for condition complete and Advanced checkboxes are selected, then they both must evaluate for this activity to choose the Yes transition; otherwise, the No transition is chosen.
Activity fields
| Field | Mandatory | Description |
|---|---|---|
| Name | N | Descriptive activity name displayed on a canvas. |
| Description | N | Type a brief description for the activity. |
| Task type | Y | Select the task type to create. You can make a selection from the corresponding task table. |
Task values from | N | The values used to create the task may either come from:
|
| Wait for condition complete | N | If selected, then the activity waits for the condition to be met (and the task to be completed) before continuing. Yo can specify more than one condition; in this case, all of them have to be met before continuing. |
| Completion conditions | N | Specify the conditions to meet before completing. |
| 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 | Set values for the task in this script. Use the variable 'new_task' when setting additional values. For example: |
| 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.
Input variables
| Field | Mandatory | Description |
|---|---|---|
| Name | N | Displayed activity name. |
| Description | N | Type a brief description for the activity. |
| Script | N | The script to execute. |
Set Values activity
The Set Values activity set values on the current record when the workflow freezes or ends. These values determine the activity behavior.
Activity fields
| Field | Mandatory | Description |
|---|---|---|
| Name | N | Descriptive activity name displayed on a canvas. |
| Description | N | Type a brief description for the activity. |
| Table | Y | Specify a table to be affected by this activity. This table should contain columns for which you need to set new values. 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.
When creating this activity, specify a Field or Custom value 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 workflow version to which this activity instance related to. By default, it is populated with the current workflow name value that you are working on. |
| Type | Y | Select Field or Custom as the type of the value to check against for. |
| Column | Y | This field appears when you have selected the Field option. In there, you can specify a column containing options for a condition. These options will become exits of the activity. For example: if you are building your workflow basing on the Incident table and you have chosen the State column, your Switch activity may look like this:
When you have selected the Custom option in the field above you can customize your activity exits more precisely:
|
| Fields specific for activity exits | ||
| Condition | N | A condition to meet in order to proceed with this specified transition. |
| 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 | Y | This field appears when your have checked the Advanced checkbox. In there, you can specify the exit script. 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 will not meet or the Condition Script will not return true, the workflow will stay paused. |
In case of the Switch activity, every exit can be configured with a separate scripts. So the Advanced checkbox appears only when an activity has more that one exit, and it is displayed on exits only.
Subflow activity
This activity allows running workflow from the parent workflow.
Activity fields
| Field | Mandatory | Description |
|---|---|---|
| Name | N | Descriptive activity name displayed on a canvas. |
| Workflow | N | This field indicates the workflow version to which this activity instance related to. |
| Description | N | Type a brief description for the activity. |
Timer activity
This activity pauses the workflow execution for the specified period of time.
Activity fields
| Field | Mandatory | Description |
|---|---|---|
| Name | N | Descriptive activity name displayed on a canvas. |
| Description | N | Type a brief description for the activity. |
| Timer based on | Y | This is how the timer duration is calculated. Available options:
|
| Duration | Y | This field appears when the A user specified duration option is selected in the field above. In this field you can specify the duration of time to wait before proceeding to the next activity (from days to seconds). |
| Script | N | This field appears when the Script option is selection in the field above. In this field, you can evaluate a script implementing duration calculation logic. For develop, use native JS extended with SimpleOne API methods if needed. |
| The Schedule tab | ||
| Timezone, based on | N | Specify a timezone source for this activity. |
| 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 | Specify a table to be affected by this activity. |
| Condition | N | 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. |
| Condition 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. |
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 will not meet or the Condition Script will not return true, the workflow will stay paused.
