Versions Compared

Version Old Version 18 New Version Current
Changes made by

bcarlsen (Unlicensed)

jefron

Saved on

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

...

Documents setting up code, config, and data in a development environment using Eclipse.

Prerequisites

Details

Step 1 - Create directories

...

Step 2 - Clone repository

Clone the Github repository to the directory created to hold the code.

...

  • NOTE: this uses the standard "dev-windows" configuration.  To use a different configuration artifact pass the following three parameters:
    • -Dconfig.groupId=...
    • -Dconfig.artifactId=...
    • -Dconfig.version=...
  • NOTE: the specified configuration artifact must either have been built locally or be an a repository accessible based on the settings.xml file
  • For most dev deployments, the default build is fine because the only setting really used for the rest/webapp packages is the "base.url" which by default is set to http://localhost:8080/mappingumls-server-rest./
  • For a production deployment, you would want to use a different setting.  For example, see Deploy Instructions for the prod deployment instructions.

Step 4 - Setup Configuration

Choose a "dev-windows", "uat" , or "prod" config project target and unzip it into the directory created to  hold hold your config files.

  • config/dev-windows/target/term-server-config-dev-windows.*.zip
  • config/prod/target/term-server-config-prod.*.zip

Unzip the config

...

/target/term-server-config

...

.*.zip file into the directory created to hold your data files (these are the sample SNOMED and ICD9CM data artifacts).

Step 5 - Edit configuration

...

  • javax.persistence.jdbc.url
  • javax.persistence.jdbc.user
  • javax.persistence.jdbc.password
  • hibernate.search.default.indexBase  ( recommend choosing something in your data dir, e.g. c:/termesrver/data/indexes or ~/indexes)
  • security.activated (set to false for dev environment)
  • mail.smtp.to (list for automated system emails)

...

  • Download and install apache tomcat 7 in c:/apache-tomcat-XXXX
  • In Eclipse use the J2EE perspective and click on the "Servers" tab.
  • From here, you can add a server which simply involves pointing Eclipse to the install directory for Tomcat.
  • You can right-click on term-server-rest.war file and use "Run As->Run on Server" to deploy to Tomcat.
    • NOTE: sometimes in Eclipse this doesn't work and the tomcat does not properly recognize or deploy the app.
    • In this event, double-click on the tomcat server installation in the servers tab.
    • In the configuration screen click "Open launch configuration"

    • There, look on the Arguments tab and find the -D setting for "catalina.base", e.g.

      Code Block
      -Dcatalina.base="C:\Users\Brian Carlsen\workspace-luna\.metadata\.plugins\org.eclipse.wst.server.core\tmp0"


    •  If you open this directory you'll see a "webapps" folder.  To deploy you simply build and copy term-server-rest.war to that directory and launch the server in Eclipse.

  • The Tomcat server needs to be able to find the run configuration. Double-click on the Tomcat server you installed, open the launch configuration and add this setting:

    Code Block
    -Drun.config.ts=/path/to/your/config.properties


...

http://localhost:8080/term-server-rest/index.html

This should be a demo app that links to a  "swagger" Api documenting the current state of the APIserver.  You You should be able to test services by using authenticating with "guest" username and "guest" as the authToken parameter.password..


Step 10 - Integration test

Run the integration tests (only do this if you know what you're doing):

Code Block
# configured to ponit ot DB loaded above.
mvn -Prest -DskipTests=false -Drun.config.ts=/path/to/config.properties
# configured to point to empty db
mvn -Pmojo -DskipTests=false -Drun.config.ts=/path/to/config-test.properties

 

...