Versions 5.39 and later of the Sentinel System Driver use the Windows Installer which allows you to install the driver on any Windows 9x/NT/2000 system as if it were a regular application. This document describes the installation procedure for the Sentinel System Driver.
If you are installing the driver for DOS, Windows 3.x, OS/2, or any non-Intel Windows NT machine, you must use the old installer. The old installer is located in the /Legacy directory of the driver media. The old installer has been kept to allow developers that are not yet ready to migrate to the Windows Installer to keep their old installation methods. There are some limitations to doing this, however. The old installer does not support installing only the USB driver; you must use the new installer to do that.
Also, the legacy installer does not properly upgrade the USB driver on Windows 2000. If you use the legacy installer to install the driver over a previous installation on Windows 2000, you will have to manually update the USB driver through the Device manager.
The following sections assume you will use the provided setup.exe file, with or without command-line options, to install the driver on your end user's system. If instead you wish to use the supplied merge modules to seamlessly add the Sentinel System Driver installation to your own application's installation, see Sentinel System Driver Windows Installer Merge Modules for instructions.
Upgrade Note: You are not required to upgrade to the latest driver. If you are currently using the previous version of the Sentinel System Driver, and everything is working satisfactorily, you do not need to upgrade. However, if you wish to upgrade to the latest version of the driver, you must first uninstall the previous driver by using the Windows Add/Remove Programs icon in the Control Panel before following the instructions below.
|
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 any USB Sentinel SuperPro keys before continuing the installation. See Important Note on Sentinel SuperPro USB Keys for details.
If you have the driver on CD, place the CD in the computer and, if Autorun is enabled, the installation program should automatically run. Otherwise, run setup.exe from the root directory of the driver media.
If you do not have the correct version of the Windows Installer, it will automatically be installed for you.
If setup detects an older version of the Sentinel System Driver, you will be prompted to confirm the upgrade. The older version is uninstalled immediately after you confirm the upgrade. If you exit the installation after this, the older version will not still be installed.
Select either Complete or a Custom installation. Complete will install both the parallel and USB driver.
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.
Select Install.
Depending on the operating system you are using and the configuration of your computer, you may be asked to reboot if you have performed an upgrade. This is necessary to start the new parallel driver.
|
NOTE: If instead of using setup.exe, you are interested in using the supplied merge modules to seamlessly add the Sentinel System Driver installation to your own application's installation, see Sentinel System Driver Windows Installer Merge Modules. |
Go to the Control Panel from the Start menu.
Select Add/Remove Programs.
Look for the item that says Sentinel System Driver and select it.
The installer will allow you to modify, repair, or remove the installation--select the option you want and follow the instructions.
If you select Modify, you can add or remove the parallel or USB driver later.
Depending on the operating system you are using and the configuration of your computer, you may be asked to reboot.
There are four basic methods of installing the Sentinel System Driver onto an end user's computer using the installer on this CD.
If you are installing your application using a non Windows Installer installation package, then you must use methods 1 or 2. Developers that use Windows Installer can use any of the four methods.
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.
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).
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 data.cab. It is very possible that if you use InstallShield for Windows Installer you also have a data.cab file. In this case, the two data.cab files would have to be merged together (since all the files have to reside in one directory). If your installer does not require a data.cab file, just include this file on your CD. You will then place the Sentinel System Driver.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.
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:
If you are using method 3, then you need only two files that total about 800 KB:
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 end users 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 prevents you from having outdated versions of the driver being shipped with your application.
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 \. As an 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. Some valid Windows Installer command-line options are as follows (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
Argument? |
|---|---|---|
| /f [p|o|e|d|c|a|u|m|s|v] |
Repairs or reinstalls missing or corrupted files. Use this option in conjunction with the following flags:
|
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:
|
YES |
| /l [i|w|e|a|r|u|c|m|p|v|+] <log file> |
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:
|
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 \" 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 RainbowSSD5.39.2.
To install the driver without user interaction, but display a progress bar: setup /v"/qp"
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 USB SuperPro driver quietly: setup /v"/qb ADDLOCAL=USB_Driver"
To install the driver normally (with user interaction), but log results: setup /v"/L* filename.log" (Note that filename.log should be set to your desired log file name. The file will be overwritten if it already exists.)
To repair a driver installation: setup /f
To uninstall the driver (confirms uninstall with user): setup /x
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.
| 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="ConfigFiles,USB_Driver" (You should always install the configuration files feature on any installation.) |
| 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:
|
| 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 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 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 or 2000. 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. |
| CONFIRMUPDATE |
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 USB SuperPro driver when set. (It only works during uninstallation of the entire package.) The USB SuperPro driver is a Plug 'n' Play (PnP) driver that is WHQL (Windows Hardware Quality Labs) certified on Windows 2000. 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 systems. Other operating systems fully uninstall the driver. |
There are three features that can be set using the above ADDLOCAL, REMOVE, or REINSTALL properties on the Sentinel System Driver:
ConfigFiles - This contains the necessary configuration and help files for the Sentinel System Driver. This option should always be installed.
Parallel_Driver - This feature installs the parallel port driver for any Rainbow Technologies hardware security keys.
USB_Driver - This feature installs the USB SuperPro driver. It is only available on Windows 98, Windows 2000, and certain versions of Windows 95. Selecting this feature on unsupported operating systems has no effect.
All properties and the values they are set to are case-sensitive.
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.
This version of the driver contains a new driver configuration program. It is located in the C:\Program Files\Rainbow Technologies\Sentinel System Driver directory unless you change the install directory. It is called SetupSysDrvr.exe and it can be run by double-clicking it. When you run it, a window will come up. It will give you a few configuration choices as well as tell you what version of the driver it detects. If you only have the USB driver installed and you do not have any USB keys plugged in, it will not detect the driver. This is because the USB driver is loaded by Plug-n-Play whenever a key is plugged in. If there is no USB key plugged in, the driver is not loaded yet. The parallel driver is always loaded, so if you install it, 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 components, repair the installation, or remove the installation. This option is the same as going to the Control Panel, Add/Remove Programs and selecting the Sentinel System Driver. If the driver configuration program does not detect the installed driver, you can point it to the Sentinel System Driver.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. Browse to the file, click OK and it will run the installer for you.
This 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. In some cases, manual modifications are necessary and this option allows you to do this. Any changes to the ports could potentially cause the driver to fail. For more information on changing the ports and what the various options mean, select this option and then select help.
This option allows you to stop and start the NT parallel driver. This also works in Windows 2000 (sometimes referred to as Windows NT 5.0). 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.
|
North and South America |
||||||
|---|---|---|---|---|---|---|
| Rainbow Technologies North America | ||||||
|
||||||
| Australia | ||||||
| Rainbow Technologies (Australia) Pty Ltd. | ||||||
|
||||||
| China | ||||||
| Rainbow Information Technologies (China) Co | ||||||
|
||||||
| France, Spain, Portugal, Italy, Greece, Turkey, Israel, Middle East, North & Central Africa | ||||||
| Rainbow Technologies France | ||||||
|
||||||
| Germany, Austria, Switzerland, Poland, Czech Republic, Slovakia, Hungary, Romania, Croatia, Russia and former Russian States | ||||||
| Rainbow Technologies Germany | ||||||
|
||||||
| Taiwan and Southeast Asia | ||||||
| Rainbow Technologies (Taiwan) Co | ||||||
|
||||||
| United Kingdom, Ireland, Sweden, Norway, Denmark, Finland, Netherlands, Belgium, Luxembourg, South Africa | ||||||
| Rainbow Technologies UK | ||||||
|