Using the Rules Editor App

The Rules Editor app allows administrators to define rules that trigger actions on available events ​in Avid Content Core. A rule defines a situation in which an action gets triggered. It combines a trigger (event), multiple conditions (filters) for an entity and one or more actions. For example, you can define a rule that sends a notification (action) when a Proxy Job (entity) is updated (trigger) and its Status attribute has a Completed value (condition). Using the Rules Editor app, you can create, edit, enable/disable, duplicate, copy, export, import and delete rules.

The Rules Editor saves rules to and retrieves saved rules from the Rules Engine. The Rules Engine service evaluates the rules and in case a rule matches it invokes the action in the corresponding Action Engine, which will orchestrate the action.

n In this version, a maximum of 500 rules is supported.

Rules Processing: Included Back-End Components and Workflow

The Rules Engine is able to receive entity change events. When an event arrives the Rules Engine determines the rules with a matching trigger. A trigger is a first filter step in the Rules Engine defining the kind of change (such as created, updated, deleted).

For each found rule the Rules Engine calculates the rule condition. A condition consists of a set of comparison operators acting on the triggering entity. For better efficiency, primarily data from the change event gets used. When a condition includes entity properties not contained in the event the Rules Engine retrieves it from the underlying system.

A matching condition indicates a rule match. In this case, the Rules Engine triggers the execution of actions configured in the rule by queuing action commands. For this purpose, the Rules Engine reads the related Action Configuration, resolves expressions and sends a corresponding Action Message to the responsible Action Engine. The Action Engine executes the action.

Accessing the Rules Editor App

As a Workflow Administrator, you can access the Rules Editor app through the administrator settings.

To access the Rules Editor app:

  1. Sign in to ACC with an account that is assigned to a Workflow Administrator role.

  2. Click the User Menu in the upper-right corner of the user interface and select the Admin Mode option.

    While the ACC UI switches to admin mode, a "Please Wait" message is displayed.

  3. In the Admin mode Fast Bar, click the Rules Editor button.

    The Rules Editor app opens.

    If your account is not assigned to a Workflow Administrator role, a corresponding “no access” message will be shown.

For more information on accessing the administrator settings, see Managing the ACC Administrator Settings.

For information on the Rules Editor app layout, see Understanding the Rules Editor App Layout.

Creating a Rule: Basic Steps

The following procedure summarizes the main steps required for creating a rule.

How to create a rule:

  1. In the app's sidebar, select the rule type Content Core Jobs.

  2. In the Rules and Items panel, click the Add new rule button.

  3. Add a trigger.

  4. Add an entity.

  5. Add one or more Actions.

  6. Add a name for the rule in the Details panel.

  7. (optional) Define filter conditions for the entity.

  8. Define the parameters for the action(s).

  9. Enable the rule in the Details panel.

  10. Save the rule.

For more information, see the following topics: