Section I: Introduction
The Revelation Universal Driver Network User License (NUL) is designed to greatly enhance the network performance of your OpenInsight application. Although the Universal Driver NUL is easy to install, it is strongly encouraged that you familiarize yourself with this guide to ensure that the Universal Driver is optimally configured for your application. This installation guide is broken into three sections: Server Installation, Technical Information, and Managing the Universal Driver from the Management Console.
What is the Revelation Universal Driver NUL 5.2?
The Revelation Universal Driver is a client/server product designed to operate on Microsoft Windows. It is a required component for properly networking your OpenInsight application. It provides enhanced performance, reliability, and integrity for OpenInsight applications using linear hash files.
A Word About Licensing
Installation of the Revelation Universal Driver NUL version 5.2 indicates agreement and acceptance of the terms of the license. For details of the licensing agreement, consult the PDF or hardcopy that was delivered in the compressed file. If your copy of the Revelation Universal Driver NUL version 5.2 did not include a copy of the license agreement, please call Revelation Software at (800) 262-4747 or (201) 594-1422 to request a copy.
Universal Driver Limitations
The Revelation Universal Driver NUL version 5.2 will not work with all Microsoft workstations. The only supported workstations are Windows 7 Professional and Windows 8 & 8.1 Professional and Windows 10 Professional or better. The only supported server operating systems are 64-bit versions of Windows Server 2008, Windows Server 2012, and Windows Server 2016.
The Revelation Universal Driver NUL version 5.2 will ONLY communicate with OpenInsight 9.4 and above. All other versions of OpenInsight will return an error message (for example, FS1018). The Universal Driver 4.7.2 can be utilized with OpenInsight 9.3.2 and below as well as Arev.
Universal Driver 5.x Features
The Universal Driver NUL 5.2 has the following new features:
Latest Communication Technology – The Universal Driver NUL 5.2 utilizes the latest communication libraries to provide robust, reliable service between the UD server and its clients.
64-bit – The Universal Driver 5.2 may only be installed on 64-bit versions of Windows Operating Systems (e.g. Server 2012 or Server 2016).
Secure communications option – If desired, the communications channel between the UD server and its clients can be SSL encrypted, preventing unauthorized interception of sensitive information.
Authenticated clients option – If desired, only explicitly authorized client software can connect to the UD server over a secure SSL channel.
Connection Retry – If the communication link between the client and server is temporarily lost, and then restored, the client will attempt to reconnect and resume normal operations.
VSS friendly – The UD 5.2 is VSS (Volume Snapshot Service) aware and can thus be backed up with minimal disruption to normal operations. Please see Shares in Section II of this document for VSS configuration.
Controllable Resizing – The UD 5.2 (through the OpenInsight UD console) can have its “resizing thread” programmatically disabled and re-enabled. This allows high-volume installations to disable resizing during peak processing times, improving performance.
Customizable Write Flags – An optional registry setting can now be specified to control the flags that Windows uses when opening LK/OV files, allowing sites to customize the behavior for their individual needs.
The Universal Driver NUL 5.2 also has an interface to the OI Console that allows you to view and manage record locks without having to stop the Linear Hash Service. The OI Console interface allows multiple locked record to be selected and unlocked in one step from any workstation on the network.
License Enhancements Introduced in OpenInsight 10.0.4
Starting with OpenInsight 10.0.4, "child" processes launched from OpenInsight can be configured so that they do not consume additional license seats. In particular, CTO, AREV64, BRW, and O4W calls (using the engine server's built-in web server) made from a copy of OpenInsight will not count against the licensed count of users.
For example, a single user copy of OpenInsight can now run the IDE, a CTO session, and generate a BRW report at the same time.
Note that this enhancement requires both OpenInsight 10.0.4 (or above), and the Universal Driver 5.2 (or above). OpenInsight 10.0.4 will work with the Universal Driver 5.1, but it will not exhibit these license enhancements until it is "paired" with a UD 5.2.
To take advantage of this license enhancement for O4W and engine server tasks, users/developers must update their eserver.cfg file (either directly or through the Settings dialogs). In particular, any passwords that are currently explicitly embedded in the eserver.cfg can be replaced with an asterisk ("*"); this indicates that the specific connection should use the enhanced licensing. This also has the additional advantage of no longer requiring manual updates to the eserver.cfg file when passwords are changed for the applications or users defined in the connection string. (As an additional enhancement, the username can also be replaced with "*" if you wish to use the 'default user' created for an application).
For example, if your eserver.cfg previously contained the following lines:
WebServerConnection_console=SYSPROG,OICONSOLE,OICONSOLE,65,1,RUN_OECGI_REQUEST,,,1,,
SystemMonitor=RTI_OEMONITOR_CLEANUP,SYSPROG,SYSPROG,SYSPROG;RTI_OEMONITOR_INDEX,SYSPROG,SYSPROG,SYSPROG
They can now be replaced with the following lines:
WebServerConnection_console=SYSPROG,OICONSOLE,*,65,1,RUN_OECGI_REQUEST,,,1,,
SystemMonitor=RTI_OEMONITOR_CLEANUP,SYSPROG,*,*;RTI_OEMONITOR_INDEX,SYSPROG,*,*
Conventions Used in this Document
To facilitate the explanations and instructions used throughout this Installation Guide, certain conventions will be used.
If a word is Monospaced and EMBOLDENED, it represents a filename, directory, a keystroke or something that should be typed. If the emboldened word is also within <ANGLED-BRACKETS>, the user must replace the angled-brackets and the word within them with an appropriate word or phrase. Available selections will appear nearby, most often in a tabular format.
If a word is “enclosed in double-quotation marks”, it refers to something on the windows desktop, such as a button or menu choice. In some instances, a quoted word or phrase may be used to indicate a response that was generated by the system.
'Single quotation-marks’ will be used to indicate industry terms and to distinguish certain keywords.
If a word is italicized, it expresses emphasis or importance.
Pre-installation Requirements
Make certain that you have administrative privileges for the server onto which you wish to install the Revelation Universal Driver NUL 5.2.
Material Checklist
Verify that you have all the materials that are shipped with the Revelation Universal Driver NUL 5.2 by your side during the installation. At a minimum, the delivered items within the compressed file consist of:
This Installation Guide
32-bit Client setup.exe for OpenInsight 9.4 only
64-bit Server setup.exe
Revelation Universal Driver 5.2 Readme