Workflow Canvas

This section describes how to use the Workflow Canvas to receive data streams, define rules and set triggers to take necessary actions.

🚧

Setting up workflows

A project must be created first before you can create a workflow. This is because the Workflow canvas works off data it receives from the project it is connected to.

📘

Setting up workflows

You can connect multiple workflows to a single project. This enables you to create multiple workflows using data from a singular project

Create Workflow

To create a workflow, click on “Create a workflow”, at the sidebar.

A pop up appears. Here you click on the "drop-down arrow" to select the project you want receive data from to design your workflow.
After this, you input a workflow name, give a brief description of the workflow and then click "create workflow" to confirm.

📘

Creating a workflow

Choose a workflow name that is similar to the project you are receiving data from and one that is easier for you to remember.

Once the workflow has been created, it takes you to the Workflow Canvas where you start a workflow by dragging and dropping in an "input node", define the workflow's parameters withrule nodes and specify alerts with the"action nodes".

Input Nodes

The input nodes marks the beginning of any workflow. It is what connects the data from your previously selected project to the other nodes on the workflow canvas.

To connect “Input Nodes” to the Workflow Canvas, drag the “Input Node” icon from Workflow Canvas tool bar and drop it on the canvas.

📘

Tips

There can be only one input node on a workflow canvas.

🚧

Tips

The input nodes cannot be linked to the action nodes, they must pass through the rule nodes before being connected to an action node.

Rule Nodes

The rule nodes help to perform operations on the data coming from the input nodes.

To connect “Rule Nodes” to the workflow canvas, drag the “Rule node icon” from Workflow Canvas tool bar and drop it on the canvas.

To connect two nodes together, click on and drag the small circle beside one node to the other node i.e click on the circle on the input node and drag to the small circle on the rule node.

The node connector line snaps to the circle on the other and a connection between both nodes is made.

📘

Tip

To remove the connection between two nodes, all you have to do is hover your cursor on any end of the connecting line. As you hover, the blue circle turns red, you click once and the connection between nodes are severed.

Configure the Rule Editor (setting triggers)

The rule editor is where you can customize ruĺes that trigger run on. To view the details in the Rule Nodes, Double click on the “dragged Rule nodes” on the canvas to edit the rule to set your rule for the workflow.

Under the Rule editor, there is the IF statement tab that enables you to create or design detailed rules in the rule nodes. To create a rule, there are some input fields to consider when creating a rule:

Creating an IF Statement Rule

Under this field, you are shown a drop-down of standardized sigma data header which you can select from, you are also shown a drop-down of mathematical operators you can select from and the value amount to set rule.

Sigma Standardized Data Header

Under this field, click on the arrow button, and you are shown a drop-down list of all the sigma data headers which you can select from to be able to add data points to set triggers or rules.

📘

Tips

These headers have nested data points that you use to call a specific Json characteristic from the stream

📘

Note

The rule nodes can be mapped together with the input nodes to allow the data stream from the input nodes to the rule nodes to design the rule.

Sigma Standardized data Formats/Points

Under this version, there is some data format or points that you can select from to set triggers. To select the data points, click on the data format you want to use and a drop-down menu will appear to select the data point you want. These data points include:

User: Under this data header, there is some data format that you can select from which include user_id, registration_time, email, first_name, last_name, and mobile number.

Device: Under this data header, there are some data points to select from which include manufacturer, device_type, OS, device_model, user_agents, ip_address, and device_Id.

Location: Under this data header, there are some data points to select from which include region, street, city, address, longitude, latitude, postal_code, and country.

Transaction: Under this header, we have the following data points parameters transaction_id, timestamps, amount, currency, success, gateway, and gateway_reference.

Billing Address: Under this header, we have the following data points parameters region, street, city, address, longitude, latitude, postal_code, and country.

Payment Method: Under this header, we have the following data points, method_type, payment_method_Id, scheme, card_last_four, expiry_month, and expiry_year.

Operators

Operators are mathematical symbols that sigma is using to set ranges or limits for transactions. The symbols usually represent an action to take. Under this field, click on the arrow button, there will be a drop-down of several mathematical symbols you can use and select from to set range, limits, or exacts for transactions. Symbols contained in this field are Greater than(>), less than(<), greater or equal to (=>), less than or equal to (=<), equal to (=), not equal to (!=), in, not in, like, not like, is null, and is not null.

Value Amount

This is the amount in total that you want to set your rule

Apply Rule

After you have set the If statement rules to set triggers, to apply the rule statement, click on the ”apply” button at the top right of the rule editor to apply the rule.

Reset Rule

In a situation where you are not satisfied with the if statement you have set, you could decide to reset the rule and start afresh. To reset the rule editor, click on the “Reset” button at the top right of the Rule editor.

Add Additional Rules

Once you have added the first rule, to another rule, click on “Add Additional rule” to add a new rule, so to add or create a subsequent new rule, click on the “plus icon” beside each of the rules you have created

📘

Tips

you can add additional rules in a rule editor to a specific trigger node. When this happens a user can connect these rules with AND or OR functions by clicking the checkbox to select one.

Action Nodes

This is the field where you are able to signify the task to be taken after the rules have been set. it is where you can customize rules that trigger run on. There are some action options that you can choose either you can either Allow, Block or Review the rules you have set.

To connect “Action Nodes” to the workflow canvas, drag the “Action nodes icon “ from the top right corner of the canvas to the dashboard to set action or a trigger for the data stream in the workflow. The action nodes are to specify what tasks to be taken when the rule has been set.

📘

Tips

The rule nodes can be mapped together with the input nodes to allow the data stream from the input nodes to the rule nodes to design rule

Action Node Configuration

This section describes how to manage and configure your action nodes. you are able to Edit, set up triggers for the workflow and apply the action set for the workflow.

View Action Editor

To view the details of the action editor, Double click on the “Dragged action node” on the canvas to set the action for the rule on the workflow.

Setting Up Then Statement For Triggers To Run On

Under the Action editor, there is “Then Statement” which enables you to set the action to take place after setting the rules. Under this field, there is a drop-down option or parameters of actions you can select either to Allow, Block, or Review an action.

you have the option to set a “Custom action” for the triggers to run on. Click on the “ Custom action checkbox” to activate the custom mode. Fill in the action you want the rule to run whether you want to send an SMS alert, pause a transaction, suspend transactions and more.

Edit Action Editor

To give a title or a name to an action editor, click on the "Edit icon" beside the action editor tab.

Apply Action

After you have selected the option you want the action rule/editor to perform, click on “Apply” at the top right of the action editor canvas to confirm the action for the trigger to run on.

Reset Action

In a situation where you are not satisfied with the Then statement you have set, you could decide to reset the action editor to select a new action option. To reset the rule editor, click on the “Reset” button at the top right of the Rule editor.

Manage your Workflow canvas

This section describes enabling a workflow, editing, undoing, redoing, and managing your workflow canvas.

Display workflow

Click on "workflow" at the navigation bar to display the workflow list. With this display, you can view the details of the workflow you have created which enables you to manage your workflow canvas. The following parameters of the displayed workflow include:

Workflow name: This is the name or title given to the workflow when creating a workflow canvas

Created On: This is the date the workflow was created

Status: This is for you to know whether the workflow is "Enabled or Disabled" at that particular time

Actions: This is the options tab where you can enable or disable a workflow, view a workflow, and rename a workflow.

Rename a workflow canvas

When you want to rename a workflow canvas, you can rename the canvas from the display workflow page or from the workflow canvas page.

To rename a workflow from the display workflow page, click on the "Action menu bar" of the workflow, and click on the "Rename workflow icon" to rename the workflow.

A modal popup for you to rename the workflow to make changes. Click on the Rename to confirm

To rename a workflow from the canvas, click on the "Rename icon" at the top-left of the canvas and make the changes.

Enable workflow

To enable a workflow process, click on the options button under the action tab on the display workflow page list, and click on the "Enable workflow to activate a workflow canvas.

Disable Workflow

when you want to disable a workflow canvas, click on the options button under the action tab on the display workflow page list, and click the "Disable workflow" to deactivate a workflow.

View workflow

To view a workflow canvas, click on the options button under the action tab on the display workflow page list, and click on View workflow to view the workflow canvas.

Zoom Workflow canvas

You have the option to either "Zoom in or Zoom out your workflow canvas with the plus(+) and (-) sign

Undo Workflow

To undo a workflow process, click on the undo icon at the top-right of the canvas

Redo workflow

To redo a workflow process, click on the Redo icon at the top-right of the canvas

Save the workflow

To save in a workflow canvas, click on the "Save tab at the top-right of the workflow canvas