Skip to main content

Creating a New Notification

Paige Freeman
  • Updated

To create a new notification:

  1. From the Web Admin dashboard, select Design Notification Events.
    The Notifications page displays.
  2. From the Notifications page, select the Create New Notification button.
  3. The Create a new notification window displays, as shown below.
  4. From the Select a Trigger Event section, select the radio button for the event you wish to trigger your notification. Options include Scheduled, Created, Changed, or Removed.
    At this time, Scheduled notifications are supported for desktop, web client, and e-Business. Real-time notifications (Created, Changed, Removed) are only supported by the web client and will not function for desktop or e-Business. Personify recommends using Scheduled notifications at this time.
  5. From the Select a Template drop-down, you can select to create your notification based on pre-set templates delivered with Notification Designer.
    -OR-
    Select Build from Scratch from the Select a Template drop-down and then select the Namespace and Collection that will drive your new notification. Once you have selected the Namespace and Collection, select OK. This information can not be modified once it is selected.
  6. The Notification Settings page displays. The fields that display on this page will depend on the selected Trigger Event. 
    1. For Real-Time Notifications:
      At this time, Scheduled notifications are supported for desktop, web client, and e-Business. Real-time notifications (Created, Changed, Removed) are only supported by the web client and will not function for desktop or e-Business. Personify recommends using Scheduled notifications at this time.
      From the Event Details tab, perform the following:

      1. Enter the Event Name. This is the name of your notification.
        The event name cannot be modified once the notification has been saved.
      2. Enter the Description. This is a brief description of your notification.
      3. If you selected “Changed” as the Trigger Event, an additional drop-down displays for you to select the properties to monitor. Select the Monitor this list of properties drop-down to view the list of available properties within your selected data collection. You can select multiple properties from this list.
      4. The Additional Criteria section allows you to define additional requirements that must be met in order for your new notification to trigger. Each filter property can be mapped to an API object. The properties available to add in this section include child object collections.
        If you want to honor the Allow System Notification flag on a customer record, new notifications should have the AllowSystemNotificationFlag property set as Equal to Y in the Additional Criteria section. The base templates include this property by default, but it can be removed if necessary.
        1. Select the +Add Filter button to add additional criteria.
        2.  Select the desired Property from the drop-down, then select OK.
        3. Select the Operator and Value Type of Static or Dynamic, if necessary.
          Available operators include Equal, NotEqual, LessThan. LessThanOrEqual, GreaterThan, GreaterThanOrEqual, In, Not in, IsNull, Not Null, Contains, Starts With, Ends With, and Between.
        4. Enter the Value.
        5. Continue to add additional properties as desired.
    2. For Scheduled Notifications:
      From the Event Details tab, perform the following:

      1. Enter the Event Name. This is the name of your notification.
        The event name cannot be modified once the notification has been saved.
      2. Enter the Description. This is a brief description of your notification.
      3. Select the Frequency.
        Depending on the selected frequency, additional fields may display:
        1. Every X minutes: enter the number of minutes
        2. Hourly: enter the number of hours
        3. Daily: enter the number of days
        4. Weekly: enter the number of weeks and select the weekdays
        5. Monthly: enter or select the day and number of months
        6. Yearly: enter or select the month and day
      4. Select the Timezone.
        This will default based on the Timezone selected in Global Settings.
      5. Select the Start Date and Start Time.
      6. Select the End Date and End Time, if necessary.
      7. The Additional Criteria section allows you to define additional requirements that must be met in order for your new notification to trigger. Each filter property can be mapped to an API object. The properties available to add in this section include child object collections.
        If you want to honor the Allow System Notification flag on a customer record, new notifications should have the AllowSystemNotificationFlag property set as Equal to Y in the Additional Criteria section. The base templates include this property by default, but it can be removed if necessary.
        1. Select the +Add Filter button to add additional criteria.
        2.  Select the desired Property from the drop-down, then select OK.
        3. Select the Operator and Value Type of Static or Dynamic, if necessary.
          Available operators include Equal, NotEqual, LessThan. LessThanOrEqual, GreaterThan, GreaterThanOrEqual, In, Not in, IsNull, Not Null, Contains, Starts With, Ends With, and Between.
        4. Enter the Value.
        5. Continue to add additional properties as desired.
  7. Once you have finished making changes, select Save and Close to save your notification and return to the Notifications page, OR select Next to continue to the Email Details tab.
  8. From the Email Details tab, perform the following:
    notificationemaildetails.png
    1. From the Attributes window, select the + button to add any attributes you want to use in the To, CC, or BCC fields, or within the Email Body. Attributes must be added in this window before they can be used in any fields within the Email Details tab.
    2. The From and Reply to fields will default with the values that are set in Global Settings. You can change these values if necessary.
    3. If you modify the email address in the From field, the Verify button becomes available. Select the button to verify the email address. Once the email is verified, a green checkmark and Verified label will display below the From field.
      The email address entered in the From field must be verified as an active email address. For more information, please see Verifying a Notification Email Address. Additionally, the email address used in the From field must be a company email address for the notification event to function. Free personal email accounts such as Gmail and Yahoo are not acceptable.
    4. Enter the email address(es) this notification should be sent to in the To field.
      The To field can be mapped to the PrimaryEmailAddress API property once it is added in the Attributes section of the Email composition tab.
      IMPORTANT: Please be aware that any email address that is entered in the To, CC, or BCC field(s) will be live and will receive the email notification upon the triggering event if the notification is not in Test mode. Test mode can be set on the Manage Notification Event or Design Notification Event page. Newly-created notifications are set to Test mode by default.
    5. If you wish to add CC and/or BCC email addresses for the notification, select the CC/BCC button to open those fields for edit.
      These fields will default with any value that is set in Global Settings.
    6. Enter the Subject for the email notification.
    7. Select the Header Template and Footer Template.
      These fields will default with any value that is set in Global Settings.
      For more information on creating notification headers and footers, please see Notification Headers and Footers.
    8. Use the editor to enter the Email Body of the notification.
      1. Once properties are added in the Attributes window, select the << arrows next to any corresponding attribute to have it appear where your cursor is in the Email Body editor.
      2. The email body can also be configured using an HTML editor by selecting the HTML button to the left of the email body editor.
    9. Select the Preview Email button to view a preview of your email notification.
      Graphical user interface, text, application, email Description automatically generated
  9. Once you have finished making changes, select Save and Close to save your notification and return to the Notifications page.
  10. After creating a new real-time notification, you must refresh the notification templates from the web client. For more information, please see Refresh Notification Templates.