Create an Instance

Creating a Notification Instance is handled by the Notifications->Templates view

🚧To create a Notification Instance, please follow the steps below:

1

Navigate to the Notifications Templates View

The Notifications Templates view handles Notification Instances for the system

🚧To navigate to the Templates view:

  • Click on the Notifications -> Templates link via the navigation bar

After, the Notification Instances view will display

2

Open the New Notification View

The New Notification view handles creating new Notification Instances

🚧To open the New Notification view:

  • Click the Add button located above the Notification Instances Table.

After, a New Notification view will display.

3

Populate the Core Properties

The Core Properties panel handles entering general properties of a Notification Instance

🚧To populate the Core Properties of the Notification Instance, follow the sections below

Populate the Name

The Instance Name is a display name for the Notification Instance. This can have characters, numbers, and special characters

🚧To populate the Name:

  • Enter the new Name into the Instance Name input

Populate the Mnemonic

The Instance Mnemonic is a unique identifier for the Notification Instance. This can have character, numbers and some special characters.

White spaces (i.e. [SPACES]) are not allowed

🚧To populate the Mnemonic:

  • Enter a new Mnemonic in the Instance Mnemonic input

Populate the Entity Type

The Entity Type is the type of context to use for a particular resource

🚧To populate the Entity Type:

  • Click on the Entity Type input

After, a drop down will appear with a collection of available Entity Type options

  • Select an appropriate Entity Type option for the context of the Notification Instance

Populate the Description

The Description is the explanation and purpose for what this Notification Instance was intended for

🚧To populate the Description:

  • Enter a new Description into the Instance Description input

Populate the Template

The Template is the Notification Template to use for this Notification Instance

Notification Instances use Templates to format and populate data into a message that can be sent as a Notification

🚧To populate the Template:

  • Click on the Template input

After, a drop down will appear with a collection of available Template options

  • Select an appropriate template for the Notification

4

Populate the Parameters

The Parameters are variables that can be provided for the Notification Instance. The Notification Instances will use these to populate data into the Template.

🚧To populate the Parameters:

  • For each parameter, enter a value into the value input (referring to its Parameter description for context)

5

Populate the Filter, Trigger, and Target Panel

The Filter, Trigger, and Target panel contains the following:

  • Filter — What is the collection of data to look for

  • Trigger — What piece of data will be used as a flag to trigger the notification

  • Target — This is the medium/source of communication to send as a notification (e.g. email, sms, etc...)

🚧To populate the Filter, Trigger, and Target of the Notification Instance, follow the sections below:

Populate the Filter

The Filter is Which entities will be the subject of the notification.

Enter an expression that selects only the entities which should receive a message when the notification is triggered.

🚧To populate the Filter:

  • Enter a filter in the Filter input

Populate the Trigger

The Trigger is a flag indicating when the notification should be run.

Enter an expression that determines when to run this notification.

🚧To populate the Trigger:

  • Enter a new Trigger into the Trigger input

Populate the Target

The Target is How to notify the subject of the notification.

Enter an expression that resolves into a valid contact point for the subject.

🚧To populate the Target:

  • Enter a new Target into the Target input

6

Save

Saving will allow you to save the Notification Instance

🚧To save the Notification Instance:

  • Click the Save button

After, the New Notification View will close and a success notification will appear in the top right-hand corner of the screen

7

Verify the Notification Instance

In this step, we will verify the Notification Instance was successfully created by locating the new Notification Instance in the Notification Instances Table

🚧To verify the Notification Instance was created successfully:

  • Search for the Notification Instance in the Notification Instances Table

PreviousInstancesNextEdit an Instance

Last updated