Run-time Environment for Windows

The following options are available for distributing Sentinel LDK Run-time Environment for Windows operating systems:

>Integrate installation of the Sentinel LDK Run-time Environment into your application’s installer using either of the two options below:

•Sentinel LDK Run-time Environment Merge module

•Sentinel LDK Run-time Environment Installation API

>Deliver either of the following Sentinel LDK Run-time Environment installation utilities to your end users:

•HASPUserSetup.exe: A GUI-based installer

•haspdinst.exe: A command-line utility

NOTE Thales recommends that you not enable end users to mix the use of the HASPUserSetup.exe and haspdinst.exe utilities. Deliver only one of these utiliites to end users.

Each of these methods is described in greater detail in the topics that follow.

Sentinel LDK Run-time Environment Merge Module

The Sentinel LDK Run-time Environment installation is available as a merge module, in the file haspds.msm. You can use the merge module to seamlessly integrate the Sentinel LDK Run-time Environment installation in your MSI installation. Merge modules deliver shared Windows Installer components, code, files, resources, registry entries and setup logic in a single, composite file.

NOTE The haspds.msm merge module cannot be run as a standalone application.

When integrated with your MSI installer, the haspds.msm merge module copies the haspds_windows.dll into the Win32 system directory of the end user’s computer. The haspds_windows.dll is called by the MSI module to install or uninstall the Sentinel LDK Run-time Environment.

The benefits of using the Sentinel LDK installation merge modules in a single unified MSI installer include:

>Providing end users with a single, compound file for your application that includes the Sentinel LDK Run-time Environment installation

>Installation self-repair provided by reusing the MSI installer

A demonstration of the use of the haspds.msm merge module is provided. For more information, see Sample Merge Module Installer.

Implementation Requirements

Before including the Sentinel LDK merge module in your installer, review the following requirements:

>The Sentinel LDK merge module require Windows Installer version 2.0 or later.

>To successfully execute the Run-time Environment installation, end users require administrator rights. Ensure that this is accounted for in your installation scripts.

>Processes that require the Sentinel LDK Run-time Environment should not be active in the background when installing the Run-time Environment.

>Before validating the WSM module, change the project properties to relate to your specific development environment.

>If you intend to apply a digital signature to your installer, ensure that you first adjust the properties in your development environment.

>Before compiling the MSI project, change the path to external files to match your development environment

Implementation of Sentinel LDK Merge Modules

Implementation of Sentinel LDK merge modules is a straightforward process that simply requires you to add the .msm file containing the Run-time Environment installation to your MSI-compliant installer setup. After you have created your MSI installer, the wrapped file automatically includes the Sentinel LDK installation merge module.

The haspds.msm merge module can be found in:

%ProgramFiles(x86)%\Thales\Sentinel LDK\API\RuntimeInstall\MSI

NOTE

>Do not alter the versioning data in the default merge module or in the MSI DLL sample.

>Do not alter any entity in the default merge module.

>When the Run-time Environment is already installed on a target machine:

•If you install a version of haspds_windows.dll that is newer than the already-installed haspds_windows.dll, the installed DLL will be replaced with the new one.

•If a new version of haspds_windows.dll is the same as the previous version, the file timestamp will be compared. If the version of the DLL that is being installed is equal to or older than the existing haspds_windows.dll, the DLL will not be replaced.

In any event, the haspds_windows.dll will be executed.

Sample Merge Module Installer

A sample MSI installer containing the Sentinel LDK merge module is provided and should be reviewed before implementing the haspds.msm merge module into your own installer.

The sample installer is a full MSI-installer containing the Sentinel LDK Run-time Environment installation merge module and the required shared libraries for installing the Run-time Environment.

The sample installer does the following:

>Verifies that the user has the required administrator rights to install the Run-time Environment

>Stops a running Sentinel License Manager service before the Run-time Environment is installed, and re-starts the service after the installation is complete.

>Installs or removes Run-time Environment

The sample installer can be found in:

%ProgramFiles(x86)%\Thales\Sentinel LDK\Samples\RuntimeInstall\MSI

Before attempting to try the sample installer, review the following requirements:

>Administrator rights are generally required in order to install the Driver sample. However, it is possible for a restricted user to install the Driver. For more information, see Microsoft Support Knowledge Base article # 259459 (http://support.microsoft.com/kb/259459/en-us).

>You must change the resource path to your own environment in the project files (*.wsi, *.wsm) in order to successfully compile the samples.

NOTE You can incorporate a branded DLL into the sample by replacing the name of the demo DLL with the name of the branded DLL.

Sentinel LDK Run-time Environment Installer API

Use the Sentinel LDK Run-time Environment installer API to integrate the installation process into your custom setup application. For additional information, see Sentinel LDK RTE Installer API Reference.

haspdinst.exe

haspdinst.exe is a command-line utility that installs the Sentinel LDK Run-time Environment. Following the installation of Sentinel Vendor Suite, the file is located in:

%ProgramFiles(x86)%\Thales\Sentinel LDK\Redistribute\Runtime Environment\cmd Install

You can distribute this standalone application to your end users.

To install the Sentinel LDK Run-time Environment using haspdinst.exe:

>At the command-line prompt, type haspdinst -i.

For more information and a full list of the available switches for the haspdinst.exe utility, see the Sentinel LDK Installation Guide.

HASPUserSetup.exe

HASPUserSetup.exe is a GUI-based installation program to independently install the Sentinel LDK Run-time Environment. Following installation of Sentinel Vendor Suite, the file is located in:

%ProgramFiles(x86)%\Thales\Sentinel LDK\Redistribute\Runtime Environment\Setup

This easy-to-use program has an intuitive GUI-based wizard. After your end users run the file, they should follow the on-screen instructions to complete the Run-time Environment installation.

After the successful execution of HASPUserSetup.exe, an entry is generated in Program and Features in the Windows Control Panel.