IMG 1010 - Route Entry

Owned by Kelli Higdon
Last updated: Apr 01, 2024
13 min read

 

 

Route Entry Dialog Box

The Route Entry object is used to configure a Route Entry under a Route Table, Cause Code Table, or Service Route Table. Right click on either of the tables mentioned and select New Entry and a New Entry dialog box will appear. The Route Entry object allows a user the ability to configure how a call is routed using the different criteria in the tables fields. The entries created are displayed in the object table below the Route Entry object in ClientView and up to 5000 entries can be created under each Route Table. Refer to the information below.

In software version 10.3.x-10.5.1_ER1 the Router String field in each of the Route Tables below all support a maximum of 24 digits. In software version 10.5.1_ER2 and above, that maximum number was increased to 32 digits.

----  Entry used in a Route Table ----

Accessing this Pane

Dialogic IMG EMS-> Routing Configuration-> Routing Tables-> Route Table -> Add Entry

ClientView Pane

Maximum Objects

An IMG will allow up to 66 combined Route Tables, Cause Code Tables, Time Of Day Tables and Service Routing/TOD Tables per Dialogic IMG EMS. The IMG has a max capacity of 100,000 combined entries of the Tables mentioned above. For example: the IMG can support creating 20 Route Tables with each Route Table having 5000 entries.

Related Topics

IMG 1010 - Creating a Route Table

Field Descriptions (Route Table Entry)

Entry ID

The Entry ID is automatically populated with the next available ID number. To modify, click in the Entry ID field and select from drop down menu. ID's range from 1 to 5000

Enable

The enable field enables or disables each individual route entry. The entry can be enabled and disabled without having to recreate it.

True - The entry is valid and will be part of the table.
False - The entry is not valid and will be omitted from the route table.

Route Criteria Type

Below are selections from drop down menu under Route Criteria Type. The Routing Criteria Type refers to a manner used to determine the appropriate path over which the call is transmitted or routed.

Route Criteria Type Value

Description

Dialed Number

The router will try to match the dialed number entered in the Router String field. (i.e. - Called Party Number).

Originating Number

The router will try to match the originating number. (i.e. - Calling Party Number).

Channel Group

Router will match on the channel group configured in the In Channel Group field.

Called

Router will match on the Called Party Nature of Address value. When Called NOA is selected, the Criteria Values field below can now be modified. Select the Criteria Value from that drop down menu. Refer to the Nature of Address (NOA) Values Table below for a table displaying the supported Nature Of Address values.

Calling

Router will match on the Calling Party Nature of Address value. When Calling NOA is selected, the Criteria Values field below can now be modified. Select the Criteria Value from that drop down menu. Refer to the Nature of Address (NOA) Values Table below for a table displaying the supported Nature Of Address values.

FCI

The router will match on the Forward Call Indictor value. Once FCI has been selected, the FCI M bit field below can now be modified. This functionality was added in software version 10.5.0 ER4.

Multimedia Call

The IMG will route the call to a given endpoint when call is determined to be multimedia type. See

Router String

Click in the Router String field and enter the string of digits the IMG will match on. The Router String field becomes available when the Routing Criteria Type is set to either Dialed Number or Originating Number. The valid characters are 0-f, X, and &. Refer to the IMG 1010 - Router String Wildcards  topic for more information on the digits supported. The Router String field supports a maximum of 32 digits.

In Channel Group

The In Channel Group field will have a drop down menu which lists of all the Channel Groups configured. The In Channel Group field becomes available when the Routing Criteria Type is set to Channel Group. Select Not Used if this field will not be utilized.

Match IMG as Well

The Match IMG as well field can be used to specify that the rules applied in the Route Entry also apply to the IMG selected in the drop down list. This field is available to be utilized on any of the Route Criteria Types. Select Not Used if this field will not be utilized.

Criteria Values

Select from drop down menu the Criteria or NOA Values  to be utilized. This box is valid for Routing Criteria Type of Called NOA and Calling NOA only.

FCI - M bit

This field is initially set to Not Used. If the Routing Criteria Type above is set to FCI then this field can be modified. Below are the choices in the drop down menu of this field. This functionality was added in software version 10.5.0 ER4.

Don't Care- Doesn't matter what value of M bit in the ISUP IAM is. Route Call using Route Action Type below.
0- Route call using Route Action Type field below when the value of the M bit in the ISUP IAM is 0.
1- Route call using Route Action Type field below when the value of the M  bit in the ISUP IAM is 1.

The FCI M bit routing feature was designed to be utilized following the Brazilian ITU specifications. Using this field for other protocols such as ANSI may result in unintended outcomes.

Route Action Type

Route Action Type:

Description:

Channel Group/Outgoing Channel Group

Route on a specific Channel Group. When Channel Group is selected, the field just below the Route Action Type field will be renamed to Outgoing Channel Group and will contain all available channel groups configured.

Route List/Outgoing Route List

Route on a specific Route List. When Route List is selected, the field just below the Route Action Type field will be renamed to Outgoing Route List and will contain all available Route Lists configured.Feature F-19620 provides SIP reroute on RTP inactivity. The RTP Media Inactivity Detection (MID) functionality has been enhanced to add an option for reentering routing rules so an incoming call can be retried with another external gateway, using a sequential method such as Route List routing, until IMG is able to receive RTP.

Route Table/Outgoing Route Table

Route on a specific Route Table. When Route Table is selected, the field just below the Route Action Type field will be renamed to Outgoing Route Table and will contain all available Route Table objects configured.

TOD Table/Outgoing Time of Day Table

Route on a specific Time of Day Table. When TOD Table is selected, the field just below the Route Action Type field will be renamed to Outgoing Time of Day Table and will contain all available Time of Day Route Table objects configured.

Treatment Table/Outgoing Treatment Table

Route on a specific Treatment Table. The field below Route Action Type field will change to Outgoing Treatment Table and will contain all available Treatments configured.

Cause Code/Reject Cause Code

When the Route Action Type field is set to Cause Code the IMG will reject the incoming call with a cause code selected from the Reject Cause Code field that gets created when Cause Code is selected. This feature was added in software version 10.5.3.

Outgoing Channel Group

The Outgoing Channel Group field has a drop down menu which lists of all the Channel Groups configured. Select the channel group that the call will be routed to.

---- Entry used in a Cause Code Table ----

Accessing this Pane

Dialogic IMG EMS-> Routing Configuration-> Cause Code Tables-> New Cause Code Table -> Add Entry

ClientView Tree

ClientView Pane

Maximum Objects

An IMG will allow up to 66 combined Route Tables, Cause Code Tables, Time Of Day Tables and Service Routing/TOD Tables per Dialogic IMG EMS. The IMG has a max capacity of 100,000 combined entries of the Tables mentioned above. For example: the IMG can support creating 20 Route Tables with each Route Table having 5000 entries.

Related Topics

IMG 1010 - Cause Code Tables

Field Descriptions (Cause Code Entry)

Entry ID:

The Entry ID is automatically populated with the next available ID number. To modify, click in the Entry ID field and select from drop down menu. ID's range from 1 to 5000.

Enable

The enable field enables or disables each individual cause code entry. The entry can be enabled and disabled without having to recreate it.

True - The entry is valid and will be part of the table.
False - The entry is not valid and will be omitted from the route table.

Route Criteria Type

Cause Code- When creating an entry under a Cause Code Table the Route Criteria field defaults to Cause Code and cannot be modified.

Router String

The Router String field is not applicable when the entry being created is under a Cause Code Table. This field is set to Not Used and cannot be modified.

In Channel Group

The In Channel Group field is not applicable when the entry being created is under a Cause Code Table. This field is set to Not Used and cannot be modified.

Match IMG as Well

The Match IMG as well field can be used to specify that the rules applied in the Cause Code Entry also apply to the IMG selected in the drop down list. Select Not Used if this field will not be utilized.

Criteria Values

Select from drop down menu the Criteria or Cause Code Values to be utilized for this Cause Code entry.

FCI - M Bit

The FCI - M bit field is not applicable when the entry being created is under a Cause Code Table. This field is set to Not Used and cannot be modified.

Route Action Type

Cause Code- When Cause Code is selected from drop down menu, the field just below the Route Action Type will default to Outgoing Cause Code. A cause code can be selected from the drop down menu in that field. The cause code in the Criteria Values field above will now be mapped to a different Cause Code that is selected in the Outgoing Cause Code field created.

Treatment Table - When Treatment Table is selected from drop down menu, the field just below the Route Action Type will default to Outgoing Treatment Table. The Outgoing Treatment Table field contains a drop down menu displaying all available treatments that are configured to be played.

Outgoing Cause Code / Outgoing Treatment Table

Refer to the Route Action Type field above for information on this field.

----  Entry used in a Service Route Table  ----

ClientView Tree

Dialogic IMG EMS -> Routing Configuration -> Service Routing Tables -> Service Route Table -> Add Entry

ClientView Pane   

Maximum Objects

An IMG will allow up to 66 combined Route Tables, Cause Code Tables, Time Of Day Tables and Service Routing/TOD Tables per Dialogic IMG EMS. The IMG has a max capacity of 100,000 combined entries of the Tables mentioned above. For example: the IMG can support creating 20 Route Tables with each Route Table having 5000 entries.

Related Topics

 IMG 1010 - Service Route Tables

Field Descriptions (Service Route Table Entry)

Entry ID

The Entry ID is automatically populated with the next available ID number. To modify, click in the Entry ID field and select from drop down menu. ID's range from 1 to 5000.

Enable

The enable field enables or disables each individual service route entry. The entry can be enabled and disabled without having to recreate it.

True - The entry is valid and will be part of the table.
False - The entry is not valid and will be omitted from the route table.

Route Criteria Type

Below are selections from drop down menu under the Route Criteria Type object when the entry is set to Service Route Table.

Route Criteria Type Value:

Description:

Dialed Number

The router will try to match the dialed number entered in the Router String field. (i.e. - Called Party Number).

Originating Number

The router will try to match the originating number. (i.e. - Calling Party Number).

Channel Group

Router will match on the channel group configured in the In Channel Group field.

Called

Router will match on the Called Party Nature of Address value. When Called NOA is selected, the Criteria Values field below can now be modified. Select the Criteria Value from that drop down menu.

Calling

Router will match on the Calling Party Nature of Address value. When Calling NOA is selected, the Criteria Values field below can now be modified. Select the Criteria Value from that drop down menu.

FCI

The router will match on the Forward Call Indictor value. Once FCI has been selected, the FCI M bit field below can now be modified. This functionality was added in software version 10.5.0 ER4.

Router String

Click in the Router String field and enter the string of digits the IMG will match on. The Router String field becomes available when the Routing Criteria Type is set to either Dialed Number or Originating Number. The valid characters are 0-f, X, and &. Refer to the IMG 1010 - Router String Wildcards  topic for more information on the digits supported. The Router String field supports a maximum of 32 digits.

In Channel Group

The In Channel Group field will have a drop down menu which lists of all the Channel Groups configured. The In Channel Group field becomes available when the Routing Criteria Type is set to Channel Group. Select Not Used if this field will not be utilized.

Match IMG as Well

The Match IMG as well field can be used to specify that the rules applied in the Service Route Entry also apply to the IMG selected in the drop down list. This field is available to be utilized on any of the Route Criteria Types. Select Not Used if this field will not be utilized.

Criteria Values

Select from drop down menu the Criteria or NOA Values to be utilized. This box is valid for Routing Criteria Type of Called NOA and Calling NOA only.

FCI - M Bit

This field is initially set to Not Used. If the Routing Criteria Type above is set to FCI then this field can be modified. Below are the choices in the drop down menu of this field. This functionality was added in software version 10.5.0 ER4.

Don't Care- Doesn't matter what value of M-Bit in the ISUP IAM is. Route Call using Route Action Type below.
0- Route call using Route Action Type field below when the value of the M bit in the ISUP IAM is 0.
1- Route call using Route Action Type field below when the value of the M bit in the ISUP IAM is 1.

Note: The FCI M bit routing feature was designed to be utilized following the Brazilian ITU specifications. Using this field for other protocols such as ANSI may result in unintended outcomes.

Route Action Type

Treatment Table- When Treatment Table is selected from drop down menu, the field just below the Route Action Type will default to Outgoing Treatment Table. The Outgoing Treatment Table field contains a drop down menu displaying all available treatments that are configured to be played.

Service TOD Table- When Service TOD Table is selected from the drop down menu, the field just below the Route Action Type will default to Service TOD Table. The Service TOD Table will be populated with all the Service Time Of Day Tables created. Select the Service Time Of Day table to route on.

 Cause Code Values Table

Below is a list of all the cause code entries that are in the cause code table entry object.

Value:

Description:

 

Value:

Description:

000

Reserved

 

053

Outgoing Calls Barred Within CUG

001

Unallocated

 

054

Unknown Cause Code

002

No Route to Specified Transit Network

 

055

Incoming Calls Barred Within CUG

003

No Route to Destination

 

056

Unknown Cause Code

004

Send Special Information Tone

 

057

Bearer Capability Not Authorized

005

Misdialled Trunk Prefix

 

058

Bearer Capability Not Available

006

Channel Unacceptable

 

059 - 061

Unknown Cause Code

007

Call Awarded

 

062

Inconsistency b/w access info and sub class

008

Preemption

 

063

Service of Option Not Available, unspecified

009

Preemption - Circuit Reserved for Reuse

 

064

Unknown Cause Code

010 - 015

Unknown Cause Code

 

065

Bearer Capability Not Implemented

016

Normal Call Clearing

 

066

Channel Type Not Implemented

017

User Busy

 

067

Unknown Cause Code

018

No User Responding

 

068

Unknown Cause Code

019

No Answer from User

 

069

Requested Facility Not Implemented

020

Subscriber absent

 

070

Restricted Digital Info Bearer Only

021

Call Rejected

 

071 - 078

Unknown Cause Code

022

Number Changed

 

079

Service or Option Not Implemented, unspecified

023

Unknown Cause Code

 

080

Unknown Cause Code

024

Unknown Cause Code

 

081

Invalid Call Reference Value

025

Exchange Routing Error

 

082

Identified Channel Does Not Exist

026

Non-Selected User Clearing

 

083

Call Identity Does Not Exist

027

Destination Out of Order

 

084

Call Identity In Use

028

Invalid Number Format

 

085

No Call Suspended

029

Facility Rejected

 

086

Call Identity Has Been Cleared

030

Response to STATUS ENQUIRY

 

087

User Not Member of CUG

031

Normal, Unspecified

 

088

Incompatible Destination

032

Unknown Cause Code

 

089

Unknown Cause Code

033

Unknown Cause Code

 

090

Non-existent CUG

034

No Circuit/Channel Available

 

091

Invalid Transit network Selection

035 - 037

Unknown Cause Code

 

092

Unknown Cause Code

038

Network Out of Order

 

093

Unknown Cause Code

039

Frame Mode Connection Out of Service

 

094

Unknown Cause Code

040

Frame Mode Connection Operational

 

095

Invalid Message, unspecified

041

Temporary Failure

 

096

Mandatory Information Element Missing

042

Switching Equipment Congestion

 

097

Message Type Non-existent or Not Implemented

043

Access Information Discarded

 

098

Message Not Compatible with Call State

044

Requested Circuit/Channel Unavailable

 

099

Information Element/Parameter Non-existent

045

Unknown Cause Code

 

100

Invalid Information Element Contents

046

Precedence Call Blocked

 

101

Message Not Compatible with Call State

047

Resource Unavailable, unspecified

 

102

Recovery on Timer Expired

048

Unknown Cause Code

 

103

Parameter Non-existent or Not Implemented

049

Quality of Service Unavailable

 

104 - 109

Unknown Cause Code

050

Requested Facility Not Subscribed

 

110

Message with Unrecognized Parameter

051

Unknown Cause Code

 

111

Protocol Error, unspecified

052

Unknown Cause Code

 

112 - 254

Unknown Cause Code

 

Value:

Description:

 

Value:

Description:

400

Bad Request

 

482

Loop Detected

401

Unauthorized

 

483

Too Many Hops

402

Payment Required

 

484

Address Incomplete

403

Forbidden

 

485

Ambiguous

404

Not Found

 

486

Busy Here

405

Method Not Allowed

 

487

Request Terminated

406

Not Acceptable

 

488

Not Acceptable Here

407

Proxy Authentication Required

 

489

Bad Event

408

Request Timeout

 

491

Request Pending

410

Gone

 

493

Undecipherable

412

Conditional Request Failed

 

494

Security Agreement Required

413

Request Entity Too Large

 

500

Server Internal Error

414

Request-URI Too Long

 

501

Not Implemented

415

Unsupported Media Type

 

502

Bad Gateway

416

Unsupported URI Scheme

 

503

Service Unavailable

417

Unknown Resource-Priority

 

504

Server Time -out

420

Bad Extension

 

505

Version Not Supported

421

Extension Required

 

513

Message Too Large

422

Session Interval Too Small

 

600

Precondition Failure

423

Interval Too Brief

 

603

Busy Everywhere

429

Provide Referrer Identity

 

604

Does Not Exist Anywhere

480

Temporarily Unavailable

 

606

Not Acceptable

481

Call/Transaction Does Not Exist

 

 

 

Nature of Address (NOA) Values Table

The following table defines the values in the Nature of Address field.

Value

NOA

Description

000

Reserved

 

001

Subscriber Number

The number represents a subscriber’s location.

002

Unknown: National Use

 

003

National Number

 The number represents a national carrier.

004

International Number

The number represents an international carrier.

005

Network Specific number

The number represents a specific network.

006 - 112

Unknown NOA

 

113

Subscriber Number - Operator Requested

The number represents a calling party request for operator assistance with a subscriber number.The number is a non-unique subscriber number.

114

National Number - Operator Requested

The number represents a calling party request for operator assistance with a national number.

115

International Number - Operator Requested

The number represents a calling party request for operator assistance with an international number.The number is a non-unique national number.

116

No Number Present - Operator Requested

The calling party requests operator assistance.The number is a non-unique international number.

117

No Number Present - Cut Through

No number is present, so the call should be cut-through to the carrier.

118

905 Call

The number represents a calling card or other enhanced service call made through a local exchange carrier’s public telephone or through a carrier end-office.

119

Test Call

The number represents a call that is made to test a circuit.

120 - 127

Unknown NOA

 

 

Return to Documentation Home I Return to Sangoma Support