Readme.txt caCORE EVS API: source code and server installation Version 4.1 June 27, 2008 ================================================================ Contents ================================================================ 1.0 Introduction 2.0 Required Software 2.1 Java 2 Platform 2.2 Servlet Container 2.3 Ant (required to build the source code) 2.4 caCORE Software Development Kit (SDK) 2.5 LexBIG Service 3.0 Install in Tomcat 3.1 Edit server.xml 3.2 System Properties 3.3 Deploy the war file 4.0 Install in JBoss 4.1 Edit oracle-ds.xml 4.2 System Properties 4.3 Deploy the war file 5.0 Tests 5.1 Web application 6.0 Building caCORE EVS API 7.0 License ================================================================ 1.0 Introduction ================================================================ This document contains the instructions for installing a local version of caCORE EVS API version 4.0 on a machine running a Windows 2000/NT/UNIX/LINUX operating system. PREREQUISITE: The LexBIG Server must be installed prior to installing a local version of EVS API 4.0. See Section 2.5 below. ================================================================ 2.0 Required Software ================================================================ ---------------------------------------------------------------- 2.1 Java 2 Platform (required) ---------------------------------------------------------------- Java 2 Platform Enterprise Edition (J2EE) or Standard Edition (J2SE) is required to compile and run caCORE EVS. J2SDK jdk1.5.0.06 or later version is required. You can download the JDK from Sun Microsystems, Inc. at the following locations: http://java.sun.com/j2ee/ http://java.sun.com/j2se/ ---------------------------------------------------------------- 2.2 Servlet Container ---------------------------------------------------------------- This installation assumes that you have either JBoss 4.0.5 or later or Tomcat 4.1 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.3 Ant (required to build the source code) ---------------------------------------------------------------- Ant 1.6.x is required to build the EVS API source code. If you don't have it, go to: http://ant.apache.org/ ---------------------------------------------------------------- 2.4 caCORE Software Development Kit (SDK) ---------------------------------------------------------------- The caCORE SDK 4.0 is required to build the EVS API source code. If you don't have it, go to: http://gforge.nci.nih.gov/frs/?group_id=366 ---------------------------------------------------------------- 2.5 LexBIG Service ---------------------------------------------------------------- The LexBIG Server* needs to be installed to provide access to the available vocabulary data by the EVS API. The install jar is available at: http://gforge.nci.nih.gov/frs/download.php/3643/LexBIG-install-2.2.0.jar *The LexBIG Server installation requires a database installation described in the installation guide. The installation Administrative Guide is available at: http://gforge.nci.nih.gov/frs/download.php/3644/LexBIG-install-admin-guide-2.2.0.jar ================================================================ 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. The EVS client talks to the LexBIG API, all database configuration is handled in the LexBIG installation. ---------------------------------------------------------------- 3.2 System Properties ---------------------------------------------------------------- In order for EVS API 4.1 to know how to communicate with LexBIG To facilitate that communication, the following system property needs to be set: gov.nih.nci.cacore.evsProperties="{LOCATION OF EVS.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 LexBIG config file. i.e. LG_CONFIG_FILE=C:/LexBIG-2.2.0/resources/config/config.props Set JAVA_OPTS to be something BEFORE calling startup.bat or before calling catalina.bat. (or you can edit those files, but it isn't advised) Example (windows): SET JAVA_OPTS='-DpropName=propValue' Example (UNIX): export JAVA_OPTS='-DpropName=propValue' ---------------------------------------------------------------- 3.3 Deploy the war file ---------------------------------------------------------------- The following file, evsapi40.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 4.1 to know how to communicate with LexBIG To facilitate that communication, the following system property needs to be set: gov.nih.nci.cacore.evsProperties="{LOCATION OF EVS.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 LexBIG config file. You can move it whereever you like as long as the property value reflects the physical location of the file. i.e. LG_CONFIG_FILE=C:/LexBIG-2.2.0/resources/config/config.props Edit your {JBOSS_HOME}/server/defaut/deploy/properties-service.xml file to contain the following: gov.nih.nci.cacore.evsProperties=C:/tomcat/webapps/evs.properties ---------------------------------------------------------------- 4.3 Deploy the war file ---------------------------------------------------------------- The following file, evsapi41.war, should be dropped into the jboss default\deploy directory. Restart JBoss. ================================================================ 5.0 Tests ================================================================ Assuming you are running Tomcat or JBoss locally, 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/evsapi41 ================================================================ 6.0 Building caCORE EVS ================================================================ To rebuild the caCORE EVS API war file, all you need to do is run "ant build-system" from your base installation directory. The following packages will be generated and saved to the output\evsapi41\package\ directory: - client - local-client - remote-client - webapp - ws-client The evaspi41 warfile will be saved to your output\evsapi41\package\webapp directory. ================================================================ 7.0 License ================================================================ The caCORE EVS version 4.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://java.sun.com/xml/docs/summer02/LICENSE.html 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