Page History

The Workflow supports a set of activities of various types to configure a process that fits your needs.

See the Workflow Editor article to familiarize yourself with the functionality.

Available activities:

Image Added

Info

To define variables in your activities via the agent interface if necessary, 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.
Click Save or Save and Exit to apply the changes.

See the Creating a new activity article to learn more.

Basic activities

Section

Column
Image Added

Column

Begin activity

This activity, along with the End activity, is initial and appears

when

in a

new

newly created 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

in a

new

newly created workflow. It is

created; it's

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 {your_instance_url}/list/wf_activity
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.

Input variables

FieldDescriptionEventChoose 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).Param 1Specify the first event parameter if it is required for this event. If this parameter is a string value, then it must be within quotes (" ").Param 2Specify the second event parameter if it is required for this event. If this parameter is a string value, then it must be within quotes (" ").

Utilities
Anchor
utilities
utilities

The activities included in this category execute scripts, change and update records.

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	Specify the script to execute.
Description	N	Type a brief description of the activity.

Note

This activity type causes the update of the current target record after execution. The activity logic is defined by the Immediately value in the When to Run field within the Workflow Activity Type (wf_activity_type) table.

Also, the Immediately option and the related activity behavior allows to avoid the update of records within Run Script scripts, as follows:

Code Block

language	js
theme	Eclipse
title	Run Script

current.update();

It will be done automatically.

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 the previous ones are finished.

In the example below, the Join activity waits for the results of processing of the If, Subflow, and Wait activities. 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 bypasses the Join activity (in this case, it is the No exit of the If activity), then the Incomplete exit is taken.

Image Added

Warning

Never join multiple exits from an activity to a single Join activity, otherwise, the Join activity works incorrectly and never selects the Complete transition.

In the example below, both exits from the If activity lead to the Join activity. Even though the condition of the If activity is met, the Join activity selects the Incomplete exit as the No exit from the If activity is inactive.

Image Added

How to use the Join activity

In the left side menu, open the Utilities tab and drag and drop the Join activity.

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.

Input variables

FieldDescriptionConditionA condition to meet for taking the Yes transition.AdvancedSelect this checkbox to specify a script to evaluate.Script

Enter a script that must be evaluated in this field. If the script sets the variable answer to yes, then the Yes transition is taken; otherwise, the No transition will be chosen.

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 with the Join activity;.
Then connect its exits , create transitions from the Join activity exits (Complete and Incomplete) to the exit activities: Complete and Incomplete.

Exit activities

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.

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

This exit is taken when all joined activities have finished running and proceeded to this activity.
Incomplete	This exit is taken when all joined activities have finished running, but at least one of them has not proceeded to this activity, that is, 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 specific values to the current record. These values determine the activity behavior when the workflow freezes or ends.

Note
This activity type causes the update of the current target record after execution. The activity logic is defined by the Immediately value in the When to Run field within the Workflow Activity Type (wf_activity_type) table.

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.
Table	Y	A table to be affected by this activity. This field is populated automatically.
Set Values	N	Select the field whose value you want to change when the workflow freezes or ends, and define the new value. Click the leftmost field to open the drop-down list of available fields. Click the rightmost field to open the drop-down list or enter the value (depending on the type of the selected field). Image Added

Record Generator activity

The Record Generator activity creates records in any 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

proceed with the

Yes transition; otherwise, the No transition is chosen.

transition.

Note
Make sure that all mandatory fields are populated when using this activity; otherwise, the workflow will break its execution.

Activity fields

Field	Mandatory

Input variables

Field

	Description
Name

Displayed activity name

	N	Activity name. A good practice is to make the name descriptive for clarity.
Description	N	Type a brief description

for

of the activity.

Task

type

Type

Y

Select the task type

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 to select from autosuggest.

Task

values

Values from

N

The

values used to create the task may either come from:

source of values for a task to be created. Available options:

Values – values that you specify in the appropriate choice list.
Template – an existing template related to the selected task table.

Set Values

N

Specify an existing template related to the selected task table.

Info
This field appears when the Task Values from field value is equal to Values.

Task Template

Y

Specify an

Template - an

existing template related to the selected task table

;Values - values that you specify in the appropriate choice list

.

Info
This field appears when the Task Values from field value is equal to Template.

Wait for

condition completeIf

Condition Complete

N

Select this checkbox to display Completion Conditions. When selected,

then

the

activity waits

conditions are mandatory 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.

completing the task.

Completion Conditions

Y

Specify conditions for the created task. The process will not proceed to the next activity until the task meets all conditions.

Info
The field is displayed when the Wait for Condition Complete checkbox is selected.

Advanced

N

Completion conditionsSpecify the conditions to meet before completing.Advanced

Select this checkbox to specify a script to

evaluate

execute. When you select this checkbox,

a

the Script text

box appears where you can enter the script

field 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

This field is displayed when the Advanced checkbox is selected.

Note
A script runs after the task values are set

using

(defined in the Task Template or Set Values

you have specified

fields).

For example:

Code Block

language	js
theme	Eclipse
title	Script
linenumbers	true

new_task.

short

parent_

description

id = current.

short_description;Task values from groupTemplateThis 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 valuesThis 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

FieldDescriptionNameDisplayed activity name.DescriptionType a brief description for the activity.ScriptThe 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.

Input variables

FieldDescriptionSet values

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.

sys_id;
new_task.caller = current.getValue('caller');

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 specific scripts or send notifications. When the Create Event action runs, a new event record is created in the Event (sys_event) table.

See the Events article to learn more.

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 to select from autosuggest.

Param 1 ... Param 5

N

Specify the event parameter. If this parameter is a string value, it must be enclosed in quotes.

Info

The defined parameters may be used in records related to the system event:

records of the Notification Rule (sys_notification_rule) table
records related to the Notification Rule (sys_notification_rule) table: Notifications Script (sys_notification_script) and Notification Template (sys_notification_template)
records of the Event Script Actions (sys_event_script_action) table

See the Events article to learn more.

Description

N

Type a brief description of the activity.

Conditions

The activities included in this category set conditions to continue the processing and define further transition of the workflow. The transition taken depends on the conditions set and the activity outcome.

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.

Table

N

A table to be affected by this activity. This field is populated automatically.

Condition

Y

Define conditions mandatory for proceeding with the Yes transition.

Advanced

N

Select this checkbox to specify a script to execute. When you select this checkbox, the Script field appears.

Script

N

This field appears when the Advanced checkbox is selected. If specified, the workflow is paused at this activity until this script returns true. The result of the script execution will be added with the AND operator to the results of the Condition specified.

Code Block

language	js
theme	Eclipse
title	Example
linenumbers	true

const isUserManager =
  ss.hasRole('process_manager'); // true or false
return isUserManager;

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

Type a brief description of the activity.

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.

Info
An empty condition always returns true.

Advanced

N

Select this checkbox to specify a script to execute. When selected, the Script field appears.

Script

N

This field is displayed when the Advanced checkbox is selected. If the script is executed, the result of the script will be added with the AND operator to the results of the Condition specified. To proceed with the Yes transition, the script should return the true value.

Code Block

language	js
theme	Eclipse
title	Example
linenumbers	true

const uc = new SimpleUserCriteria();
const isUserLocal =
  uc.userAcceptanceByCriteria(ss.getUserID(), '165470191717512124'); // true or false
return isUserLocal;

Switch activity

The Switch activity manages transitions by checking the field values against the defined case values (one or more). This activity works like the switch statement.

The activity checks against conditions specified in the Column field or in manually defined exits and, based on the outcome, selects the next transition.

Activity fields

Field

Mandatory

Description

Table

N

A table to be affected by this activity. This field is populated automatically.

Name

N

Activity name. A good practice is to make the name descriptive for clarity.

Type

Anchor

	type field Switch activity
	type field Switch activity

Y

Select the source of exit 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.

Column

Y

Specify a column containing options for the condition. These options will become exits of the activity. Click the magnifier icon Image Added to see the list, or start typing the column name in the field to select from autosuggest.

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.

To create additional exits, perform the following steps:

Right-click the Switch activity and select Add exit.
Double-click the exit to open the exit form fields.
Fill in the fields.
Click Save.
Repeat to add more exits if needed.

Anchor

	create custom exits for switch
	create custom exits for switch

Field	Mandatory	Description
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	Define conditions mandatory for proceeding with this specified transition.
Advanced	N	Select this checkbox to specify a script to execute. When selected, the Script field appears.
Script	Y	This field appears when the Advanced checkbox is selected.

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.

Input variables

FieldDescriptionTypeSelect Field or Custom as the type of the value to check against for.ColumnThis field appears when you have selected the Field option. In there, you can specify a column to be processed by a condition.

Subflow activity

This activity allows running workflow from the parent workflow.

Input variables

FieldDescriptionWorkflowThe workflow to run. You can choose any preferred workflow created earlier from the list.

Timer activity

This activity pauses the workflow execution for the specified period of time.

Input variables

FieldDescriptionDescriptionBrief activity description.Timer based on

This is how 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.

Duration

This field appears when the option A user specified duration 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). This field is mandatory.

Wait for 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.

Input variables

sets the answer variable to true. Select the Advanced checkbox to show this field

Field	Description
Name	Displayed activity name.
Description	Type a brief description for the activity.
Condition	The workflow is paused at this activity until the record meets the condition specified.
Advanced	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	If specified, the workflow is paused at this activity until this script	returns 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 will not meet or the Condition Script will 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 individual scripts. So the Advanced checkbox appears only when the activity has more than one exit. The checkbox appears only on exit forms.

Approvals

The User Approval activity configures the approval processing: it creates approvals, sets approval rules and conditions.

User-approval activity

Excerpt Include

	User-approval activity
	User-approval activity
nopanel	true

Subflows

The Subflow activity performs another workflow. This activity is useful for complex workflows that include other processes.

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	Y	The published workflow to be performed by the activity. Click the magnifier icon Image Added to see the list, or start typing the workflow name in the field to select from autosuggest.
Description	N	Type a brief description for the activity.

When a Subflow block is started, a workflow context is created for the current record. Until the context is finished, another Subflow block with the same workflow cannot be started, since at any given time only one workflow context can exist for the current record.

For example, a Subflow block referring to the "Request 2nd phase" workflow is configured in the main workflow. After the main workflow starts, the "Request 2nd phase" subflow is started. The subflow execution context is paused. If another attempt to launch the "Request 2nd phase" subflow is made within the main workflow, the subflow is created in the canceled state.

Timers

The Timer activity pauses the workflow. This activity is useful when the process requires waiting for a certain period.

Timer activity

The Timer activity defines a period of time during which the current workflow does not run. It follows the logic below:

If the workflow context is not finished and the block following the Timer block has the Finished state – the block processing is restarted.
If the workflow context is not finished and the block following the Timer block has the Waiting state – the block processing is not restarted.
If the workflow context at the moment of running of the Timer block is finished – processing of the block following the Timer block is not started.

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.

Timer, based on

Y

The way the timer duration is calculated. Available options:

A User Specified Duration – specify the duration of time to wait before proceeding to the next activity.
Script – specify a script for duration calculation.

Duration

Y

Specify the duration of time to wait in days, hours, minutes and seconds to wait before proceeding to the next activity.

Info
This field appears when the A User Specified Duration option is selected in the Timer, based on field.

Script

Y

Specify the script implementing the duration calculation logic. Here, you can use the SimpleOne API methods.

Info
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:

(No Time Zone)
A Specific Time Zone

Timezone

Y

Select a timezone from the list. Click the magnifier icon Image Added to see the list, or start typing the schedule name in the field to select from autosuggest.

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 to select from autosuggest.

Info
This field appears when the Timezone, based on option is A Specific Schedule.

Table of Contents

absoluteUrl	true
class	fixedPosition

...

Page tree

Page History

Versions Compared

Old Version 26

New Version Current

Key

Basic activities

Begin activity

End activity

Create Event activity

Input variables

Utilities Anchorutilitiesutilities

Run Script activity

Join activity

If activity

Input variables

Join activity

How to use the Join activity

Record Generator activity

Set Values activity

Record Generator activity

Input variables

Run Script activity

Input variables

Set Values activity

Input variables

Create Event activity

Conditions

Wait Condition activity

If activity

Switch activity

Switch activity

Input variables

Subflow activity

Input variables

Timer activity

Input variables

Wait for Condition activity

Input variables

Approvals

User-approval activity

Subflows

Subflow activity

Timers

Timer activity

Utilities
Anchor
utilities
utilities