0% found this document useful (0 votes)
69 views

Knowledge Base 3329 - What Are The Available Parameters For The ClickShare Desktop App Installer (MSI)

zb

Uploaded by

gorep26515
Copyright
© © All Rights Reserved
We take content rights seriously. If you suspect this is your content, claim it here.
Available Formats
Download as PDF, TXT or read online on Scribd
0% found this document useful (0 votes)
69 views

Knowledge Base 3329 - What Are The Available Parameters For The ClickShare Desktop App Installer (MSI)

zb

Uploaded by

gorep26515
Copyright
© © All Rights Reserved
We take content rights seriously. If you suspect this is your content, claim it here.
Available Formats
Download as PDF, TXT or read online on Scribd
You are on page 1/ 7

A typical scenario is that the IT administrator creates a Windows command script file that triggers a silent installation of the

ClickShare
Desktop App using msiexec.exe

Next to the general msiexec.exe parameters, the following ClickShare specific parameters can be passed to manage the deployment:

USER_EXP is a deployment parameter used to select a pre-configured user experience for an application. Once this experience is
chosen during deployment, it becomes fixed and cannot be changed by end users through the application's preference settings. This
ensures a consistent user interface and controlled experience across all instances of the application, preventing any customization by
the end users and maintaining uniformity throughout the application's use. For full details, click here.

Supported parameters

Accepted Available
Parameter Description
values in

ACCEPT_EULA YES Mandatory parameter

BETA_PROGRAM YES, NO Optional parameter v4.19+

Default value: YES

To control the “Beta Program” UI option


NO: NO UI option for Beta Program in the app

PRODUCT_USAGE_ANALYTICS YES, NO Optional parameter v4.13+

Default value: YES

To turn on and off “Usage Statistics”


BETA_PROGRAM will be NO when PRODUCT_USAGE_ANALYTICS is set to NO

YES, NO Optional parameter v4.15+


APP_BASED_CONFERENCING
Default value: NO

To install the driver for App Based Conferencing (Smart Meeting Flow)

VIRTUAL_AUDIO_DRIVER YES, NO Optional parameter v4.19+

Default value: NO

Use ONLY for certain laptops that have an audio issue


VIRTUAL_AUDIO_DRIVER can only be YES when
APP_BASED_CONFERENCING is set to YES

MINI, Optional parameter v4.41+


LARGE
DEFAULT_UI Default value: Not Set

To decide the UI style of the app


MINI: The UI style is Mini and the users can not switch to the Large UI style
LARGE: The UI style is Large and the users can switch to the Mini/Large UI style
Not Set: The UI style is Large and the users can switch to Mini/Large UI style.
Accepted Available
Parameter Description
values in

MINI, Optional parameter v4.35 -


LARGE v4.40
Default value: Not Set

To decide the UI style of the app


MINI: The UI style is Mini and the users can not switch to the Large UI style
LARGE: The UI style is Large and the users can switch to the Mini/Large UI style
Not Set: The UI style is the last setting or Large and the users can switch to
Mini/Large UI style.

MINI, Optional parameter v4.23 -


LARGE v4.34
Default value: Not Set

To decide the UI style of the app


MINI: The UI style is Mini and the users can not switch to the Large UI style
LARGE: The UI style is Large and the users can switch to the Mini/Large UI style
Not Set: The UI style is the last setting or Mini and the users can switch to
Mini/Large UI style.

CALENDAR_INTEGRATION YES, NO Optional parameter v4.28+

Default value: Not Set

To turn on and off “Calendar Integration” and its UI option


NO: Calendar Integration is turned OFF and the users can not see the UI option
in the app
YES: Calendar Integration is turned ON and the users can see the UI option to
turn it OFF/ON in the app
Not Set: Calendar Integration is turned OFF and the users can see the UI option
to turn it OFF/ON in the app

Starting from v4.27.2, Calendar Integration will be turned OFF whenever the App
is auto-updated.

AUTO_UPDATE YES, NO Optional parameter v4.28+

Default value: YES

To control if the app will be automatically updated or not

EXTENDED_DESKTOP YES, NO v4.31+


Optional parameter

Default value: Not Set

To install the Extended Desktop driver


NO: The Extended Desktop driver will not be installed
YES: The Extended Desktop driver will be installed
Not Set

If the extended desktop driver of Extension Pack is found, the Extended


Desktop driver will be installed and overwritten
Accepted Available
Parameter Description
values in

If the extended desktop driver of Extension Pack is not found, the


Extended Desktop driver will be not installed
Accepted Available
Parameter Description
values in

USER_EXP LUI Optional parameter V4.38+


BB
Default value: LUI
SB
SA To select a pre-configured user experience. Once the experience is chosen in the
deployment, it cannot be changed in the application preference by end users.

LUI: Experience prior to 4.37, planned to be deprecated before the end of


2024.

BB (Basic Button): Intuitive sharing experience with simplified UI flow.

It only works when using a button.


Grab peripherals with a Button in hybrid meetings and connect to
ClickShare to share your desktop.

SB (Smart Button):Advanced meeting experience with Teams and Zoom


conferencing.

It only works when using a button.


Hostflow: ClickShare automatically guides you as a host or participant.
ConferenceView: share your content and meeting participants side by
side in hybrid meetings.

SA (Smart App): Full application experience with peripheral integration.

Use ClickShare App to connect and share (local and remote).


App-based conferencing: grab the room peripherals with ClickShare App.
PresentSense: Automatically detect and seamlessly connect to ClickShare.

Depending on the USER_EXP option set, the current settings of the following
parameters will be affected:

1. When USER_EXP is set to "BB" or "SB"


CALENDAR_INTEGRATION,
APP_BASED_CONFERENCING and VIRTUAL_AUDIO_DRIVER will
set to "NO"
DEFAULT_UI will set to "LARGE"

2. When USER_EXP is set to "SA"


CALENDAR_INTEGRATION will be set to "NO",
APP_BASED_CONFERENCING and VIRTUAL_AUDIO_DRIVER will
set to "YES"
DEFAULT_UI will set to "LARGE"

3. When USER_EXP is set to "LUI"


The current settings for CALENDAR_INTEGRATION,
APP_BASED_CONFERENCING, VIRTUAL_AUDIO_DRIVER and
DEFAULT_UI will remain unchanged. Nevertheless, the users will
still be able to modify these parameters by using the available
values for them.
Accepted Available
Parameter Description
values in

TARGETDIR Valid [This parameter is deprecated in V4.28 and onwards] v4.4 -


directory v4.27.2
Optional parameter

Default value : C:\ClickShareApp

The following directories are not allowed:


C:\Program Files, C:\Program Files
(x86), C:\ProgramData, C:\Users, C:\Windows, C:\Recovery, C:\OneDriveTemp

Features of User_Exp

Installation Desktop app Not Installed Desktop app installed with MSI (4.38+)

Basic Smart Smart


App Type Button App (v4.38+) Button App(~v4.37) Legacy
Button Button App

No No No
Yes Yes Yes
UI Mode (Switch Toggle) New New New
New (Large)/Old(Small) New (Large)/Old(Small) (Large) (Large) (Large) New (Large)/Old(Small)
only only only

With
With With Both
With Both App and
Work Mode with Button only with Button only Button Button App
Button
Only Only and
Button

Smart meeting flow No No No Yes Yes Yes

Yes
APP_BASED_CONFERENCING
No No No No Yes (can be turned on/off
DRIVER
with option)

Yes

(can be
Yes
turned
PresentSense No No No No on/off (can be turned on/off
with with app UI setting)
app UI
setting)

Command line examples:

# Normal installation
msiexec.exe /i ClickShare_Installer.msi /qn ACCEPT_EULA=YES
# Disable usage analytics
msiexec.exe /i ClickShare_Installer.msi /qn ACCEPT_EULA=YES PRODUCT_USAGE_ANALYTICS=NO

# Install to non-default path


msiexec.exe /i ClickShare_Installer.msi /qn ACCEPT_EULA=YES TARGETDIR=D:\CSApp

# Normal installation + install the App-based Conferencing drivers


msiexec.exe /i ClickShare_Installer.msi /qn ACCEPT_EULA=YES APP_BASED_CONFERENCING=YES

# Installation with disabling Beta Program


msiexec.exe /i ClickShare_Installer.msi /qn ACCEPT_EULA=YES BETA_PROGRAM=NO

# Installation with Mini UI


msiexec.exe /i ClickShare_Installer.msi /qn ACCEPT_EULA=YES DEFAULT_UI=MINI

# Installation with disabling Calendar Integration


msiexec.exe /i ClickShare_Installer.msi /qn ACCEPT_EULA=YES CALENDAR_INTEGRATION=NO

# Installation with disabling Auto Update


msiexec.exe /i ClickShare_Installer.msi /qn ACCEPT_EULA=YES AUTO_UPDATE=NO

# Installation with Extended Desktop Driver


msiexec.exe /i ClickShare_Installer.msi /qn ACCEPT_EULA=YES EXTENDED_DESKTOP=YES

# Enable Basic Button experience


msiexec.exe /i ClickShare_Installer.msi /qn ACCEPT_EULA=YES USER_EXP=BB

# Enable Smart Button experience


msiexec.exe /i ClickShare_Installer.msi /qn ACCEPT_EULA=YES USER_EXP=SB

# Enable Smart App experience


msiexec.exe /i ClickShare_Installer.msi /qn ACCEPT_EULA=YES USER_EXP=SA

# Enable Legacy UI experience


msiexec.exe /i ClickShare_Installer.msi /qn ACCEPT_EULA=YES USER_EXP=LUI

Info! If you see api.amplitude.com being rejected by your firewall or proxy, this is the statistics engine of the client attempting to
upload anonymous usage information. It can be disabled individually per client or system-wide with
the PRODUCT_USAGE_ANALYTICS=NO switch. The installed client may need to be deleted from the system(s) before installing the
MSI again. The latest client performs a complete uninstall before re-installing the client - If the original driver was in use by the OS
during the MSI installation, the PC will need to be rebooted to reload the HIVE.

See the following KB articles for information on how to install the MSI file through Windows Command Scripts.

Version 4.27.2 and lower (how to: KB 2531)


Version 4.28 and higher (how to: KB 8156)

Troubleshooting tips:

If there are any issues, it is possible to create a .txt file including the detailed log of the MSI deployment. To do so browse to the folder
where the ClickShare Desktop App msi file is stored and use command:
msiexec.exe /i ClickShare_Installer.msi /qn ACCEPT_EULA=YES EXTENDED_DESKTOP=YES
CALENDAR_INTEGRATION=NO APP_BASED_CONFERENCING=YES DEFAULT_UI=MINI /L*v .\toto.txt

This will create a log file called "ilog.txt" in the current working directory with the detailed Windows Installer Package logs. See KB 2149 for
details.

You might also like