Prodotti

What are the available parameters for the ClickShare Desktop App installer (MSI)

Numero articolo: [3329] - Codice legacy: [12000]

Applicabile a

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

ParameterAccepted valuesDescriptionAvailable in

ACCEPT_EULA

YES

Mandatory parameter

 

BETA_PROGRAM

YES, NO

Optional parameter

Default value: YES

To control the “Beta Program” UI option
NO: NO UI option for Beta Program in the app

v4.19+

PRODUCT_USAGE_ANALYTICS

 

YES, NO

 

Optional parameter

Default value: YES

To turn on and off “Usage Statistics”
BETA_PROGRAM will be NO when PRODUCT_USAGE_ANALYTICS is set to NO

v4.13+

APP_BASED_CONFERENCING

YES, NO

Optional parameter

Default value: NO

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

v4.15+

VIRTUAL_AUDIO_DRIVER

YES, NO

Optional parameter

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

v4.19+

DEFAULT_UI


 

MINI, LARGE

Optional parameter

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.

v4.35+

MINI, LARGE

Optional parameter

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.

v4.23 - v4.34

CALENDAR_INTEGRATION

YES, NO

Optional parameter

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.

v4.28+

AUTO_UPDATE

YES, NO

Optional parameter

Default value: YES

To control if the app will be automatically updated or not

v4.28+

EXTENDED_DESKTOPYES, NO

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
  • If the extended desktop driver of Extension Pack is not found, the Extended Desktop driver will be not installed 
v4.31+

USER_EXP

LUI
BB
SB
SA

Optional parameter

Default value: LUI

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"

V4.38+

TARGETDIR

 

Valid directory

 

[This parameter is deprecated in V4.28 and onwards]

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

v4.4 - v4.27.2

 

Features of User_Exp

InstallationDesktop app Not InstalledDesktop app installed with MSI (4.38+)
App TypeButton App (v4.38+)Button App(~v4.37)Basic ButtonSmart ButtonSmart AppLegacy
UI Mode (Switch Toggle)

Yes

New (Large)/Old(Small)

Yes

New (Large)/Old(Small)

No

New (Large) only

No

New (Large) only

No

New (Large) only

Yes

New (Large)/Old(Small)

Work Modewith Button onlywith Button onlyWith Button OnlyWith Button OnlyWith Both App and ButtonWith Both App and Button
Smart meeting flowNoNoNoYesYesYes
APP_BASED_CONFERENCING DRIVERNoNoNoNoYes

Yes

(can be turned on/off with option)

PresentSenseNoNoNoNo

Yes

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

Yes

(can be turned on/off with 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.

Proprietà

Ultimo aggiornamento 30 mag 2024