Web-Based User Interface¶

The ICR web-based user interface (web UI) allows Platform Owners, Service Providers, and Subscribers to populate and maintain the routing rules database, monitor statistics, and manage users in ICR.

Web Browser Requirements¶

The ICR web UI can be accessed from any of the following web browsers:

http://imsworkx.com/support/supported-browsers/

Account Roles¶

The type of user account determines the selections available on the main menu, and the permissions assigned to a user further define the tasks that they can perform.

The different roles are defined as:

Platform Owners deploy the network that runs ICR. The Platform Owner is responsible for defining physical egress routes and the Service Providers.
Service Providers offer their customers routing features as services. The Service Provider allocates numbers to their users and establishes routing plans for these numbers. The Service Provider is also responsible for defining Subscriber accounts.
Subscribers uses routing features as a service.

Note

Permissions assigned to every subscriber account allow them to access only their own account, forwarding plan, and speed call number information. The same permissions are assigned to every subscriber and cannot be modified.

Each Platform Owner can have the following permissions:

Name	Permission
User Administration	Add, remove, and edit other Platform Owners.
Service Providers	Add, remove, and edit Service Providers.
Settings	Edit system-wide application settings.

Each Service Provider can have the following permissions:

Name	Permission
User Administration	Add, remove, and edit other Service Providers.
Service Provisioning	Add, remove, and edit Subscribers and numbers.
Settings	Edit system-wide application settings.

Each Subscriber can have the following permissions:

Name	Permission
Administrator Provisioning	Add, remove, and edit other Subscribers.
Service Administration	Edit number forwarding.

Note

Permissions that any user has access to may be set on a per-user basis.

Navigating in ICR¶

This section describes the common page navigation tools that are used by all accounts.

To see the full list of features that a user can access, select one of the options on the left side of the screen to navigate to that section.

Location on Screen	Function
Upper Left	Shows user name and role of current user. Click the user name to go to the My Account page.
Left	Shows the main menu. Click to navigate to other sections of ICR.
Upper Right	Click to navigate to the Help page or to log out of ICR.
Center	Shows information or records for the current section of ICR.
Bottom	Additional options to select, view, and filter records.

Task Bar

The tasks that a user is able to perform are determined by the permissions assigned when the user account is created.

The task bar provides the following functionality:

Add - Click to open a page where a user can create records for users, service providers, subscribers, calling plans, or routing rule records.
Edit - Click to open a page where a user can make necessary changes to records that have been selected.
Import and Export - Click to import and export bulk loads of ICR records.

Tip

For more information on importing and exporting records, see Provisioning.

Using the Web UI as a Platform Owner¶

Opening the Web UI

In a web browser, connect to the host address of the NIU.
On the Login page, enter the Username and Password.

Tip

Click Forgot Password to generate a password reset link.

Default user name: icr_administrator Default password: im5_wrkX

Click Login. The My Account page will be displayed.

Tip

This page can be accessed at any time by clicking the user name next to “Logged in as”.

Changing the Password

Click Change Password on the My Account page.
Enter the Current Password and the New Password.
Click Save Changes.

Note

The new password must be a minimum of 8 characters and a maximum of 16 characters.

Managing Service Providers¶

Click Service Providers on the main menu to open a list of all service provider accounts added to ICR.

To Add Service Providers

Click Add on the task bar.
Enter the user information in the text boxes.

_images/blueplatformownerAddprovider.png

Setting	Description
Name	Name of the Service Provider.
Default Username	User name to log in to the default account.
Notes	Blank area to record notes.
Email	Notifications and password reset requests are sent to this email address.
Address	Physical address of the Service Provider.
First Name	First name of entity who uses the account.
Last Name	Last name of entity who uses the account.
Phone	Primary phone number of the contact.

Click Save Service Provider.

To Edit Service Providers

Right-click on the Service Provider to be edited.
Click Edit Service Provider.
Make necessary changes.
Click Save Service Provider.

Managing Settings¶

Click Settings on the main menu to view and edit application-wide settings of ICR.

Setting	Description
Default No Route Behavior	Sets the default behavior for SIP calls when no route is found for the call. The options available directly correspond to SIP final response codes. If 302 is selected, a SIP URI of where to redirect the call must also be provided.
Redirect Address	Specifies the address a SIP redirect message will be sent. This address will allow the use of the IVR.
Point Code Format	Specifies if point codes will be ANSI or ITU format. ANSI point codes will be in the format of xxxxxxxx-xxxxxxxx-xxxxxxxx. ITU point codes will be in the format of xxx-xxxxxxxx-xxx.
Route Call Timeout	Specifies the time, in seconds, to wait for a destination before the call times out and a 480 response is returned.
Egress Route	If Use Contact Header Host is selected, the host part in the SIP URI of the Contact header is used in the redirection or connection of SIP calls. If Use Contact Header Host is not selected, specify a valid host/domain name or IP address to be used in the redirection or connection of SIP calls. An optional port number can be included separated by a colon (:). For example, 127.0.0.1, 10.10.10.10:5065, local-niu, pstn.gw.provider.net, sbc.vzw.net:5080.
Routing Prefix	Sets the prefix added to the call during the call processing.
SIP Connection Type	Redirect: Configures the routing engine to send a 302 Redirect in response to calls with routable destinations. This is the default behavior, calls will be simply redirected to their routed destination. Proxy: Configures the routing engine to proxy calls to their routed destination. Attended Transfer: Configures the routing engine to transfer calls to their routed destination using an Attended Transfer via a SIP Refer as specified in RFC 5395. Back to Back User Agent: Configures the routing engine to connect the calls to their routed destination by acting as a back to back user agent.
Play Media on Error	Enabled the playing of media that a subscriber will hear as the called party is answering.
Allow Routing with Custom Criteria	Enables the use of specified custom criteria for call routing.
Custom Criteria	A table of custom criteria to use when Allow Routing with Custom Criteria is turned on. The criteria shown in the left column are disabled and the criteria shown in the right column are enabled. Segment Name - Routes calls based on the Segment Name of the application.xtml section of the SIP INVITE. This can be an Exact Match or a Pattern (Regex). Segment Tag - Routes calls based on the Segment Tag of the application.xtml section of the SIP INVITE. This can be an Exact Match or a Pattern (Regex).
Max Inactive Days for Records	ICR will remove records that have been inactive longer than this value every night at midnight, where midnight is determined by the time on the active NIU. A value of zero will never remove inactive records.
Minimum Password Length	The minimum length users can set their password.
CSV Retention Time	How long the CSVs for imports and exports will be kept on the system.
Web Help Page	Determines the page to which Platform Owners and Service Providers are redirected after selecting Help.
Installed Audio Package	Configures the prompt set that will be used in the web UI.
Strip Prefix	Enables the stripping of a specified prefix from a number. If a prefix is not present, the number will not be changed.
Prefix To Strip	The exact digits to remove from the beginning of a number when Strip Prefix is turned on. If a number starts with a plus (+), this prefix must also have the plus (+) to match and be stripped.
Minimum Digits Remaining	Specifies the minimum number of digits that must be left after the prefix is stripped. If this minimum is not reached, the prefix will not be removed from the number.

Called and Calling Sources Settings

Each source can be enabled or disabled, and the list is evaluated in top to bottom order. Each option has configurable policy and post processing settings, explained in the following table.

A calling number can be pulled from the From, Diversion, P-Asserted-Identity, or History-Info header as the source. A called number can be pulled from the To, Diversion, or Request-URI header as the source.

_images/blueplatformownerSourceSettings.png

Setting	Description
Attempt Implicit ‘user=phone’	If enabled, the user part of the called source will be processed as ‘;user=phone’ even if that is not present.
Add ‘phone-context’	If enabled, the configured ‘;phone-context=’ value is used if the URI is being treated as a tel-URI and the number is not global and does not contain an existing ‘phone-context’ parameter.
Digits Heuristic	Determines the called number digits. ‘Longest Digit Substring’ uses the longest substring of digits 0-9 present in the user part of the SIP URI as the digits. If there are two or more substrings that meet this criteria, the first one is used. ‘As Is’ uses the user part of the SIP URI as the digits.
Add Post Process	Strip Prefix - Define a prefix to be removed if found in the digits of the number extracted from the called source. The prefix is discarded and the remainder is treated as the called number. Extract Substring - Define a range property that indicates the interval to extract from the digits of that called source. Any other numbers are discarded. The interval includes the first number and excludes the second. For example, a substring of 0 to 2 would select the first two numbers. Set Country Code - Allows a number to be set which overwrites an existing country code property of the extracted number. Default Country Code - Allows a number to be set which sets a country code property for the extracted number, unless one is already present. Digits Only - Generates an error if a non-digit character is found in the extracted number. The Minimum Length setting is optional and, if set, will generate an error if the length of the extracted number is less than this value. Parse Country Code - Allows a number to be set where remaining digits are examined for a leading plus (+), which is then removed along with the country code from the digit string.

Managing Administrators¶

Click Administrators on the main menu to view a list of all platform owner accounts added to ICR.

To Add Administrators

Click Add on the task bar.
Enter the user information in the text boxes.

Setting	Description
Username	User name to log in to the default account.
Email	Notifications and password reset requests are sent to this email address.
First Name	First name of entity who uses the account.
Last Name	Last name of entity who uses the account.
View Only	Make this account view only or assign permissions.
User Administration	Add, edit, and remove other Platform Owners.
Service Providers	Add, edit, and remove Service Providers.
User Reset	Reset other users’ passwords.
Settings	Edit system-wide application settings.

Click Save Administrator.

To Edit Administrators

Right-click on the Administrator to be edited.
Click Edit User.
Make necessary changes.
Click Save Administrator.

Call Detail Records¶

Click Call Detail Records on the main menu to view and export Call Detail Records. The type of account and assigned permissions determine the records that are available to view.

Platform Owners can view statistics for all services that they host.

Using the Web UI as a Service Provider¶

Opening the Web UI

In a web browser, connect to the host address of the NIU.
On the Login page, enter the Username and Password.

Tip

Click Forgot Password to generate a password reset link.

Click Login. The My Account page will be displayed.

Note

This page can be accessed at any time by clicking the user name next to “Logged in as”.

Changing The Password

Click Change Password on the My Account page.
Enter the Current Password and the New Password.
Click Save Changes.

Tip

The new password must be a minimum of 8 characters and a maximum of 16 characters.

Managing Subscribers¶

Click Subscribers on the main menu to view a list of all subscriber accounts added to ICR.

To Add Subscribers

Click Add on the task bar.
Enter the user information in the text boxes.

Setting	Description
Name	Name of the entity that will use services. This is also the default user name.
Default Username	User name to log in to the default account.
Notes	Blank area to record notes.
Email	Notifications and password reset requests are sent to this email address.
Address	Physical address of the Subscriber.
First Name	First name of entity who uses the account.
Last Name	Last name of entity who uses the account.
Phone	Primary phone number of the contact.

Click Save Subscriber.

To Edit Subscribers

Right-click on the Subscriber to be edited.
Click Edit Subscriber.
Make necessary changes.
Click Save Subscriber.

Managing Numbers¶

Click Numbers on the main menu to view a list of all numbers added to ICR.

To Add Numbers

Click Add on the task bar.
Enter the number information in the text boxes.

Setting	Description
Subscriber	The name of the Subscriber that will use this number.
Time Zone	The time zone to be used by this number for call routing.
Number	The telephone number provisioned for the Subscriber.
Parameters	The additional parameters that will affect this number.

Click Save Number.

To Edit Numbers

Right-click on the number to be edited.
Click Edit Number.
Make necessary changes.
Click Save Number.

Managing Labels¶

Click Labels on the main menu to view a list of labels added to ICR.

To Add Labels

Click Add on the task bar.
Select the Criteria, Destination, or Parameter tab.
Enter the label information in the text boxes.

Criteria

Type	Description
Date	Routes calls based on a date or series of dates.
Day of Week	Routes the call based on the day.
Time of Day	Routes the call based on time. ICR uses the 24 hour clock.
Phone Number	Routes the call based on phone number. X can be used as a wildcard.
NANPA	Routes calls based on the three digit area code.
Point Code	Routes call based on the signaling point code of the call.
LATA	Routes call based on the local access transport area.
Zip Code	Routes the call based on the geographic location of the calling party.

Destination

Destination	Description
Number	The destination is a telephone number.
SIP URI	The destination is a SIP endpoint. Provide the full SIP URI required in the input field when selecting this option. For example, sip:service2@network-services.net. Can include the following templates: ‘{{calling_number}}’, ‘{{called_number}}’, ‘{{egress_route}}’ which will be populated with extent content if found. For example, {{calling_number}}-{{called_number}}@{{egress_route}} Where calling number is 1112223333, called number is 2224446666, and egress route is 111.222.333.444 and the URI after processing is: sip:1112223333-2224446666@111.222.333.444 A template value of anything other than these three variables will result in an exception being thrown, and a 480 Temporarily Unavailable will be returned. The failing replacement and base template will be in the error log on the AS.
Trunk Group	The destination is a trunk group. The called number and egress route stay the same. However, the signaling instructs the next network elements in the call to send the call over the indicated trunk group.
Trunk Group with Outpulse	The destination is a trunk group. The address information does change.

Parameters

For more information, please see SCE JavaScript Helpers.

Click Save Label.

To Edit Labels

Right-click on the label to be edited.
Click Edit Label.
Make necessary changes.
Click Save Label.

Managing Call Plans¶

Click Call Plans on the main menu to view a list of all call plans added to ICR.

To Add Call Plans

Click Add on the task bar.
Enter the call plan information in the text boxes.

Setting	Description
Call Plan Name	The name of the call plan.
Subscriber	The name of the Subscriber that will use this call plan.
Far End Pickup Failure Destination	Where the call will be sent in the event that the call is not answered.
Timeout	Specifies the time, in seconds, to wait before the call is considered failed.

Click Open Rule Editor to add rules to the call plan.
Click Add Rule to create a rule.

Forward	Description
Always	Forwards the call to a destination.
Event/Holiday	Routes calls based on a date or date range.
Day of Week	Routes the call based on the day.
Time of Day	Routes the call based on time. ICR uses the 24 hour clock.
Percent Allocation	Routes calls to multiple destinations based on the allocation specified.
Limited/Ongoing	Limits the number of concurrent calls can be routed to this rule’s destination.
Limited/Periodic	Limits the number of calls in a time range. This time range is in hours.
Calling Match	Routes the call based on phone number. X can be used as a wildcard.
Calling NPA	Routes calls based on the three digit area code.
Calling Point Code	Routes call based on the signaling point code of the call.
Calling LATA	Routes call based on the local access transport area.
Calling Zip	Routes the call based on the geographic location of the calling party.
Labeled Criteria	Routed the call based on a created label.

Destination	Description
Number	The destination is a telephone number.
SIP URI	The destination is a SIP endpoint. Provide the full SIP URI required in the input field when selecting this option. For example, sip:service2@network-services.net. Can include the following templates: ‘{{calling_number}}’, ‘{{called_number}}’, ‘{{egress_route}}’ which will be populated with extent content if found. For example, {{calling_number}}-{{called_number}}@{{egress_route}} Where calling number is 1112223333, called number is 2224446666, and egress route is 111.222.333.444 and the URI after processing is: sip:1112223333-2224446666@111.222.333.444 A template value of anything other than these three variables will result in an exception being thrown, and a 480 Temporarily Unavailable will be returned. The failing replacement and base template will be in the error log on the AS.
Trunk Group	The destination is a trunk group. The called number and egress route stay the same; however, the signaling instructs the next network elements in the call to send the call over the indicated trunk group. To specify the trunk-context parameter, append the descriptor to the trunk group value. For example, TG1;trunk-context=example.com.
Trunk Group with Outpulse	The destination is a trunk group. The address information does change.
Continue	The destination will be the same as dialed.
Terminate	End the call.
Next Rule	Add child rules that allow more control of a call.
Menu	Add child rules that will route based on collected digits to build an IVR menu.
Call Plan	The destination will be determined by a different call plan. The text field must exactly match the Call Plan Name of the corresponding call plan.
Labeled Destination	The destination is based on a created Label.

Note

You can change the order of the rules by dragging a rule to a new location in the list. Rules are evaluated from the top of the page down, until the first criteria is met.

(Optional) Click Audio Manager to upload audio files for custom menus.

Note

Audio files must have an 8 kHz sample rate and be single channel (mono), µ-law WAV format.

Note

When naming audio files, do not use spaces or any characters that are string delimiters.

Close the Rule Editor.
Click Save Call Plan.

To Edit Call Plans

Right-click on the call plan to be edited.
Click Edit Call Plan.
Make necessary changes.
Click Save Call Plan.

Managing Routes¶

Click Routes on the main menu to view a list of all routing tables added to ICR.

To Add Routes

Click Add on the task bar.
Enter the route information in the text boxes.

Setting	Description
Number	The number that will be routed by ICR.
Call Plan	The call plan that will be used to determine the route in ICR.
Priority	The order in which routes are evaluated for the number. A lower number has a higher priority.

Click Save Routing Table to save the changes.

To Edit Routes

Right-click on the route to be edited.
Click Edit Route.
Make necessary changes.
Click Save Routing Table.