Create a Roster Tag

Roster tags can contain up to 39 contacts specifying who should be notified (and how) when alarms are not otherwise acknowledged. You may have as many Roster Tags in your system as you require.

Every VTScada installation includes a tag named Default Call-Out Off, which is meant to function as an off button for the default roster area. You are advised not to modify or delete this tag.

For all roster tags sharing the same area property, the following rules apply:

• Only one can be active at any time.
• One must always be active.

When two or more Roster tags share an Area, activating one will automatically deactivate the others.

If a Roster is a child of a custom AlarmDatabase, it will call out alarms only from that database rather than all. Alarms with a matching Area property but under another AlarmDatabase will not be called out by this Roster.
You may switch to the legacy behavior where all AlarmDatabases are searched, but this will be slower if you have a large number of AlarmDatabase tags. See: LimitRosterToParentDB

To update the contact list you must have the Edit Roster Contacts privilege.
Legacy applications used the Manual Data or Tag Parameter View privilege. Accounts with those privileges will be granted the Edit Roster Contacts privilege on upgrade. The older privileges will no longer serve to modify the roster.

The following generalized instructions will help to guide you through the configuration of a Roster tag. Detailed notes for each property are provided in the article describing Roster Tags.

Add a contact by selecting a blank row in the list and filling in the various property fields. Edit by selecting a configured row and changing property fields. The list itself allows only two functions: change the order by selecting a row and using the arrows below the list, to the left. Delete a contact by selecting a row and using the X button below the list, to the right.

1. Open the Tag Browser and create a new tag, selecting Roster as the type.
   
2. Give the tag a name describing its purpose. ("Evening shift", etc...)
3. Leave the Area field Default unless you intend to send some alarms to one group of operators and other alarms to a different group.
   (See Roster Selection Hierarchy)
4. Give the tag a meaningful description.
5. Open the Contacts tab.

6. Click the Add Contact button.
   A new row is added to the end of the roster list.
7. Click under Method.
   A drop-down selection of the available communication methods is shown.
8. Select the Communication Method option as appropriate.
9. Enter an operator's name in the Name field.
   This is only a description and may include a note about the contact method as well as the name. For example, "Joe home phone", "Jane cellular phone".
10. Enter a phone number (Voice, SMS message), pager number (Pager), or email address (Email) in the Phone Number / Email Address field.
    If email, you may enter a list of addresses, separated by commas.
11. If the selected contact method for this operator is Pager, enter the pager's PIN number in the PIN Number field.
12. Provide the user's security account name in the User Name field.
    Alarm acknowledgment by email or text is not possible without this.
13. Repeat for Person 2 etc. until you have added all the designated operators you require for this roster.
14. If any contact or set of contacts should have a delay or be repeated before the roster attempts the next, click the Add delay/repeat button.
15. Configure the rules for delay or repeat or both as appropriate.
    The rule applies to all preceding contacts, up to the top of the list or to the previous rule.
    If no delay rule is set between consecutive contacts, then no delay is used.
16. Drag rows up and down to change the order and to group contacts with delay/repeat rules.
17. Open the Settings tab.
18. Choose whether to repeat the entire list after the last contact is attempted.
19. Click OK.
    The new Roster tag will now appear in your Tag Browser.

Phone number formatting matters. You must use a format that is acceptable for whichever service provider or device you have opted to use. You are generally safe using the E.164 standard of canonical phone numbers Format defined by the E.164 standard. Including the area code and subscriber number with no dashes, spaces or extra characters Ex. 15553217654, however, you are advised to check your device manual or check with your service provider to confirm their formatting rules.

Troubleshooting:

• The communication method you want to select is not enabled.

Communication methods are enabled only when VTScada can use those methods. For example, if you have not attached an SMS device and configured an SMS Appliance tag, then you cannot choose to send an alarm message by SMS text.

Related information:

Script a Custom View of a Roster (For advanced developers only.)