Web-Based User Interface¶

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

Web Browser Requirements¶

The GETS web UI is accessible 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 GETS. 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 configures call plans and allocates them to their users.

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 call plans.
Settings	Edit system-wide application settings.

Navigating in GETS¶

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 GETS.
Upper Right	Click to navigate to the Help page or to log out of GETS.
Center	Shows information or records for the current section of GETS.
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, calling plans, or routing rule 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 GETS 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: gets_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 GETS.

To Add Service Providers

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

_images/PlatformOwnerAddServiceProvider.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 GETS.

Setting	Description
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.
Number Mask	Specifies the default pattern of added phone numbers. For example: D(DDD)DDD-DDDD would format 15551234987 into 1(555)123-4987.
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 routing engine to connect calls to a local media endpoint and play the announcement “A system error has occurred” when an error in the routing engine occurs. This only applies to SIP calls.
Max Inactive Days for Records Before Removal	GETS 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.
Web Help Page	Determines the page to which Platform Owners and Service Providers are redirected after selecting Help.

Managing Administrators¶

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

To Add Administrators

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

_images/PlatformOwnerAddPlatformOwner.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 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 Call Plans¶

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

To Add Call Plans

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

Setting	Description
GETS Number	The number associated with this call plan, with or without the carrier value prepended.
Time Zone	The time zone used by the call plan to determine call routing.

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.

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.

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

Click Administrators on the main menu to view a list of all service provider accounts added to GETS.

To Add Administrators

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

_images/ServiceProviderAddServiceProvider.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 Service Providers.
Service Provisioning	Add, edit, and remove Subscribers and numbers.
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.