Web-Based User Interface¶

The CRS 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 CRS.

Web Browser Requirements¶

The CRS 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 CRS. The Platform Owner is responsible for defining physical egress routes and other network specifics. Additionally, Platform Owners create and define Service Providers.
Service Providers offer their customers routing features as services. The Service Provider is responsible for defining numbers and associated routing behavior, allocating numbers to Subscribers, and determining the amount of customization for Subscribers.
Subscribers use 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.
User Reset	Reset other user account passwords.
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.
Service Activation	Activate call plans.
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 options.
Service Activation	Activate call plans.

Note

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

Navigating in CRS¶

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.

_images/NavigatingInCRSPlatformOwner.png

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 CRS.
Upper Right	Click to navigate to the Help page or to log out of CRS.
Center	Shows information or records for the current section of CRS.
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.
Edit - Click to open a page where a user can make changes to records that have been selected.
Import and Export - Click to import and export bulk loads of CRS 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: crs_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 view a list of all service provider accounts added to CRS.

To Add Service Providers

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

_images/PlatformOwnerAddServiceProviders.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 CRS.

Setting	Description
Contact Header	Specifies the contact header to add to messages that are routed on the switch.
Egress Route	Specifies the hostname or IP address used in the redirection or connection of SIP calls. If the call is completed using a 302 redirect, the host part of the SIP URI placed in the contact header will be the value set for the egress route. When this setting is left blank, the hostname or IP address in the SIP URI of the Contact header from the initiating INVITE is used.
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.
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	Configures the sounds a caller will hear as the called party is answering. Silence will have no tone.
Customer Service Address	Specifies the customer service destination.
Maximum Inactive Days for Records	CRS will remove records that have been inactive longer than this value every night at midnight, which is determined by the time on the active NIU. A value of zero will never remove inactive records.
Minimum Password Length	The minimum number of characters that a password must be.
Web Help Page	Determines the page to which Service Providers and Subscribers are redirected after selecting Help.
Installed Audio Package	Configures the prompt set that will be used in the web UI.

Managing Administrators¶

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

To Add Administrators

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

_images/PlatformOwnerAddPlatformOwners.png

Setting	Description
Username	User name to log in to the default account. Can contain only lowercase characters, numbers, or underscores.
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 user account 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.

After setting up CRS and importing all the previous data, you will then need to add new Subscriber accounts and set up routing rules associated with each account. To add new Subscribers, you will be creating the following:

Key Numbers - This will be used to create the identifier on the account and the Subscriber account itself.
Numbers - This will be used to create the numbers associated with the Subscriber account.
Groups and Supergroups - These will be used to create the groups of numbers and groups of groups associated with the Subscriber account for call redirecting.
Call Plans - This will be used to create the routing rules associated with the Subscriber account.

Managing Key Numbers¶

Key numbers are used as an identifier for Subscriber accounts, and then numbers and groups are associated with that Subscriber using that common key number. A key number does not have to be a valid phone number but must be 10-digit identifier unique to that Subscriber account.

Click Key Numbers on the main menu to view a list of all key numbers and their subscriber accounts added to CRS.

To Add Subscribers

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

Setting	Description
Key Number	The 10-digit identifier for this Subscriber account. This is also the default user name.
Name	Name of the entity that will use services.
Default Username	User name to log in to the default account.
IVR PIN	The PIN used to log in to the IVR interface. There is an option to randomly generate this PIN.
Single-Number Override	Determines whether this Subscriber can use an override number to direct all numbers to a single destination.
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 CRS.

To Add Numbers

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

Setting	Description
Subscriber	10-digit identifier of the Subscriber account to associate with the number.
Time Zone	The time zone used by the number to determine call routing.
Number	The telephone number that will be redirected based on the applied routing rules.
Parameters	The optional set of parameters configured for this number that are passed to the routing engine.

Click Save Number.

To Edit Numbers

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

Managing Call Plans¶

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

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.
Key Number	10-digit identifier of the Subscriber account to associate with the call plan.

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

Forwarding Settings	Description
Calling Point Code	Routes calls based on the calling number’s point code.
Always	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.
Percent Allocation	Routes calls to multiple destinations based on the allocation specified.
Calling Match	Routes the call based on phone number. X can be used as a wildcard.
Calling NPA	Routes the call based on the three digit area code.
Calling LATA	Routes the call based on the local access and transport area.
Calling ZIP	Routes the call based on the geographic location of the calling party.

Destination Settings	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 call is completed as dialed with no additional modifications.
Terminate	The call will be ended.
Next Rule	Add child rules that determine destination.
Table	The specified calling number will be redirected to the specified new called number.

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.

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 Groups¶

Click Groups on the main menu to view a list of all groups added to CRS.

To Add Groups

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

Setting	Description
Key Number	10-digit identifier of the Subscriber account to associate with the group.
Group Name	Name of the group.
Group Number	Identification number of the group.
North American Number	Require that any number destination provided in a call plan is a North American number.
International	Block destinations in call plans that are international.
Carrier Services	Block destinations in call plans that are 700xxxxxxx style numbers.
Toll-free	Block destinations in call plans that are toll free numbers.
Premium Rate	Block destinations in call plans that are toll numbers.
Abbreviated Dialing	Block destinations in call plans that are service numbers such as 511.
Call Plans	A list of call plans associated with this group. The call plans on the right are in the group and the call plans on the left are not in the group. An individual call plan can be associated with more than one group.
Numbers	A list of numbers associated with this group. The numbers on the right are in the group and the numbers on the left are not in the group. An individual number can be associated with more than one group.

Click Save Group.

To Edit Groups

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

Note

To activate a call plan, right-click on a group in the table and click Activate call plan. In the Activate Call Plan window, click Activate next to the call plan to activate.

Managing Supergroups¶

Click Supergroups on the main menu to view a list of all supergroups added to CRS.

To Add Supergroups

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

_images/ServiceProviderAddSuperGroup.png

Setting	Description
Key Number	10-digit identifier of the Subscriber account to associate with the supergroup.
Supergroup Name	Name of the supergroup.
Supergroup Number	Identification number of the supergroup.
Groups	A list of groups associated with this supergroup. The groups on the right are in the supergroup and the groups on the left are not in the supergroup. An individual group can be associated with more than one supergroup.

Click Save Supergroup.

To Edit Supergroups

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

Note

To activate a call plan, right-click on a supergroup in the table and click Activate call plan. In the Activate Call Plan window, click Activate next to the call plan to activate.