Follow the steps below to deploy the UXM Desktop Agent, software can be downloaded from here: Download Agent Software.
Please note that old EXE installer have to be uninstalled first, there is no migration path from EXE to MSI installer, the MSI installer is mainly used for new customers that haven't deployed the EXE installer via SCCM.
There are 2 different ways to deploy the agent:
- Using your corporations deployment tools like SCCM, Group Policies.
- Remote install via domain admin and psexec.
Prerequisities
Installation options
| Argument | Value |
|---|---|
|
AGENT_KEY= |
Agent Key generated when Splunk App is configured. Is used for extra security and to prevent customs on same SaaS solution to be able to access other customers data. |
| COLLECTOR= |
UXM collector url that data is send to, has to be http:// or https://, both IP and DNS can be used. HTTPs requires that you use DNS and have a valid HTTPs certificate on the Splunk server / Reverse Proxy. Use https://customername.uxmapp.com if hosted by MCG on our SaaS solution. |
| VERIFY_HTTPS= |
true: Will verify HTTPs connection and server certificate. Valid HTTPs certificate has to be installed on Splunk server / Reverse Proxy. false: Ignores HTTPs certificate warnings. |
|
|
|
|
PROXY_AUTO_DETECT= |
true: Will look through all users on the PC and use the first proxy setting it finds. false: Will use proxy settings supplied below. |
|
PROXY_SERVER= |
Proxy server |
|
PROXY_PORT= |
Proxy port |
|
PROXY_USER= |
Proxy user if proxy server requires authentication. |
|
PROXY_PASSWORD= |
Proxy password if proxy server requires authentication. |
|
PROXY_AUTOCONFIG_URL= |
JavaScript file that can return different proxy servers depending on host.
|
|
CA_CERTIFICATES_FILE= |
Path to custom ca-certificates.crt file to use, this file contains Root CA authorities. |
|
SYNCHRONIZE_EACH_MIN= |
How often new/updated profiles are downloaded from the Splunk collector server. Default is every 60 minutes, only new and updated profiles is downloaded. |
|
ENABLE_UI_PLUGIN= |
Enable Desktop UI monitoring plugin, launches PCAgentUI.exe process for each user session on the PC. (For monitoring clicks and events inside monitored programs) |
|
ENABLE_CHROME_PLUGIN= |
true: Install Chrome extension to get measurements from monitored Websites. false: Chrome extension won't be installed by UXM Desktop, you can deploy it via GPO's if your enterprise deploys Chrome extensions this way. (Recommended) |
|
ENABLE_FIREFOX_PLUGIN= |
true: Force Firefox addon to be installed to get measurements from monitored Websites. Not working since Firefox 74, see https://blog.mozilla.org/addons/2020/03/10/support-for-extension-sideloading-has-ended/ false: Firefox addon won't be installed by UXM Desktop, deploy via ESR. |
|
ENABLE_IE_PLUGIN= |
true: Installs Internet Explorer BHO addon to get measurements from monitored Websites. false: Internet Explorer addon won't be installed. |
|
FORCE_ACTIVATION= |
true: Force the Chrome extension and Firefox addon to be loaded, users won't be able to disable the plugins. false: Users will be asked to accept the extensions, see following guide on how the extensions can be forced. |
|
/i |
Specifies normal installation. |
|
/x |
Uninstalls the package. |
|
/silent |
Instructs setup to be silent, silent, will show an progress UI. |
|
/qn |
Instructs setup to install very silent where no UI or questions is asked. |
|
/norestart |
Prevents Setup from restarting the system following a successful installation, or after a Preparing to Install failure that requests a restart. |
| /l*v! "filename" |
Causes Setup to create a log file, and allows you to specify a fixed path/filename to use for the log file. |
Corporations deployment tools like SCCM, Group Policies
We don't provide support for using your own deployment tools, but can assist you in how you should push the software out and which installer arguments thats required.
You can use the installation options and generate your own installation command like the following example:
msiexec /i UXM_Desktop_Agent_YYYY.MM.DD.msi /qn /norestart /l*v! "filename" AGENT_KEY=TR32AD87 COLLECTOR=https://customername.uxmapp.com ENABLE_UI_PLUGIN=true ENABLE_CHROME_PLUGIN=false ENABLE_FIREFOX_PLUGIN=false FORCE_ACTIVATION=false
Upgrading agent to new version
The agent will reuse old settings and can be upgraded with the command:
msiexec /i UXM_Desktop_Agent_YYYY.MM.DD.msi /qn /norestart /l*v! "filename"
Append updated settings if needed.
Remote install via domain admin and psexec
Installing remotely
You can use psexec to install the program silently on a remote machine, can be used if you only need to push the agent out to a small number of machines.
psexec \\pc-hostname -u domain\adminUser -p adminPassword msiexec /i "\\networkShare\SYSVOL\domain\Software\UXM_Desktop_Agent_YYYY.MM.DD.msi" /qn /norestart AGENT_KEY=TR32AD87 COLLECTOR=https://customername.uxmapp.com ENABLE_UI_PLUGIN=true ENABLE_CHROME_PLUGIN=false ENABLE_FIREFOX_PLUGIN=false FORCE_ACTIVATION=false
A Bat/PowerShell script is attached to this article that takes a list of machines and pushes the software out to them.
Uninstalling remotely
You can execute the uninstallation program remotely, notice there is a difference between x86 and x64 bit machines.
psexec \\pc-hostname -u domain\adminUser -p adminPassword msiexec /x "\\networkShare\SYSVOL\domain\Software\UXM_Desktop_Agent_YYYY.MM.DD.msi" /qn /norestart
A Bat/PowerShell script is attached to this article that takes a list of machines and uninstalls the software from them.
Troubleshooting issues
Log files are stored under %PROGRAMDATA%\MCG\UXM PC Agent\Logs we will need these if there are any issues with the agent.
It can also be nessesary to enable debug logging, this is done by editing the files C:\Program Files\MCG\UXM Desktop Agent\PCAgent.properties and C:\Program Files\MCG\UXM Desktop Agent\PCAgentUI.properties and setting the level to debug, a restart of the UXM Desktop Agent services is needed afterwards.
