Web-Based User Interface¶

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

Web Browser Requirements¶

The PCS 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 PCS. 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 signing policies, allocates numbers to their users, and establishes routing plans. The Service Provider is also responsible for defining Subscriber accounts.
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
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 lists.

Note

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

Navigating in PCS¶

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 PCS.
Upper Right	Click to navigate to the Help page or to log out of PCS.
Center	Shows information or records for the current section of PCS.
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 changes to records that have been selected.
Import and Export - Click to import and export bulk loads of PCS 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: pcs_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 PCS.

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

_images/PlatformOwnerSettingsNormalization.png

Setting	Description
Number Mask	Specifies the default format of added phone numbers. For example, d(ddd)ddd-dddd would format 15551234987 into 1(555)123-4987.
Default Country Code	Prepended to Numbers and List Entries that are provisioned without a country code.
Reject With Media	Determines if a message is played when a call is rejected.
Drop Anonymous Calls	Specifies if calls from an anonymous number are dropped. A call is considered to be anonymous when the calling number either has “anonymous” populated in the user part of the From header or has a Privacy header configured.
Voicemail Service Location	Specifies the voice mail destination.
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. Strict Router - Determines whether proxied INVITEs routing to the egress route will modify the Request-URI and the egress route. If not selected, these will be used to populate the Route header and the egress route will be indicated as a loose router. Always use Egress Route as Next Hop - Determines whether proxied INVITEs will always be routed based on the egress route even if a Route header is present in the INVITE.
Routing Prefix	Sets the prefix added to the call during the call processing.
Ring While Contacting Called Party	Configures the sounds a subscriber will hear as the called party is answering. Silence will have no tone.
Retain Trunk Group ID for Forward Call	Determines whether a forwarded call retains its primary trunk group ID.
Maximum Inactive Days for Records	PCS 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.
Calling Number Source	Each source can be added or removed, 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.
Called Number Source	Each source can be added or removed, 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 called number can be pulled from the To, Diversion, or Request-URI header as the source.

Calling/Called Number Source Settings

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.

Managing Administrators¶

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

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.
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 Service Selection Criteria¶

Click Service Selection Criteria on the main menu to view and edit the screening criteria in PCS.

These criteria are used along with provisioned numbers to screen calls for matches. First, the call is evaluated to see if it matches any provisioned numbers. Then, the country code of the call is evaluated for a match. Last, the host IP addresses in the Via header(s) of a SIP INVITE and the SCCP source point code of a Termination Attempt or Initial DP are evaluated for a match.

_images/ServiceProviderServiceSelectionCriteria.png

Setting	Description
Called Party Country Code Criteria	Click + to create a list of country codes that will be used to evaluate called party numbers for a match when the number has not been previously provisioned. If a match is found, the Service Provider’s screening rules will be used.
INVITE Via Header(s) IP Address Criteria	Click + to create a list of single IP addresses or CIDR-notation ranges that will be used to evaluate Via headers of a SIP INVITE for a match when the number has not been previously provisioned. If a match is found, the Service Provider’s screening rules will be used. Host names will not be resolved.
SCCP Source Point Code Criteria	Click + to create a list of point code ranges that will be used to evaluate the SCCP source point code of a Termination Attempt or Initial DP when the number has not been previously provisioned. If a match is found, the Service Provider’s screening rules will be used. Point code values must be in decimal format.

Managing Screening Rules¶

Click Screening Rules on the main menu to view and edit the screening rules in PCS.

These screening rules can be evaluated in a different order than the default by clicking the name of the rule and dragging into the desired order. If a call that is being screened matches a rule at the top of the list, that call will not be screened further.

Additionally, these rules can be enabled, disabled, and controlled by the Subscriber.

STIR/SHAKEN

This screening rule determines the call flow based on whether the calling number has a valid certificate. A certificate is valid if it has a signature that can be verified and it is not expired. By default, this is set to block calls with an invalid certificate.

Whitelist

This screening rule determines the call flow based on whether the calling number is a match to the whitelist of the called party. By default, this is set to allow calls to the called number if the number is a match.

Blacklist

This screening rule determines the call flow based on whether the calling number is a match to the blacklist of the called party. By default, this is set to block calls to the called number if the number is a match.

TNS Call Guardian

This screening rule compares the TNS Call Guardian rating of the calling number to the rule. If the TNS Call Guardian rating is higher than the connect above number, the call will connect. If the TNS Call Guardian rating is lower than the disconnect below number, the call will disconnect. If the TNS Call Guardian rating is equal to or between the two numbers, the call will be screened further by the next rule.

Audio Captcha

This screening rule presents the calling party with a set of digits that they have to dial to confirm that a human is calling.

Since DTMF digits must be collected, IN calls are forwarded with a Forward_Call to a SIP switch to convert the call to SIP.

All of the call treatment options, prompts, and dialing timeouts are configurable.

Recorded Greeting

This screening rule allows the calling party to record a greeting (such as their name), which is then played to the called party. After hearing the greeting, the called party can decide the call treatment, including accepting the call, blocking the call, or forwarding the call to voice mail, by dialing the corresponding digit.

Since DTMF digits must be collected, IN calls are forwarded with a Forward_Call to a SIP switch to convert the call to SIP.

All of the call treatment options and prompts are configurable. You can select “Disable Treatment” for any unused option. The following is a list of the default call treatment options.

Option 1

The default call treatment is “Continue”. When the called party dials “1”, the call will be accepted and connected.

Option 2

The default call treatment is “Terminate”. When the called party dials “2”, the call will be blocked and disconnected. If the Reject With Media setting is turned on, a termination message will be played.

Option 3

The default call treatment is “Terminate with Message”. When the called party dials “3”, the call will be blocked, disconnected, and the calling party will hear a message such as, “The person you have called does not accept phone solicitations. Please add their name to your Do Not Call List”.

Option 4

The default call treatment is “Voicemail”. When the called party dials “4”, the call will be forwarded to the Voicemail Service Location configured in the settings.

Click Custom Audio to upload custom audio files that can be selected as an audio prompt for the Audio Captcha and Recorded Greeting screening rules.

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.

Managing Origination Sources¶

An origination source defines one or more IP addresses and unique ID to identify the source for calls that are originated by a Subscriber. If a call is coming from this defined source, then it is known that it is coming from a Subscriber and can be verified with a digital signature.

Click Origination Sources on the main menu to view a list of all calling sources added to PCS.

To Add Origination Sources

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

Setting	Description
Name	Name of the source.
Originating SIP	A list of IP addresses authorized to call from this source that will be matched against the SIP addresses of an INVITE. This value can be a single address or CIDR-notation ranges.
Number Mask	INVITEs from this source with matching phone numbers will use the specified SHAKEN values. ‘X’ can be used as a wildcard value in this field.
Origination ID	The unique string to identify the source in messaging.
Attestation	The level of trust that is assigned to this source. If Full Attestation, the service provider has authenticated the calling party and they are authorized to use the calling number. If Partial Attestation, the service provider has authenticated the calling party but cannot verify that the source is authorized to use the calling number. If Gateway Attestation, the service provider has authenticated where the call was received from but cannot authenticate the source. If No Attestation, a SHAKEN identity header will not be added.
Certificate	The digital certificate to be used for validating and signing traffic from this source. The drop-down menu will be automatically populated with all available certificates.

Click Save Origination Source.

To Edit Origination Sources

Right-click on the source to be edited.
Click Edit Origination Source.
Make necessary changes.
Click Save Origination Source.

Managing Subscribers¶

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

To Add Subscribers

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

_images/ServiceProviderAddSubscriber.png

Setting	Description
Service Enabled	Determines whether PCS service is active for this account.
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.
Enable/Disable Screening Rules	Select which screening rules are enabled for this Subscriber.
Whitelist	List of numbers that will always be allowed to connect to this Subscriber.
Blacklist	List of numbers that will always be blocked from connecting to this Subscriber.

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

To Add Numbers

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

Setting	Description
Subscriber Name	The name of the Subscriber who will use this number.
Number	The telephone number provisioned for the Subscriber.
Nickname	Optional name for the number (such as Cell Phone or Work Phone)
Whitelist	List of numbers that will always be allowed to connect to this number.
Blacklist	List of numbers that will always be blocked from connecting to 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 Settings¶

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

Note

Some settings may not be available to change based on override permissions set by the Platform Owner.

Setting	Description
Number Mask	Specifies the default format of added phone numbers. For example, d(ddd)ddd-dddd would format 15551234987 into 1(555)123-4987.
Default Country Code	Prepended to Numbers and List Entries that are provisioned without a country code.
Reject With Media	Determines if a message is played when a call is rejected.
Drop Anonymous Calls	Specifies if calls from an anonymous number are dropped. A call is considered to be anonymous when the calling number either has “anonymous” populated in the user part of the From header or has a Privacy header configured.
Voicemail Service Location	Specifies the voice mail destination.
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. Strict Router - Determines whether proxied INVITEs routing to the egress route will modify the Request-URI and the egress route. If not selected, these will be used to populate the Route header and the egress route will be indicated as a loose router. Always use Egress Route as Next Hop - Determines whether proxied INVITEs will always be routed based on the egress route even if a Route header is present in the INVITE.
Routing Prefix	Sets the prefix added to the call during the call processing.
Ring While Contacting Called Party	Configures the sounds a subscriber will hear as the called party is answering. Silence will have no tone.
Retain Trunk Group ID for Forward Call	Determines whether a forwarded call retains its primary trunk group ID.
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.
Keystore URL	The base URL of the keystore.
Keystore Authentication Token	The token that is passed to the keystore for validation of access.
Global Whitelist	List of numbers that will always be allowed to connect to any Subscriber.
Global Blacklist	List of numbers that will always be blocked from connecting to any Subscriber.

Managing Administrators¶

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

To Add Administrators

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

_images/ServiceProviderAddAdministrator.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.

Service Providers can see Call Detail Records for all their Subscribers.

Using the Web UI as a Subscriber¶

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 Whitelists and Blacklists¶

From the My Account page, a Subscriber can view and edit the number lists in PCS.

Whitelist

Blacklist

To Add Numbers

Click the + to the right of the table.
Type the new number to add to the list.

To Remove Numbers

Click the - to the left of the number to be removed.

Managing Numbers¶

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

To Edit Numbers

Right-click on the number to be edited.
Click Edit Number.

Make the required changes in the text boxes.
Click Save Number.

Managing Administrators¶

Click Administrators on the main menu to view a list of all subscriber accounts added to PCS.

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. 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.
Administrator Provisioning	Add, edit, and remove other Subscribers.
Service Administration	Edit Subscriber number lists.

Click Save Administrator.

To Edit Administrators

Right-click on the Administrator to be edited.
Click Edit Administrator.
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.

Subscribers can view statistics for all of their services.