IQgateway Selective Router

IQgateway Selective RouterRelease 6.0

User Guide

October 2008

© 2008 SolaCom Technologies Inc. All rights reserved.

The information furnished in this document by SolaCom Technologies Inc. ("SolaCom") is believed to be accurate. SolaCom makes no warranties, expressed or implied, regarding the information contained herein, and assumes no liability for errors or omissions.

SolaCom assumes no liability otherwise arising from the application or use of any such information or product for any infringement of patents or other intellectual property rights owned by others that may result from such application or use.

Neither the supply of this information or the purchase of product conveys any license, either expressed or implied, under patents or other intellectual property rights owned by SolaCom or licensed from third parties by SolaCom, whatsoever.

Purchasers of product are also hereby notified that the use of this information or product in certain ways or in combination with SolaCom or non-SolaCom furnished goods or services may infringe patents or other intellectual property rights.

This document and related products contain valuable trade secrets and proprietary information belonging to SolaCom. No part of this document may be reproduced, stored in a retrieval system, or transmitted in any form or by any means without prior written permission from SolaCom. Reverse engineering, decompiling and disassembling are explicitly prohibited.

The product specifications and information contained in this document are subject to change by SolaCom without notice.

B2214180-1 SR1

SolaCom Services Team

Our Customer System Support & Services Centre is staffed by qualified SolaCom service professionals. We provide the support, service, and know-how you need to seamlessly operate and manage your mission-critical communications infrastructure.

Our support team is available to: • answer queries and provide information • help diagnose and troubleshoot incidents • dispatch qualified personnel for field support, including:

training, installation, configuration, QoS audits, personalized requirements, and more.

We offer a complete range of services to support you and your system.

You may request support online or by phone: • Web: services.solacom.com • Email: [email protected] • North America toll free: 1-888-SolaCom (1-888-765-2266) • Phone anywhere: +1 613 693 0641

Our normal business hours are Monday to Friday from 09:00 to 17:00 ET.

For emergency or urgent requests, 7 days per week, 24 hours per day, use the phone numbers above and follow the voice prompts.

i

http://services.solacom.com/

mailto:[email protected]

Safety Summary

The following general safety precautions must be observed during all phases of operation, service and repair of this product. Failure to comply with these precautions or with specific warnings elsewhere in this manual violates safety standards of design, manufacture and intended use of the product. SolaCom assumes no liability for the customer’s failure to comply with these requirements.

Ground the equipment

To minimize shock hazard, the equipment switch must be connected to an electrical ground. The equipment has a three-conductor AC power cable. This power cable must be plugged into an approved three-contact electrical outlet with the grounding wire (green) firmly connected to an electrical ground at the power outlet. The power cables meet International Electrotechnical Commission (IEC) safety standards.

Keep away from live circuits

Operating personnel must not remove modules or otherwise tamper with the equipment switch or related components. Component replacement and internal adjustments must be made by qualified maintenance personnel. Do not replace components with the power cable connected. To avoid injuries, always disconnect power and discharge circuits before removing equipment shelves or making major modifications.

iii

iv

Do not service or adjust alone

Do not attempt major component replacement, internal service or adjustment unless another person, capable of rendering first aid and resuscitation, is present.

Replacement of modules

Replacement of modules should be performed by qualified maintenance personnel. (Those who have been trained and certified by SolaCom.)

Electrostatic discharge (ESD)

This product contains components that can be damaged by electrostatic discharge. You must take precautions when handling modules. As a minimum precaution, use grounded wrist straps at all times when handling modules.

Do not modify the product

Do not install substitute parts or modify the product. Contact an authorized Sales and Service Office for service and repair to ensure that product integrity is maintained:

SolaCom Technologies Inc. 80 Jean-Proulx Gatineau, QC J8Z 1W1 Canada

Tel: 613-693-0641 Fax: 613-693-0642

Power surge advisory

Electrical surges (typically lightning transients) are very destructive to customer terminal equipment connected to AC power sources. We recommend that the customer install an AC surge arrestor in the AC outlet to which the equipment is connected.

Contents

1 About This Document .................................................................................................. 11 1.1 References ................................................................................................................ 11

2 Introduction .................................................................................................................. 13 2.1 Call Handling ........................................................................................................... 14 2.2 System Components ................................................................................................. 14 2.3 Overview .................................................................................................................. 15

3 Initial SR Configuration .............................................................................................. 17 3.1 Using the CLI ........................................................................................................... 17 3.2 Using IQadmin ......................................................................................................... 18 3.3 Configuring EdgeIQ................................................................................................. 19

3.3.1 Configuring Bladeware ...................................................................................... 20 3.3.2 Configuring Spans.............................................................................................. 20 3.3.3 Configuring Trunk Groups ................................................................................. 20 3.3.4 Configuring Route Sets ...................................................................................... 21

3.4 Configuring Partitioning .......................................................................................... 21 3.4.1 Selective Router Partitioning Options ................................................................ 23

3.5 Configuring DNIS Translation................................................................................. 26 3.5.1 Early Supervision and Early Audio States ......................................................... 32 3.5.2 Filter and Prefix Examples ................................................................................. 32

3.6 Configuring ANI Translation ................................................................................... 33 3.6.1 ANI Translation.................................................................................................. 34

v

vi

3.6.2 Filter and Prefix Examples..................................................................................36 3.7 Configuring ESNs.....................................................................................................37 3.8 Configuring the TN-ESN table .................................................................................39 3.9 Configuring Fixed Transfer Codes ...........................................................................41 3.10 Configuring VPC ....................................................................................................44

A TN-ESN Provisioning ...................................................................................................47 Customer Assistance.......................................................................................................47 Overview of Provisioning Interface................................................................................47 File Naming and Formats ...............................................................................................48

Input Files (.XTES, .TES, and .BTES) ........................................................................48 Output File (.RTES).....................................................................................................49

Provisioning Process.......................................................................................................49

B List of Acronyms...........................................................................................................51

Index .......................................................................................................................................53

Figures

Figure 1: Basic Routing Capabilities ...................................................................................... 13 Figure 2: CLI .......................................................................................................................... 18 Figure 3: EdgeIQ .................................................................................................................... 19 Figure 4: Partitioning .............................................................................................................. 22 Figure 5: Call Processing ........................................................................................................ 23 Figure 6: DNIS Translation .................................................................................................... 27 Figure 7: ANI Translation Group ........................................................................................... 33 Figure 8: ANI Translation....................................................................................................... 34 Figure 9: ESN ......................................................................................................................... 37 Figure 10: TN-ESN................................................................................................................. 40 Figure 11: Fixed Transfer Code Group................................................................................... 42 Figure 12: VPC ....................................................................................................................... 44 Figure 13: TN-ESN Update Process ....................................................................................... 50

vii

ix

Tables

Table 1: Partitioning Field Descriptions ................................................................................. 23 Table 2: Partitioning Options Field Descriptions ................................................................... 26 Table 3: Early Supervision and Early Audio .......................................................................... 32 Table 4: Filter and Prefix DNIS Examples ............................................................................. 32 Table 5: ANI Translation Group Field Descriptions .............................................................. 33 Table 6: ANI Translation Field Descriptions.......................................................................... 36 Table 7: Filter and Prefix ANI Examples ............................................................................... 36 Table 8: ESN Field Descriptions ............................................................................................ 38 Table 9: List of Acronyms ...................................................................................................... 52

IQgateway SR User Guide

11

1 About This Document

This document describes the IQgateway SR (Selective Router), its components, and initial configuration. This document is of interest to you if you are involved in installing, configuring, or maintaining components of an IQgateway SR system, or if you are a customer or a third party system integrator interfacing to a SolaCom IQgateway TN-ESN database.

1.1 References

Appendix A contains details that a third party system integrator may need to interface to a SolaCom IQgateway SR TN-ESN database.

Some common industry acronyms are used throughout this document. For reference, Appendix B contains a list of the acronyms used and their expanded form.

The following documents may be used in conjunction with this guide: • IQadmin User Guide • EdgeIQ Configuration Guide • EdgeIQ Configuration Reference • System Configuration Manual

Documentation for third party components is included with the system.


2 Introduction

The IQgateway Selective Router (SR) bridges the gap between conventional PSTN and VoIP networks. It enables accurate 9-1-1 call routing regardless of the originating call format.

Figure 1: Basic Routing Capabilities

Basic features include: • Selective routing – Based on an association made in the TN-ESN table, the

9-1-1 call is routed to the correct primary PSAP. The TN-ESN table can be updated manually or automatically.

• Alternate routing – In the event that the primary PSAP is not accessible, the 9-1-1 call can be routed to alternate locations.

13

Introduction

• Default routing – If a 9-1-1 call cannot be associated with a specific PSAP, it can be routed to a default location.

• Abandoned call routing – If a 9-1-1 call is abandoned before it is answered at the PSAP, the ANI of the caller is still routed, and hence is available to the operator for call back.

• VoIP I2 call handling – ESQK queries are performed to route VoIP 9-1-1 calls.

2.1 Call Handling

Whenever there is a incoming call, it is handled by IQgateway SR as follows: 1 A call is received and is identified as a 9-1-1. The following information can

be used to identify the call to be a 9-1-1 call: • the dialed number • the originating IP address • the physical channel on which the call is received

2 A dip to the VPC can be performed using the ANI of the call. The following information can be used to decide if a dip is required: • the dialed number • the originating IP address • the physical channel on which the call is received

3 The response contains a new ANI called a pseudo ANI (PANI)/ESQK along with an ESRN (emergency service routing number).

4 The ESRN is used to route the call or to dip the ESN database. • When the ESRN is used to route the call, the outbound call can be sent

with the ANI (callback number), the PANI/ESQK (location of the caller) and the ESRN as the new dialed number, in which case the ESRN is the directory number of the targeted PSAP.

• When an ESN dip is performed, the ESN is use to identify the Primary PSAP. The Primary PSAP DN is used to route the call. The outbound call can be sent with the ANI (callback number), the PANI/ESQK (location of the caller) and the Primary PSAP DN.

2.2 System Components

The IQgateway system contains the following components: • Application server running VSOS, IQscript, and IQgateway Selective Router

software • Administration server running IQadmin and related software • T1/E1 interface kit

14


• VoIP interface kit • KVM interface kit

Note: See the System Configuration Manual for a detailed parts breakdown and possible system specific variations.

2.3 Overview

IQgateway SR is set up and configured before shipping. However, a number of tasks need to be performed to verify the initial setup and complete the installation. The following lists are an overview of the installation, initial configuration, and verification steps.

To perform the installation… 1 Verify that the site is prepared adequately for installation:

• Floor or desk space for placement of the cabinet (~200 pounds) requires front and back clearance of 24 inches)

• One standard AC outlet protected by a UPS • RJ45 cable for Internet access and RJ48 cables for T1/E1 access

2 Check the System Configuration Manual to verify that all physical components have been included in the shipment: • See “Equipment List (BOM)” to verify part numbers and quantities • See “Cable Connections” to confirm existing (pre-installed) cable

connections (power, T1/E1, Ethernet, KVM, serial connections) 3 Run cables from IQgateway to external facilities:

• External Ethernet switch to the Internet (RJ4 cable) • T1/E1 patch panes to the PSTN (TR48 cables)

4 Turn on the power to IQgateway and verify the LEDs: • Ethernet LEDs are green • Ethernet activity LEDs are flashing • Active (OK) T1/E1 span LEDs are green • Inactive and disabled T1/E1 span LEDs are red • T1/E1 spans for which the far end does not detect a signal are yellow • Status LEDs are green • Blue Hot Swap LEDs are off

The initial selective router configuration steps are listed below and described in detail in Section 3.

15

Introduction

16

To perform the initial configuration… 5 Use either IQadmin or the CLI to configure bladeware, spans, and trunk

groups: • Configure bladeware • Configure T1 or E1 and VoIP spans • Create incoming trunk groups • Create outgoing trunk groups • Configure route sets

6 Use IQadmin to configure: • Partitioning • DNIS Translation (routing tables) • ANI Translation • ESNs • TN-ESN tables • Fixed Transfer Code Groups • VPC Configuration (if required)

Once the initial configuration is complete, you should perform the following verification steps using IQadmin. Refer to the IQadmin User Guide for details.

To perform the verification… 7 Use IQadmin (System Monitoring/Physical View) to verify T1/E1 and VoIP

channels: • Indicators for the used T1/E1 spans are enabled (green) • Indicators for T1/E1 channels are enabled (green) • Indicators for the VoIP span is enabled (green) • Indicators for VoIP channels are enabled (green)

8 Perform test calls.


3 Initial SR Configuration

This section describes the initial configuration steps required to get IQgateway SR working in your environment.

3.1 Using the CLI

The CLI (command line interface) can used to configure bladeware, spans, and trunk groups. It may be necessary to use the command line interface instead of IQadmin to configure bladeware, spans, and trunk groups. You should use the CLI if IQprobe is disabled on you system, or if you have a version of IQadmin prior to release 8.0. In either of these cases, IQadmin does not contain System Administration > EdgeIQ in the sidebar menu. If you see System Administration > EdgeIQ in the sidebar menu after launching IQadmin (see Section 3.2), skip to Section 3.3.

To start the CLI… • Double click the shortcut on the Desktop.

The path to the executable is either “C:\EdgeIQ\Applications\CLI.exe” or “C:\Versatel\Applications\CLI.exe”.

• Type q or Q to quit the CLI prompt.

17

Initial SR Configuration

Figure 2: CLI

For complete CLI instructions see the EdgeIQ Configuration Guide, the EdgeIQ Reference Guide, or use the CLI help feature: Type ? <command> to view the arguments associated with specific commands.

To continue with the initial SR configuration using the CLI, execute the commands listed in Section 3.3.

3.2 Using IQadmin

Depending on when the initial software installation occurred, IQadmin is installed by default in either of the following folders:

• “C:\Versatel\IQadmin” • “C:\EdgeIQ\IQadmin”

To launch IQadmin… • From the Start menu, click one of the following:

The IQadmin icon on the desktop (when available) All Programs > Versatel EdgeIQ > IQadmin > IQadmin. All Programs > SolaCom Technologies > IQadmin > IQadmin.

Refer to the IQadmin User Guide for basic IQadmin operation.

18


3.3 Configuring EdgeIQ

Edge IQ is used to configure bladeware, spans, and trunk groups.

To execute EdgeIQ commands… 1 From the sidebar menu, expand System Configuration and then click EdgeIQ. 2 Select a command from the list.

You can type any portion of a known command to scroll the list. 3 On the right side of the page, select or enter the values for the arguments of

the selected command. 4 Click Execute.

The EdgeIQ command output and a history of commands executed are displayed in the lower areas of the page.

Figure 3: EdgeIQ

Note: Disable bladeware, spans, trunk groups, and channels before manipulation, and enable them after manipulation. Use the following commands:

• EnableBWSpan

• EnableSpan

• EnableChannel

• DisableBWSpan

19


• DisableSpan

• DisableChannel

3.3.1 Configuring Bladeware

In this context, bladeware configuration provides an association between the signaling component of an IP voice call and the audio component.

To configure bladeware… • Use the following commands:

ConfigureVOIPBW to configure parameters for a given VoIP bladeware. Specifically to add the correct gateway IP address

CreateVOIPBWTrunkGroup to associate a VoIP trunk group with a particular VoIP bladeware.

ConfigureRTPSourceParameters to configure the default source (local) IP address and UDP port from which RTP and RTCP packets are sent over a VoIP clear channel

DisplayBW to display current bladeware settings DisplayBWSpan to display current bladeware span settings DisplayVOIPBW to display current VoIP bladeware settings

3.3.2 Configuring Spans

Span configuration assigns signaling characteristics to T1 or E1 and VoIP spans. The T1 or E1 card has 16 available spans with 24 or 32 channels per span. The VoIP card has one available span with 512 channels.

To configure T1 or E1 and VoIP spans… • Use the following commands:

DisplayCard to view information about the cards in your system DisplaySpan to view information about T1 or E1 spans DisplayVoIPSpan to view information about VoIP spans DisplayClock to display information about system clock synchronization

sources ConfigureSpan to configure T1 or E1 signaling characteristics ConfigureVoIPSpan to configure VoIP signaling characteristics

3.3.3 Configuring Trunk Groups

A trunk group is a group of channels with identical protocols.

20


To configure trunk groups… • Use the following commands:

DisplayTrunkGroup to view information about the trunk groups in your system

CreateXXXTrunkGroup where XXX is one of the following signaling types: ClearChannel, PRINFAS, PRI, SS7, VOIPBW, VOIPClearChannel) to create additional trunk groups

MoveSpanToTrunkGroup to move spans into a trunk group MoveChannelToTrunkGroup and MoveRangeOfChannelsToTrunkGroup to move channels into a trunk group

3.3.4 Configuring Route Sets

A route set is a set of trunk groups. It is required primarily so that bladeware can be configured properly. The incoming VoIP trunk group must be added to the route set.

To configure route sets… • Use the following commands:

DisplayBearerRouteSet to view route sets that are already configured ConfigureBearerRouteSet to create a new route set AddTrunkGroupToBearerRouteSet to add trunk groups to a route set RemoveTrunkGroupFromBearerRouteSet to remove trunk groups from

a route set

3.4 Configuring Partitioning

Partitioning tables are used to identify incoming 9-1-1 calls and process them appropriately.

To access the Partitioning table… • From the sidebar menu, expand System Configuration and then click

Partitioning.

21


Figure 4: Partitioning

Field Description

Index Each entry contains a unique index number, which is used by the system and cannot be modified.

Name The name of the partitioning rule.

Type The type of call source.

ani – the calling party number.

anidomain – the calling IP address.

dnis – the called party number.

channel – shelf.slot.span.channel

trunk – the trunk number or group of trunks.

Rule The parameter applied to the call.

Controller The application script used to process the call.

Controller Type The type of controller used to process the call.

22


23

Field Description

Options If Controller Type is set to selectiverouter, double clicking opens the Selective Router Partitioning Options dialog box.

Table 1: Partitioning Field Descriptions

3.4.1 Selective Router Partitioning Options

The Selective Router Partitioning Options dialog box opens when you double click on the Options entry in the Partitioning tale. Use this dialog box to set the partitioning options that are highlighted in the following flowchart:

Figure 5: Call Processing


Field Description

General Tab

Default ESN The fallback number that is used if a route is not set for the ESQK. To use this ESN, Force Default ESN must be checked.

Force VPC Specifies that Voice Positioning Center is used.

Force VPC ESRN Allows the script to bypass the SRDB if the VPC DIP is successful and provides a valid ESRN. If Force VPC is cleared, this setting is disabled and ignored.

Force Default ESN Specifies that the Default ESN is used for the incoming call.

Early Off Hook Specifies that the call is answered immediately.

Local Ringback Specifies that the call is answered immediately and a ringback is generated on the incoming leg. If Early Off Hook is cleared, this setting is disabled and ignored.

Hook Flash Transparency

Specifies that a hook flash is received from the outbound leg and forwarded to the inbound leg.

Abandon Call Treatment

Specifies how an incoming leg going on-hook is treated.

FORCED_ROUTING – the outgoing leg continues regardless of the status of the incoming leg or the validity of the ANI.

TANDEM – the outgoing leg is terminated.

E911 – a combination of the two other settings. If the ANI is known, FORCED_ROUTING is used, otherwise TANDEM is used and both legs are terminated.

Force SRDB Specifies that the selective routing database should be used. Clear this option to skip the TN-ESN process.

24


25

Field Description

ANI Tab

ANI Format Defines the format of the ANI, where “I” and “II” represent information digits. “I” is associated with an area code, and “II” provides additional information on the origin of the call (normal, prison, pay-phone, etc.).

II+10 digit – 12 digits expected.

I+10 digit – 11 digits expected.

10 digits – Exactly 10 digits (Default).

I+7 digits – 8 digits expected.

II+7 digits – 9 digits expected.

7 digits – Exactly 7 digits.

Any Number of Digits – the received ANI is treated as is regardless of the number of digits.

Override ANI If defined, the original call ANI is replaced with the new value.

Area codes 1 - 4 Associates up to four different area codes with single information digits.

Area code 1 – associated with digits 0 and 4.




Allow partial ANI Specifies whether to allow partial ANI.

No – if more than or less than the exact number of digits expected are received, the ANI is discarded and the call proceeds as if no ANI or information digits were received.

Yes – if more than the number of digits expected are received, the leading digits are ignored and the ANI is flagged as partial. If fewer digits are received, the missing digits are considered to be 0’s. For example, if the digits 196131234 are received and the ANI format is I+10 digits, the received digits are assumed to be 00196131234, and the ANI is flagged as partial.


26

Field Description

Allow test calls Specifies whether to allow test calls.

No – none of the incoming calls can be considered to be a test call.

Yes – when the test digits match the designated digits based on the ANI format, the call is considered to be a test call. The call is not routed, and when answered, a busy tone is connected until the built-in test call timer expires.

Test digits The digits that determine that the call is a test call. If Allow Test Calls is set to No, this setting is ignored.

DNIS is PANI Specifies whether a PANI is present in the DNIS field, which is the case for a wireless call.

Table 2: Partitioning Options Field Descriptions

3.5 Configuring DNIS Translation

The DNIS (dialed number identification service) translation table is used to route calls to their destination using predefined resources such as route sets, trunk groups, and channels.

Entries are processed in the order that they appear in the table. The default entry is a “catch-all” to route all calls to a default destination. Specific entries could be added above the default to route to specific locations. Typically, one specific entry would be added per ESRN.

To access the DNIS Translation table… • From the sidebar menu, expand System Configuration and then click DNIS

Translation.


27

Figure 6: DNIS Translation

Field Description

Index Each entry contains a unique index number, which is used by the system and cannot be modified.

Name The name of the route. You can use any printable character except square brackets [ ] and spaces.

To prevent the routing algorithm from using a routing table entry, precede the name with a semicolon (;).

The Else list box allows you to define the response to the incoming leg when an attempt to access an outgoing leg fails.

Clicking on the Edit Text button launches the Tandem_RoutingTranslation.txt. This can be used as a scratch pad for adding


28

Field Description

DNIS Allows calls to be routed based on the leading digits of the called party number (DNIS). Use {digit} to specify an optional digit, {digit1,digit2} to specify a list of optional digits, and {digit1-digit2} to specify a range of optional digits.

Example: When entering {1}819777{1,2}00 the following DNIS will trigger the route:

1 819 777 1000 to 1 819 777 1009 1819 777 2000 to 1 819 777 2009 1 819 777 0000 to 1 819 777 0099 819 777 1000 to 819 777 1009 819 777 2000 to 819 777 2009 819 777 0000 to 819 777 0099

Note that if you use a single pair of brackets alone in a rule, e.g. {1}, {123}, {1-9}, it is interpreted as a catch all, and is therefore often applied as a final "else" rule to match anything else.

Priority Controls the order of entries with the same leading digits. When multiple routes are available for a given called party number, a priority must be set to identify the order in which the routes are accessed. The lowest value priority is tried first.

A value of -1 indicates that there are no more alternate routes. If you have a list of alternate routes, it is recommended to end it with a priority of -1, for example, with four alternate routes, use 0, 1, 2, -1.

If you want to load share between multiple routes, specify multiple entries with the same leading digits and priority. The algorithm selects each route in a round-robin fashion.

Range: -1 to 99.

Retries Sets the number of re-attempts are made on the same route before trying the next route.

Route Type Used in combination with Route (see below).


29

Field Description

Route Specifies the bearer route, trunk group, or channel used to route all calls matching the DNIS field of the entry. To indicate a channel, enter 4 values in Shelf.Slot.Span.Channel format, for example 31.6.0.5. When no route is defined, a cause value can be provided to overwrite the default behaviour to be returned to the application. The cause value can be between 0 and 127.

The bearer route, trunk group, and channel must be defined on EdgeIQ using the CLI.

LRB Allows you to enable or disable a ringback tone on the incoming leg prior to completing the outgoing call leg.

Super Early Supervision Early Audio Description

Disable Disable Normal call processing.

Disable Enable Upon receiving a

Delivered Event or a Progress Event, a single Progress Call command is sent on the incoming leg.

Enable Disable Upon receiving an

Offered Event, a single Accept Call command is sent.

Enable Enable Upon receiving an

Offered Event, a single Progress Call command is sent.

(See Section 3.5.1)


30

Field Description

Audio Allows the caller to hear the call progress audible tones directly from the outbound leg (ringback, busy, fast busy, recordings, etc.). Early audio normally provides a more accurate status of the call progress for the caller. The incoming call’s VoIP equipment must be capable of allowing audio to flow back to the caller prior to receiving an answer signal from the far end (EdgeIQ). In SIP, this means that the caller’s SIP device must be capable of receiving a 183 (progress) message instead of a simple 180 (ringing) message.

This only applies to incoming IP calls and has no effect for incoming TDM calls. For IP calls, set to Enable.

(See Section 3.5.1)

Filter Allows you to modify the incoming called party number before forwarding it to the network. The contents of the Prefix string are used to alter the called party number.

Disable – The Prefix string is used to prefix the leading digits string.

Input – The Prefix string overwrites the leading digits string.

All – The Prefix string overwrites the entire input string including the leading digits.

-1 to -9 removes the specified number of digits from the input string (e.g. -1 changes 1819 to 819).

Prefix Used to modify the incoming called party number based on the Filter state.

Suffix Used to add a string to the end of the called party number. Suffixes are used for IP calls only, and allow different IP destinations for each route.


31

Field Description

Send ANI and ESQK

For 9-1-1 calls only, this field allows you to substitute the DNIS with the ESQK/PANI, thereby sending the ANI along with the ESQK/PANI to the far end. The PSAP receiving this call will use the ESQK/PANI to make a request to the ALI database, and use the ANI to call back the 9-1-1 called if required. Use with outbound 9-1-1 trunks that require two telephone numbers to be sent to the PSAP.

ALI – Automatic Location Information

ANI – The calling number

DNIS – Dialed Number Information Service

ESQK – Emergency Service Query Key

PANI – Pseudo ANI

PSAP – Public Safety Answering Point

ANI Translation Group

Used to make reference to a set of rules that allows you to manipulate (translate) the ANI for the outbound call.

Recorder Route Type

The recorder can be located on a route of its own. This field is used to specify the type of route through which the recorder can be accessed. Choices are No route (used if no recorder is defined), Bearer Route, Trunk group, or Channel.

Recorder Route Number

Used to specify the route number of routes through which the recorder can be accessed.

Recorder Gain Index

Used to specify the gain index for the audio destined for the recorder. Values rage from 0 to 47. Leave blank if there is no recorder. To find the gain in db refer to the CLI command DisplayGain -1.

Recorder Called Party Number

Used to specify the telephone number or IP address of the recorder. The system gains access to this destination and sends the appropriate audio for recording. Leave blank if the routing to the recorder is via clear channel.

Send Supplementary Info

Allows supplemental information to be sent along with the outbound call. This is only valid for SIP calls. It is ignored for other types of calls.


32

Field Description

Comment This field may contain any information you want to record.

3.5.1 Early Supervision and Early Audio States

The Super (Early Supervision) and Audio (Early Audio) settings can be combined to produce the following:

Super Audio Description

Disable Disable Normal call processing

Disable Enable Upon receiving a Delivered Event or a Progress Event, a single Progress Call command is sent on the incoming leg.

Enable Disable Upon receiving a Delivered Event or a Progress Event, a single Accept Call command is sent on the incoming leg.

Enable Enable Upon receiving a Delivered Event or a Progress Event, a single Progress Call command is sent on the incoming leg.

Table 3: Early Supervision and Early Audio

3.5.2 Filter and Prefix Examples

The following examples show what the output number would be given several combinations of Filter settings and Prefix digits, with a sample input number of 8197710011 and a DNIS of 819.

Filter Prefix Output Description

Disable 1 18197710011 The number is prefixed with a 1.

Input 613 6137710011 819 is overwritten with 613.

All 6135551212 6135551212 The entire number is overwritten.

-3 - 7710011 The first 3 digits are removed.

Table 4: Filter and Prefix DNIS Examples


3.6 Configuring ANI Translation

The ANI translation group table is used to define groups of specific ANI translation tables, which allow you to alter the outgoing calling party number.

To access the ANI Translation Group table… • From the sidebar menu, expand System Configuration and then click ANI

Translation Group.

Figure 7: ANI Translation Group

Field Description

ID Each entry contains a unique ID number, which is used by the system and cannot be modified.

Group Name The name of the ANI translation group. You can use characters a-z, A-Z, - , _ , spaces, and 0-9.

ANI Translation Accesses the ANI Translation page.

Table 5: ANI Translation Group Field Descriptions

33


3.6.1 ANI Translation

Double click on the ANI Translation field to access an ANI Translation table for a particular translation group entry.

Figure 8: ANI Translation

Field Description

Index Each entry contains a ID index number, which is used by the system and cannot be modified.

Name The name of the rule.

34


35

Field Description

ANI Allows translations to occur based on the leading digits of the calling party number (ANI). Use {digit} to specify an optional digit, {digit1,digit2 } to specify a list of optional digits, and {digit1-digit2} to specify a range of optional digits.

Example: When entering {1}819777{1,2}00 the following ANI will trigger the translation:

1 819 777 1000 to 1 819 777 1009 1 819 777 2000 to 1 819 777 2009 1 819 777 0000 to 1 819 777 0099 819 777 1000 to 819 777 1009 819 777 2000 to 819 777 2009 819 777 0000 to 819 777 0099

Note that if you use a single pair of brackets alone in a rule, e.g. {1}, {123}, {1-9}, it is interpreted as a catch all, and is therefore often applied as a final "else" rule to match anything else.

Filter Allows you to modify the outgoing calling party number before forwarding it to the network. The contents of the Prefix string are used to alter the calling party number.

Disable – the Prefix string is used to prefix the leading digits string.

Input – the Prefix string overwrites the leading digits string.

All – the Prefix string overwrites the entire input string including the leading digits.

-1 to -9 removes the specified number of digits from the input string (e.g. -1 changes 1819 to 819).

Prefix Used to modify the incoming calling party number based on the Filter state.

Suffix Used to add a string to the end of the calling party number. Suffixes are used for IP calls only, and allow different IP destinations for each route.


36

Field Description

Info Digits Specifies whether the ANI should be prefixed with one information digit (I), two information digits (II), or none. This field applies to CAS trunks/circuits, and needs to match the signaling protocol used on the outbound trunk/circuit. For other signaling protocols, it should be set to none.

None (default) – the field is not used.

I – the incoming call I information digit is prefixed to the ANI. If none was received, a 0 is prefixed.

II – the incoming call II information digits are prefixed to the ANI. If none was received, 00 are prefixed.

Allow Partial ANI Specifies whether to allow partial ANI.

Yes (default) – the ANI translations is applied to the partial ANI.

No – calls with an incoming ANI marked as partial are sent with no ANI (null string).

Comment This field may contain any information you want to record.

Table 6: ANI Translation Field Descriptions

3.6.2 Filter and Prefix Examples

The following examples show what the output number would be given several combinations of Filter settings and Prefix digits, with a sample input number of 8197710011 and an ANI of 819.

Filter Prefix Output Description

Disable 1 18197710011 The number is prefixed with a 1.

Input 613 6137710011 819 is overwritten with 613.

All 6135551212 6135551212 The entire number is overwritten.

-3 - 7710011 The first 3 digits are removed.

Table 7: Filter and Prefix ANI Examples


3.7 Configuring ESNs

This is where you configure IQgateway SR for 9-1-1 selective routing and selective transfer to the correct PSAP. When the emergency service routing number (ESRN) is not available, such as when VPC is not used, the ANI is used to perform a lookup in a local database and retrieve the corresponding ESN. The ESN is then used to determine the translation and route to send the call to its proper destination. The local database contains the TN-ESN associations.

To access the ESN table… • From the sidebar menu, expand Selective Router and then click ESN.

Figure 9: ESN

37


Field Description

ESN The emergency service number. Each ESN represents a unique combination of emergency service agencies (e.g. Law Enforcement, Fire, and Emergency Medical Service) designated to serve a specific range of addresses within a particular geographical area, or Emergency Service Zone (ESZ). The ESN facilitates selective routing and selective transfer, if required, to the appropriate PSAP, and the dispatching of the proper service agencies.

Maximum of 9 digits.

ESN Label A meaningful text label for the ESN.

Primary PSAP Label

A meaningful text label for the primary PSAP.

Primary PSAP TN The telephone number for the primary PSAP.

RNA (Ring No Answer)

The number of seconds the primary PSAP rings before being transferred to the secondary PSAP.

Selective Transfer Code

Opens the Selective Transfer Codes dialog box where you define the individual transfer agencies.

Fixed Transfer Code Group

Defines the fixed transfer code group associated with the ESN. Fixed transfer codes are used to call specific numbers. These groups are defined in the Fixed Transfer Code Group table (see Section 3.9).

Multiple Party Conference

Allows a hook flash to start the process of adding conference participants. When a supervised transfer is completed, a second hook flash returns a dial tone and mutes the audio to all but the originator of the hook flash. Up to 12 participants can then be added using any of the transfer methods.

Table 8: ESN Field Descriptions

You must add all your ESNs before configuring the TN-ESN table.

To add ESNs to the ESN table… 1 Click the Insert button. 2 In the Input dialog box, enter the number of an ESN.

38


You can use a maximum of 9 digits. 3 Click OK.

The primary PSAP is added to the ESN table. 4 If you need to edit any of the fields, double click on the text. 5 To associate selective transfer codes for the ESN, do the following:

• Double click on the Selective Transfer Code field.

• Enter the labels and telephone numbers for any secondary PSAPs. • Click Save. Note that if you have more that six transfer agencies, you must add the remaining codes as fixed, rather than selective, transfer codes. You must first create a fixed transfer code group (see Section 3.9) and then select that group in the Fixed Transfer Code Group field.

6 Repeat the above steps for other ESNs.

3.8 Configuring the TN-ESN table

Once the ESN table contains your primary ESN, you can configure the local TN-ESN (telephone number – emergency service number) table. Each TN-ESN entry is used to associate telephone numbers in an NPA and NXX range with a specific ESN.

To access the TN-ESN table… • From the sidebar menu, expand Selective Router and then click TN-ESN.

39


Figure 10: TN-ESN

Field Description

Telephone Number A 10-digit telephone number.

Emergency Service Number

An ESN defined in the ESN page.

You can add telephone numbers manually or do a bulk update by importing TN-ESN (.tes) files provided by a location database server.

To configure the TN-ESN table manually… 1 Click the Insert button. 2 Enter the NPA and NXX combination.

40


3 In the fields labelled XXXX, enter the 4-digit range of telephone numbers.

IQadmin creates a table entry for each number in the range. For example, if the First Telephone Number XXXX is 0000 and the Last Telephone Number XXXX is 0010, ten table entries are created.

4 Enter the emergency service number to associate with the telephone number range.

5 Click OK.

To perform bulk updates, location database server must be provisioned to provide the IQadmin computer with the appropriate files via sFTP (secure file transfer protocol). For more information see the TN-ESN provisioning details in Appendix A.

To configure the TN-ESN table using a bulk update… 1 Click the Import Settings button. 2 Enter the settings according to the following table and then click OK.

Setting Description Time interval between imports The number of minutes between

automated imports. Maximum result files stored The maximum number of post-processing

(backup and results) files that are stored, after which older files are deleted.

Path to import folder The path and folder that holds the .tes files.

3 To import the TN-ESN file immediately, click the Import button and then answer Yes to the prompt.

3.9 Configuring Fixed Transfer Codes

Each ESN can contain a maximum of 6 selective transfer codes. This table allows you to define groups of fixed transfer codes for an ESN.

41


To access the Fixed Transfer Code Group table… • From the sidebar menu, expand Selective Router and then click Fixed Transfer

Code Group.

Figure 11: Fixed Transfer Code Group

Field Description

Index Each entry contains a unique ID number, which is used by the system and cannot be modified.

Group Name The name of the fixed transfer code group. You can use characters a-z, A-Z, - , _ , spaces, and 0-9.

A maximum of 32 characters are allowed.

Fixed Transfer Code Accesses the Fixed Transfer Code page.

To create fixed transfer code groups… 1 Click the Insert button. 2 In the Input dialog box, enter a name for the fixed transfer code group.

42


3 Click OK.

The fixed transfer code group is added to the table. 4 Double click on the Fixed Transfer Code field. 5 In the Fixed Transfer Code table, click the Insert button. 6 In the Input dialog box, enter a name for the fixed transfer code.

The code must be an asterisk (*) followed by two digits.

7 Click OK. 8 Specify the type, telephone number, and label according to the following

table.

Setting Description

Type The action that the selective router takes when a fixed transfer is initiated.

Telephone Number – calls the number.

Call Back 911 caller – the ANI is used to call the 911 caller back.

Hold 911 Caller – the 911 caller is put hold.

Mute 911 Caller – the 911 call cannot be heard. Other conference parties continue to be able to speak and listen as before.

Set Privacy on 911 Caller – the 911 caller ceases to hear anything. Other conference parties continue to be able to speak and listen as before.

Release Last Leg – releases the last leg that was joined to the conference.

Except for Telephone Number, only one code of each type is permitted within a fixed transfer code group.

Telephone Number The telephone number for the transfer.

43


44

Setting Description

Label A label for the code. For example, “Fire”, “EMS”, etc.

9 Repeat steps 5 to 8 for any additional fixed transfer codes. 10 Click Back to Fixed Transfer Code Group to return to the previous page and

add more groups if needed.

3.10 Configuring VPC

The VPC dialog box allows you to configure the parameters for the VoIP Positioning Center. The following is a sample screen. The VPC provider should supply the proper values.

Figure 12: VPC

Field Description

username A username to access web services.

password A password to access web services.

uri Finds the destination Computer.


45

Field Description

proxy Finds the destination proxy (if used).

action The action to perform.

xmlns The instruction to use.


A TN-ESN Provisioning

The information in this appendix defines the set of actions and describe the corresponding files and procedures that a customer or a third party system integrator must implement to interface to a SolaCom IQgateway Selective Router solution internal TN-ESN database.

Customer Assistance

SolaCom will assist the customer’s or the third party system integrator’s team to ensure proper understanding of the API. Actions performed against the IQgateway Selective Router solution must be restricted to those described below.

Overview of Provisioning Interface

The LDS interfaces indirectly to the TN/ESN database using flat files. These comma delimited text files are uploaded to IQgateway SR IQadmin server using a secure protocol called Secure FTP (sFTP), which uses SSH as the underlying protocol for security and encryption). The sFTP service running on the IQadmin server points to a specific default folder when the LDS connects to upload/download files. The default folder is “C:\IQAdmin\TN_ESN_Updates”. IQgateway uses vShell from VanDyke Software (www.vandyke.com) to implement its sFTP service.

The first field in the file is a command followed by a TN and an ESN. The command instructs IQadmin to ADD or REMOVE records. Specific file extensions are used to denote a file being transferred, a file ready for processing, a file that has been processed, and a result file. The LDS is able to retrieve that result file to determine if any errors have occurred.

47

TN-ESN Provisioning

File Naming and Formats

Files uploaded by the LDS must follow the naming convention:

YYYYMMDDHHMMSS.XTES (X=transfer)

Once the file is transferred, it is renamed by the LDS to:

YYYYMMDDHHMMSS.TES

After processing by the IQadmin, the file is renamed to:

YYYYMMDDHHMMSS.BTES (B=BACKUP)

The corresponding result file, created by IQadmin, is named

YYYYMMDDHHMMSS.RTES (R=RESULT)

IQadmin does a cleanup of files with extensions BTES and RTES.

Input Files (.XTES, .TES, and .BTES)

The text file (DOS format) is comma delimited and has the following fields:

Field Description

Command Can be ADD or REMOVE. Note that ADD updates a record if it already exists.

TN A ten digit telephone number (can be truncated if using wildcard). Digits are {0..9,*}. * is used as a wildcard and can be used to specify a range. Any digit after * is ignored. * is expanded from 0 to 9 over the number of digits required to make a full 10 digit number. E.g. 819771001* represents 8197710010 to 8197710019 while 819771* represents 8197710000 to 8197719999.

ESN Normally a 4-digit number. Digits are {0..9}. The ESN must exist (must have been manually configured in IQgateway SR) for the command to be valid.

Records in a file are processed sequentially from top to bottom. If the same ten digit number is specified more than once in a file then the last action will prevail.

The maximum number of lines per file is 65536.

48


Output File (.RTES)

The result file includes the following information: • Beginning of processing • Completion of processing • Number of records processed • Number of errors • Error cause followed by input line for every line causing an error if any. Three

types of errors exist “Invalid Command”, “Invalid TN” and “Invalid ESN”.

The following shows the content on a file with 250 good records:

Content of file 20070330091400.RTES Beginning processing 30-Mar-2007 at 09:15:00 Processing complete 30-Mar-2007 at 09:15:45 250 entries processed successfully. 0 errors detected.

The following shows an example of a file that processed 249 good records and 1 invalid record:

Content of file 20070330091630.RTES Beginning processing 30-Mar-2007 at 09:17:00 Processing complete 30-Mar-2007 at 09:17:49 Invalid Command: AD,6132884663,1234 249 entries processed successfully. 1 errors detected.

Provisioning Process

The following diagram depicts the provisioning process:

49

TN-ESN Provisioning

Figure 13: TN-ESN Update Process

At the end of the process, the result file is ready for retrieval. The LDS can use the same sFTP protocol to retrieve the file.

50


B List of Acronyms

Acronym Expanded Form

ALI Automatic Location Information

ANI Automatic Number Identification

API Application Programming Interface

BOM Bill Of Materials

CAS Channel Associated Signaling

CDR Call Detail Record

CLI Command Line Interface

CTI Computer Telephony Integration

DN Dialed Number

DNIS Dialed Number Information Service

ESN Emergency Service Number

ESZ Emergency Service Zone

ESQK Emergency Service Query Key

ESRN Emergency Services Routing Number/Name

IP Internet Protocol

KVM Keyboard-Video-Mouse

LRB Local RingBack

LDS Location Database Server

NPA Numbering Plan Area

51

List of Acronyms

52

Acronym Expanded Form

PANI Pseudo Automatic Number Identification

PRI Primary Rate Interface

PSAP Public Safety Answering Point

PSTN Public Switched Telephone Network

RNA Ring No Answer

sFTP secure File Transfer Protocol

SIP Session Initiation Protocol

SR Selective Router

SSH Secure SHell

SRDB Selective Routing DataBase

TDM Time Division Multiplex

TN-ESN Telephone Number to Emergency Service Number

UPS Uninterruptible Power Supply

VoIP Voice over Internet Protocol

VPC VoIP Positioning Center

VSOS Versatel Switch Operating System

Table 9: List of Acronyms


Index

A

abandoned calls ........................................................................................................ 14, 24

administration server ...................................................................................................... 14

ANI

format .......................................................................................................................... 25

override........................................................................................................................ 25

partial..................................................................................................................... 25, 36

send with ESQK/PANI................................................................................................ 31

tab ................................................................................................................................ 25

translation .............................................................................................16, 31, 33, 34, 36

application server ........................................................................................................... 14

application servers.......................................................................................................... 14

audio..............................................................................................................20, 30, 31, 38

B

bladeware ................................................................................................16, 17, 19, 20, 21

bulk TN-ESN updates .............................................................................................. 40, 41

C

call

handling ....................................................................................................................... 14

processing.................................................................................................................... 23

53

Index

channels .................................................................................................. 14, 20, 22, 29, 31

CLI............................................................................................................................ 17, 51

command line interface............................................................................................. 17, 51

components ..................................................................................................................... 14

conference................................................................................................................. 38, 43

configuration................................................................................................. 11, 15, 16, 17

customer service ................................................................................................................ i

D

database server.................................................................................................... 40, 41, 51

DNIS translation ................................................................................................. 16, 26, 27

E

E1.................................................................................................................. 14, 15, 16, 20

EdgeIQ.............................................................................................. 11, 17, 18, 19, 29, 30

ESN

configuring...................................................................................................................37

default ..........................................................................................................................24

force default .................................................................................................................24

ESQK............................................................................................................ 14, 24, 31, 51

F

fixed transfer codes..................................................................... 16, 38, 39, 41, 42, 43, 44

FTP ............................................................................................................... 41, 47, 50, 52

I

installation.............................................................................................................. i, 15, 18

IQscript ...........................................................................................................................14

K

keyboard-video-mouse.............................................................................................. 15, 51

N

NPA .................................................................................................................... 39, 40, 51

O

override ANI...................................................................................................................25

54


P

partitioning ..................................................................................................................... 21

options ......................................................................................................................... 23

prefix ........................................................................................................................ 30, 35

priority............................................................................................................................ 28

provisioning TN-ESN .................................................................................................... 47

PSAP ...........................................................................................13, 14, 31, 37, 38, 39, 52

R

references ....................................................................................................................... 11

ring no answer .......................................................................................................... 38, 52

ringback...............................................................................................................24, 29, 30

routes ........................................................................................................................ 28, 31

sets ....................................................................................................................16, 21, 26

type ........................................................................................................................ 28, 31

routing

abandoned call ....................................................................................................... 14, 24

alternate ....................................................................................................................... 13

default.......................................................................................................................... 14

selective ......................................................................................................13, 24, 37, 38

tables...........................................................................................................16, 21, 26, 27

RTCP.............................................................................................................................. 20

RTP ................................................................................................................................ 20

S

safety ............................................................................................................................... iii

selective transfer............................................................................................37, 38, 39, 41

servers

administration.............................................................................................................. 14

application ................................................................................................................... 14

database ............................................................................................................40, 41, 51

service ............................................................................................................................... i

sFTP ..............................................................................................................41, 47, 50, 52

spans ..................................................................................................15, 16, 17, 19, 20, 21

SS7 ................................................................................................................................. 21

55

Index

56

supplementary info .........................................................................................................31

T

T1.................................................................................................................. 14, 15, 16, 20

test calls .................................................................................................................... 16, 26

TN-ESN ........................................................ 11, 13, 16, 24, 37, 38, 39, 40, 41, 47, 50, 52

TN-ESN provisioning .....................................................................................................47

trunks .................................................................................................................. 22, 31, 36

groups................................................................................. 16, 17, 19, 20, 21, 26, 29, 31

U

UDP ................................................................................................................................20

V

verification ................................................................................................................ 15, 16

VoIP................................................................................ 13, 14, 15, 16, 20, 21, 30, 44, 52

VPC................................................................................................... 14, 16, 24, 37, 44, 52

force ESRN ..................................................................................................................24

VSOS ........................................................................................................................ 14, 52

Documents

IQgateway Selective Router