Skip to main content
Skip table of contents

Triggers

A Trigger represents a reusable entity that defines the structure of how a retention period begins. You use a Trigger as a building block for defining another type of entity called Retentions. The Trigger does NOT contain the Retention Duration. The Trigger is used by the Retention Entity to determine the Retention Rule. The Trigger, together with the Retention and Lifecycle Action, make up the Lifecycle Phase.

See the following table for each trigger type:

Trigger Type

Description

Special

Predefined triggers for dates that can be assigned to items dynamically according to user interaction

Event

There are two types of Event Triggers:

  • Recurring - These are typically for Case Records and are created by a recurring date. For example:

    • End of Fiscal Year (EFY)

    • End of Calendar Year (ECY), also known as End of Current Year

  • Manual - These are typically for Case Records and are created manually by a user or can be generated by the API. For example

    • Employee Termination & Contract Expiration

Date Property

Starts retention when a date property is met. For example:

  • Date Created (@Created)

  • Date Modified (@Modified)

  • Custom date column (e.g. True Document Date, Contract Date)

Rule

Starts retention on when a rule evaluates to true. For example:

  • Status = Completed

  • Flag = Yes

Event Triggers result in one or more occurrences that specify the date and time that particular event happened and the specific record(s) that should be targeted. Events are typically used for Case Records. Date and Rule Triggers define how the date and time will be determined based on the properties of the record itself.

Editing Triggers

You may edit the Title or Description of a Trigger, and the property will simply be changed throughout the software.

Changing properties other than Title or Description may cause the lifecycle or all items using the trigger to be reset. 

JavaScript errors detected

Please note, these errors can depend on your browser setup.

If this problem persists, please contact our support.