Recipient List widget - Metasys - LIT-12011953 - Server - Metasys UI - 7.0.50

Metasys UI Help

Product
Building Automation Systems > Graphics and Interfaces > Metasys UI
Document type
User Guide
Document number
LIT-12011953
Version
7.0.50
Revision date
2024-03-19
Product status
Active

What is a Recipient List?

The Recipient List is a widget available on the Notification object. The Notification object provides a means to send event notification messages that are generated by other objects to any BACnet device. The Notification object is mainly used to route alarm messages to third-party BACnet devices. The Recipient List is a list of one or more recipient destinations to which notifications are sent when event-initiating objects detect the occurrence of an event. Use the Recipient List to view and configure the details of a Notification object including the recipients of the notification.

What are the requirements to use a Recipient List?

You require View and Modify Items permission to configure the details in the Recipient List.
Note: For MVE on Metasys UI, see Recipient List widget for MVE on Metasys UI for more information.

How do I access the Recipient List?

  1. Click on the Notification object in the Network tree.
  2. Recipient List is the default widget on Page 1.

How do I add a new recipient to the Recipient List?

  1. Click on the Notification object in the Network tree.
  2. Click the Edit icon in the upper-right corner of the Recipient List widget.
  3. Click +.
  4. Complete the fields in the Recipient Details window as required. The following table describes the fields:
    Table 1. Recipient Details window
    Field Description
    Recipient Type Choose from IP Address, Device ID, MSTP Address, Local Broadcast, Remote Broadcast, or Global Broadcast.
    IP Address The 4 byte IP Address of the destination if you route by IP address. This value is ignored when Network Number is set to 65,535. When set to 255.255.255.255 IP Address or the broadcast IP Address, notifications are broadcast based on the Network Number. A value of 0 sends a local broadcast. A value of 1–65,534 sends a remote broadcast.
    Network Number The network number for the destination if you route by IP or MS/TP address: 0 designates the address of the local network; 1–65,534 identifies a destination address on the specified network; and 65,535 specifies the use of global broadcast notification.
    UDP Port The UDP Port number used to send the notification message to the destination if you route by address. When the port is set to 0, this value when written is replaced with the port used by the supervisory device on the IP network.
    Process ID The process ID in the recipient device that receives the event notification messages.
    Valid Days The days of the week on which notifications can be sent to this destination during the defined Start and Stop Time. To specify all times, use 00:00:00 for Start Time and 23:59:59 for Stop Time.
    Transitions Three options which indicate the types of transitions sent to the destination: Off Normal, Fault, or Normal.
    Confirmation Indicates whether to send Confirmed or Unconfirmed event notifications. This selection is ignored when you use global broadcast notifications.
  5. Click ADD.
  6. Click SAVE.

How do I edit a recipient in the Recipient List?

  1. Click on the Notification object in the Network tree.
  2. Click on the recipient that you want to edit in the Type column of the Recipient List.
  3. Edit the fields in the Recipient Details window, as required.
  4. Click OK.
  5. Click SAVE.

How do I delete a recipient from the Recipient List?

  1. Click on the Notification object in the Network tree.
  2. Click the Edit icon in the upper-right corner of the Recipient List widget.
  3. Select the recipient that you want to delete and click the delete icon.
  4. Click SAVE.

How do I reorder the recipients on the Recipient List?

  1. Click on the Notification object in the Network tree.
  2. Click the Edit icon in the upper-right corner of the Recipient List widget.
  3. Select the recipient that you want to move and click the up or down arrow to change the order of the item in the list.
  4. Click SAVE.