Installation on Windows

Installation flavours

The SpringCard Companion setup package contains:

  • The SpringCard Companion Application itself,
  • The different versions of the SpringCard Companion Service,
  • The SpringCard Companion SDK,
  • The drivers for all the SpringCard devices that are supported by the SpringCard Companion.

There are 3 fully different installation flavours, and it is important for the system administrator to decide which one fits the best the organizations' software deployment policy.

Flavour #1: single user, in-profile installation

In flavour #1, the installation targets the (current) user's profile, namely C:\Users\{username}\AppData\Roaming. Nothing has to be installed in the computer's global directories (such as C:\Program Files).

The SpringCard Companion Service is launched within the user's session, as a small software (SpringCardCompanionTray.exe) that stays in Windows' bar.

Pros

  • No administrative priviledges required to deploy the application and the service,
  • Works well with roaming profiles and remote desktop architectures,
  • Installation is as easy as copying the SpringCard Companion directory into the user's profile directory, uninstallation is as easy as deleting it.

Cons

  • SpringCard Companion must be installed into the profiles of every user who needs to use it. This results in a waste of disk space in case many users are expected to use (and therefore install) SpringCard Companion.

How to perform a Flavour #1 installation ?

  • Manual setup: launch SpringCardCompanionSetup.exe and, in the first screen, select "Single user, in-profile installation".
  • Unattended setup: invoke SpringCardCompanionSetup.exe /SILENT /FLAVOUR=1.

Flavour #2 : shared installation (all users), no background service

In flavour #2, the installation targets the computer's application directory, namely C:\Program Files. Only the data files created by the user are to be stored in his profile.

The SpringCard Companion Service is launched within the user's session, as a small software (SpringCardCompanionTray.exe) that stays in Windows' bar.

Pros

  • SpringCard Companion is made available to all the computer's users through a single-step setup,
  • No waste of disk space.

Cons

  • Administrative priviledges are required to deploy the application and the service.

How to perform a Flavour #2 installation ?

  • Manual setup: launch SpringCardCompanionSetup.exe and, in the first screen, select "Shared installation (all users), no background service".
  • Unattended setup: invoke SpringCardCompanionSetup.exe /SILENT /FLAVOUR=2.

Flavour #3 : shared installation (all users), with background service

In flavour #3, the installation targets the computer's application directory, namely C:\Program Files. Only the data files created by the user are to be stored in his profile.

The SpringCard Companion Service is launched by the system, on startup, as a background service (SpringCardCompanionSvc.exe).

The tray software (SpringCardCompanionTray.exe) could be used by the user to interact with the service, but does not run the service code anymor. It could even be disabled,.

Pros

  • SpringCard Companion is made available to all the computer's users through a single-step setup,
  • The SpringCard Companion Service runs independently from user sessions. This prevent the user from stopping it.
  • No waste of disk space.

Cons

  • Administrative priviledges are required to deploy the application and the service.

How to perform a Flavour #3 installation ?

  • Manual setup: launch SpringCardCompanionSetup.exe and, in the first screen, select "Shared installation (all users), with background service".
  • Unattended setup: invoke SpringCardCompanionSetup.exe /SILENT /FLAVOUR=3.

Installer command-line reference

The SpringCardCompanionSetup.exe executable supports the following command-line parameters:

Flag Data Role
/SILENT none Perform an unattented installation (if possible). The installer's window remains visible during the installation.
/VERYSILENT none Perform an unattented installation (if possible). The installer's window remains hidden.
/FLAVOUR 1, 2 or 3 Installation flavour. This parameter is mandatory for an unattented installation.
/COMPONENTS a comma-separated list of components Select the components to be installed. See "components" paragraph below.
/ELEVATE none Run the setup program with admin priviledges.
/LOG none
Log file name
Create a log file in the user's TEMP directory.
Create a log file using the specified file name.

Components

Component Description
service Install the SpringCard Companion Service.
application Install the SpringCard Companion Application.
drivers Install the drivers for all the devices that are supported by SpringCard Companion.
sdk Install the documents and sample projects for developers.

If the /COMPONENTS entry is absent from the command line and the /SILENT flag is specified, default is to install all components.

Examples

Deploy only the service, as tray, for a single user

SpringCardCompanionSetup.exe /SILENT /FLAVOUR=1 /COMPONENTS="service"

Deploy the application and service, as tray, for all users

SpringCardCompanionSetup.exe /SILENT /FLAVOUR=2 /COMPONENTS="service,application"

Deploy the application for all users and the background service

SpringCardCompanionSetup.exe /SILENT /FLAVOUR=3 /COMPONENTS="service,application"

Update

Once SpringCard Companion has been installed, any execution of SpringCardCompanionSetup.exe will re-install the application (or a new version of the application) with the same flavour.

To change the flavour, 2 steps are required:

  1. Uninstall SpringCard Companion by using Windows' Control Panel "Programs and Settings" applet, or by running the Uninstall Companion utility. The existing data and settings will be preserved.
  2. Install SpringCard Companion again, choosing another flavour.