Web-Based User Interface¶

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

Web Browser Requirements¶

The ECF 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 ECF. 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.
Settings	Edit system-wide application settings.

Each Service Provider can have the following permissions:

Name	Permission
Subscriber Administration	Activate accounts and reset PINs for Subscribers.
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 options.

Note

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

Navigating in ECF¶

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 ECF.
Upper Right	Click to navigate to the Help page or to log out of ECF.
Center	Shows information or records for the current section of ECF.
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: ecf_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 ECF.

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 ECF.

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.
Use E-Mail for Account Activation and Reset	Determines whether an email message is sent during account activation or password recovery.
E-Mail Host	Specifies the host used to send the account activation and password recovery email messages.
E-Mail Port	Specifies the port used to send the account activation and password recovery email messages.
E-Mail User	Specifies the user used to send the account activation and password recovery email messages.
E-Mail Password	Specifies the password of the user used to send the account activation and password recovery email messages.
E-Mail TLS	Specifies whether TLS is used for the account activation and password recovery email messages.
Recovery E-Mail Content	Determines the Subject, Headline, and Content of a password recovery email message.
Activation E-Mail Content	Determines the Subject, Headline, and Content of an account activation email message.

Managing Administrators¶

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

To Add Administrators

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

_images/PlatformOwnerAddAdministrator.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.
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 ECF.

To Add Subscribers

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

_images/ServiceProviderAddSubscriber.png

Setting	Description
Number	The number for this Subscriber account. This is also the default user name.
Display Name	Name of the entity that will use services.
Timezone	The time zone used by the Subscriber to determine call forwarding.
Status	Determines whether this Subscriber account is locked after entering an invalid PIN too many times.
Call Manager	Determines whether this Subscriber can access additional features such as creating acceptance lists and forwarding schedules.
IVR PIN	The PIN used to log in to the IVR interface. There is an option to randomly generate this PIN.
Default Number	The number calls will be forwarded to when no plans are active. This can be the same as the Number for this account.
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.
Notes	Blank area to record notes.

Click Save Subscriber.

To Edit Subscribers

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

To Edit Subscriber Forwarding

Right-click on the Subscriber with the call forwarding behavior to be edited.
Click Edit Forwarding Options.
Make necessary changes.

_images/ServiceProviderSubForwarding.png

Click Save Changes.