Table of Contents | ||
---|---|---|
|
v1.2.0
Installation and Setup of Infrastructure Components
Note: If you have Windows User Access Control turned on, you may need to disable it in order to complete the installation properly.
...
NOTE: we have created a common, publicly accessible Apelon DTS instance for maintaining a central set of concepts for use by the OpenCDS community. Software to access this is included in the OpenCDS source distribution.
Install Java SE SDK version 7
- Download appropriate 32-bit or 64-bit Java SE SK from http://www.oracle.com/technetwork/java/javase/downloads/index.html
- Run executable, install using default options
- You can use a non-default installation directory if desired
- Windows: Control Panel → System → Advanced → Environment Variables → System Variables
- Set JAVA_HOME to Java SE SDK location
- e.g., C:\Program Files\Java\jdk1.7.0_45.jdk
- Add %JAVA_HOME%\bin to path
- In this example, was added to beginning of path
- Set JAVA_HOME to Java SE SDK location
- Linux/Mac:
- Add JAVA_HOME as an environment variable to the shell environment.
- bash/linux: export JAVA_HOME=/path/to/jdk
- bash/mac: export JAVA_HOME=`/usr/libexec/java_home -v 1.7`
- Add $JAVA_HOME/bin to PATH
- bash: export PATH=$PATH:$JAVA_HOME/bin
- Add JAVA_HOME as an environment variable to the shell environment.
Install Tomcat
- Download latest Tomcat
- Windows:
- Download “32-bit/64-bit Windows Service Installer” from relevant download page at http://tomcat.apache.org
OpenCDS has been tested using both Apache Tomcat versions 6 and 7, and it can be built to run on either, but the public download is built for Tomcat version 7.
- Note: OpenCDS will not deploy on JBoss without making some changes to the included libraries
- Accept defaults
Installation directory may be changed if desired
Set Tomcat Administrator Login to something secure
- You may even prefer to remove the administrator login if you have physical access to the server.
Control Panel → System → Advanced → Environment Variables → System Variables
Set CATALINA_HOME to, e.g., “C:\Program Files\Apache Software Foundation\Tomcat 6.0”
Add %CATALINA_HOME%\bin to Path
- In this example, was added to beginning of Path
- Linux/Mac:
- download the tar.gz package, and unpack it to the desired location.
- Set CATALINA_HOME to the location of the Tomcat folder
- export CATALINA_HOME=/path/to/tomcat
- Add CATALINA_HOME/bin to PATH
- export PATH=$PATH:$CATALINA_HOME/bin
- Windows:
OpenCDS Configuration
Externalized OpenCDS configuration options are stored in the locations below:
...
knowledge-repository.type may be either of the two following values:
SIMPLE_FILE
CLASSPATH
- knowledge-repository.path is the absolute or relative path to the configuration, depending upon which type is chosen (above).
- Example configurations for SIMPLE_FILE may include:
- /var/lib/opencds/resources_v1.1/
- /home/opencds/config/resources_v1.1/
- $HOME/.opencds/config/resources_v1.1/
- etc.
- The path for the CLASSPATH type is relative to the classpath of the running JVM (e.g., Tomcat).
- resources_v1.1/
- Example configurations for SIMPLE_FILE may include:
- log4j.logfile is the location used by OpenCDS to write the logs. This line is optional. Typical values may include:
- /var/log/opencds/opencds.log
- $HOME/.opencds/logs/opencds.log
Install OpenCDS Sample Knowledge Repository
Filesystem-based Method
- A sample knowledge repository is distributed with the OpenCDS deployment file (the 'war').
- Download opencds-knowledge-repository-data.zip from the OpenCDS website | Members | Binary Downloads | at http://develop.opencds.org/OpenCDSDemo/latest/opencds-knowledge-repository-data.zip
- Unzip it to the location specified in the OpenCDS Configuration discussion above.
- The location must be on a filesystem visible to the running instance of Tomcat.
Jar-based Method
NOTE: This option is for developers and advanced users.
- A test repository is included in the war, and may be updated with custom repository elements by following the standard procedures for manipulating jar files.
- NOTE: Developers may update their local copies of the codebase to automatically build the war with a custom repository. However, please do not commit this to the repository.
Install OpenCDS RunTime WAR file
- Download latest OpenCDS RunTime war file from the OpenCDS website | Members | Binary Downloads | OpenCDS11
- Rename the file to “opencds-decision-support-service.war”
- (this step is not absolutely necessary, but will make your runtime match other instructions in our documentation, and so it is probably a good idea unless you know what you are doing).
- Stop Tomcat
- Copy the opencds-decision-support-service.war file into the %CATALINA_HOME%\webapps folder
- Restart Tomcat
Test the Installation
- Open a web browser on the same machine that you installed Tomcat on, and go to
- http://localhost:8080/opencds-decision-support-service/evaluate?wsdl
- The browser should display the WSDL.
- If it is installed on a different machine, or you changed the default port to something different than 8080, make the appropriate changes to the URL above.
- To interact with the DSS, a convenient program to use for testing and demo is the oXygen XML editor (http://www.oxygenxml.com). We use the Academic/Non-Commercial version, and a free trial license is available at http://www.oxygenxml.com/register.html.
- Other tools are available, and some are open-source, such as SoapUI at http://www.soapui.org , or the Firefox addon at https://addons.mozilla.org/en-US/firefox/addon/soa-client, for those of you who want to experiment.
- You can also use the open-source MirthConnect software to test rules, as well as in a production environment, because it includes support for web services. The software can be found at http://www.mirthcorp.com/products/mirth-connect. We have some sample channels available in the Demo folder.
- If you are using oXygen, go to Tools → WSDL SOAP Analyzer → Saved SOAP request, and use the sample .wssc files available from the OpenCDS website | Members | Binary Downloads | OpenCDS11. Hitting the "Send" button will interact with the DSS. Note that a base64 converter for reading base64 payloads is available at http://ostermiller.org/calc/encode.html or http://www.opinionatedgeek.com/DotNet/Tools/Base64Encode/default.aspx
Document Version History
(Duplicated/reversed from original document–included for historical purposes.)
...