Edit an Instance

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

🚧To edit 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

Locate the Notification Instance Record

The *Notification Instance Record" will be displayed in the Notification Instances Table

🚧To locate the Notification Instance record:

  • Search the Notification Instances Table.

Searching for a Notification Instance

To locate the Notification Instance, search by:

  • 👀Manually searching for the desired Notification Instance record

  • 🔍Filtering the Notification Instances by entering the Notification Instance Name into the Search input.

3

Open the Edit Instance View

Editing an Instance is handled by the Actions Column of the Notification Instances Table

🚧To edit a Notification Instance record:

  • Click the Edit button in the Actions Column of the Notification Instances Table

After, the Edit Instance view will display

4

⭐Update the Core Properties (Optional)

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

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

Update the Name

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

🚧To update the Name:

  • Enter the new Name into the Instance Name input

Update 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 updated the Mnemonic:

  • Enter a new Mnemonic in the Instance Mnemonic input

Update the Entity Type

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

🚧To update 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

Update the Description

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

🚧To update the Description:

  • Enter a new Description into the Instance Description input

Update 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 update 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

5

⭐Update the Parameters (Optional)

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)

6

Update 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 update the Filter, Trigger, and Target of the Notification Instance, follow the sections below:

Update 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 update the Filter:

  • Enter a filter in the Filter input

Update 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 update the Trigger:

  • Enter a new Trigger into the Trigger input

Update 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 update the Target:

  • Enter a new Target into the Target input

7

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

PreviousCreate an InstanceNextEnable / Disable Instance

Last updated