Versions Compared

Old Version 6

changes.mady.by.user Dina Baksheeva

Saved on

compared with

New Version Current

changes.mady.by.user Dina Baksheeva

Saved on

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

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

Tip

Role required: admin, wf_admin.

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

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

Create a table 
Anchor
create a table for new activity
create a table for new activity

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

To create this child table, complete the steps below:

  1. Navigate to System Definition → 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 Exitexit to apply the changes.

For more information about the table attributes, refer to the Table Attributes articleSee the Create Tables article to learn more.

Create an activity type
Anchor
create an activity type for new activity
create an activity type for new activity

Activity An activity type is an entity intended for the categorization of to classify the newly created or updated activities. It allows defining properties Use it to define properties and behavior for an activity. 

To create an activity type, complete the steps below:

  1. Navigate to Workflow → Activity Type.
  2. Click New and fill in the fields.
  3. Click Save or Save and Exitexit to apply the 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.

Note

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


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

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

Info

It is recommended to use SVG files . However, other image formats will do as well.Recommended with a height and width : of 24 px. Other image formats are also supported.


Activity Type Categorytype categoryN

Specify a category for the activity.

Activity TabletableN

This is a reference field where you can specify a Specify the previously created table for this activity type created before.

When to RunrunN

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

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

Create an activity type exit 
Anchor
create an activity exits for new activity
create an activity exits for new activity

To create an activity type exit, 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 Exitexit to apply the changes.

Activity Workflow activity type exit form fields

FieldMandatoryDescription
NameNActivity Specify the activity type exit name.
Activity TypetypeN

Activity Specify the activity type to which this exit is related.

Exit ConditionconditionN

Specify a

JS

script that

will return 'true' or 'false'. The script

defines the condition

that must

to be met to exit the activity. The script returns the true or false value.

Code Block
languagejs
themeEclipse
titleExample
:
activity.result == 'complete'


DescriptionNActivity Add a description of the activity 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 orderorder of the exit. If the activity type has multiple exits, they are arranged in the activity block in ascending order depending on the value of this field.

Configure the activity form layout 
Anchor
configure the form layout for new activity
configure the form layout for new activity

Warning

It is not recommended to change the form layout for the "out-of-the-box" activities. This may cause problems when adding these activities to a workflow.

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). 

    Section


  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 that appeared, enter "Workflow" in the View name field.
  6. Click Create to apply the changes.
  7. Configure the set of fields to display on the activity form.
  8. Click Save to apply the changes.
Tip

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 Definition → 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 Exitexit to apply the changes.

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

Image Modified

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


Table of Contents
absoluteUrltrue
classfixedPosition
printablefalse

...