Scroll Content Block |
---|
OverviewThe Agent Desktop Native (ADN) application, supported by LiveVox U10 and later versions, is an installable application designed to enhance the agent experience by offering the following features: - Browser-independent access to the Agent Desktop
- Integrated voice through WebRTC
- Access to the screen recording feature
Desktop Native commands enablement - Enables the use of Desktop Native commands
This document provides a summary of the changes across the different releases, and instructions about how to download, install, configure, and use the Agent Desktop Native application. This document is intended for individuals who are responsible for the setup and training of contact center agents, and individuals who have access to the Agent Desktop configurations. Note |
---|
The ADN application supports Windows 8.1+, Mac OS 10.9+, and Linux Debian 8. This document provides instructions for installation on Windows and Mac systems. |
Summary of ChangesThe following table summarizes the changes to the Agent Desktop Native application across different releases. Scroll Table Layout |
---|
orientation | portrait |
---|
sortDirection | ASC |
---|
repeatTableHeaders | default |
---|
widths | 15%,15%,55%,15% |
---|
sortByColumn | 1 |
---|
tableStyling | confluence |
---|
sortEnabled | false |
---|
cellHighlighting | true |
---|
|
ADN Version | Platform Release | Changes | Release Date |
---|
7.2 | U10 | - Supports the Copy to Clipboard feature, which enables you to copy the Contact manager fields and Call Flow variables and paste them to the destination.
- Enhanced
|
keystroke - support for the Keystroke emulation sequence
|
support installation of - installing the ADN application using Group Policies (GPO) on
|
the standard windows - the standard Windows installer path.
Note |
---|
Contact your internal IT team for the Microsoft installer (MSI) package required to install the Agent Desktop Native application. |
| January 28, 2020 | 7.4 | U15 | - For ADN mass installation, you can use the MSI package
|
can be used - , which supports provisioning using config.mst and config.json files.
|
For See- go to Installing the Agent Desktop Native Application using MSI Package section in this document.
Note |
---|
Contact the LiveVox Customer Care Team for the MSI installer package required to install the Agent Desktop Native application. For contact information, go to the LiveVox Customer Care Contacts section in this document. |
- The ADN icon is now available in the System Tray.
- You can configure ADN
|
can be configured - for incoming call pop-up notifications with the U15 platform.
| December 22, 2020 | 7.5 | U16 | - Ensures ADN adheres to Whitelist IP settings as configured in the LiveVox Portal's Security tab.
- Enables you to view PDF files from links shared on the agent chat or email through ADN.
| February 10, 2021 |
noteLiveVox U10 to U15 releases work with ADN 7.6.1 | U17 | - Allows configuring notifications and ADN system tray settings.
- Security updates included in Electron from 9.3.5 to 9.4.4 (chromium v83)
| October 20, 2021 |
Platform Release | ADN Version |
---|
U10, U11, U12 | ADN 7.3 | U13 | ADN 7.3, ADN 7.6.1, or later versions | U15, U17 | ADN 7.6.1 or later versions |
Note |
---|
Before upgrading to the platform release, ensure that you have upgraded your ADN version according to the above ADN Compatibility with Platform Release table. |
Downloading and Installing the ADN ApplicationYou can download the ADN application v7.6.1 on the agent’s station either through the LiveVox portal, Agent Sign In page, or by contacting the LiveVox Customer Care Team. Note |
---|
Due to limitations of the AppImage portable packaging system, you cannot use the auto-upgrade feature in Linux. This issue will be fixed in upcoming versions. |
Scroll Content Block |
---|
Downloading the ADN ApplicationLiveVox Portal To download the Agent Desktop Native application through the LiveVox portal: - Log in to the LiveVox portal with an account that has administrator privileges and navigate to Configure > Agents > Agent Desktop > Desktop Native tab.
- Scroll down to the Desktop Native Commands section and click a platform (Windows, Mac, or Linux) for which you want to download the ADN application.
Image Added
|
Scroll Content Block |
---|
Agent Sign In PageTo download the ADN application through the Agent Sign-In page, navigate to the Agent Sign-In page, sign in with your credentials, and then click the Get The App link. Image Added Note |
---|
Your browser automatically detects the correct download file for your operating system. |
|
Installing ADN Application on WindowsTo install the ADN application on a Windows system, follow the procedure below: - Run the agent-desktop-native-<version>.exe file to launch the installer. The following message appears.
Image Added - Click the Yes button to begin the installation process. An Agent Desktop Native Setup window appears.
Image Added - The application is installed on the local machine. You can launch the ADN application from the applications folder, or the icon placed on the desktop.Image Added
Installing ADN Application Using the MSI PackageFor ADN mass installation, you can use the MSI installer package, which supports provisioning using the config.mst and config.json files. Note |
---|
- This is applicable only to the Windows platform.
- Contact the Customer Care Team for the MSI installer package required to install the Agent Desktop Native application. For contact information, go to the LiveVox Customer Care Contacts section in this document.
|
- Copy the Microsoft installer package ADN 7.6.1.msi and config.mst file to the specific folder. For Example, C:\temp\ADNInstall\
- Create the config.json file using Notepad in the same folder with the following contents. Update the Value field with your appropriate Client code.
{"clientCode":"Value"} - Open the Windows command prompt and go to the MSI package directory. For example, cd C:\temp\ADNInstall\
- Execute the following command:
msiexec /i agent-desktop-native-7.6.1.msi TRANSFORMS=config.mst
Info |
---|
After the successful installation, the config.json file is available at the following locations depending on the installation method: If the MSI or the EXE is executed by clicking the installer, the config.json is available in the user folder. For example, C:\Users\username\AppData\Roaming\Agent Desktop Native If the MSI installer is executed by a command running as admin and passing the config.mst file, the config.json is available at system level. For example, C:\Program Files\Agent Desktop Native
|
Note |
---|
When upgrading the ADN version, the installation works as below: - The EXE installer removes the previous EXE installation.
- The MSI installer removes any previous installation.
- The EXE installer doesn't remove the previous MSI installation. The upgrade process with ask/force strategy uses the EXE installation in the CDN (Content Delivery Network). If you try to use an EXE installer to upgrade an ADN version installed using an MSI installer, the following message appears:
Image Added
|
Scroll Content Block |
---|
Installing an ADN Application on a Mac - After downloading the ADN application, run the .pkg file to launch the installer.
- Follow the installation on-screen instructions to complete the installation process.
Image Added After the installation process is complete, launch the ADN application from the applications folder.
|
Configuring the ADN Application You can configure the Agent Desktop Native settings on the Configure tab of the LiveVox portal. Log in to the LiveVox portal with an account that has administrator privileges and navigate to Configure > Agents > Agent Desktop > Desktop Native. On the LiveVox U10 platform and above versions, the Desktop Native tab is available by default in the Agent Desktop screen of the LiveVox admin portal. - Click the Associated Entities tab and ensure that the selected desktop is associated with the service to which the agent must log in. You can configure the association in the Client or Service editor.
Image Added - On the Desktop Native tab, ensure that the Native Mode is set to Optional or Required. The Native Mode drop-down menu has the following options:
- Disabled: Agent cannot log in using ADN.
- Optional: Agent can use the browser or ADN to log in.
- Required: Agent can log in only using ADN.
Image Added
- Choose an Update Strategy to define the version of the Agent Desktop Native application:
- Ok: No restriction to use any version of ADN.
- Ask: If an agent has a different version installed than the one configured for the site, a pop-up window prompting an update appears. An update notification appears after the agent logs in to the Agent Desktop Native application and selects a service.
Image Added - Force: After login, the update process installs and starts the new version without intervention. The update automatically launches when an agent logs in to the Agent Desktop Native application and selects a service.
Image Added
- Set Whitelist Addresses to define trusted domains. If the domain is not added in the Whitelist address list, the Agent Desktop displays an error message.
Image Added
Anchor |
---|
| #WhiteList_address |
---|
| #WhiteList_address |
---|
|
Note |
---|
- By default, only the trusted LiveVox domains are listed. This mechanism blocks the loading resources that do not match the information contained on the whitelists. Click the ellipsis next to the Whitelist Addresses to open the Whitelist Addresses pop-up window that allows you to view and manage the list of all the approved addresses for the Desktop Native application.
- Add: Adds a new entry. Enter the address to be added as a whitelisted address in the Address field.
- Delete: Deletes an entry. Select the address and click the Delete button to delete an entry.
- OK: Click OK to save the changes.
- Close: Click Close to discard the changes.
For example, https://*livevox.com/**, *://www.google.com/**, https://yahoo.com/**. Image Added - Typically, when enabling access, you should create a specific top-level-domain entry, and a wildcard-subdomain entry, such as: *://yahoo.com/** , *://*.yahoo.com/**
- If you have a single-sign-on provider, you must allow access to the provider. For example, *://yourcorp.okta.com/**
- To discover what URLs need to be whitelisted, check the information in any of the BLOCKED errors that appear in the application window or the ADN logs. For more information about the ADN logs, go to the ADN Logs section of this document.
|
Scroll Content Block |
---|
Configuring the ADN Application on the Agent WorkstationLaunch the ADN application. Image Added You are prompted to configure your client code by the following message. Image Added - To copy your Client Code, go to the General tab of the Client editor.
Image Added Enter or paste your Client Code in the Agent Desktop Native-Settings window, and click the Save button. Image Added Specify your login credentials and click the Next button. Image Added Info |
---|
- You can select the Remember Me checkbox to save your Login ID for the next logins. Your password is not saved.
- You can use the Clear option to remove your entered credentials.
|
- In the Service drop-down menu, select a service to which you want to log in, and then click Sign In.
Image Added
Now, you are logged into the Agent Desktop. Depending on the selected service, you are prompted to either dial in or connect by using your computer audio using WebRTC. Image Added |
The ADN Icon in the System TrayOnce the ADN application is installed, you can see the ADN icon in the system tray as follows. This tray icon allows agents to do certain tasks even when the application is closed. Note |
---|
When an agent clicks the close (X) button in the upper right corner of the ADN application, the ADN application does not completely quit. This action only minimizes the application into the lower right corner (system tray), but retains the logon status of the agent and allows the agent to accept phone calls. |
Image Added The icon color changes depending on the agent's state. The following table shows the icons for an agent's state. Icon | Description |
---|
Image Added | Default | Image Added | Agent is in Ready state. | Image Added | Agent is in Not Ready state. | Image Added | Agent is in call. | Image Added | Agent is in Hold state. | Image Added | Agent is in Preview Dial. | Image Added | Agent is getting an inbound call. | Image Added | Agent is in Wrap Up state. | Image Added | Agent is online. | Image Added | Agent is offline. |
In addition, an icon with a red dot is displayed in an agent's tray when there is a new chat notification. For example, if an agent receives a message from another agent, then a red dot appears on the Ready state icon to indicate that there is a message waiting.Image Added When agents right click on the tray icon, they are provided with the following options: Scroll Content Block |
---|
ADN FunctionalityThe Agent Desktop Native application contains the same functionality as the Agent Desktop application on the browser. For more information, see the Agent User Guide on the User Hub. Image Added ADN LogsYou can view errors reported when performing the ADN operations at the following locations on the respective OS versions: - Windows: %USERPROFILE%\AppData\Roaming\Agent Desktop Native\logs\
- macOS: ~/Library/Logs/Agent Desktop Native/
- Linux: ~/.config/Agent Desktop Native/logs/
ADN SecurityMost of the ADN functionality is based on the Chrome and LiveVox ADN tries to adopt the latest Chrome version as early as possible. In addition to the security features of ADN adopted Chrome version and any backported bug fixes, ADN has additional layers of security as below. - At the network-access layer, ADN filters the request based on a domain-whitelist. By default, this allows only secure LiveVox pages to load into the ADN. At clients' discretion, this configuration can be expanded to include client-internal domains as well. By limiting network access in this way, it becomes much harder to attack the ADN with a drive-by exploit.
- For client-configured allowed domains, ADN severely restricts the available features such as media access, and ADN advanced APIs are disabled for all the domains except the LiveVox Agent Panel.
- ADN uses only the Chrome core features and does not use many features such as the Google Search-bar, the chrome:settings pages, the ability to install plugins/extensions, bookmark functionality, etc. So any exploits which target these features are ineffective.
3. Before upgrading to these releases, please ensure your Agent Desktop Native version is upgraded to ADN 7.3.Downloading and Installing the Agent Desktop Native Application You can download the ADN application v7.5 on the agent’s station either through the LiveVox portal, Agent Sign In page, or by contacting the LiveVox Customer Care. Team Downloading the Agent Desktop Native ApplicationLiveVox Portal To download the Agent Desktop Native application through the LiveVox portal: - Login to the LiveVox portal with an account that has administrator privileges and navigate to Configure > Agents > Agent Desktop > Desktop Native tab.
- Scroll down to the Desktop Native Commands section and choose a platform (Windows, Mac, or Linux) for which you want to download the Agent Desktop Native application.
Image Removed
Agent Sign In PageTo download the Agent Desktop Native application through the Agent Sign In page, navigate to the Agent Sign In page, sign in with your credentials, and then click the Get The App link. Image Removed Note |
---|
Your browser automatically detects the correct download file for your operating system. |
Installing the ADN Application on WindowsTo install the ADN application on a Windows system, follow the procedure below:- Run the agent-desktop-native-<version>.exe file to launch the installer. The following message appears.
Image Removed - Click the Yes button to begin the installation process. An Agent Desktop Native Setup window appears.
Image Removed - The application installs on the local machine. You can launch the Agent Desktop Native application from the applications folder, or the icon placed on the desktop.Image Removed
Installing the Agent Desktop Native Application using MSI PackageFor ADN mass installation, MSI installer package can be used which supports provisioning using config.mst and config.json files. Note |
---|
- This is applicable only to the Windows platform.
- Contact the Customer Care Team for the MSI installer package required to install the Agent Desktop Native application.
|
- Copy the Microsoft installer package ADN 7.5.msi and config.mst file to the specific folder. For Example, C:\temp\ADNInstall\
- Create the config.json file using the Notepad in the same folder with the below contents. Update the Value with your appropriate Client code.
{"clientCode":"Value"} - Open the windows cmd prompt and go the MSI package directory. For Example, cd C:\temp\ADNInstall\
- Execute the following command:
msiexec /i agent-desktop-native-7.5.0.msi TRANSFORMS=config.mst
Installing the Agent Desktop Native Application on Mac - After downloading the ADN application, run the .pkg file to launch the installer.
- Follow the installation on-screen instructions to complete the installation process.
Image Removed After the installation process is complete, launch the ADN application from the applications folder.
Configuring the ADN Application You can configure the Agent Desktop Native settings on the Configure tab of the LiveVox portal. Login to the LiveVox portal with an account that has administrator privileges and navigate to Configure > Agents > Agent Desktop > Desktop Native. On the LiveVox U10 platform and above versions, the Desktop Native tab is available by default in the Agent Desktop screen of the voice portal. - Click the Associated Entities tab and ensure that the selected desktop is associated with the service to which the agent must log in. You can configure the association in the Client or Service editor.
Image Removed - On the Desktop Native tab, ensure that the Native Mode is set to Optional or Required. The Native Mode drop-down menu has the following options:
- Disabled: Agent cannot log in using ADN
- Optional: Agent can use the browser or ADN to log in
- Required: Agent can log in only using ADN
Image Removed
- Choose an Update Strategy to define the version of the Agent Desktop Native application:
- Ok: No restriction to use any version of ADN
- Ask: If an agent has a different version installed than the one configured for the site, a pop-up prompting an update appears. An update notification appears after the agent logs in to the Agent Desktop Native application and selects a service.
Image Removed - Force: After login, the update process installs and starts the new version without intervention. The update automatically launches when an agent logs in to the Agent Desktop Native application and selects a service.
Image Removed
- Set Whitelist Addresses to define trusted domains. If the domain is not added in the Whitelist address list, the agent will be displayed with a similar error window.
Image Removed
Anchor |
---|
| #WhiteList_address | #WhiteList_address | Note |
---|
- By default, only the trusted LiveVox domains are listed. This mechanism allows blocking of all loading resources which do not match the whitelists. Click the ellipsis next to the Whitelist Addresses to open the Whitelist Addresses pop-up window that allows you to view and manage the list of all the approved addresses for the Desktop Native application.
- Add: Adds new entry. Enter the address to be added as a whitelisted address in the address field.
- Delete: Deletes an entry. Select the address and click the Delete button to delete an entry.
- Ok: Click Ok to save the changes.
- Close: Click Close to discard the changes.
For example, https://*livevox.com/**, *://www.google.com/**, https://yahoo.com/**. Image Removed - Typically, when enabling access, you will want to create a specific top-level-domain entry, and a wildcard-subdomain entry like this: *://yahoo.com/** , *://*.yahoo.com/**
- If you have a single-sign-on provider, you need to allow access to them as well. For example, *://yourcorp.okta.com/**
- You can discover what URLs need to be whitelisted is to check the details in any "BLOCKED" errors appearing in the app window or the ADN logs. For detailed information on ADN logs, see the ADN Logs section of this document.
|
Configuring ADN application on the Agent WorkstationLaunch the ADN application. Image Removed You will be prompted to configure your client code by the below message. Image Removed Info |
---|
You can set the Client Code from the settings options.- On a Windows system, go to Application > Settings.
- On a Mac system, go to Agent Desktop Native > Settings.
| Enter your Client Code. The Client Code is available on the General tab of the Client editor.Image RemovedEnter your Client Code in the Agent Desktop Native-Settings window, and click the Save button. Image RemovedSpecify your login credentials and click the Next button. Image Removed Info |
---|
- You can select the Remember Me checkbox to save your Login ID for the next logins. Your password will not be saved.
- You can use the Clear option to remove your entered credentials.
| In the Service drop-down menu, select a service to which you want to log in, and then click Sign In. Image RemovedDepending on the selected service, the agent desktop prompts you to either dial in or connect by using your computer audio via WebRTC. Image RemovedADN Icon in System TrayOnce the ADN application is installed, you can see the ADN icon in the system tray as below. This tray icon allows agents to do certain tasks even when the application is closed. Note |
---|
When an agent clicks the close (X) button in the upper right corner of the ADN application, the ADN application is not completely quit. This action only minimizes the application into the lower right corner (system tray), retaining the logon status of the agent and allowing them to accept phone calls. |
Image Removed The icon color will change depending on the agent state. The below table shows icons for different agent's states. Icon | Description |
---|
Image Removed | Default | Image Removed | Agent is in Ready state. | Image Removed | Agent is in Not Ready state. | Image Removed | Agent is in call. | Image Removed | Agent is in Hold state. | Image Removed | Agent is in Preview Dial. | Image Removed | Agent is getting the inbound call. | Image Removed | Agent is in Wrap Up state. | Image Removed | Agent is online. | Image Removed | Agent is offline. | In addition, agents are displayed the icon with a red dot when there is a new chat notification. For example, an agent is in ready state and gets a message from another agent, then the agent gets the notification and this is indicated on the ready state icon with red dot. Image Removed When agents right click on the tray icon, they are provided the below options: Ready: Allows to change the state to Ready. Not Ready: Allows to change the state to Not Ready with the specific break code.Change Service: Allows to change from one service to another available service without having to sign out or re-establish the audio path.Sign Out: Allows to sign out.Always on Top: When configured, the ADN application is kept in the foreground of all desktop applications at all times. Note |
---|
When configured with the U15 and above version, the ADN application will pop-up when minimized for new incoming voice interactions. | Open: Allows to bring the app to the foreground.Quit: Allows to close the app permanently, the tray icon also closes. Image Removed
Agent Desktop Native FunctionalityThe Agent Desktop Native application contains the same functionality as the Agent Desktop application on the browser. For more information, see the Agent User Guide on User Hub. Image RemovedADN LogsYou can view errors reported when performing the ADN operations at the following locations on the respective OS versions:- Windows: %USERPROFILE%\AppData\Roaming\Agent Desktop Native\logs\
- macOS: ~/Library/Logs/Agent Desktop Native/
- Linux: ~/.config/Agent Desktop Native/logs/
24 Hour Customer Care Line: (888) 477-3448 LiveVox Customer Care Email: customercare@livevox.com This document is an unpublished work protected by the United States copyright laws and is proprietary to LiveVox, Inc. (“LiveVox”). Disclosure, copying, reproduction, merger, translation, modification, enhancement, or use by anyone other than authorized employees, clients or licensees of LiveVox, and its affiliate companies, without the prior written consent of LiveVox, is prohibited. This document is intended as a guide to assist users of systems provided by LiveVox, and does not constitute the provision by LiveVox of any legal or compliance advice. Compliance by authorized clients or licensees of LiveVox with all applicable local, state, federal, or foreign laws and regulations is the sole responsibility of those authorized clients or licensees. Further, features and services that rely on third party performance are subject to the errors and omissions of those third parties, over which LiveVox has no control. LiveVox therefore disclaims all liability resulting from or arising out of any services supplied by or through any third-party vendor or any acts or omissions of the applicable third party vendor. Additionally, LiveVox makes no representations or warranties with respect to the accuracy of content supplied by parties other than LiveVox.
For Internal and Client Use Only |