Introduction
This section provides requirements, instructions, and troubleshooting information for installing a LexEVS Local Runtime.
Preliminary considerations
https://cabig-kc.nci.nih.gov/Vocab/KC/index.php/Image:Warning.jpg |
LexEVS has been tested with the operating systems and hardware specified in the Supported Platforms. While LexEVS is expected to run on many variations of hardware and software similar to the test platforms, results cannot be guaranteed. Before you begin you should check to make sure that your platform will support the software. |
- There are a number of Prerequisite Software products that you must install to run a LexEVS Local Runtime on your platform. You must make sure that you have the proper software and versions, depending on which LexEVS environment you are installing. Do this now, for the Local Runtime designated prerequisite software, before continuing to the install steps.
- As an option you may consider the command line install of a LexEVS Local Runtime for putting all the necessary files in place based on a pre-decided list of components to include. As noted in the last step of the GUI Installer for LexEVS Local Runtime, you can save a file that represents the choices you have made during the GUI install. This file can be used as-is or be edited and then fed into an install on another server. Follow the steps for installing a LexEVS Local Runtime using the optional command line method if you should choose this route.
- Complete the Downloading and installing the LexEVS Local Runtime steps below.
Once you have completed the prerequisite software install, the Local Runtime environment install steps, and the verification test as described in this guide then you should be ready to start programming using the API to meet the needs of your application. Not counting prerequisite software products the installation and verification should not take more than 60 minutes.
LexEVS QuickStart Install
Follow this link to get things up and running quickly. Not recommended for a production environment. LexEVS 6.0 Local Runtime Quick Start
Downloading and Installing the LexEVS Local Runtime
Step |
Action |
||||||||||||||||||||
1. Download the latest version of the Local Runtime GUI install package from the right. The location you have chosen to save this on your computer will be referred to as the SAVE_DIRECTORY. Examples will use scratch as the directory. |
GUI Installer for LexEVS Local Runtime Unknown macro: {LEXEVS_HOME}
/runtime directory. See the ReadMe for the latest information for about this release.
/runtime directory. See the ReadMe for the latest information for about this release. |
What's inside
Now that you have the basic Local Runtime placed into LEXEVS_HOME on your server, you may want to take the time to see what's inside. This is an optional part of the install. Go to the LexEVS 6.0 Local Runtime Installation directory Guide to discover the contents of each of the sub directories in LEXEVS_HOME.
Configuring the LexEVS environment
The LexEVS Local Runtime can be configured to work with many different databases, however, the recommended databases are MySQL or PostgreSQL. Specific versions are noted in the prerequisite software. Following installation of a database of your choice you should follow these steps in order.
Step |
Action |
||
1. Configure Database Management System properties |
MySQL properties |
||
2. Create a database |
Consult database management system documentation. We provide an example and a recommendation for MySQL. LexEVS must have access to a user with rights to create, update and delete tables. |
||
3. Make sure the JDBC driver in place |
The java software interface for a given supported database must be available in the <install-root>/runtime/sqlDrivers directory
|
The lbconfig.props file has the latest documentation embedded inside of it. lbconfig.props should be considered authoritative if there is a difference between the documentation written here and that contained in lbconfig.props. |
|
5. Set DB_PRIMARY_KEY_STRATEGY |
See the parameter settings documentation for more information. |
Testing the LexEVS Local Runtime
This Local Runtime installation provides a test suite to verify the environment. Before running these tests the Local Runtime and databases must already be configured.
Step |
Action |
|||
1. Your database management system and your web container must be running. This should already be true but if you get connection errors then it is usually due to this. |
|
|||
2. In a command prompt window change to the test directory: Unknown macro: {LEXEVS_HOME}
\test{_}* Unknown macro: {ext}
-v{_}* _ is the extension appropriate for your operating system (bat for Windows, sh for Unix)
If all the tests pass then you have successfully installed the LexEVS Local Runtime. Congratulations!
Troubleshooting
/runtime/sqlDrivers/ directory. If you are changing drivers remove the existing driver jar file to ensure that the class loader does not incorrectly load the older driver file.
|