Automation

Getting Started

Set up the Automation module and create your first workflow.

Getting Started

This guide walks you through creating your first automated workflow.

Prerequisites

Before you begin, ensure you have:

  • Access credentials provided by your administrator
  • Understanding of the business process you want to automate
  • Any external API endpoints or email settings configured

First Steps

1. Access Workflows

Navigate to Automation from the sidebar. This opens the workflow management view where you can:

  • View all workflows and their status
  • Create new workflows
  • Enable or disable existing workflows
  • View execution history

2. Understanding Workflows

A workflow consists of:

ComponentDescription
TriggerWhat starts the workflow
ActionsSteps the workflow executes
ConditionsBranching logic based on data
VariablesData passed between steps

3. Workflow List

The workflow list displays:

ColumnDescription
NameWorkflow identifier
Trigger TypeHow the workflow starts
StatusEnabled or disabled
Last RunMost recent execution
ExecutionsTotal run count

Creating Your First Workflow

Step-by-Step

  1. Click Add Workflow
  2. Enter a workflow name
  3. Add a trigger node (entry point)
  4. Add action nodes for each step
  5. Connect nodes with edges
  6. Configure each node's settings
  7. Save and enable the workflow

Simple Example: Send Email on New Order

  1. Trigger: Entity Event - Sales Order Created
  2. Action: Send Email

Testing Workflows

Manual Execution

Test any workflow manually:

  1. Open the workflow
  2. Click Execute
  3. Provide any required input
  4. View execution results

Viewing Results

After execution:

  1. Navigate to Executions
  2. Find the execution entry
  3. View step-by-step results
  4. Check for any errors

Enabling Workflows

Activation

Workflows must be enabled to run automatically:

  1. Open the workflow
  2. Toggle Enabled to on
  3. Save the workflow

Disabling

To temporarily stop a workflow:

  1. Toggle Enabled to off
  2. Workflow stops triggering
  3. Can be re-enabled anytime

Next Steps

Once you understand the basics: