Cumulus can perform predefined actions based on events that occur in catalogs. Events are generated by user actions or the Cumulus Scheduler.  Events include changing a metadata value, creating a new category, deleting a record, and more. When an event is linked to an action, we call it a trigger.

Triggers are the basis for email notifications that help keep you informed, and help keep your workflow flowing.

Anatomy of a Cumulus Trigger

A trigger configuration specifies two things:

• Event – The event is what Cumulus is waiting on. Each time the event occurs, Cumulus performs the action.
• Action – This is the task Cumulus performs when the event occurs.

There are three trigger event categories in Cumulus:

• Catalog Event Triggers – Use a catalog event trigger when you want Cumulus to watch for catalog settings changes.
• Record Event Triggers – Use a record event trigger when you want Cumulus to watch for record creations, deletions, or metadata field changes (any field or a specific field).
• Category Event Triggers – Use a category event trigger just like a record event trigger, only for specific categories instead.

You can apply a trigger on three different levels in Cumulus:

• Catalog Level – Create a trigger at a catalog level when you want Cumulus to watch all records or categories in a catalog. For example, any record was added or any category was deleted, or a metadata field in any record was changed. Options for catalog level triggers are asset record additions and deletions, category additions and deletions, metadata field changes (any field or a specific field), and catalog settings changes.
• Record Level – Create a trigger at a record level when you want Cumulus to watch a specific asset record for metadata field value updates.
• Category Level – Create a trigger at a category level when you want Cumulus to watch a specific category for metadata field value updates.

Catalog level triggers are far more common than record or category level triggers. Examples of catalog event triggers are:

• Notify a project manager when any project (category metadata) is set to “Delayed” or some other status of concern. (The trigger watches the “Status” metadata field for the value “Delayed”. When the field is so set, the project manager is notified.)
• Notify users when any asset is assigned to them. (The trigger watches the “Assigned To” metadata field, which displays a menu of user names. Each user sets up a trigger to watch for his or her name selected in the field. When selected, the user is notified.)
• Notify a catalog manager when any new assets are cataloged. (The trigger watches the entire catalog for newly cataloged assets. When new assets are cataloged, the catalog manager is notified.)

By contrast, a record or category level trigger would be set up when someone wants to watch a specific asset record or category: “I need to know when this record is deleted” or “I want to know when this asset is approved,” etc.
In a nutshell, a trigger can notify one or more users when any of the following occurs in a Cumulus catalog:

• Additions – Asset record or category.
• Deletions – Asset record or category.
• Modifications – Metadata field or catalog permissions.

Configuring Triggers

All triggers, no matter which type, are configured from the Properties window of the object to which the trigger will be assigned. So, if configuring a record event trigger, you’d do so from the Properties window for that asset record. (Right-click on the asset record and choose Properties from the context menu.)

Catalog event triggers are set up from the Properties window of the catalog, which you can access by right-clicking on the catalog name in the category tree, as shown in the image below.

This trigger will notify someone when the STOP DISTRIBUTION field check box is selected in any asset record.

At first, it might seem as though the configuration of a trigger takes many steps; but you’re guided by a wizard, so they’re very easy to configure.

The last step in setting up a trigger involves choosing additional email recipients who will receive the notifications. As the creator of the trigger, you will be notified by default, so there’s no need to add yourself to the list. You can add as many additional users as you want.

The last step of configuring an email trigger is to determine who in addition
to you will get email when the trigger is fired off by Cumulus. Add as many
users as you need.

There is no limit on the number of triggers you can create in a catalog. To edit or delete an existing trigger, return to the Properties window and select it from the list.

For details on the various options available for each trigger type, see the Cumulus Client Guide.