Rulemaster

Prev Next

Rulemaster: The Ultimate Automation Engine in Canary7

✨ Overview

Rulemaster is a powerful automation engine built into Canary7, designed to streamline your warehouse workflows by executing predefined business rules based on events such as Shipment Creation or Receipt Creation.

By leveraging Rulemaster, you can:

  • ✅ Automate decision-making processes

  • 🔁 Eliminate repetitive manual tasks

  • 🧩 Enforce consistency across operations

  • 🌐 Integrate with external systems in real time

    ⚒️ How Rulemaster Works

    Rulemaster listens for specific events within the system (e.g., when a shipment is created), and triggers rules based on the selection criteria you define. If the criteria are met, the rule’s process is executed.

Event Triggers:

  • Shipment Created

  • Receipt Created

Each rule has:

  • 🧲 Selection Criteria – The filters that determine whether the rule should trigger. These can include:

    • Shipment Type

    • Company

    • Priority

    • Destination

    • and more...

  • ⚙️ Process – The action that is carried out if the selection criteria are met. Examples:

    • Set Shipment Profile

    • Assign Carrier

    • Trigger Wave Creation

    • Send Data to External System

🔢 Core Components of a Rule

Field

Description

Name

A unique, descriptive title for the rule

Event

The event that triggers rule evaluation (e.g. Shipment Created)

Selection

The conditions/filters that must be met (e.g. CompanyID = 17)

Process

The action(s) executed if criteria are met

📊 Selection Criteria: Targeting the Right Data

Each Event supports different Selection Classes, which determine which part of the data is being evaluated:

✉️ Shipment Created

Selection Class

Available Fields

Shipment Header

Company, Warehouse, Country, Shipment Type, Ship to Country ID, Customer Code, Order Ref, Net Weight, Volume, Quantity, etc.

Shipment Detail

Item, Item Group, Allocation Rule, Category, Quantity, etc.

🎓 Receipt Created

Selection Class

Available Fields

Receipt Header

Company, Warehouse, Receipt Type, Source Info, Order Number

Receipt Detail

Item, Item Group, Category, Quantity, Order Number


🎚 Processes: Automate with Precision

Rulemaster supports a rich library of Processes, executed when a rule is triggered. These can be simple or multi-step automations.

Shipment Created

Process

What It Does

Common Use Case

Delete Shipment

Removes shipment

Cancel invalid shipments

Delete Shipment Detail

Removes an item line

Remove cancelled items

Add Shipment Detail

Adds item line

Add last-minute order items

Explode Item Assembly

Breaks kit into parts

Track individual components

Assign Outbound Status Flow

Applies workflow

Auto-progress to Pick/Pack

Assign Terms of Sale

Adds Incoterms

Add delivery terms for logistics

Assign Detail Group Value

Tags item group

Grouping for future splitting

Split Shipment by Grouping

Creates multiple shipments

Separate items by rules

Shipment Webhook

Sends API call

Notify external systems

Run Assigned Carrier/Service

Consign with selected carrier

For strict delivery services

Run Automatic Carrier Assignment

Auto-select best carrier

Evaluate post-processing

Assign Shipment Type

Categorise shipment

Use for job creation/picking

Add To and Run Wave

Join wave + start process

Automate batching of orders

Receipt Created

Process

What It Does

Use Case

Assign Receipt Preference

Defines rules like partial close

Control partial receipt logic

Assign Receipt Type

Categorise receipt

Differentiate returns, standard

Run Auto Location Assignment

Auto-assign putaway locations

Reduce operator decision-making


🧪 Example Use Case

📦 If a Shipment is created for Company = ABC Logistics and Type = B2B,
🎯 Then set the Shipment Profile to B2B_FastTrack.

This ensures that every B2B shipment for ABC Logistics is processed consistently and with the correct configuration.

🧠 Good to Know

  • 🕒 Rules are triggered in real-time when the event occurs.

  • 🔄 Multiple rules can run on the same event if their criteria are met.

  • 🪜 Rule priority is determined by their order – rules run top to bottom.

  • 🚫 Rulemaster does not control inventory allocation or picking strategy – those are managed by:

    • Allocation Rules

    • Shipment Picking Job Creation

    • Picking Profiles

🚀 Accessing Rulemaster

To access Rulemaster in Canary7:

  1. Go to the Navigation Menu

  2. Search or navigate to Rulemaster

  3. Click Add Rule to begin creating rules

  4. Define the Event, Selection Class, and Process