Readme.txt caCORE LexEVS API: source code and server installation Version 5.1 December 18, 2009 ================================================================ Contents ================================================================ 1.0 Introduction Building LexEVS from source code is no longer required 2.0 Required Software 2.1 Java 2 Platform 2.2 Servlet Container 2.3 LexEVS local runtime ervice 3.0 Install in Tomcat 3.1 Place lexeves.properties in classpath 3.2 System Properties 3.3 Deploy the war file 4.0 Install in JBoss 4.1 Edit properties-service.xml 4.2 System Properties 4.3 Deploy the war file 5.0 Tests 5.1 Web application 6.0 License ================================================================ 1.0 Introduction ================================================================ Users no longer need to do source code builds of the LexEVS web-enabled api. This document, instead, directs the user to instructions for installing a local version of caCORE web-enabled LexEVS API version 5.1 on a machine running one of the following Windows 2000/NT/UNIX/LINUX operating system. You will still need to have the following software installed ---------------------------------------------------------------- 2.2 Servlet Container ---------------------------------------------------------------- This installation assumes that you have either JBoss 4.0.5 or later or Tomcat 5.0 or later installed. If using JBoss skip to section "4.0. Install in JBoss" If using Tomcat proceed to the next section. If you don't have either they can be found at: JBOSS: http://sourceforge.net/projects/jboss/ TOMCAT: http://jakarta.apache.org/tomcat/ ---------------------------------------------------------------- 2.5 LexEVS Local Runtime Service ---------------------------------------------------------------- The LexEVS local runtime Service needs to be installed to provide access to the available vocabulary data by the web-enabled LexEVS API. The install jar is available at: http://gforge.nci.nih.gov/docman/view.php/491/20167/LexEVS_51_localRuntime.jar LexEVS local runtime service installation requires a database installation described in the installation guide. The installation guide is available at: https://cabig-kc.nci.nih.gov/Vocab/KC/index.php/LexEVS_5.x_Installation_Guide All following instructions are also contained at the above guide location. ================================================================ 3.0 Install in Tomcat ================================================================ ---------------------------------------------------------------- 3.1 Edit server.xml ---------------------------------------------------------------- In previous releases of caCORE, modification of this file was required to support the caDSR and caBIO CORE components which communicate with relational data sources. The caCORE EVS 4.0 has been released independently of the other CORE components. Web-enabled LexEVS client talks to the local runtime LexEVS API, all database configuration is handled in the LexBIG installation. ---------------------------------------------------------------- 3.2 System Properties ---------------------------------------------------------------- In order for the web-enabled LexEVS API 5.1 to communicate with LexEVS local runtime,the following system property needs to be set: org.LexGrid.LexBIG.caCore.Properties= This is accomplished in Tomcat by having placing the the lexevs.properties file in the classpath of the web application (WEB-INFO/classes) ---------------------------------------------------------------- 3.3 Deploy the war file ---------------------------------------------------------------- The following file, lexevsapi51.war, should be dropped into the tomcat webapps directory. Restart Tomcat. ================================================================ 4.0 Install in JBoss ================================================================ ---------------------------------------------------------------- 4.1 Edit oracle-ds.xml ---------------------------------------------------------------- In previous releases of caCORE, modification of this file was required to support the caDSR and caBIO CORE components which communicate with relational data sources. The caCORE EVS 4.0 has been released independently of the other CORE components. The EVS client talks to the LexBIG API, all database configuration is handled in the LexBIG installation. ---------------------------------------------------------------- 4.2 System Properties ---------------------------------------------------------------- In order for EVS API 5.1 to know how to communicate with LexBIG To facilitate that communication, the following system property needs to be set: org.LexGrid.LexBIG.caCore.Properties="{LOCATION OF lexevs.properties}" where {LOCATION OF EVS.PROPERTIES} represents the location the the evs.properties file on the local file system. This file resides in {YOUR_EVS_API_HOME}/conf folder and the LG_CONFIG FILE property needs to be modified to point to your local runtime LexEVS configfuration file. You can move it where ever you like as long as the property value reflects the physical location of the file. i.e. LG_CONFIG_FILE=C:/LexEVS_50/resources/config/lbconfig.props Edit the {JBOSS_HOME}/server/defaut/deploy/properties-service.xml file and add the following: org.LexGrid.LexBIG.caCore.Properties=/local/content/evs/lexevs51/lexevs.properties ---------------------------------------------------------------- 4.3 Deploy the war file ---------------------------------------------------------------- The following file, lexevsapi51.war, should be dropped into the jboss default\deploy directory. Restart JBoss. ================================================================ 5.0 Tests ================================================================ Assuming you are running Tomcat or JBoss locally, and depending on the port settings of the given servlet container the following test should work. ---------------------------------------------------------------- 5.1 Web application ---------------------------------------------------------------- Entering the following in a web browser should display the Home Page for the caCORE EVS Example Project if everything is working correctly: http://localhost:8080/lexevsapi51 ================================================================ 6.0 Building caCORE LexEVS no longer required ================================================================ It is no longer required that the user build LexEVS from source the war file for the current edition is provided here: http://gforge.nci.nih.gov/docman/view.php/491/20170/lexevsapi51.jboss.war http://gforge.nci.nih.gov/docman/view.php/491/20171/lexevsapi51.tomcat.war ================================================================ 7.0 License ================================================================ The caCORE EVS version 5.1 software is licensed under the terms contained in the license located at: http://ncicb.nci.nih.gov/download/cacoreevsapilicenseagreement.jsp This product includes software developed by the Apache Software Foundation (http://www.apache.org/). -Apache SOAP, Crimson, Xerces, and Xalan are part of Apache XML project. -Tomcat, ORO, and Lucene are part of the Apache Jakarta project. All aforementioned Apache projects are trademarks of the Apache Software Foundation. For further open source licensing issues pertaining to Apache Software Foundation, visit: http://www.apache.org/LICENSE Hibernate is Free Software. The LGPL license is sufficiently flexible to allow the use of Hibernate in both open source and commercial projects. http://www.gnu.org/copyleft/lesser.html This product includes software developed by Castor (http://www.castor.org), which is licensed under the Exolab license: http://www.castor.org/license.html Sun, Sun Microsystems, Solaris, Java, JavaServer Web Development Kit, and JavaServer Pages are trademarks or registered trademarks of Sun Microsystems, Inc. The jaxp.jar and jaxb-rt-1.0-ea.jar are redistributed as whole binary jars and are subject to the Sun license terms as stated in http://www.java.com/en/download/license.jsp UNIX is a registered trademark in the United States and other countries, exclusively licensed through X/Open Company, Ltd. Windows, WindowsNT, and Win32 are registered trademarks of Microsoft Corp. All other product names mentioned herein and throughout the entire caCORE EVS project are trademarks of their respective owners. //end