Skip Navigation
NIH | National Cancer Institute | NCI Wiki   New Account Help Tips
Skip to end of metadata
Go to start of metadata

Introduction

This section provides requirements, instructions, and troubleshooting information for installing LexEVS Grid Services.

Preliminary Considerations

  • The Supported platforms are the same for this environment as they are for the Local Runtime and Distributed.
  • Before installing the LexEVS Grid Services environment you must have both an LevEVS Local Runtime installed and a LexEVS Distributed working.
  • Just like the Distributed install, it is not required that you load a terminology into the Local Runtime in order to complete the installation of the Grid Services environment. However, the Grid services are not very useful if they have nothing in the underlying Local Runtime to query against.
  • This environment currently has no additional Prerequisite software beyond that of the the Distributed environment.
  • Complete the #Downloading and Installing the LexEVS Data or Analytical Grid Services steps below.

Once you have completed the Grid Services environment install steps and the verification test as described in this guide then you should be ready to start using the Grid Services features to meet the needs of your application. Not counting prerequisite software products the installation and verification should not take more than 30 minutes.

Downloading and Installing the LexEVS Data or Analytical Grid Services

Installation summary:

  • The LexEVS Grid Services are designed and implemented to run against an installed Distributed environment.
  • Separate data and analytical services have been implemented for LexEVS. Both services run on application servers.
  • JBoss and Tomcat are the only supported containers at this time.
  • These services are not designed to run on the same application service container and must be installed on separate application containers.

Step

Action

1. Download the latest version of the LexEVS Analytical or Data Services ZIP file from the right. You have a choice between ZIP files tailored for JBoss or Apache Tomcat installations. The location you have chosen to save this on your computer will be referred to as the SAVE_DIRECTORY. Our command examples will use scratch as this directory.

Note

Access to the downloads does not require an account. If you are having trouble downloading files then you may need to disable pop-up blockers or check any firewall settings at your site.

LexEVS caGrid Analytical Services
caGrid Analytical Services working in terms of the LexGrid model and LexEVS API, compliant with 21090 data types but otherwise consistent with the LexEVS Distributed environment. These can be deployed to an Apache Tomcat or JBoss container. Each ZIP file contains a wsrf.war file.
LexEVS_60_caGRIDServices_analytical_tomcat.zip
LexEVS_60_caGRIDServices_analytical_jboss.zip

LexEVS caGrid Data Services
caGrid Data Services working in terms of the LexGrid model and LexEVS API, compliant with LexGrid model elements. These can be deployed to an Apache Tomcat or JBoss container. Each ZIP file contains a wsrf.war file.
LexEVS_60_caGRIDServices_data_tomcat.zip
LexEVS_60_caGRIDServices_data_jboss.zip

2. Unzip the file or files you have downloaded to SAVE_DIRECTORY.

Warning

Each ZIP contains a file by the same name. This is by design because you can not deploy the Data or Analytical Grid Services to the same server. Therefore you must do these one at a time or unzip them to separate locations.

For example extract Data Services to:

C:\scratch\LexEVS 6.0 Analytical Services\wsrf.war

and

C:\scratch\LexEVS 6.0 Data Services\wsrf.war

Note

Windows typically understands ZIP files and can extract files. Unix has an unzip command. Other utilities can be used such as 7-zip or WinZip.

Unzipping the LexEVS Services as described.

3. Shut down your application or servlet container. This presumes that you have already installed a web server as outlined in the Supported Software. The command to do the shut down will be web server specific. See the documentation for your web server for information on how to do this. There may be many alternatives.

  • JBoss example:
    • Windows:

      shutdown.bat -S
      
    • Unix:

      ./shutdown.sh -S
      
  • If you experience Java errors then the server may already be down.

Shutting down the JBoss server as described.

4. Create a directory for the web archive.
Create a directory called wsrf.war inside this directory:

{WEB_SERVER_HOME}\{DEPLOYMENT_HOME}

..where WEB_SERVER_HOME is your application server home directory.
DEPLOYMENT_HOME is the Web Archive deployment directory for your application server.

  • JBoss example:
    • Windows:

      c:\jboss-5.1.0.GA\server\default\deploy
      
    • Unix:

      /jboss-5.1.0.GA/server/default/deploy
      
  • For example:
    • Windows:

      mkdir wsrf.war
      
    • Unix:

      mkdir wsrf.war
      

Create the web archive directory as described.

5. Unzip the wsrf.war file to the wsrf.war directory.

  • JBoss example:
    • Windows:
      From: c:\scratch\wsrf.war
      To: c:\jboss-5.1.0.GA\server\default\deploy\wsrf.war
    • Unix:
      From: /scratch/wsrf.war
      To: /jboss-5.1.0.GA/server/default/deploy\wsrf.war
      Windows does not see WAR files as compressed files, therefore you must obtain an unzip utility such as 7-zip or WinZip. In Unix you should be able to use the unzip command.

Deploying the services web archive file as described.

Resetting the Application Service Address

In summary:

  • The grid services are normally built to run against a hosted version of LexEVS.
  • Some users may need to run these services against their own instance of LexEVS.
  • In this case, an XML configuration file must be included in the installation process.
  • It will be necessary to download a client application to retrieve this file.

Step

Action

1. Download LexEVS_60_client.zip from the right. This is from the client for a Distributed install. Note:Third party dependencies are not required for this installation process.

LexEVS Distributed ClientEnables Java programs to establish a connection to an already-deployed LexEVS Distributed node.LexEVS_60_client.zip LexEVS Distributed Client 3rd Party dependenciesContains all the code required by the LexEVS Distributed Client.lexevsapi60-client-dependencies.zip

2. Unzip LexEVS_60_client.zip to the SAVE_DIRECTORY.

Unzip the LexEVS client file to the scratch directory as described.

3. Copy the application-config-client.xml file out of the unzipped client and into the deployed wsrf.war directory structure.

copy {SAVE_DIRECTORY}\LexEVS_60_client\conf\application-config-client.xml {WEB_SERVER_HOME}\{DEPLOYMENT_HOME}\wsrf.war\WEB-INF\classes

...where SAVE_DIRECTORY is the location of the downloaded file.
WEB_SERVER_HOME is your application server home directory.
DEPLOYMENT_HOME is the Web Archive deployment directory for your application server.
JBoss example:

  • Windows:

    copy  c:\scratch\LexEVS_61_Remote\conf\application-config-client.xml  c:\jboss-5.1.0.GA\server\default\deploy\wsrf.war\WEB-INF\classes
    
  • Unix:

    copy  /scratch/LexEVS_61_Remote/conf/application-config-client.xml  c:/jboss-5.1.0.GA/server/default/deploy/wsrf.war/WEB-INF/classes
    

    Note

    If you are repeating these steps for the other services WAR file then it will have its own separateapplication-config-client.xmlfile that will be similarly placed in the WEB-INF/classes folder of the exploded WAR file.

Copy the application client configuration file to the classes home directory.

4. Edit the application-config-client.xml file. There are three lines where you need to have the proper URL as a value. The three lines are found:

  1. In the EvsServiceInfo bean with this text <entry key="APPLICATION_SERVICE_URL"
  2. In the AppService bean with this text <property name="serviceUrl"
  3. (OPTIONAL) in the EvsAuthenticationProviderbean with this text {{<property name="serviceUrl"}}The values each have a URL like this:

    http://{SERVER_ADDRESS}/{WAR_FILE_DEPLOYED}/...
    

    For each you must change the SERVER_ADDRESS and WAR_FILE_DEPLOYED only where {{SERVER_ADDRESS} is the address of your server (domain and optionally the port number).
    WAR_FILE_DEPLOYED is the name of the WAR file you placed in the server directories for deployment.
    Example lines for the file:

  4. <entry key="APPLICATION_SERVICE_URL" value="http://localhost:8080/lexevsapi61/http/applicationService"/>
  5. <property name="serviceUrl" value="http://localhost:8080/lexevsapi61/http/applicationService"/>
  6. <property name="serviceUrl" value="http://localhost:8080/lexevsapi61/http/applicationService"/>

Editing the application client configuration file with circles around locations to change as described above.

Verifying the LexEVS Grid Services

If the grid services have a valid LexEVS remote (Distributed) application service to run against they should at least deploy within the container and allow JBoss or Tomcat to display an Axis success page. Testing of the services will require the user to set up a grid services client and run sample queries.

Step

Action

1. Start your application or servlet container if it is not already started. The start command will be web server specific. See the documentation for your web server for information on how to do this.JBoss example:

  • Windows:

    Run.bat \-c default
    
  • Unix:

    ./Run.sh \-c default
    

Starting the JBoss server.

2. Verify the installation by opening a browser to either:

http://{SERVER_ADDRESS}/wsrf/services/cagrid/LexEVSDataService

or

http://{SERVER_ADDRESS}/wsrf/services/cagrid/LexEVSGridService

...where SERVER_ADDRESS is the address of your server (domain and optionally the port number)
For example:

http://localhost:8080/wsrf/services/cagrid/LexEVSDataService

or

http://localhost:8080/wsrf/services/cagrid/LexEVSGridService

If you are using localhost then your browser must be running on the same server as LexEVS.

Default web page after successful start of LexEVS Grid Services

If you see the typical Axis service message then you have successfully installed the LexEVS Grid Service. Congratulations!

Troubleshooting

  • Deployment errors may occur if all instances of references in the application-config-client.xml are not correctly configured with the web address of a Distributed install.
  • Beware of port conflicts when operating two application service containers on the same physical machine.