Interactive Voice Response (IVR)
Module: Account Management
Overview
Interactive Voice Response is a third-party software system that IBS has integrated with SBN to respond to alarms in the Alarm Queue with automated voice messages.
Users determine which alarms the IVR should automatically respond to by making selections in Zone Types (program #1733), Branch Profiles (program #1530), Scheduling (program #563), and Dealer Profiles (program #1537). Users determine how the IVR responds to alarms (which Action Plan contacts to call, in what order, and so on) in the IVR tab of Data Entry (program #559). Assign an IVR terminal to process these alarms in Terminals (program #1861).
Users may manually start or pause IVR processing on alarms in Dispatch (program #537) using the Start/Pause IVR button.
Note: Only one IVR process may run per incident.
This document covers the following topics:
IVR Zone, Branch, and Dealer Types
IVR Options
Options define several features of IVR processing. The IVR options are described below.
- ivr - Option ivr compiles IVR procedures and tables, including all IVR ATOM procedures and GUI support procedures. This option should be turned on when option ivr001 is on.
- ivr001 - When on, the IVR tab appears in program #559.
- ivr002 - The value of this option defines IVR High Priority.
- ivr003 - The value of this option defines IVR Regular Priority.
- ivr004 - The value of this option defines IVR Environmental Priority.
- ivr005 - The value of this option defines IVR Low Priority.
- ivr006 - The value of this option defines the IVR High Priority second hit delay.
- ivr007 - The value of this option defines the IVR Environmental Priority second hit delay.
- ivr008 - The value of this option defines the IVR Regular Priority second hit delay.
- ivr009 - The value of this option defines the IVR Low Priority second hit delay.
- ivr010 - The value of this option defines the number of minutes for the IVR incident timer LIVE_ACK_TRANS.
- ivr011 - The value of this option defines the IVR maximum busy attempts.
- ivr012 - The value of this option defines the number of seconds for the IVR delay on busy retry.
- ivr013 - The value of this option defines the IVR weekday start time.
- ivr014 - The value of this option defines the IVR weekday stop time.
- ivr015 - The value of this option defines the IVR Saturday start time.
- ivr016 - The value of this option defines the IVR Saturday stop time.
- ivr017 - The value of this option defines the IVR Sunday start time.
- ivr018 - The value of this option defines the IVR Sunday stop time.
- ivr019 - The value of this option defines a field position in program #1590 that defines the drop-down menu for the Event Parameter field in the IVR Auto Insert section of program #1733.
- ivr020 - The value of this option defines the user ID that SBN records in the Alarm Log when the IVR takes an alarm from the Alarm Queue.
- ivr021 - When on, the IVR only processes Branch IVR signals.
- ivr022 - This option defines the VDN type to use for installations with a blank Default VDN Type field in the IVR tab of Data Entry (program #559).
- ivr023 - This option defines the VDN type to use for installations with a blank VDN Type field in the Call Flow section of the IVR tab of Data Entry.
- ivr024 - This option defines the skill position of the secondary VDN type for installations with a blank VDN Type field in the Call Flow section of the IVR tab of Data Entry. If this skill position in the Skill fields of the Data Entry Basics tab contains the value defined by option ivr025, SBN uses that VDN type for the installation rather than the value of option ivr023.
- ivr025 - This option defines the skill value of the secondary VDN type for installations with a blank VDN Type field in the Call Flow section of the IVR tab of Data Entry. If the skill position defined by option ivr024 in the Skill fields of the Data Entry Basics tab contains the value defined by this option, SBN uses this VDN type for the installation rather than the value of option ivr023.
- ivr026 - This option defines the number of minutes that SBN puts an installation into Test mode when a user chooses the Voice Test On button in the Two Way Voice window of Dispatch (program #537).
- ivr027 - This option defines the maximum number of minutes allowed since an alarm was received by the IVR Bridge Control Table for automatic IVR processing to take place. If an alarm comes in on a zone of a type with the Two-Way Voice check box selected in program #1733 and more time has passed than the number of minutes defined by this option since the signal was received by the IVR Bridge Control table, SBN does not activate IVR processing for the alarm.
- ivr028 - This option was added for IVR_CLEAN Ups.
- ivr029 - If this option is on, the IVR agent ID dialog appears after logon.
- ivr030 - This option defines the time range, in minutes, used as buffer to the actual scheduled service request start time. The default is currently set to 120.
- ivr031 - This option defines the IVR Schedule start range minimum in hours. The default is currently set to 480 (8:00 a.m.).
- ivr032 - This option defines the IVR Schedule start range maximum in hours. The default is currently set to 1020 (1700 or 5 p.m.).
- ivr033 - IVR resolution code #1
- ivr034 - IVR resolution extension #1
- ivr035 - IVR resolution code #2
- ivr036 - IVR resolution extension #2
- ivr037 - IVR message event required.
- ivr038 - Communications Log Sent User.
- ivr039 - Communications Log Sent Department
- ivr040 - IVR Leave Message logging Event #
- ivr041 - IVR Leave Message logging Event Extension
- ivrcb - 555-1212 is IVR callback number for this server.
- ivrext - 1234 is IVR extension for transfers.
- ivrlog - On => IVR logging in w# tables.
- ivrpw - ctiuser1 IVR Webserver password.
- ivrterm - SBN terminal used by IVR when processing calls.
- ivrto - When on, this option control the number of seconds for the IVR to connect, send, and receive timeouts.
- ivrurl - http://10.2.145.138:8080/IBSRequestCTI/SbnGenesysInt. When on, this option determines the IVR Webserver URL.
- ivrusr - When on, this option determines the IVR Webserver user.
- ocivm - 1 Minute passcard level to be notified via IVR.
IVR Zone, Branch, and Dealer Types
Users determine which alarms the IVR should automatically respond to by making selections in Zone Types (program #1733), Branch Profiles (program #1530), and Dealer Profiles (program #1537). The IVR fields for each of these programs are described in the sections below.
IVR - Zone Types (Program #1733)
IVR - Branch Profiles (Program #1530)
IVR - Dealer Profiles (Program #1537)
IVR - Zone Types (Program #1733)
Zone Types contains several fields which SBN uses to determine which zone types the IVR automatically responds to. When you select the Enable IVR check box, these fields and check boxes appear in the IVR Auto Insert section on the far right side of the Zone Types program window.
The first step in setting up IVR processing is to select the Enable IVR check box in this section for any zone types that you want the IVR to respond to. Then select other check boxes and fields in the IVR Auto Insert section as necessary.
You may then further define IVR settings in the sublevel tabs of program #1733:
- Branches tab - Enter branches in this tab for which the zone type should not be eligible for IVR processing.
- Dealer tab - Enter dealers in this tab for which the zone type should not be eligible for IVR processing.
- Sub Type tab - Enter zone type/subscriber type combinations that SBN allows within the incident and before an alarm on the current zone type to proceed with IVR processing.
- Call Type tab - Enter specific combinations of branch, dealer, and sub type that can override the Call Type defined for the selected zone type.
(See the Zone Types document in System Administration for more information on the sublevel tabs.)
The following graphic shows the Zone Types window with the IVR Auto Insert section outlined in red.
/am_ivr_zone_types_main.jpg)
Field Descriptions - IVR Auto Insert Section
The following table describes the fields in the IVR Auto Insert section of Zone Types.
Field | Description |
Enable IVR | Determines whether the IVR process is used for this zone type. |
Queues Allowed | Select a check box for each of the alarm queues where alarms on the selected zone type are processed by the IVR. |
VDN Type | The number in this field determines the VDN type to use in the IVR activity table. Note: Depending on the type of IVR your company uses, an entry in this field may not be necessary. |
Call Type | Determines the IVR call flow that SBN uses for the selected zone type. (The call flows in this menu are those with the Call Type check box selected in the IVR tab of program #559.) |
Event Param | Along with the contact type in an action plan, the Event Parameter determines the call type that SBN uses for each contact in an action plan. For example, if the event_param is 'CAN' and the cont_type = 'P' (premise), then the call_type = 'CAN'. If the event_param = 'CAN' and cont_type = 'C' (contact person), then call_type = 'ICL'. Note: Use option ivr019 to define a field position in program #1590 that defines the drop-down menu for this field. |
Initial Date Threshold | Number of days that have passed since the alarm system installation date in order for SBN to begin IVR processing. (If this number of days has not passed since the installation date, SBN does not begin IVR processing.) |
Lone Trigger | Determines if the zone type received alone must trigger IVR processing. |
IVR_REST Bypass | Select this check box to prevent IVR processing on the selected zone type. Users can begin IVR processing on any zone type in Dispatch (program #537) regardless of whether the Enable IVR check box is selected in program #1733 unless this check box is selected. The IVR will not process zone types with the IVR_REST Bypass box checked under any circumstances. |
Max Time (seconds) | Maximum age of an incident, in seconds measured from when the incident started, for IVR to act on it. This is a cutoff, not a delay before IVR starts: if IVR does not begin processing the incident within this many seconds of its start, the incident is not automatically processed by IVR. |
Runaway | Determines if the triggering installation must be put in Runaway mode after the incident is created and IVR processing is started. |
Runaway Days (No label) | Number of days to put the triggering installation in Runaway mode. |
IVR - Branch Profiles (Program #1530)
The second step in setting up the IVR is to determine which alarm signal types you want the IVR to process for each branch. To do this, select particular check boxes in Branch Profiles (program #1530) for each branch you want the signal types processed on. These check boxes are outlined in red in the graphic below.
Note: Option ba455 must be on for the IVR CAN, IVR BAT, and IVR TTM check boxes to appear in program #1530. Action 1530/989 must be on as well to see these check boxes.
Note: If the contact phone number in Branch Profiles is not exactly ten numbers after omitting all existing non-numeric characters, you cannot enter an IVR request for this branch into the IVR Queue.
/am_ivr_branch_profiles.jpg)
Field Descriptions - IVR Check Boxes
The following table describes the IVR check boxes in Branch Profiles.
Field | Description |
IVR CAN | Select this check box to allow IVR processing for the selected branch on alarm signals of type 'CAN' (Cancel Alarm). |
IVR BAT | Select this check box to allow IVR processing for the selected branch on alarm signals of type 'BAT' (Low Battery). |
IVR TTM | Select this check box to allow IVR processing for the selected branch on alarm signals of type 'TTM' (Test Timer Missing). |
IVR - Dealer Profiles (Program #1537)
The third step in setting up the IVR is to determine which alarm signal types you want the IVR to process for each dealer. To do this, select particular check boxes in Dealer Profiles (program #1537) for each dealer you want the signal types processed on. These check boxes are outlined in red in the graphic below.
Note: Option ba455 must be on for the IVR CAN, IVR BAT, and IVR TTM check boxes to appear in program #1537. Action 1537/989 must be on as well to see these check boxes.
Note: If the contact phone number in Dealer Profiles is not exactly ten numbers after omitting all existing non-numeric characters, you cannot enter an IVR request for this dealer into the IVR Queue.
/am_ivr_dealer_profiles.jpg)
Field Descriptions - IVR Check Boxes
The following table describes the IVR check boxes in Dealer Profiles.
Field | Description |
IVR CAN | Select this check box to allow IVR processing for the selected dealer on alarm signals of type 'CAN' (Cancel Alarm). |
IVR BAT | Select this check box to allow IVR processing for the selected dealer on alarm signals of type 'BAT' (Low Battery). |
IVR TTM | Select this check box to allow IVR processing for the selected dealer on alarm signals of type 'TTM' (Test Timer Missing). |
IVR Tab of Data Entry
Users determine how the IVR responds to alarms on an installation in the IVR tab of Data Entry (program #559). The IVR tab contains several fields and check boxes used to set up IVR call flow for the installation. The following graphic displays the IVR tab of Data Entry.
Note: Option ivr001 and action 559/800 must be on for the IVR tab to appear in Data Entry. The default location of the IVR tab is after the Basics tab and before the Dispatch tab.
When a user indicates in the IVR_REST (E_css_ins_misc3) field of the Basics tab of Data Entry that the selected installation is IVR restricted, SBN selects the None radio button in the IVR tab, wiping out any existing IVR setup for the installation. If a user selects the Change button in the IVR tab on an installation that is IVR restricted, SBN displays the error message, "This installation is IVR restricted."
The Change button does not appear in the IVR tab when action 559/801 is off. When action 559/802 is off, the Change button only appears if the Template check box or Call Type check box is not selected in the IVR tab. When actions 559/801 and 559/802 are both on, the Change button always appears in the IVR tab.
/ivr_opt_out.png)
Field Descriptions - IVR Tab
The following table describes the fields in the IVR tab of program #559.
Field | Description |
None | Select this radio button to indicate that the IVR does not respond to any alarms on this installation. |
IVR Opt-Out | Select this radio button to opt-out of the IVR processing on the selected installation. |
Template | Select this radio button to use a template for IVR processing. |
Select | You may select a template to use for IVR processing. The IVR processing setups in this drop-down menu have the Template check box selected in the IVR tab of program #559. |
Phone 1 Spec | Phone related values that the IVR uses to reach phone extensions for the installation premises, (such as "," for pause, "#" for pressing the pound key, etc.). |
Phone 2 Spec | Phone related values that the IVR uses to reach phone extensions for the installation premises, (such as "," for pause, "#" for pressing the pound key, etc.). |
Installation | Select this radio button to use another installation's IVR processing setup. |
Number | Enter an installation number to use its IVR processing setup. |
Custom | Select this radio button to customize IVR processing for the installation. When you select this radio button, SBN removes check marks from the Template and Call Type check boxes. |
Call Flow Extension | |
Use Flow Extension | Select this check box for the IVR to auto-dial phone number extensions. If this check box is blank, the IVR stops to let an operator dial phone number extensions. |
Pause Before Extension | Select this check box to auto-pause the IVR before dialing an extension for a phone number. |
Call Structure (1) | Select a call structure that determines which parts of the action plan will be included in the IVR process on the Initial Pass: Premise Only, List Only, or Premise + List. |
Call Structure (2) | Select a call structure that determines which parts of the action plan will be included in the IVR process on all Subsequent Passes: Premise Only, List Only, or Premise + List. |
VDN Type | Secondary VDN type to use for the installation in the IVR activity table. Define the primary VDN type for the installation in the Default VDN Type field. Note: Depending on the type of IVR your company uses, an entry in this field may not be necessary. Use option ivr023 to define the VDN type to use when this field is blank. Use option ivr024 to define the skill position of the secondary VDN type for installations that have no entry in this field. If this skill position in the Skill fields of the Data Entry Basics tab contains the value defined by option ivr025, SBN uses that VDN type for the installation rather than the value of option ivr023. Use option ivr025 to define the skill value of the secondary VDN type for installations that have no entry in this field. If the skill position defined by option ivr024 in the Skill fields of the Data Entry Basics tab contains the value defined by this option, SBN uses this VDN type for the installation rather than the value of option ivr023. |
Pass Attempts (1) | Number of times the IVR attempts contact via Call Structure 1. |
Pass Attempts (2) | Number of times the IVR attempts contact via Call Structure 2. |
Initial Pass Fields | |
Active? | Select this check box if Initial Pass is active. |
Contact Delay | Number of seconds the IVR pauses before calling the next contact. |
Contact Phone Delay | Number of seconds the IVR pauses before calling each of a contact's phone numbers, (for contacts that have multiple phone numbers in the action plan). |
Voice Mail Allowed? | Select this check box for the IVR to leave voice mails on Initial Pass. |
Pass Delay | Number of seconds to pause after Initial Pass. |
Pass #2 Fields | |
Active? | Select this check box if Pass #1 is active. |
Contact Delay | Number of seconds the IVR pauses before calling the next contact. |
Contact Phone Delay | Number of seconds the IVR pauses before calling each of a contact's phone numbers, (for contacts that have multiple phone numbers in the action plan). |
Voice Mail Allowed? | Select this check box for the IVR to leave voice mails on Pass #1. |
Pass Delay | Number of seconds to pause after Pass #1. |
Subsequent Fields |
|
Active? | Select this check box if Subsequent Passes are active. |
Contact Delay | Number of seconds the IVR pauses before calling the next contact. |
Contact Phone Delay | Number of seconds the IVR pauses before calling each of a contact's phone numbers, (for contacts that have multiple phone numbers in the action plan). |
Voice Mail Allowed? | Select this check box for the IVR to leave voice mails on Subsequent Passes. |
Pass Delay | Number of seconds to pause after each Subsequent Pass. |
Max Voice Mail/Phone | Maximum number of voice mails to leave for each phone number. |
Default VDN Type | Primary VDN type to use for the installation in the IVR activity table. Note: Depending on the type of IVR your company uses, an entry in this field may not be necessary. Use option ivr022 to define the VDN type to use when this field is blank. |
Numeric Pager Content | Determines what data the IVR sends to numeric pagers: Call Back Number, Incident Number, or both. |
Dispose Incident on Completion | Select this check box in order for SBN to dispose of alarm incidents after completing the IVR call flow. |
Create Comm Log on Completion | Select this check box in order for SBN to create an entry in the Communication Log (program #1888) after completing the IVR Call Flow. |
Comm. Code | Select a communication code that SBN uses for entries it creates in the Communication Log (program #1888) when the Create Comm Log on Completion check box is selected. (This menu originates from program #1517.) |
Key 1 | Select a Key 1 code that SBN uses for entries it creates in the Communication Log (program #1888) when the Create Comm Log on Completion check box is selected. (This menu originates from program #1519.) |
Send to Department | Select a department that SBN enters in the Send To Department field of entries it creates in the Communication Log (program #1888) when the Create Comm Log on Completion check box is selected. |
Temp Note Pause | Select this check box to make the IVR pause after the Initial Pass and after calling the premises if there is active Temporary Text for the installation in the Texts tab of program #559. |
Actplan Note Pause | Select this check box to make the IVR pause after the Initial Pass and after calling the premises if there is text entered in the Text field of the Action Plans tab of program #559 for the action plan the IVR is processing. |
MSGID Note Pause | Select this check box to make the IVR pause after the Initial Pass and after calling the premises if there is an entry in the Msg ID field of the Action Plans tab of program #559 for the action plan the IVR is processing. |
Schedule Pushback | Number of minutes to push back the open/close schedule's expected closing time when the IVR Call Flow is complete if the alarm incident is unresolved. |
Template | Select this check box if this custom IVR setup can be used as a template. (This setup appears in the Template menu of this tab when this check box is selected.) |
Call Type | Select this check box if this custom IVR setup should appear in the Call Type menu of the IVR Call List window in Dispatch (program #537) and the Call Type menu of Zone Types (program #1733). |
Pause on Agency | Select this check box to make the IVR pause each time it gets to an agency in the action plan contact list. |
Schedule Fields | |
MTWThFSaSu | Three rows of check boxes with each day of the week. Select each day of the week that the IVR Call Flow is used. |
From | A field for each of the three rows of Day check boxes. Enter the beginning time of day when the IVR Call Flow is used on the selected days. |
To | A field for each of the three rows of Day check boxes. Enter the ending time of day when the IVR Call Flow is used on the selected days. |
Outside Schedule Direct Connect | If this box is not checked, calls are postponed until the next scheduled date/time. If this box is checked, calls are made outside of the schedule, but are not prompted with an automated message. Instead, the IVR directly connects the call to an available agent. |
Premise Override Dir Connect | If this box is checked, the IVR uses its automated message when calling the premise contact in the action plan contact list rather than directly connecting the call to an agent. |
Delays Override | Select this check box to make the IVR use the delay settings defined for the installation rather than the delay settings defined for the selected IVR processing template. |
Schedule Push Override | Select this check box to make the IVR use the Schedule Pushback defined for the installation rather than the Schedule Pushback defined for the selected IVR processing template. |
Completion Override | Select this check box to make the IVR use the completion settings defined for the installation (in the Dispose Incident on Completion and Create Comm Log on Completion check boxes) rather than the completion settings defined for the selected IVR processing template. |
Schedule Adherence Buttons | |
Customer Time | Select this radio button if the IVR should only call during scheduled times according to the customer's time zone. |
Time Zone | Select this radio button if the IVR should only call during scheduled times according to the selected time zone. |
Both | Select this radio button to first apply the schedule to the selected time zone, and then to the customer's time zone. |
Time Zone Selection (No label) | This field appears when you select the Time Zone or Both radio button and allows you to select a time zone. |
IVR Algen Process
Once you have determined which alarms the IVR should automatically respond to in Branch Profiles (program #1530), Dealer Profiles (program #1537), and Zone Types (program #1733), and determined how the IVR responds to alarms in the IVR tab of Data Entry (program #559), you can begin processing alarms using the IVR.
Note: You cannot send IVR messages to any of the verification numbers to the premise. Any attempt to do so will open an error message window.
The SBN Alarm Generator (Algen) routes alarms for automatic IVR processing according to the rules below:
1. Upon receiving an alarm signal, Algen checks if IVR Auto Insert is active for the current zone type in program #1733. If no, it continues with standard processing. If yes, it goes to step 2.
2. Algen checks whether the current installation is already present in the ivr_activity table. If it already exists, Algen continues with standard processing. If not, it goes to step 3.
3. Algen checks the following generic conditions:
- If the incident number attached to the current signal is 0, Algen stops processing the alarm. (Signals with incident number 0, such as Log Only events, are not true incidents.)
- If the installation is currently in Test mode, Algen stops processing the alarm.
- Current installation and CID monitoring statuses must both be in a Monitored status. If not, Algen stops processing.
4. Algen checks if the following points are valid. If any are false, it stops processing the alarm. If all conditions are true, it goes to step 5.
- Current Alarm Queue number is allowed (in program #1733).
- Initial Date Threshold is outside the range entered in program #1733.
- Signal received within Max Time from start of incident (defined in program #1733).
- IVR_Rest Bypass field in program #1733 is respected according to setting.
- If a signal is received alone, confirm that the Lone Trigger check box is selected in program #1733.
- Branch or dealer does not appear in the Branch or Dealer tab of program #1733.
- Alarms on zones received before the current zone alarm match the allowed zone types and sub types in the Sub Types tab of program #1733.
5. If all conditions are true, then the Algen starts the IVR process, with the appropriate settings; (call type settings, installation's override settings, etc.).
IVR Processing on Alarms Moved Between Alarm Queues
When the IVR is processing an alarm incident that is moved to another alarm queue using Clear Queues (program #567), the ivr_alarmqueue_info stored procedure:
1. Looks up the alarm in the ma_alarmlogsum table to determine in which alarm queue the alarm incident is located
2. Validates that the alarm is indeed in that alarm queue
- If it is, IVR processing continues as normal
- If it is not, the procedure cycles through the alarm queue tables to find the correct alarm queue in which the alarm is located, and then the IVR processes the alarm when it is located
Starting IVR in Dispatch
Users may start manual IVR processing on alarms in Dispatch (program #537) using the Start/Pause IVR button. Users may also pause IVR processing on an alarm using this button.
The Dispatch window contains a field that displays whether the installation has an IVR setup configured in the IVR tab of program #559. If the None radio button is selected in the IVR tab, this field displays "No IVR Config". If an IVR setup is configured in the IVR tab, this field displays "IVR Ready" as shown in the graphic below. If you attempt to start the IVR on an installation with no IVR configuration, SBN displays the error message "No IVR configuration found."
After you take an alarm in Dispatch, to start IVR processing choose the Start/Pause IVR button. (Outlined in red in the graphic below.)
/am_ivr_dispatch.jpg)
When you select the Start/Pause IVR button for an installation with an IVR setup configured in the IVR tab, the IVR Call List window opens. Make changes to open fields in the IVR Call List window as necessary and press the Update button to submit the changes. Press the Start button to allow the IVR to begin processing the alarm.
Note: if the same IVR call is scheduled more than once, the IVR will pull its information from the exact scheduled alarm time slot.
The following graphic displays the IVR Call List window.
/am_ivr_dispatch_ivr_call_list.jpg)
Field Descriptions - IVR Call List
The following table describes the fields in the IVR Call List window.
Field | Description |
Action Plan Used | Select the action plan you want the IVR to use for the alarm. |
Incident # on Premise? | Select Yes or No to determine whether the IVR includes the incident number in the voice message played for the Premise Phone Number. |
Call Type | Select the IVR Call Flow settings to use for the alarm. This drop-down menu includes:
|
Next Contact/Phone/Time | Displays the next contact and phone number the IVR will call, and the time that the call is scheduled. |
Temporary Notes (1) | Temporary text entered for the action plan in the Texts tab of program #559. |
From (1) | Date on which the text in the Temporary Notes (1) field becomes effective. |
To (1) | Date on which the text in the Temporary Notes (1) field expires. |
Temporary Notes (2) | Temporary text entered for the action plan in the Texts tab of program #559. |
From (2) | Date on which the text in the Temporary Notes (2) field becomes effective. |
To (2) | Date on which the text in the Temporary Notes (2) field expires. |
Temporary Notes (3) | Temporary text entered for the action plan in the Texts tab of program #559. |
From (3) | Date on which the text in the Temporary Notes (3) field becomes effective. |
To (3) | Date on which the text in the Temporary Notes (3) field expires. |
Last 24h Incident Summary | Displays details of incidents on the installation in the last 24 hours. |
Current Plan Gap | Indicates action plan contacts the IVR did not call. |
Contact Additional Information | Comment text entered for each contact on the action plan. (This information comes from the Contact Details window of the Action Plans tab in program #559.) |
Action Plan's Texts | Regular (not temporary) text entered for the action plan in the Texts tab of program #559. |
Action Plan's MSG_ID Text | Standard Message ID text attached to the action plan in the Texts tab of program #559. |
Action Plan's Redirection Schedule | Indicates days and times that a permanent substitute action plan is in place. (This information comes from the Action Plans tab in program #559.) |
Excluded Phones | Indicates which contact phone numbers will be excluded from the call flow. |
Alarm Queue Tab
When option mo202 is on, a Toggle IVR button and field appear in the Alarm Queue tab of Data Entry (program #559).
The Toggle IVR button allows you to toggle between hiding and displaying alarms that the IVR is processing; (these alarms are assigned to the IVR terminal). The Toggle IVR field indicates whether the Alarm Queue displays signals that the IVR is processing. When IVR Toggle is on, no IVR signals appear in the queue. When IVR Toggle is off, IVR signals are displayed.
Note: When a terminal is type I in the Terminals program (#1861), SBN considers it an IVR terminal in the Alarm Queue.
The following graphic displays the Alarm Queue tab with the Toggle IVR button and field outlined in red.
/am_ivr_alarm_queue.jpg)
Alarm Log Tab
There is a Cancel IVR button in the Alarm Log tab of program #559. This button allows you to cancel IVR processing on an alarm and puts it into the Alarm Queue with no terminal assigned so that an operator can take it.
The following graphic displays the Alarm Log tab with the Cancel IVR button outlined in red.
/am_ivr_alarm_log.jpg)
Terminals (Program #1861)
Use program #1861 to define and maintain skills that you can attach to monitoring terminals for routing signals in Dispatch (program #537). You can define specific functionality, such as IVR, for specific terminals.
SBN routes alarms on zone types that are set up to be automatically processed by the IVR to the IVR terminal.
The IVR terminal should be set to Type I in the field in the graphic below that is outlined in red. (SBN considers Type I terminals IVR terminals in the Alarm Queue when you toggle between including IVR alarms and not including IVR alarms in the queue.)
/am_ivr_terminals.jpg)
IVR Queue Manager (Program #1676)
Within this program, the user is able to view alarms by an Incident or an Alarm Type that is in the IVR Queue. You are also able to see that the queue is running. The ability for user to double click on incident number and be taken to that particular installation has also been added.
/sr43157_newrefreshbutton.png)
Field Descriptions - Incidents Tab
The following table describes the top fields in the IVR Call List window.
Field | Description |
Incident | An alarm incident number, |
Type | Type of alarm. |
Select All | Selects whole field. |
Dealer | Abbreviation that identifies the dealer. |
The following table describes the bottom fields under the "Incidents" tab in the IVR Call List window.
Field | Description |
Incident # | System generated alarm number associated with particular alarm signal. |
Priority | Priority of the zone from which the signal was generated. |
Delete | Delete an individual entree within that given field. |
Zone Type | Unique identifier. |
Name | Full name of the contact person on this account. |
Create Time | Taken from the alarm log when the Start IVR button is selected. |
Duration | Running time of the incident in the IVR. |
Date | The date of the incident. |
Time | The time of the incident. |
Mon Br | Taken from the installation of the incident selected for the IVR queue, but if none is used, this column will be left blank. |
Queue | Contains the queue that the incident is in when inserted into the IVR Queue Manager. |
Status | Shows whether or not the incident is A=active in the IVR or P=paused in the IVR queue. |
Installation Name | Name of the installation. |
Next Call | Displays the date of the Next Call to be performed. |
Deleting an Incident on the Incidents Tab.
Added event extension when deleting an incident from the IVR Queue. Now what is selected and written in the comment field is noted in the alarm log. (Below)
Alarm log (#559)
User can view the Event Extension within the Alarm log (Below).
Field Descriptions - Scheduling Tab
/sr43156_scheduletab.png)
The following table describes the top fields in the IVR Call List window.
Field | Description |
Service Ticket # | System generated number of the service request. |
Work Type | The scheduled types of work for a specific installations. |
Dealer | Abbreviation that identifies the dealer. |
The following table describes the bottom fields under the "Scheduling" tab in the IVR Call List window.
Field | Description |
Installation # | Installation number for the account. |
Request # | Computer generated number that identifies each request. |
Start Date | Start date taken from the IVR details from when an IVR Call Flow began. |
End Date | End date taken from the IVR details from when an IVR Call Flow ended. |
Delete | Delete an individual entree within that given field. |
Field Descriptions - Agents Tab
/sr43156_agentstab.png)
The following table describes the top fields in the IVR Call List window.
Field | Description |
Incident | An alarm incident number, |
Dealer | Abbreviation that identifies the dealer. |
The following table describes the bottom fields under the "Agents" tab in the IVR Call List window.
Field | Description |
Incident # | SBN-generated incident number for the alarm. |
Agent Id | ID of operator who handled the signal. |
Event | System-assigned event number. |
Name | Full name of the contact person on this account. |
Delete | Delete an individual entree within that given field. |
Button Functions
The following table displays the buttons, describes the shortcut keys, actions, and functionality.
Button | Name | Shortcut Key | Action | Description |
| Search | F5 | 1676 / 1 | Display search results. |
| Delete | Shift + F10 | 1676 / 6 | Delete selected batch. |
| Start/Pause | N/A | 1676 / 7 | Open the IVR Call List window and start or pause IVR processing on the selected alarm event |
| Refresh | F11 | N/A | Update the IVR with new or changed information. |
Related Programs
The following table lists programs related to the IVR.
Program | Number | Document Link | Description |
Dispatch | 537 | View and treat incoming alarms. Users may start IVR processing on alarms in Dispatch using the Start/Pause IVR button. | |
Data Entry Master and Basics | 559 | Enter customer contact and monitoring information about alarm system installations. Access the IVR tab from this program. | |
Zone Types | 1733 | Define and maintain zone types and specify information on alarm processing for each type. This program contains several fields that determine which zone types the IVR responds to. | |
Branch Profiles | 1530 | Define and maintain branches. Select particular check boxes for each branch you want a signal type processed on. | |
Dealer Profiles | 1537 | Define and maintain dealers. Select particular check boxes for each dealer you want a signal type processed on. | |
Alarm Queue Tab | N/A | View all alarms that are currently unresolved and determine which ones to treat. The Toggle IVR button in this tab allows you to toggle between hiding and displaying alarms that the IVR is processing. | |
Alarm Log Tab | N/A | View recorded incidents for the selected installation. The Cancel IVR button in this tab allows you to cancel IVR processing on an alarm. | |
Terminals | 1861 | Define and maintain skills that you can attach to terminals for the routing of signals in Dispatch. Set up an IVR terminal in this program. |
Modifications and Updates to IVR
The following table lists modifications and updates to the IVR document.
Mod Number | Date | Description |
n/a | 09/07/12 | document created. |
07.02.22039, 08.03.08899 | 09/20/12 | Added Default VDN Type field to IVR tab of program #559. Added options ivr022-ivr025. |
07.79.22919, 07.79.22920 | 11/20/13 | Added section for IVR processing on alarms moved between alarm queues |
08.80.09543 | 03/31/14 | Added 14 fields and action 559/802 to IVR tab of program #559 |
08.80.09526, 07.80.23168, 08.80.09525, 07.80.23161 | 04/09/14 | Added Scheduling to the list of IVR-enabled programs. |
n/a | 07/23/14 | Images updated. |
07.81.23618, 07.81.23617 | 10/09/14 | Added notes about exact contact number counts, leaving messages at verification numbers, and scheduling more than one IVR call. |
n/a | 03/10/15 | Added note that only one IVR may run per incident. |
07.82.23980, 07.82.23973, 07.82.23897, 07.82.23727, 08.82.10051, 08.82.09993, 08.82.09869 | 08/04/17 | Originally developed in R82, IVR Queue Manager (#1676) was created for user to be able to view alarms by Incident or Alarm Type that is in the IVR Queue. You are also able to see that the queue is running. |
N/a | 08/29/17 | Updated Pictures. |
07.87.25464, 07.87.25462, 08.87.11123, 08.87.11122 | 08/29/17 | Added additional fields to program #1676 (IVR Queue Manager) – Dealer ID, Duration, Create Time, Incident date, Incident time, Monitoring Branch, Queue, and IVR Status. |
n/a | 08/30/17 | Updated Pictures to reflect new Refresh button as well as Event Extension when an Incident is deleted. |
08.87.11124, 08.87.11116, 07.87.25457, 08.87.11073 | 08/30/17 | Added Event Extension when deleting an incident from the IVR Queue. Now what is selected and written in the comment field is noted in the alarm log. Also added Refresh button on Incidents page. |
n/a | 11/20/17 | Images updated. |
07.92.26431, 08.92.11848, 08.92.11854, 08.92.11855, 08.92.11856, 07.92.26432, 07.92.26433, 07.92.26434 | 07/31/20 | New Opt-Out radio button added within the field of the IVR screen. Image updated. |
08.92.11919, 07.92.26538, 07.92.26539 | 12/08/20 | New column "Installation Name" added within IVR Queue Manager (#1676). |
/sr43157_alarmlog_cancelledincident.png)
/search.png)

/start.png)
