System Workflows
System Workflows allow you to execute custom logic when records are added, updated or deleted. This can be updating data within the system, creating new records or sending emails.
Clicking on the sub-menu - ‘Workflow’ from the main navigation menu - ‘Manage’, you will be able to view the landing page for the Workflow Management.
These are the topics on this page:
Managing System Workflows
In the Workflow window, you can search for a workflow data through the "Search Field", edit the entity data, manage the data workflow on the an existing information, or completely delete a workflow function. You may also add a new data workflow for the system to use.
- The 'Add Script' Button lets you create a new workflow. For an in depth guide, please visit Adding / Editing Workflow
- The 'Edit' Button lets you edit the details of the corresponding workflow. For an in depth guide, please visit Adding / Editing Workflow
- The 'Manage' Button lets you manage the corresponding workflow. For an in depth guide, please visit Manage Workflows
- The 'Delete' button lets you delete the corresponding workflow. For an in depth guide, please visit Deleting a Workflow
Adding / Editing Workflow
This section will allows you to add the new Workflow.
Clicking on the ‘Add Workflow’ button from the Workflow Management landing page, you will be able to add the new Workflow by submitting the following information:
Workflow: Enter the name for a Workflow.
Entity: Select the entity from the dropdown for which the Workflow to be created.
Run Nightly: Select ‘Yes’ or ‘No’ to run.
Click on ‘Save Changes’ button to add the new Workflow. The newly created Workflow will be added to the Workflows list as shown below.
Click on ‘Save Changes’ button to add the new Dashboard. The newly created dashboard will be added to the dashboards list.
Manage a Workflow
This section allows you to manage the structure for workflows. Click on the ‘Manage’ button from the ‘Workflows Listing’ screen to open ‘Manage Workflow’ section.
By default, displays following information to you:
Workflow Name
Entity Name
Follow the below steps to define the structure for Workflow:
Step 1: Start Event On
Select the one or multiple triggers to start event. You can select any of the following triggers:
Create
Read
Update
Delete
Step 2: Add Step
Select the steps to be taken after the trigger event occurs from the Step 1. Select steps following order:
Add Stage: Select the ‘Add Stage’ option from the “Add Step” dropdown and submit the following details:
Description
Click on ‘Save Changes’ to add the stage.
Add Check Condition: Once the Stage is added, you need to add the Check Condition. Click on the ‘Add Check’ button or Select the ‘Check Condition’ option from the “Add Step” dropdown and submit the following details:
Description
Apply Rules (Please refer the Section View Builder Table Rules for more details about how to apply rules)
Click on ‘Save Changes’ to add the Check Conditions.
Action: After adding the Stage and the Check Condition, you need to select the action to be taken. You can add any of the following action(s):
SQL Statement: Follow the below steps to add ‘SQL Statement’ action:
Step A: Select the ‘SQL Statement’ option from ‘Action’ or ‘Add Step’ dropdown to add the ‘SQL Statement’ action. After selecting the ‘SQL Statement’ option, you will be taken to Step B.
Step B: Complete the form by submitting the following information:
Action Type (Read Only): Displays the ‘SQL Statement’ as the action type
Table (dropdown selection)
Description
Step C: Click on ‘Save Changes’ to save the form. After clicking on the ‘Save Changes’ you will be taken to the Step D.
Step D: Default ‘Entity’ Details: This section consists of the following modules:
Form: Display the system generated form for the selected Table in Step B. You need to add the tags in all the form fields.
Entity: Select the entity from the dropdown.
Column: Display the fields of the selected entity. Select the field to view the tags.
Tag: The tag will be displayed for the selected Column Field.
Add: Select the Form Field and Click on the ‘Add’ button to copy the Tag into the Form Field.