- 26 Oct 2024
- 22 Minutes to read
- Print
- DarkLight
- PDF
General Settings
- Updated on 26 Oct 2024
- 22 Minutes to read
- Print
- DarkLight
- PDF
This section consists of the following tabs:
- Alerts & Notifications
- Client Versions
- Devices
- Domain Names
- Locations
- Roles
- SSO Configuration
- Tenant Variables
- User Mapping
- Users
Alerts & Notifications
This section enables you to add, edit, or delete alerts and notifications. You can also configure email alerting to specific recipients based on specific filter criteria. You can view existing alert notifications with the number of recipients and alerts sent.
When you click on this tab, the Alerts & Notifications page opens with the following tabs:
- Nectar Score Locations
- Nectar Score Users
- Poor Calls
These are explained in the following sections.
NECTAR SCORE LOCATIONS
When you click on the NS Locations tab, you can view a list of alerts that were created for calls with a specific Nectar score and monitored location(s). You can add a new alert or edit an existing alert. You can also delete an alert.
Add a New Location Alert
- Click Add Alert. The Add Alert - Nectar Score By Location page opens.
- Enter the following information to create an alert:
Parameter | Description |
Display Name | Enter up to 20 alphanumeric characters for the name of the alert. |
Locations | Select the location(s) you want to monitor for this alert using the drop-down. |
Alerting Time | Select from the following options:
|
When to send reports | This parameter shows when the Alerting Time is set to Last Day. Click to set the time that the report will be sent using the time zone of the user creating the alert. |
Time Zone Settings: |
|
Time Zone | Select a time zone using the drop-down. |
Threshold Options: |
|
Average Nectar Score | Select the Nectar score that will trigger an alert using the up/ down arrow. |
Minimum Total Sessions | Select the minimum total sessions that will trigger an alert using the up/down arrow. |
Additional Options: |
|
Platform | Select a platform(s) to which this alert will apply, such as All or Cisco. |
Modality | Select a modality(s) to which this alert will apply, such as All or Audio. |
Session Type | Select a session type(s) to which this alert will apply, such as All or Conference. |
Session Scenario | Select a session scenario(s) to which this alert will apply, such as All or External. |
Network Type | Select a network type(s) to which this alert will apply, such as All or External WIFI. |
Alerting Mechanism: |
|
Select this option to be able to send an email with a message. | |
Event | Select this option to create an event for the alert. If selected, this event will appear in EVENTS (Details tab > Historic Events). |
Email Options: |
|
Send to | Enter the email address(es) that you want to use to notify when an alert is triggered. If adding multiple emails, separate using a comma. |
Subject | Enter a subject for the email that will be sent. |
Message | Enter the message that will be included in the notification email. |
3. Click Add. The new alert is added to the list of alerts on the NS Locations tab. Notice that the Is Enabled check box is selected, which means the alert has been enabled.
Edit a Location Alert
- Click the Edit button next to the alert you want to edit. The Edit Alert - Nectar Score By Location page opens.
- Make changes to the alert parameters, as needed.
- Click Save. Or, click Cancel.
Delete a Location Alert
- Click the Delete button next to the alert you want to delete. The Delete Alert dialog opens.
- Click Delete. Or, click Cancel. The alert is removed from the list of alerts on the NS Locations tab.
NECTAR SCORE USERS
When you click on the NS Users tab, you can view a list of alerts that were created for calls with a certain call quality percentage for a monitored user(s). You can add a new alert or edit an existing alert. You can also delete an alert.
Add a New User Alert
- Click Add Alert. The Add Alert - Nectar Score page opens.
- Enter the following information to create a new User alert:
Parameter | Description |
Alert Name | Enter up to 20 alphanumeric characters for the name of the alert. |
Threshold: |
|
Nectar Score Percentage | Select the Nectar score that will trigger an alert using the up/ down arrow. |
Monitored Users | Click the check box next to the user(s) you want to monitor for this alert. Options are:
|
Time Zone Settings: |
|
Time Zone | Select a time zone using the drop-down. |
Alerting Mechanism: |
|
Select this option to be able to send an email with a message. | |
Event | Select this option to create an event for the alert. If selected, this event will appear in EVENTS (Details tab > Historic Events). |
Recipients: |
|
Send to | Enter the email address(es) that you want to use to notify when an alert is triggered. If adding multiple emails, separate using a comma. |
Subject | Enter a subject for the email that will be sent. |
Message | Enter the message that will be included in the notification email. |
Alert Monitored Users Via: | Click the Email check box, if you want to send an email to the monitored user(s). The Subject and Message fields open for you to enter the appropriate Subject and email message. |
3. Click Add. The new alert is added to the list of alerts on the NS Users tab. Notice that the Is Enabled check box is selected, which means the alert has been enabled.
Edit a User Alert
- Click the Edit button next to the User alert you want to edit. The Edit Alert - Nectar Score page opens.
- Make changes to the User alert parameters, as needed.
- Click Save. Or, click Cancel.
Delete a User Alert
- Click the Delete button next to the User alert you want to delete. The Delete Alert dialog opens.
- Click Delete. Or, click Cancel. The alert is removed from the list of alerts on the NS Users tab.
POOR CALLS
When you click on this tab, you can view a list of alerts that were created for calls with poor quality by location or by user. You can also specify other thresholds for alerting. You can add a new alert or edit an existing alert. You can also delete an alert.
Add a New Poor Call Alert
- Click Add Alert. The Add Alert - Poor Calls opens.
- Enter the following information to create an alert:
Parameter | Description |
Display Name | Enter up to 20 alphanumeric characters for the name of the alert. |
Alert Category | Select one of the following options:
|
Locations | Select the location(s) you want to monitor for this alert using the drop-down. |
Users/Selected Users |
|
Selected Users | Lists the users to be monitored for this alert. |
Alerting Time | Select from the following options:
|
When to send reports | This parameter shows when the Alerting Time is set to Last Day. Click to set the time that the report will be sent using the time zone of the user creating the alert. |
Time Zone Settings: |
|
Time Zone | Select a time zone using the drop-down. |
Threshold Options: |
|
Poor Session Percentage | Select the Session score that will trigger an alert using the up/ down arrow. |
Minimum Total Sessions | Select the minimum total sessions that will trigger an alert using the up/down arrow. |
Additional Options: |
|
Platform | Select a platform(s) to which this alert will apply, such as All or Cisco. |
Modality | Select a modality(s) to which this alert will apply, such as All or Audio. |
Session Type | Select a session type(s) to which this alert will apply, such as All or Conference. |
Session Scenario | Select a session scenario(s) to which this alert will apply, such as All or External. |
Network Type | Select a network type(s) to which this alert will apply, such as All or External WIFI. |
Email Options: |
|
Send to | Enter the email address(es) that you want to use to notify when an alert is triggered. If adding multiple emails, separate using a comma. |
Subject | Enter a subject for the email that will be sent. |
Message | Enter the message that will be included in the notification email. |
4. Click Add. The new alert is added to the list of alerts on the Poor Calls tab. Notice that the Is Enabled check box is selected, which means the alert has been enabled.
Edit a Poor Call Alert
- Click the Edit button next to the alert you want to edit. The Edit Alert - Poor Calls page opens.
- Make changes to the alert parameters, as needed.
- Click Save. Or, click Cancel.
Delete a Poor Call Alert
- Click the Delete button next to the alert you want to delete. The Delete Alert dialog opens.
- Click Delete. Or, click Cancel. The alert is removed from the list of alerts on the Poor Calls tab.
Client Versions
This page lists the supported and unsupported client versions. This information is populated and based on the user’s platform and device used during a call.
Click Client Versions in the left panel to open the Client Versions page.
- Click the Supported check box next to each client version to indicate whether or not it is supported.
- Click the Columns drop-down to select the columns of data you want to view in the table.
- Click the Platform drop-down to select the platform(s) to include in the list of client versions.
- You can click the drop-down next to Show to specify the number of client versions to show per page. The default value is 10.
- You can use the Search box to search for a client version.
Devices
This page lists the supported and unsupported devices. This information is populated and based on the user’s platform and device used during a call.
Click Devices in the left panel to open the Devices page.
- Click the Supported check box next to each device to indicate whether or not it is supported.
- Click the Columns drop-down to select the columns of data you want to view in the table.
- Click the Platform drop-down to select the platform(s) to include in the list of devices.
- You can click the drop-down next to Show to specify the number of devices to show per page. The default value is 10.
- You can use the Search box to search for a device.
Domain Names
Click Domain Names in the left panel to open the Domain Names page. This page lists the domains that are used for admin account email addresses. The date and time they were added are also provided.
- You can click the drop-down next to Show to specify the number of domain names to show per page. The default value is 10.
- You can use the Search box to search for a domain name.
ADD DOMAIN NAME
- Click Add Domain Name. The Add Domain Name dialog opens.
- Enter the name of the new domain.
- Click Add. Or, click Cancel. The new domain is added to the list of domain names.
DELETE DOMAIN NAME
- Click X in the Actions column next to the domain you want to delete. The Delete Domain Name dialog appears.
- Click Delete. Or, click Cancel. The domain is removed from the list on the Domain Names page.
Locations
This section enables you to add, edit, or delete IP and Phone locations. You can also import or export a location.
When you click on the Locations tab, the Locations page opens with the following tabs:
- IP Locations
- Phone Locations
IP LOCATIONS
When you click on the IP Locations tab, you can view a list of the IP location(s). You can add a new location or edit an existing location. You can also delete a location.
- Click the Columns drop-down to select the columns of data you want to view in the table.
- You can click the drop-down next to Show to specify the number of locations to show per page. The default value is 10.
- You can use the Search box to search for an IP location.
Add a New IP Location
- Click Add Location. The Add Location page opens.
- Enter the following information to create a new IP location:
Parameter | Description |
Network Range Type | Select the network range type from the following options using the drop-down:
|
Network | Enter the network IP address for the new location (required). |
Network Range | Enter network range for the new location (required). |
Network Range IP Start |
|
Network Range IP End |
|
Site Name* | Enter the site name for the new location, if needed. |
Region | Enter the region for the new location, if needed. |
Internal/External | Select one of the following for the new location using the drop-down: • External
|
VPN | Specify whether or not the location uses a VPN using the drop-down. |
Wired/WiFi | Select one of the following for the new location using the drop-down:
|
Network Name* | Enter the network name for the new location (required). |
Site Code | Enter the site code for the new location, if available. |
External Network |
|
External Network Range |
|
Street Address | Enter the street address of the new location. |
City/State/Zip | Enter the city, state, and zip code for the new location. |
Country | Enter the country for the new location. |
Description | Enter a description for the new location. |
Latitude | Enter the latitude of the new location (required). |
Longitude | Enter the longitude of the new location (required). |
3. Click Add. Or, click Cancel. The new IP location is added to the list of locations on the IP Locations tab.
Edit an IP Location
- Click the Edit button next to the location you want to edit. The Update Location page opens.
- Make changes to the location parameters, as needed. Based on selections, some parameters are not available to change.
- Click Save. Or, click Cancel.
Delete an IP Location
- Click the Delete button next to the location you want to delete. The Delete Location dialog opens.
- Click Delete. Or, click Cancel. The location is removed from the list of locations on the IP Locations tab.
Import an IP Location(s)
- Click the Import button. The Import Location dialog opens.
- Click Choose File to browse to the file and select it or drag the file into the box.
- Select one of the following options:
- Overwrite list
- Add items to existing list
- Click Import. Or, click Cancel. The file is imported. The locations are added to the list of locations (or will overwrite the list based on the selected option) on the IP Locations tab.
Export an IP Location
Select one of the following:
- Click Export > Export Data. A file is downloaded that contains the locations listed in the table.
- Click Export > Export Template. A locations-template file is downloaded.
PHONE LOCATIONS
When you click on the Phone Locations tab, you can view a list of the Phone location(s). You can add a new phone location or edit an existing phone location. You can also delete a phone location.
- Click the Columns drop-down to select the columns of data you want to view in the table.
- You can click the drop-down next to Show to specify the number of locations to show per page. The default value is 10.
- You can use the Search box to search for an IP location.
Add a New Phone Location
- Click Add Location. The Add Phone Locations page opens.
- Enter the following information to create a new Phone location:
Parameter | Description |
Phone Location Name | Enter a name for the phone location. |
Phone Range (From) | Enter the range (from) for the new phone location. |
Phone Range (To) | Enter the range (to) for the new phone location. |
Source | Select the source of the new phone location, such as Avaya or Cisco, using the drop-down. |
Internal/External | Select one of the following for the new location using the drop-down: • External
|
VPN | Specify whether or not the location uses a VPN using the drop-down. |
Wired/WiFi | Select one of the following for the new location using the drop-down:
|
Site Code | Enter the site code for the new location, if available. |
Site Name | Enter the site name for the new location. |
Region | Enter the region for the new location, if needed. |
Street Address | Enter the street address of the new location. |
City/State/Zip | Enter the city, state, and zip code for the new location. |
Country | Enter the country of the new phone location. |
Description | Enter a description for the new location. |
Latitude | Enter the latitude of the new location (required). |
Longitude | Enter the longitude of the new location (required). |
3. Click Add. Or, click Cancel. The new Phone location is added to the list of locations on the Phone Locations tab.
Edit a Phone Location
- Click the Edit button next to the location you want to edit. The Edit Phone Locations page opens.
- Make changes to the location parameters, as needed.
- Click Save. Or, click Cancel.
Delete a Phone Location
- Click the Delete button next to the location you want to delete. The Delete Location dialog opens.
- Click Delete. Or, click Cancel. The location is removed from the list of locations on the Phone Locations tab.
Import a Phone Location
- Click the Import button. The Import Location dialog opens.
- Click Choose File to browse to the file and select it or drag the file into the box.
- Select oneof the following options:
- Overwrite list
- Add items to existing list
- Click Import. Or, click Cancel. The file is imported. The locations are added to the list of locations (or will overwrite the list based on the selected option) on the Phone Locations tab.
Export a Export Location(s)
Select one of the following:
- Click Export > Export Data. A file is downloaded that contains the phone locations listed in the table.
- Click Export > Export Template. A phone-locations-template file is downloaded.
Roles
This page provides a list of user roles, descriptions, and the number of users assigned to that role. You can add a new user role or edit an existing user role. You can also delete a user role.
Click Roles in the left panel to open the Roles page.
- You can click the drop-down next to Show to specify the number of roles to show per page. The default value is 10.
- You can use the Search box to search for a user role.
ADD A NEW ROLE
- Click Add Role. The Add User Role page opens.
- Enter the following role settings.
Parameter | Description |
User Role | Enter the name of the new user role. |
Description | Enter a description of the new role. |
Sections: Call Details/ Platform | Click the check box next to each dashboard to specify where this user role has access, such as:
Call Details:
Platform:
|
| ||
Actions & Permissions: Custom Platform Configuration | Click this check box to enable the capability to create and manage custom dashboards for this user role. |
| ||
Security: Maximum Login Attempts/Lockout Time | Enter the maximum number of login attempts (per 24 hours) for this user role using the up/down arrows. The default is 10. Click the calendar icon to specify the number of minutes that pass before the user with this role is locked. The default is 00:15. |
| ||
User with this role can be only manually unlocked | Click this check box to specify that the user with this role can only be unlocked manually. |
| ||
Reporting Settings | This tab shows only when Reports is selected in Sections. Click this tab to select one of the following reporting roles for this user role:
|
| ||
| Analytics Settings | This tab shows only when Reports is selected in Sections. Click this tab to select one of the following Analytics roles for this user role:
| ||
| Reports | This section shows only when Reports is selected in Sections and the Reporting Settings tab is selected. It is used to configure the report list that is available to this user role. Click the All Reports check box to grant access to all existing and newly created system reports as soon as they appear. |
3. Click Add. Or, click Cancel. The new role is added to the list of user roles.
EDIT A ROLE
- Click the Edit button next to the role you want to edit. The Edit User Role page opens.
- Make changes to the role settings, as needed.
3. Click Save. Or, click Cancel.NoteYou cannot change the name of the user role.
DELETE A ROLE
- Click X in the Actions column next to the role you want to delete. The Delete Role dialog appears.
- Click Delete. Or, click Cancel. The user role is removed from the list on the Roles page.
SSO Configuration
Click SSO Configuration in the left panel to open the SSO Configuration page. This page consists of the following sections:
- Client’s SAML Configuration File
- Identity Provider Service Configuration
- Additional Settings
- User Roles Mapping
- Enable SSO
CLIENT’S SAML CONFIGURATION FILE
Use the generated SAML 2.0 metadata configuration file to register the Service Provider for Identity Provider. Once generated, the Nectar DXP SSO configuration file appears in this area.
- Click Regenerate Metadata to update the file.
- Click Download File to download the file. Once downloaded, send the file to the customer to generate the IDP configuration file. This is usually done by the customer on the IDP portal.
- Click Copy to Clipboard to copy the file to the clipboard.
IDENTITY PROVIDER SERVICE CONFIGURATION
Select the configuration method and setup access to the IDP metadata input here.
- After the IDP configuration file is generated, click Upload Metadata to upload it. Browse to the file you want to upload, select it, and click Open.
- Click Export Metadata to download the IDP Metadata file.
ADDITIONAL SETTINGS
- Enter the IDP attribute name.
- The customer needs to provide this information and can refer to the IDP documentation for this information.
USER ROLES MAPPING
- Use Tenant User Role and External User Role drop-downs to map the Nectar DXP user roles to the customer’s user groups.
For example, the Administrator role (defined in ADMIN > Roles) is mapped to the following external group:
- Multiple Nectar DXP roles can be assigned to the same customer user group or vice versa.
- Recursive group checking is supported.
- Click Role Mapping to add additional role mapping.
ENABLE SSO
To enable SSO for the tenant, check the Enable SSO Login box.
SSO is enabled. Tenant external users are able to log in to Nectar DXP with SSO.
SSO UPDATE
Click UPDATEto save any changes.
Tenant Variables
Click Tenant Variables in the left panel to open the Tenant Variables page. This page provides a list of any defined tenant variables, such as SMS Gateway, and attributes. You can edit an existing variable or attribute.
EDIT SMS GATEWAY
- Click the Edit button next to the variable/gateway you want to edit.
The Configure SMS Gateway dialog opens.
- Make changes to the domain name, as needed.
- Click Save. Or, click Cancel.
EDIT ATTRIBUTES
- Click the Edit button next to the attribute you want to edit. The Edit Attribute Value dialog opens.
- Select the visibility mode (On or Off) for this attribute.
- Click Save. Or, click Cancel.
User Mapping
This section enables you to edit or delete endpoints, WebRTC, and Jabra user mappings. You can also bulk update the lists of endpoints and WebRTC user mappings. When you click on this tab, the User Mapping page opens with the following tabs:
- Endpoints
- Webrtc
- Jabra
These are explained in the following sections.
ENDPOINTS
When you click on the Endpoints tab, you can view a list of endpoints mappings. You can edit or delete an endpoint mapping. You can also use Bulk Update to update endpoints mappings.You can also export endpoint mappings or template information.
- Click the Columns drop-down to select the columns of data you want to view in the table.
- You can click the drop-down next to Show to specify the number of endpoints mappings to show per page. The default value is 10.
- You can use the Search box to search for an endpoint mapping.
Edit an Endpoint Mapping
- Click the Edit button next to the endpoint mapping you want to edit. The Edit Endpoint page opens.
- Make changes to the parameters, as needed. Note:You cannot change the Endpoint Name, UUID, or IP Address.
- Click Save. Or, click Cancel.
Delete an Endpoint Mapping
- Click the Delete button next to the endpoint mapping you want to delete. The Delete Endpoint dialog opens.
- Click Delete. Or, click Cancel. The endpoint is removed from the list of endpoints on the Endpoints tab.
Bulk Update Endpoint Mappings
- Click the Bulk Update button. The Bulk Update dialog opens.
- Drag a file into the box or click Choose Fileand browse to the file and select it. Note:Only UUID, Username, Endpoint Type will be validated and used for update.
- Click Update. Or, click Cancel.
Export an Endpoint Mapping
Select one of the following:
- Click Export > Export Data. A file is downloaded that contains the endpoints mappings listed in the table.
- Click Export > Export Template. An endpoints-template file is downloaded.
WEBRTC
When you click on the WebRTC tab, you can view a list of WebRTC user mappings, login information, IP addresses, platform information, etc. You can edit or delete a user mapping. You can also use Bulk Update to update user mapping data.You can also export WebRTC mappings or template information.
- Click the Columns drop-down to select the columns of data you want to view in the table.
- You can click the drop-down next to Show to specify the number of WebRTC mappings to show per page. The default value is 10.
- You can use the Search box to search for a WebRTC mapping.
Edit a WebRTC User Mapping
- Click the Edit button next to the WebRTC user mapping you want to edit. The Edit User page opens.
- Make changes to the parameters, as needed.
3. Click Save. Or, click Cancel.Note:You cannot change the Login, External IP Address, Internal IP Address, or User Mapping Address.
Delete a WebRTC User Mapping
- Click the Delete button next to the WebRTC user mapping you want to delete. The Delete Userdialog opens.Note:You cannot delete a user mapping that is mapped.
- Click Delete. Or, click Cancel. The user mapping is removed from the list on the WebRTC tab.
Bulk Update WebRTC User Mapping
- Click the Bulk Update button. The Bulk Update dialog opens.
- Drag a file into the box or click Choose Fileand browse to the file and select it. Note:Only Login and External and Internal locations will be validated and used for update.
- Click Update. Or, click Cancel.
Export a WebRTC User Mapping
Select one of the following:
- Click Export > Export Data. A file is downloaded that contains the WebRTC user mappings listed in the table.
- Click Export > Export Template. A WebRTC-template file is downloaded.
JABRA
When you click on the Jabra tab, you can view a list of Jabra user mappings, user name, IP addresses, domain name, machine name, etc. You can edit or delete a user mapping. You can also use Bulk Update to update user mapping data.You can also export Jabra mappings or template information.
- Click the Columns drop-down to select the columns of data you want to view in the table.
- You can click the drop-down next to Show to specify the number of Jabra mappings to show per page. The default value is 10.
- You can use the Search box to search for a Jabra mapping.
Edit a Jabra User Mapping
- Click the Edit button next to the Jabra user mapping you want to edit. The Edit User page opens.
- Make changes to the parameters, as needed. Note:You cannot change the User Name, External IP Address, or Internal IP Address.
- Click Save. Or, click Cancel.
Users
Click Users in the left panel to open the Users page. This page provides a list of users and information, such as first and last name, role, and login/email for that user. You can add a new user or edit an existing user. You can also delete a user.
- Click the Columns drop-down to select the columns of data you want to view in the table.
- You can click the drop-down next to Show to specify the number of users to show per page. The default value is 10.
- You can use the Search box to search for a user.
ADD A NEW USER
1. Click Add User. The Add User page opens.
Parameter | Description |
First Name | Enter the user’s first name. |
Last Name | Enter the user’s last name. |
Role | Select a role for this user using the drop-down. |
Login | Enter the login/email address for this user. |
Set Password Manually | Click this check box, if this user can set their own password. |
Password | This parameter shows when the Set Password Manually check box is selected. Enter a password for this user. |
Confirm Password | Enter the password again to confirm. |
3. Click Add. Or, click Cancel. The new user is added to the list of users.
EDIT A USER
- Click the Edit button next to the user you want to edit. The Update User page opens.
- Make changes to the user, as needed. Note:You cannot change the Login of the user.
- Click Save. Or, click Cancel.
DELETE A USER
- Click X in the Actions column next to the user you want to delete. The Delete User dialog appears.
- Click Delete. Or, click Cancel. The user is removed from the list on the Users page.