Comtarsia Logon Client 7.0 Software Distribution

Version: 18 July 2025

Introduction

This document describes the steps necessary for customization and creating an automatic installation package of the Comtarsia Logon Client 2016.

To create the Microsoft Windows Installer transforms, any software capable of creating such files can be used, e.g. Microsoft Orca from the Windows SDK/MSI tools (http://msdn.microsoft.com/en-us/library/windows/desktop/aa370557(v=vs.85).aspx)) or InstEd (http://www.instedit.com/).

Microsoft Windows Installer transform files contain changes which should be applied to an MSI file during installation by the Microsoft Windows Installer.


Prerequisite

The prerequisite for this document is a fully configured and tested master system.

1. Temporary Folder

A temporary folder must be created in which all required files can be stored. Example: c:\sos

2. Logon Client configuration

Each Logon Client configuration profile must be exported to a reg file.

Export: HKEY_LOCAL_MACHINE\SOFTWARE\Comtarsia\SOSProfile 001 -> LCConfig_SOSProfile001.reg

image002

The Regfile must be stored in the temporary folder (2.1).

3. License Key

The license key configuration must be exported to a reg file.

To do this, export the Registry key HKEY_LOCAL_MACHINE\SOFTWARE\Comtarsia\SignOn Solutions 2016\LicenceKeys:

After the export, open the registry file.

image003

The Attribute “003” defines the license key file, which must be copied to the temporary folder (2.1).

In case an attribute “003a” exists, the value must be set to “AUTO_ACTIVATE”.

Delete all another attribute “003s” if it exists.

Example:

[HKEY_LOCAL_MACHINE\SOFTWARE\Comtarsia\SignOn Solutions 2016\LicenceKeys]
"003"="99999-8889000.key003"
"003a"="AUTO_ACTIVATE”

Save the registry in a file named “LCConfig_LicenseKey.reg” and copy it to the temporary folder (2.1).

4. Panel Bitmap (Optional)

If an individual panel bitmap is defined in the profile, the Bitmap must also be copied to the temporary folder.

Example: [HKEY_LOCAL_MACHINE\SOFTWARE\Comtarsia\SOSProfile 001\LogonClient] "panelBitmap"="C:\\CLC_2016_192x192.bmp"

5. Custom SSL certificates (Optional)

If custom SSL certificates are defined in the profile, all the files must also be copied to the temporary folder.

image004

Example:

[HKEY_LOCAL_MACHINE\SOFTWARE\Comtarsia\SOSProfile 001\SyncClient] "tlsCAFile"="C:\\Program Files\\Comtarsia\\SignOn Solutions 2016\\cert\\ca_cust.cer" "tlsCertFile"="C:\\Program Files\\Comtarsia\\SignOn Solutions 2016\\cert\\client_cust.cer" "tlsKeyFile"="C:\\Program Files\\Comtarsia\\SignOn Solutions 2016\\cert\\client_cust.key"


6. The Logon Client MSI Package

The Logon Client MSI packages can be extracted from the SignOn Solutions 2016 bundle installer. First, download the SignOn Solutions 2016 bundle from the Comtarsia website: https://signon.comtarsia.com/main/en/Download

Then execute the package. After accepting the license term, the following page is shown:

TODO

image005

By pressing the “Export MSI” button, all the SignOn Solutions MSI files are extracted to a folder.

TODO

image006

The files Setup_lc_70_x64.msi and Setup_lc_70_x86.msi are the Logon Client MSI packages. Copy them to the temporary folder (2.1).


Create the MSI Transform

The temporary directory (2.1) created before should now contains all necessary files.

image007

Open any of the Comtarsia Logon Client MSI files with InstEd.

image008

Select “Transform > New Transform” to create a new “.mst”-file.

image009

Choose an appropriate file name for the new transform (e.g. “LCConfig_SOSProfile001.mst”).

Switch to the “Components” view on the left side, then right-click onto the “ComtRPCSrv.exe” component and select “Import .reg file”.

image010

Select the registry file that contains a tested Comtarsia Logon Client configuration.

image011

Do the same again for the registry file “LCConfig_LicenseKey.reg” which contains the license key configuration.

This will assign all the values of the selected registry files to the selected component. The added registry settings can be reviewed in the “Registry” table.

image012

Switch to the “Media” table and add a new row:

image013

Set the following values:

image014

The “LastSequence” number is unique and starts at the “LastSequence” number from the previous cab-file. In this example, 4 files will be added, one license key and 3 certificates. Since the previous “LastSequence” number is 13, it has to be set to 17.


Change to the “Directory” table and add a new row with these values:

image015

Afterwards, the “Directory” tables looks like this:

image016

Change to the “Component” table and add a new row:

image017

The “ComponentId” can be automatically created by clicking into the field and then pressing the little asterisk button to the right.

Change to the “File” table and add a new row:

image018

Afterwards, the “File” table look like this:

image019

Now the certificates are added: Add a new component to the “Component” table:

image020

Now the “Component” table look like this:

image021

Switch to the “File” table, and add three rows for the three certificate files:

image022 image023 image024

Afterwards, the “File” table looks like this:

image025

Go to the “Media” table, select the previously added row, right-click and select “Show ddf”:

image026

This will show the definitions used to build the cab-file. These definitions are automatically generated based on the “Sequence”-numbers, the defined files and the “LastSequence”-numbers of the cab file definition.

Since the files we defined don’t exist in the appropriate directories yet, this will give the following error.

The error message shows us where it expects the defined files:

image027

The license key fill be expected in:

C:\sos\PlatformProgramFilesFolder\Comtarsia\SignOn Solutions 2016\key\99999-8889000.key003

The certificates should be here:

C:\sos\PlatformProgramFilesFolder\Comtarsia\SignOn Solutions 2016\cert\ca_cust.cer
C:\sos\PlatformProgramFilesFolder\Comtarsia\SignOn Solutions 2016\cert\client_cust.cer
C:\sos\PlatformProgramFilesFolder\Comtarsia\SignOn Solutions 2016\cert\client_cust.key

Create these directories and copy the appropriate files to them.

When you select “Show ddf” again, no more error is shown:

image028

Right-click onto the cab-file row again, then click on “Rebuild selected CABs”.

This will create a new cab-file in the working directory (LCCustomerFiles.cab) and update “File” and “MsiFileHash” table entries.

image029

Switch to the “FeatureComponents” table and add two new rows. Enter the following values to bind the newly created components to the LC feature:

image030 image031

The resulting “FeatureComponents” table:

image032

Save the LCCustomerFiles.mst

image033

Accept the upcoming dialog with “OK”.

image034

Manual installation with MSIEXEC

It is possible to install the Comtarsia Logon Client 7.0MSI together with the prepared MSI transform via the command line.

The install transform (mst) should contain all customer specific files (licence key, certificates, customized images) and registry values needed for the Comtarsia Logon Client.

To install/update/uninstall the packages manually, the “msiexec” command is used.

For a first test of the newly created mst file you can omit the “/q” parameter, to see exactly what happens.

The following parameters will be used:

/i “path to msi” Installs the specified MSI file.

/l*v c:\lcinstall.log Enables verbose logging of the MSI installation and appends the output to the file specified.

/q Enables silent installation without user input.

TRANSFORMS=”transform1.mst;transform2.mst” Specifies a list of transforms to be applied to the MSI file during installation. The list of files is separated by semicolons.

REINSTALL=ALL REINSTALLMODE=vamus Tells msiexec to reinstall (update) the product

/x “path to msi” Uninstalls the specified MSI file.

/norestart This parameter can be optionally added to prevent the installer from automatically restarting the computer.

A detailed description of all msiexec command line parameters can be found here: http://technet.microsoft.com/en-us/library/cc759262(v=ws.10).aspx

TODO

Initial install:

msiexec /i Setup_lc_70_x64.msi /q /l*v lcinstall.log TRANSFORMS="LCConfig.mst"

Update:

msiexec /i Setup_lc_70_x64.msi /q /l*v lcinstall.log TRANSFORMS="LCConfig.mst" REINSTALL=ALL REINSTALLMODE=vamus

Uninstall:

msiexec /x Setup_lc_70_x64.msi