As an instance administrator, you may need to create your own a custom workflow activity endowed with the specific logic when the default activities set does of the activities does not fit suit your needs. You can do this via the SimpleOne agent interface.
| Tip |
|---|
Role required: admin, wf_admin. |
To create a new activity, you need to complete several the following steps:
- Create a table storing that stores the settings for of the newly created activity.
- Create an activity type that will store stores the parameters and bear has the functionality of your newly the created activity.
- Create activity exit types that will specify the exit condition from this for the activity.
- Configure the activity form view that will be is displayed in the Workflow Editor.
Create a table
| Anchor | ||||
|---|---|---|---|---|
|
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:
- Navigate to System Definition → All Tables.
- Click New and fill in the fields.
- In the Parent field, select the Workflow Activity (wf_activity) table.
- Click Save or Save and Exit 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
| create an activity type for new activity | |
| create an activity type for new activity |
Activity An activity type is an entity intended for to classify the categorization of 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:
- Navigate to Workflow → Activity Type.
- Click New and fill in the fields.
- Click Save or Save and Exit to apply the changes.
Activity type form fields
| Field | Mandatory | Description | ||
|---|---|---|---|---|
| Name | N | Specify the activity type name (for example, "Send Request"). | ||
| Active | N | Select this checkbox to activate or deactivate this activity type.
| ||
| Description | N | Type Add a brief description of the activity type. | ||
| Script | N | In 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. | ||
| Image | N | Attach an image that will be image to be displayed in the workflow editor for this activity.
| ||
| Activity Type Category | N | Specify a category for the activity. | ||
| Activity Table | N | This is a reference field where you can specify a Specify the previously created table for this activity type created before. | ||
| When to Run | N | A Specify a condition that should be met to run the activity type. Available options:
|
Create an activity type exit Anchor create an activity exits for new activity create an activity exits for new activity
| create an activity exits for new activity | |
| create an activity exits for new activity |
To create an activity type exit, complete the steps below:
- Navigate to Workflow → Activity Type Exits.
- Click New and fill in the fields.
- Select the activity type for which you create the exit in the Activity Type field.
- Click Save or Save and Exit to apply the changes.
Activity type exit form fields
| Field | Mandatory | Description | |||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|
| Name | N | Activity Specify the activity type exit name. | |||||||||
| Activity Type | N | Activity Specify the activity type to which this exit is related. | |||||||||
| Exit Condition | N | Specify a script that defines the condition to be met to exit the activity. The script returns the true or false value.
| |||||||||
| Description | N | Activity Add a description of the activity type exit description. | |||||||||
| Order | N | Specify 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 Anchor configure the form layout for new activity configure the form layout for new activity
| configure the form layout for new activity | |
| configure the form layout for new activity |
To configure the activity form view displayed in the Workflow Editor, perform the following steps:
- Open the record of the table you have created for the new activity.
Copy the value from the Name field and paste it in the URL address after the /record/ line (see the example below).
Section 
- In the hamburger menu
, navigate to Configure → Form → Layout. - In the Form view and section area, click Add new under the View name field.
- In the window that appeared, enter "Workflow" in the View name field.
- Click Create to apply the changes.
- Configure the set of fields to display on the activity form.
- Click Save to apply the changes.
| Tip |
|---|
In case you need to see the activity record often, create a menu item:
See the Panels and Navigation article to learn more about menu items and categories. |
| Warning |
|---|
It is not recommended to modify change the form layout for the "out-of-the-box" activities. This may cause troubles problems when adding these activities to a workflow. |
| Table of Contents | ||||||
|---|---|---|---|---|---|---|
|