Dynamic Recipients

Overview

The Dynamic Recipients register enables creation of recipient lists for the Communication module. Dynamic Recipients are distribution lists that evolve over time. For example, when you add a Contact and classify them in a certain way, they can be automatically added to the communication list so that Communications Managers can email or text them as required.

The system comes pre-configured with some generic recipient lists. Refer to the List of Dynamic Recipients and their usage.

At present this function can be used with the following register items:

A Communications Manager can easily include them in a Communication by adding the name of the Dynamic Recipient as a message recipient.

Managing this module requires use of CQL, the query language used in the system. CQL queries can be generated through the filtering system and then copied and pasted into a Dynamic Recipient item.

Access

To access the Dynamic Recipients register you will need to sign in with the System Admin & Data Entry role.

You can find the Dynamic Recipients register under System Administration > Dynamic Recipients.

Viewing Dynamic Recipients

Dynamic Recipients are listed in and searchable via the register Datagrid. Viewing them in this datagrid may not make much sense and they are rarely if ever changed once created.

To view an existing Dynamic Recipient:

1. Navigate to the Dynamic Recipients register datagrid.

2. Locate the item you wish to view. The register includes additional filters for Workflow Status (Active/Inactive) and Active Tags

3. Open the item using the ID

4. To return to the Datagrid use the Back button

Dynamic Recipient Settings

General

Recipient Type defines the type of recipient, at present the only option is CQL Recipients.

Name is what appears when the Communications Manager searches and enters it in the recipients list of a Communication. It helps identify the Dynamic Recipient.

CQL is the query to perform to find the recipients. This will need to retrieve compatible records in order to work. For more information on CQL see Search, Filter and Query Registers.

Register enables the Dynamic Recipient to be added into compatible register items. Only a single register is supported.

Tags enables tags to be attached to the item.

Workflow

Dynamic Recipients have only two statuses: Active and Inactive. Active are enabled for use. Inactive cannot be selected as options by users. They can be reactivated and re-added if needed.

Editing Dynamic Recipients

Dynamic Recipients can be edited from the datagrid.

1. Navigate to the Dynamic Recipients

2. Locate the Dynamic Recipient you wish to edit by using the Edit button

3. Make the necessary changes to the settings

4. Save to save your changes

Adding Dynamic Recipients

To add a Dynamic Recipient:

1. Use the New Item button for New Dynamic Recipient

2. Select a Recipient Type and enter a Name and CQL for the Dynamic Recipient and select a Register to enable it in

3. Make any other configurations changes necessary in the settings

4. Use the Save button