As an instance administrator, you may need to create your own workflow activity endowed with the specific logic when the default activities set does not fit your needs. You can do this via SimpleOne agent interface.

Role required: admin, wf_admin.

To create a new activity, you need to complete several steps:

  1. Create a table storing settings for the newly created activity.
  2. Create an activity type that will store parameters and bear the functionality of your newly created activity.
  3. Create activity exit types that will specify the exit condition from this activity.
  4. Configure the activity form view that will be displayed in the Workflow Editor.

Creating a table 

In fact, every activity stores its settings in a child table of the Workflow Activity (wf_activity) table.

To create this child table, please complete the steps below:

  1. Navigate to System Settings → All Tables.
  2. Click New and fill in the fields. 
  3. In the Parent field, select the Workflow Activity (wf_activity) table.
  4. Click Save or Save and Exit to apply changes.

For more information about the table attributes, please refer to the Table Attributes article.

Creating an activity type 

Activity type is an entity intended for the categorization of the newly created or updated activities. It allows defining properties and behavior for an activity. 

To create an activity type, please complete the steps below:

  1. Navigate to Workflow → Activity Type.
  2. Click New and fill in the fields.
  3. Click Save or Save and Exit to apply changes.

Activity type form fields

FieldMandatoryDescription
NameNSpecify the activity type name (for example, "Send Request").
ActiveN

Select this checkbox to activate or deactivate this activity type.

If you unselect this checkbox, then you will not be able to use this activity type when creating or modifying activities.

DescriptionNType a brief description of the activity type.
ScriptNIn this field, you can specify a JavaScript scenario implementing the activity logic. You are free to use SimpleOne Server-Side API there.
ImageN

Attach an image that will be displayed in the workflow editor for this activity.

It is recommended to use SVG files. However, other image formats will do as well.

Recommended height and width: 24 px.


Activity Type CategoryN

Specify a category for the activity. Click the magnifier icon  to select from the dictionary.

Activity TableN

This is a reference field where you can specify a table for this activity type created before. Click the magnifier icon  to select from the dictionary.

When to RunN

A condition that should be met to run the activity type. Available options:

  • On Change – it starts when the specified field in the form is changed.
  • Immediately – it starts when the workflow reaches the activity.

Create an activity type exit 

To create an activity type exit, please complete the steps below:

  1. Navigate to Workflow → Activity Type Exits.
  2. Click New and fill in the fields.
  3. Select the activity type for which you create the exit in the Activity Type field.
  4. Click Save or Save and Exit to apply changes.

Activity type exit form fields

FieldMandatoryDescription
NameNActivity type exit name.
Activity TypeN

Activity type to which this exit is related. Click the magnifier icon  and select from the dictionary.

Exit ConditionN

Specify a JS script that will return 'true' or 'false'. The script defines the condition that must be met to exit the activity.

Example:

activity.result == 'complete'
DescriptionNActivity type exit description.
OrderNSpecify the exit order on the activity block. The order is defined in ascending order, and exits are displayed on the activity block from the upside-down depending on their order.

Configure the activity form layout 

To configure the activity form view displayed in the Workflow Editor, perform the following steps:

  1. Open the record of the table you have created for the new activity.

  2. Copy the value from the Name field and paste it in the URL address after the /record/ line (see the example below). 

  3. In the hamburger menu , navigate to Configure → Form → Layout.
  4. In the Form view and section area, click Add new under the View name field.
  5. In the window appeared, enter "Workflow" in the View name field.
  6. Click Create to apply changes.
  7. Configure the set of fields to display on the activity form.
  8. Click Save to apply changes.

In case you need to see the activity record often, create a menu item:

  1. Open the record of the table you have created for the new activity.

  2. Copy the value from the Name field and paste it in the URL address after the /record/ line (see the example above).

  3. Copy the URL address.
  4. Navigate to System Settings → Menu Items.
  5. Click New and fill in the fields.
  6. In the Link type tab, fill in the Table and Link Type fields with any values.
  7. In the Link type tab, click the icon  and paste the URL.
  8. Click Save or Save and Exit to apply changes.

See the Navigation article to learn more about menu items and categories.


It is not recommended to modify the form layout for out-of-the-box activities. This may cause troubles adding these activities to a workflow.

  • No labels

© 2019-2023, SimpleOne

https://simpleone.ru