Rules Engine Plugin

The Rules Engine is available as a separate plugin to manage all your rules from one place. Currently, we support rules for automatically categorizing products based on specified conditions. The conditions are set up using the Query Builder. 

The Rules Engine plugin is available from the left navigation menu.

• Click the Rules Engine (Gear icon) directly, or find it by clicking the Others (3 dots icon).

 

Roles & permissions

Users having the Rules Engine Read, Rules Engine Write or Plugin Admin role can access the Rules Engine.

• Rules Engine Read - Give access to the full-page plugin and rules engine tab with read-only.
• Rules Engine Write - Give access to the full-page plugin and rules engine tab, allowing you to create, update and delete. 
• Plugin Admin - Give access to the full-page plugin and rules engine tab and the ability to create, update, and delete rules without the Rules Engine role. 

Create new rule

• Click on Add new rule (Plus icon) from the top right of the page. Or, you can click on Add rule button when there are no rules in your organization.

• Redirect the page to Create a new rule. There are two actions for the Rules Engine; 
  1. Assign to Category
  2. Generate PDF

---

Assign to Category

Here are the Rule properties that are required for the assigned category;

• Action - Define the rule type and automatically Assign to category by default.
• Context - Default language for the category.
• Target - Select the relevant category. Only one rule per one category.
  • Once you checkbox on Unassign product from the category, it will automatically unassign the product when the condition does not match the rule.

• Run Time - Define when the rule should be triggered after getting the relevant event.
  • The Event-based option is only available for the action to Assign to category. It takes approximately one minute for each event-based message to run. The frequency may be subject to change.
• Priority - Selected priority group will determine the sequence in which the rule is executed. Divided into five groups (Priority group 1 - Priority group 5) respectively.
• Name - Optional Rule name.
• Status - Active rule should be triggered. (New rule will be inactive by default)
• Product - Displayed the number of products that matches the query.
  • Edit query - allow you to add a condition or group for the product rule. Here is a simple example of a query; the condition is to find a single product type that has the product label 'Furniture' in the Furniture category.

• Triggers - List of the system events that will cause the rule to be evaluated for a product. Turn on the option for the Generate triggers from query, which will automatically add trigger events based on the selected query. 

---

Generate PDF

The generated PDF of the Rules Engine required adding a plugin of Product PDF to enable this function.

Here are the Rule properties that are required for the generated PDF;

• Action - Define the rule type and allow you to select Generate PDF from the list.
• Context - A list of supported context settings only for the Generate PDF of the selected product.
• Target - A list of PDF templates. One rule per template. 
  • Once you click on Add trigger events from the template, it will automatically add trigger events related to the PDF template in the Triggers part.
• Run Time - Define when the rule should be triggered after getting the relevant event.
  
  • Only Scheduled daily is available for the action Generate PDF and run as scheduled settings (Local time).
  • When it is about to run time daily, it will automatically generate a PDF and all queues are listed in the system monitor. 

• Name - Optional Rule name.
• Status - Active rule should be triggered. (New rule will be inactive by default)
• Products - Displayed the number of products that matches the query.
• Triggers - List of the system events that will cause the rule to be evaluated for a product that automatically adds trigger events if you add a trigger from the template. (At least one trigger per rule)

---

Trigger events

There are five event entity options, and you can select multiple trigger event types to cause the rule for the evaluated product. 

• Click on Add new triggers (plus icon) on the Triggers and select event entity.
• Asset with Labels - this trigger event is only for the Generate PDF action. Including the asset label and event type are the product, the variant group, and the variant product change. 

• Attributes - consist of the attribute's name and event type is value changed

• Attribute Group - this trigger event is only for the Generate PDF action. Including the attribute group and event type are the product, the variant group, and the variant product change. 

• Category - event type consists of the category assigned and unassigned

• Product - event type consists of  the product created and description, name, number, and label changed

Rules overview

You can view all rules created within the organization from the main page. Click the menu on the right side of a rule to get access to available functions:

Activate/Deactivate

Allow you to activate or deactivate the rule from here.

Edit 

Completed rules allow you to edit/update rules information. Any changes required to save or can be discarded.

• Assign to category - Once you edit the rule from the Rules Engine Tab in the catalog or category, the target category will be blocked and cannot change. 

• Generate PDF - When you edit the rules from the Rules Engine Main Page, the action of generating PDF will be blocked and cannot change. 

Duplicate

Allow you to copy the existing rule. The target category and template will be empty because having multiple rules for one target is impossible.

• Assign to Category - The action type, name, context, run time, product query, run priority, status, and event triggers should be copied from the existing rule. 
• Generate PDF - The action type, name, context, run time, product query, status, and event trigger should be copied from the existing rule.

Delete

A confirmation popup will display every time you want to delete the rule.

Filter Rules

With a large set of rules, you might want to utilize the Filters option to find the rule(s) you are looking for. The filter options are similar to the ones found for Product filter. 

 

Back to top