This document describes the installation methods for the Sentinel System Driver on any Windows 95/98/ME/NT/2000/XP system. All the methods described below are suitable for developers using the Windows Installer.
Note: The Sentinel USB driver is not supported on Windows 95.
|
WARNING: When you run
setup.exe to install the driver, it will automatically update your version of
the Windows Installer if necessary. It will not provide any prompts before
doing this. If you are not sure you want to update the Windows Installer—do
not run this program. |
IMPORTANT NOTE: Remove the USB keys, if any, before continuing the
installation. See Important Note on Sentinel SuperPro USB Keys
for details.
1. If
you have the driver on CD, place the CD in the computer. The installation
program should automatically run; otherwise, run setup.exe from the root
directory of the driver media. You will be required to upgrade if an older
version of driver is detected on your system.
2. Select
either Complete or a Custom installation. Complete will
install both the parallel and USB driver (as long as the operating system
supports it). If you select Custom (and if the operating system on which
you are installing supports USB), you can choose whether to install parallel,
USB, or both.
3. Click Install and follow the instructions shown. When complete, you may be asked to reboot depending upon the operating system and the configuration of your computer.
Upgrade Note: To be able to use Sentinel SuperPro version 6.3 (or higher) or products protected with the same, you are required to upgrade to the latest version of the Sentinel System Driver.
1. Go
to Start > Settings > Control Panel and select
Add/Remove Programs.
2. Double-click
Sentinel System Driver 5.42.0 (32-bit) to start the installation wizard.
It will allow you to modify, repair, or remove the installation.
3. Select the option you want and follow the instructions shown. Depending on the operating system and the configuration of your computer, you may be asked to reboot.
There are four basic methods of installing the Sentinel System Driver on
your customer's computer: .
1. Have
the users run the driver install themselves–Since the supplied installer
contains a full step-by-step installation just like any application,
most end users will be able to install the driver themselves. This can easily
be added to autorun menus or automatically run at the end of the application
installation. It can be included on your own application CD with instructions
on how to install. You can also burn your own copies of the Sentinel System
Driver CD and distribute them with your product. If you are trying to run the
installation from a menu or your own installer, you need only call the Sentinel
System Driver's setup.exe file.
2. Run
the driver installation quietly–Either during your installation, or after
your installer finishes, you can call the Sentinel System Driver installation
in quiet mode. The driver installation is then run without any required user-interaction.
Command-line switches are used to do this. This
method is very similar to the first method, except you call setup.exe
yourself with the required switches to run without outputting messages (quiet
mode).
3. Your
Windows Installer package calls the Rainbow Windows Installer package–If
your installer is written for Windows Installer, you can easily call the
Sentinel System Driver installation directly from its .msi file. This is
a supported custom action built into Windows Installer. The trick to using this
method is allowing the installer to find the files it needs to install.
The Sentinel System Driver, written using InstallShield for Windows Installer,
has all its files placed in the archive data1.cab. It is very possible
that if you use InstallShield for Windows Installer you also have a .cab
file. In this case, the two files would have to be merged together (since all
the files have to reside in one directory). If your installer does not require
a data1.cab file, just include this file on your CD. You will then place
the Sentinel System Driver 5.42.0 (32-bit).msi file in the same
directory as your own .msi file. After you add a custom action to call
the Sentinel System Driver's .msi file from your installer, the driver
will be installed quietly right along with your application in a seamless
fashion.
4. Use the Sentinel System Driver merge modules–In order to do this, your installation package must use Windows Installer. This method is probably the most difficult, but allows you the most flexibility with installation options. With this method, the Sentinel System Driver is not just installed alongside your own installer; it actually becomes part of your installer. One of the advantages of this method is that the Sentinel System Driver cannot be removed unless your application is uninstalled. Thus, even if other applications try to remove the Sentinel System Driver, Windows Installer will realize that another application requires this component. The driver is not removed until all applications that require it are removed first. Using the merge modules is fully documented in this installation guide.
When including the Sentinel System Driver on your own CD, only six files are
required, totaling about 4 MB:
§
Sentinel System Driver 5.42.0 (32-bit).msi
§
Data1.cab
§
Setup.exe
§
Setup.ini
§
Instmsia.exe
§ Instmsiw.exe
If you are using 3rd method, then you need only two files that
total about 800 KB:
§
Sentinel System Driver 5.42.0 (32-bit).msi
§ Data1.cab
We recommend, however, that you include the entire contents of the Sentinel System Driver CD onto your own application CD as long as you have room. This keeps the distribution complete. Most developers make a subdirectory on their CD for the driver and place the entire CD contents in that folder. The entire driver CD takes up less than 10 MB of space.
Another alternative is to point your customers to the Rainbow Technologies Web site (http://www.rainbow.com) where they can download the latest version of the Sentinel System Driver themselves. Assuming your customers are on the Internet already—this gives them an easy way to obtain the latest version.
The setup.exe program checks your version of the Windows Installer, updates it if necessary, and then calls on the Windows Installer to install the Sentinel System Driver from the .msi file. You can pass on any command-line options to the Windows Installer via setup.exe using the /v option. Multiple options are placed with quotation marks; any option that requires a quotation mark should be prefaced with a forward slash (\). For example:
Setup.exe /v"/qn INSTALLDIR=\"C:\Program Files\Driver\""
The above line will install the driver quietly (without prompts) into the C:\Program Files\Driver directory. For more information on the Windows Installer and its command-line options, go to Microsoft's MSDN Web site.
For msiexec.exe, use the option given in the example below, where /i option is for installing the package:
msiexec.exe /i "<path>\Sentinel System Driver 5.42.0 (32-bit).msi" INSTALLDIR="C:\Program Files\Driver\"
For more information on the Windows Installer and its command-line options, go to the Microsoft's MSDN Web site. Some valid Windows Installer command-line options are described below (see the MSDN Web site for complete information on all options):
Note: The column titled "/v Argument?" indicates whether the option must be placed within the /v quotation marks or whether it is used outside of the /v option.
|
Option |
Description |
/v |
|
/f [p|o|e|d|c|a|u|m|s|v] |
Repairs or reinstalls missing or corrupted
files. This option is available only with msiexec.exe. Use this option
in conjunction with the following flags: §
p will reinstall a file if
it is missing. §
o will reinstall a file if
it is missing or if an older version of the file is present on the user's
system . §
e will reinstall if file is
missing or an equal or older version is installed. §
d will reinstall if file is
missing or a different version is installed. §
c will reinstall a file if
it is missing or if the stored checksum of the installed file does not match
the new file's value. §
a will force a reinstall of
all files. §
u or m will rewrite all
required user registry entries. §
s will overwrite any
existing shortcuts. §
v will run your application
from the source and store the local installation package in cache memory. |
NO |
|
/x |
This uninstalls the Sentinel System Driver. |
NO |
|
/q [n|b|r|f] |
The /q option is used to set the user
interface level in conjunction with the following flags: §
q or qn will create no user
interface. §
qb will create a basic user
interface. The user interface settings below display a modal dialog box at
the end of installation. §
qr will display a reduced
user interface. §
qf will display a full user
interface. §
qn+ will display no user
interface. §
qb+ will display a basic
user interface. |
YES |
|
/l [i|w|e|a|r|u|c|m|p|v|+] |
Building with the /l option will specify the
path to the log file; these flags will indicate which information to record
in the log file: §
i will log status messages.
§
w will log nonfatal warning
messages. §
e will log any error
messages. §
a will log the commencement
of action sequences. §
r will log action-specific
records. §
u will log user requests. §
c will log initial user
interface parameters. §
m will log out-of-memory
messages. §
p will log terminal
settings. §
v will log the verbose
output setting. §
+ will append to an
existing file. §
* is a wildcard character;
allows you to log all information (excluding the verbose output setting). |
YES |
|
PROPERTY = VALUE |
All public properties can be set or modified
from the command line. To set a property from the command line, use the
following syntax: PROPERTY = VALUE So, if you wanted to
change the value of COMPANYNAME, you would enter: COMPANYNAME="Rainbow Technologies" Remember to use a
backslash (\) for quotation marks inside a quotation. |
YES |
To assist you in using the Windows installer, this section contains examples of frequently used installer command-line options.
Note: If you use the self-extracting installer replace setup
with SSD5420-32BIT.EXE.
§
To install the driver quietly: setup /v"/q"
§
To install the driver quietly and automatically
upgrade any previous version found: setup
/v"/qb CONFIRMUPGRADE=TRUE"
§
To install just the parallel port driver quietly:
setup /v"/qb
ADDLOCAL=Parallel_Driver"
§
To install just the Sentinel USB driver quietly:
setup /v"/qb
ADDLOCAL=USB_Driver"
§
To install the driver normally (with user
interaction), but log results: setup
/v"/L* filename.log" (Any previously existing file with
the same name will be overwritten.)
§
To uninstall the driver (confirms uninstall with
user): setup /x
§ To uninstall quietly: setup /x /v"/q"
Command-line options given by msiexec.exe are as follows:
§
To repair a driver installation: msiexec.exe /fa
"<path>\Sentinel System Driver 5.42.0 (32-bit).msi"
§ To install just the parallel port driver: msiexec.exe /i <path>\Sentinel System Driver 5.42.0 (32-bit).msi" ADDLOCAL="Parallel_Driver"
Using properties, you can control the way the Sentinel System Driver package is installed. The Windows Installer contains many different properties that are configurable as a command-line option. Some of these properties are discussed below; for more information, go to Microsoft's MSDN Web site.
There are two features that can be set using the ADDLOCAL, REMOVE, or
REINSTALL properties on the Sentinel System Driver:
§
Parallel_Driver–This feature installs the
parallel port driver for any Rainbow Technologies hardware security keys.
§ USB_Driver–This feature installs the Sentinel USB driver. It is only available on Windows 98, Windows 2000, and Windows XP. Selecting this feature on unsupported operating systems has no effect.
All properties and the values they are set to are case-sensitive.
|
Option |
Description |
|
ADDLOCAL |
List of features, separated by commas, to be
installed to the local hard drive. This property allows you to control which
features will be installed. The list of features is below this table. Use the
default value of "all" to install everything. Feature names are
case sensitive. For example, to install the USB driver only: ADDLOCAL="USB_Driver" |
|
REMOVE |
List of features, separated by commas, to be
uninstalled. This property allows you to control which features will be
removed. The list of features is below this table. Use the default value of
"all" to install everything. Feature names are case sensitive. For
example, to remove only the USB driver: REMOVE="USB_Driver" As with the ADDLOCAL
and REMOVE properties above, this will reinstall the selected features. |
|
COMPANYNAME |
Organization of USER performing the
installation. |
|
USERNAME |
User performing the installation. |
|
REBOOT |
Set this value to one of three values: §
Force–Always prompt for a reboot at the end of the
installation. The user interface always prompts the user with an option to
reboot at the end. If there is no user interface the system automatically
reboots at the end of the installation. §
Suppress–Suppress prompts for a reboot at the end of the
installation. Reboots at the end of the installation—say caused by an attempt
to install a file in use—are suppressed. However, the installer will still
prompt the user to reboot during the installation whenever it encounters a
reboot action in the middle of the installation. If there is no user
interface, the system automatically reboots at each forced reboot. §
ReallySuppress–Suppress all prompts for reboots during the installation
initiated by forced reboot and all prompts at end of the installation. |
|
REBOOTPROMPT |
If the REBOOTPROMPT property is set to
Suppress (or just S) any reboot performed by the Windows Installer happens
automatically without interaction from the user. Setting this property does
not initiate a reboot if one is not needed; it only suppresses the display of
any prompts for reboots to the user. |
|
ARPHELPLINK |
The Internet address for technical support.
This value shows up in the Windows 2000/XP application information. This
allows users to be directed straight to your Web site for problems. |
|
ARPHELPTELEPHONE |
The telephone number for technical support.
This value shows up in the Windows 2000/XP application information. This
allows users to be directed to your technical support number for assistance. |
|
NOVDDINSTALL |
Do not install the Virtual Device Driver
(VDD) on Window NT/2000/XP. Older DOS and Win16 applications use the VDD. Set
this property to any value to prevent the VDD installation. This property has
no effect on Windows 9x. |
|
CONFIRMUPGRADE |
Use this property to confirm that you would
like the installer to upgrade a previous Sentinel System Driver version. Set
this property to any value to confirm you would like upgrades to take place.
There is no effect if you set this on a system that does not require an
upgrade. Setting this property is only necessary if you are not using the
GUI. IMPORTANT NOTE: If you are running the installation from the command
line without the full GUI and do not set this property, if the installer
detects a driver is currently installed, it will exit without updating the
driver. |
|
SSDREBOOTREQUIRED |
When this property is set, it tells the
installer to ask for a reboot at the end of the installation. Various custom
actions in the installer will set this property when they decide a reboot is
required to complete the installation. If you are creating
your own installer using the merge modules, it is important to flag a reboot
at the end of the installation if this property is ever set. |
|
USBFULLUNINSTALL |
This property fully uninstalls the Sentinel
USB driver when set. (It only works during uninstallation of the entire
package.) The Sentinel USB
driver is a Plug 'n' Play (PnP) driver that is WHQL (Windows Hardware Quality
Labs) certified on Windows 2000 and XP. According to Microsoft
specifications, a PnP driver should never be uninstalled from a system even if
the hardware is removed. This is because PnP only loads in the drivers for
components actually plugged into the computer. When the device is removed,
the driver is never loaded. Uninstalling it risks inadvertently causing a
problem with the entire operating system. For this reason, the
USB driver is never fully uninstalled by default by the installer. Some
developers desire the ability to completely remove all traces of the USB
driver from a computer. This action is intended for this, but should be used
at your own risk. If this property is set, all traces of the USB driver are
removed from the system. In general, the computer should be rebooted if this
occurs, although the installer will not specifically prompt to do so. It is
possible for there to be multiple installations of the Sentinel System Driver
on a computer. This action does not check to see if there are other
installations on the computer. Running it may require a re-install or repair
to make the USB driver operational again for another application. This property only
affects Windows 2000 and XP systems. Other operating systems fully uninstall
the driver. |
|
SSDRELEASESTATE |
This property allows you control the version
shown of the Sentinel System Driver. To prevent installation of beta.txt—the
installer file corresponding to the beta releases of the driver—set this
property to FINAL. |
|
ISSERVICESTOPPED |
This property is used to conditionally call
the StartSpService custom action. It is set to TRUE by
RemoveOldDriver when the SuperPro server/service is stopped on the
target system for Sentinel System Driver installation. |
All USB Sentinel SuperPro keys need to be removed before installing or removing the Sentinel System Driver. Otherwise, the USB portion of the installation might fail. For this reason, we recommend providing some sort of warning to the user to remove any USB SuperPro keys from the computer before performing the installation. In the case of the supplied installer, it warns the user on the Install Confirmation dialog just before any real installation takes place. If a user fails to heed this warning then you should have the user uninstall and re-install the Sentinel System Driver without the USB key plugged in. This should repair the system and make the USB key operational.
The driver configuration program—SetupSysDriver.exe—is located in the C:\Program Files\Rainbow Technologies\Sentinel System Driver directory unless you change the directory during installation. When you run it, a window will come up giving you a few configuration choices. If you only have the USB driver installed, the configuration program will not detect the USB driver if no USB key is plugged in. This is because the plug-n-play USB driver is only loaded when a key is plugged in. This differs from the parallel driver, which is always loaded after it is installed, so the configuration program should always detect its presence.
If you select this option, the installer will run the Windows Installer for the Sentinel System Driver and allow you to modify, repair, or remove the installation. This option is the same as going to the Add/Remove Programs under Control Panel and selecting the Sentinel System Driver 5.42.0 (32-bit). If the driver configuration program does not detect the installed driver, you can point it to the Sentinel System Driver 5.42.0 (32-bit).msi file that was used to install the driver originally. This should be located with the driver media you received when you installed the driver.
The Configure Driver option allows you to manually configure the parallel ports used by the Sentinel System Driver. In general, the driver is able to automatically detect your parallel ports and does not need to be set up manually. However, in some cases manual modifications are required. Any changes to the ports could potentially cause the driver to fail. For more information on changing the ports and various options, click the Help button.
The Start/Stop NT Parallel Driver option allows you to start and stop the NT parallel driver. This also works in Windows 2000 (sometimes referred to as Windows NT 5.0) and XP. Use this option to manually cycle the driver. This option has no effect on the USB driver, which is automatically stopped and started whenever a key is removed or inserted.
|
CORPORATE
HEADQUARTERS NORTH AMERICA AND SOUTH AMERICA |
||||||||
|
Rainbow Technologies Inc. |
||||||||
|
||||||||
|
AUSTRALIA
AND NEW ZEALAND |
||||||||
|
||||||||
|
CHINA |
||||||||
|
||||||||
|
FRANCE |
||||||||
|
||||||||
|
GERMANY |
||||||||
|
||||||||
|
TAIWAN
AND SOUTHEAST ASIA |
||||||||
|
||||||||
|
UNITED
KINGDOM |
||||||||
|
|
OTHER
COUNTRIES |
|
Customers not in countries listed above,
please contact your local distributor. |