Ecrin v4.30 Doc v4.30.

02 - KAPPA 1988-2013

Installation 1/12

Installation

For most users, installation will just mean starting the setup program from the download
directory, answer the questions asked by the setup procedure, and get the program up and
running. However the combinations of operating systems and protection systems may make
the installation procedure more complex. This chapter was written to be a technical reference
and cover all combinations.

A. Definitions
Protections

Local protection: A local protection can be either a Flexlm license or a hard key
connected to either the parallel or USB port of the user computer. In case of Flexlm
license, the license is dedicated to one machine and cannot be installed on another
computer. Concerning the hard key, the KAPPA software can only be executed on the
computer where the key is plugged but the key can be plugged on any machine. A driver
needs to be installed in order to check the key.
WARNING:
You need to have the administrator privileges to install these drivers. 95% of the
reported failures to install these drivers come from insufficient privileges.
It is possible to connect a printer to the parallel key but some printers will make a
short circuit of the parallel port when turned off. If the software does not find the key,
turn the printer on or disconnect it.

Network protection means that, at run time, the program checks the presence and the
validity of a license over the network. Network protection is designed to provide several
simultaneous users. The licenses are managed by a license server, which is not necessarily
installed on the network file server. The protection is managed by software through a
license file located on the machine running the licenses server.

Installation
We support Windows XP PRO SP2/2003/Vista/Windows 7/Windows Server 2008, 32 & 64-bits.
If you encounter problems when launching the installation package, please refer to the
Troubleshooting installation guidelines, section H.
The software will be physically stored and executed from the user computer hard disk. The
installation is described in Section B.

Ecrin v4.30 Doc v4.30.02 - KAPPA 1988-2013

Installation 2/12

Major release and intermediate upgrade

As a KAPPA user, you will be dealing with two distinct types of product distributions: major
releases and intermediate upgrades. A major release corresponds to a significant amount of
improvements for a particular software, both in terms of technical content and software.
Examples of major releases are Saphir v4.20, and Emeraude v2.60. Each release in turn has
its own evolution, mirrored by a number of intermediate upgrades for minor additions and bug
fixes. Upgrades are identified by two-digit numbers, appended on the release name, e.g. Ecrin
v4.20.03 or Emeraude v2.60.06. Installing the first version of a given release is like installing a
brand new product. Installing an upgrade of an already installed release will upgrade the
installation and replace the previous contents.

B. Installation procedure
Run the SETUP.EXE program.
The installation program starts. To run the software with a protection hard key, drivers have to
be installed and they are normally installed automatically. In some instances, you may have to
install the driver manually, see Sections D and E for USB keys and Section F for parallel keys.
A welcome screen and a license agreement screen are displayed. Click on Next to continue.
The next dialog requests the type of protection: select your option.
Note that if you are running a Windows 64-bit system, the parallel port option will
be disabled as we do not support 64-bit systems for parallel keys.
Furthermore, do not connect your hard key unless the software installation is complete.

Protection type
If the FlexLM network protection has been chosen, the dialog below (left) is displayed and the
user is asked for the host name of the FlexLM license workstation in the following format:
@hostname, or port@hostname. If unknown at the time of the installation, the server may
be specified later under the Licenses tab of the Ecrin Settings Application dialog.

Ecrin v4.30 Doc v4.30.02 - KAPPA 1988-2013

FlexLM Server Name

Installation 3/12

Ecrin module selection

The next dialog (above, right) is used to select the Ecrin modules. Each module can be
enabled, set to reader, or disabled. If a module is enabled (and provided you have a valid
license) you will be able to create/edit documents for that module. With a module in reader
mode, you can only open existing documents; you can drag-and-drop elements from those
documents, but you cannot make any changes.
Note that Ecrin takes the licenses when it is launched, so if you are not going to use a given
module you should set it to reader rather than enabled. If you want to work with only one
module, you can use the Stand-alone option. Finally, note that a dialog similar to the one
above can be accessed in Ecrin under the Modules tab of the Settings Application dialog, so
you can view/edit your choices after installation.
The next dialog (below left) requires the name of the installation directory. The default target
is C:\Program Files\KAPPA\EcrZZZ, where ZZZ is the release identifier, e.g. 430 for v4.30.

Installation directory

Components selection

The next dialog requires the name of the Examples directory (by default a subdirectory of the
installation directory) where the example files will be automatically placed.
The next dialog (above right) requires the list of components to install (Ecrin, Examples).

Ecrin v4.30 Doc v4.30.02 - KAPPA 1988-2013

Installation 4/12

Only if the installation is performed from a CD, the following dialog proposes the installation of
the documentation, necessary to get access to the tutorials. Activate the Documentation
checkbox and proceed with the installation.

Documentation installation
When installing with the setup downloaded from the Kappa website, you should download the
Documentation separately and create the corresponding folder manually (i.e. C:\Program
Files\KAPPA\Ecrin 4.30\Documentation).
The following dialog (below left) allows to specify your Program Folder.

Information for the Windows manager

Installation option summary

The setup program will also check that enough space is available on the installation disk and
then will request information on the program folder to be created in the Windows manager. A
shortcut can also be created on the desktop.
The next dialog (above right) summarizes the installation options. It is possible to correct
these options by using the Back button of the installation dialogs.
After user confirmation the installation is executed. Necessary files are copied and
decompressed.

Ecrin v4.30 Doc v4.30.02 - KAPPA 1988-2013

Installation 5/12

Setup complete
If you selected a hard key and the key driver installation was not correct, the software will fail
to enable the desired modules. You will end up with all requested modules in reader mode and
a warning will be displayed. It will be necessary to install the key driver manually, see Sections
D and E for USB keys and Section F for parallel keys.
In the case of network protection, it is necessary to start a network license server. The license
server is provided in a separate toolkit and can be downloaded on the KAPPA web site.

C. Silent mode installation

The Ecrin installation package enables the Silent mode facility.
A standard (non-silent) installation necessarily needs the input from the user to respond to the
InstallShield Wizard. However, a silent installation does not prompt the end user for input.
Instead, a silent installation will get the user input from a response file (setup.iss)
To create a response file, run setup.exe with the /r argument, which runs the installation
normally, and additionally creates the response file used by a silent installation. By default, the
response file is called Setup.iss, and is created in the Windows or WinNT directory. To specify a
different name or location for the response file, use the /f1 argument to Setup.exe, as
illustrated below:
c:\Silent Mode Installation>setup.exe /r /f1"c:\Silent Mode Installation\setup.iss"
Setup.exe command-line parameters
/r : Record mode
To run the Ecrin installation program in silent mode, you must first run Setup.exe with the /r
switch to generate a response file, which stores information about the data entered and
options selected by the user at run time.

Ecrin v4.30 Doc v4.30.02 - KAPPA 1988-2013

Installation 6/12

/s : Silent mode
The command Setup.exe /s runs the installation in silent mode, by default based on the
responses contained in a response file called Setup.iss in the same directory (response files are
created by running Setup.exe with the /r option). To specify an alternative file name or
location of the response file, use the /f1 option.
/f1 : Specify alternative response file name
Using the /f1 argument allows to specify where the response file is (or where it should be
created) and what its name is, as in Setup.exe /s /f1"C:\Temp\Setup.iss". The /f1 switch
is available both when creating a response file (with the /r option) and when using a response
file (with the /s option).
/f2 : Specify alternative log file name
When running the Ecrin installation in silent mode (using the /s argument), the log file
Setup.log is by default created in the same directory and with the same name (except for the
extension) as the response file. The /f2 argument allows to specify an alternative log file
location and file name, as in Setup.exe /s /f2"C:\Setup.log".

D. Installation of the Actikey USB key driver

If you have checked the USB protection at installation time or if you already have a previous
USB driver installed on your computer, the driver will be automatically installed or updated.
You may have to execute a manual installation only if the automatic installation failed, or if
you had not specified the USB protection when you installed Ecrin. An Actikey Driver USB
directory is automatically created during the Ecrin installation under C:\Program
Files\KAPPA\Protection.
Note: the USB driver (version 1.1.1.6) included in this Ecrin installation package is
compliant with Windows 64-bit systems.
Furthermore, do not connect your USB key unless the driver installation is complete.
Installation through Ecrin
To install the USB Driver, please follow the procedure below:
1. Log in with the administrator privilege.
2. Launch Ecrin even in Reader mode.
3. Go in the Licenses tab of the Settings Application page.
4. Click on the
button.
5. Hit the Install driver button. The required driver should be automatically installed.

Ecrin v4.30 Doc v4.30.02 - KAPPA 1988-2013

Installation 7/12

USB Driver uninstalled

6. Exit the following dialog.

USB Driver installed

7. Connect your USB key.
8. Hit the Add a license icon
and choose the Actikey USB key type.
9. Select and Add your license so it is displayed in the preselection list.

Manual installation
You can also manually install or update the driver by executing the Windows Installer Package
.
Note that if a previous USB driver is detected when running the .msi file, a warning message is
displayed informing you that another USB driver version is already installed on the machine.

Windows Installer warning

In order to successfully install the latest version of the USB driver, please delete the previous
one. Go in Start/Settings/Control Panel/Add or remove Programs and remove the Actickey
USB driver program.

Ecrin v4.30 Doc v4.30.02 - KAPPA 1988-2013

Installation 8/12

Once removed, run the Windows Installer Package. The InstallShield Wizard pops up, click on
Next to continue the installation (left below). Once the installation is completed, click on
Finish (right below).

Actikey USB driver Installation

Actikey USB driver Installation complete

After the installation is complete, you can connect your USB key and launch Ecrin.
1. Go in the Licenses tab of the Ecrin Settings Application page.
2. Hit the Add a license icon
and choose the Actikey USB key type.
3. Select and Add your license so it is displayed in the preselection list.

E. Installation of the SafeNet USB key driver

If you have checked the SafeNet protection at installation time, the driver will be automatically
installed or updated.
You may have to execute a manual installation only if the automatic installation failed, or if
you had not specified the SafeNet protection when you installed Ecrin. A SafeNet directory is
automatically created during the Ecrin installation under C:\Program Files\KAPPA\Protection.

Manual installation
You can manually install or update the driver by executing the application
Run this application. The Wizard pops up, click on Next until the installation is completed.
After the installation is finished, you can connect your SafeNet USB key and launch Ecrin.
1. Go in the Licenses tab of the Ecrin Settings Application page.
2. Hit the Add a license icon
and choose the HASP USB key type.
3. Select and Add your license so it is displayed in the preselection list.

Ecrin v4.30 Doc v4.30.02 - KAPPA 1988-2013

Installation 9/12

F. Parallel key driver installation

A specific key driver has to be started on a local machine if the protection is a local parallel
port dongle. This driver is automatically initialized during the installation process. If the
automatic driver installation fails, or if you installed without requesting parallel hard key, you
will have to manually install this driver.
Note that we do not support Windows 64-bit systems for parallel keys.
Installation through Ecrin
To install the Actikey Driver, please follow the procedure below:
1. Log in with the administrator privilege.
2. Launch Ecrin even in Reader mode.
3. Go in the Licenses tab of the Ecrin Settings Application page.
4. Click on the
button.
5. Select the Tools option. The Actikey Driver Windows 2000/XP Installation pops up.

Actikey Driver dialog

6. Hit the Install button. The driver will be automatically installed, provided the required
cnrm0330.inf file is found in the default target directory.

Actikey Driver installation dialog

7. Exit the dialog and click OK.
8. Connect your parallel port key.
9. Hit the Add a license icon
and choose the Actikey parallel key type.
10. Select and Add your license so it is displayed in the preselection list.

Ecrin v4.30 Doc v4.30.02 - KAPPA 1988-2013

Installation 10/12

Manual installation
You can also manually install the Actikey driver, please follow the procedure below:
1. Log in with the administrator privilege.
2. Run the install.exe program under the directory:
C:\Program Files\KAPPA\Protection\Actikey Driver W2000 & XP.
3. Click on the Install button.
4. Connect your parallel port key.
5. Hit the Add a license icon
and choose the Actikey parallel key type.
6. Select and Add your license so it is displayed in the preselection list.

G. View / edit the protection settings in Ecrin after installation

You can launch Ecrin even without a license (in which case the modules run in reader mode)
and access the Settings Application option.
There are two tabs in this option dealing with the protection: Modules and Licenses.
The Modules tab lets you view / edit the module selection made during the installation.

Settings - Application Modules

The Licenses tab is to check the license status, maintain your license or troubleshoot
protection problems.
In

the Licenses tab, you may:

View the active protection settings,
Change the license search precedence order,
Update a local hard protection key,
Define the FlexLM license server,
Define the path of the FlexLM license file.

Ecrin v4.30 Doc v4.30.02 - KAPPA 1988-2013

Installation 11/12

Settings - Application Licenses

Please refer to the Ecrin on-line help while in those dialogs for details.

H. Troubleshooting installation guidelines

In case you would receive an internal error: 2738 when launching the Ecrin installation,
you will then need to manually register the vbscript.dll file found in C:\WINDOWS\System 32.
To do so, please follow the steps below.
For Windows Vista and Windows 7 systems:
1. Hit the Windows Vista or Windows 7 logo button.
2. Select Programs Accessories and right-click on the command prompt.
3. Choose Run as Administrator in the pop-up menu.

4. In the command prompt, type in Regsvr32 vbscript.dll and press Enter.

Ecrin v4.30 Doc v4.30.02 - KAPPA 1988-2013

Installation 12/12

5. A message should be displayed saying that the .dll file has been successfully registered.

6. Then, relaunch the Ecrin installation by executing the Ecrin setup.exe file.
For other Windows versions:
1. Hit the Start button.
2. Select Run, type cmd.
3. Follow the above procedure, starting at Step 4.

I. Configuration guidelines
To successfully run Ecrin, please ensure that the DEP does not interfere with Ecrin.
Go to the System properties in the Control Panel:
1. Hit the Advanced tab.
2. Click on Settings of Performance.
3. Choose the Data Execution Prevention tab and make sure that Turn on DEP for essentials
Windows programs and services only is checked as illustrated below.
If the second option is activated, make sure Ecrin 4.20.exe has been added to the
exception list.

4. Apply your changes.

5. Reboot the computer.
6. Launch Ecrin.