Introduction
The purpose of this document is to detail the Installation Steps and Site Configuration Options for the caDSR CDEBrowser Tool Version 4.0.0.0. The CDEBrowser Tool source and all related documentation can be accessed at http://gforge.nci.nih.gov/projects/cdebrowser. All caCORE companion projects can be referenced from http://gforge.nci.nih.gov.
Pre-requisites
The caDSR CDEBrowser Tool project is a Manual deployment. The steps are noted below
Installation Steps
Download the project package from the NCICB Download Site.
Extract all project files into the desired location. For the purpose of this document, /cderbrowser-4000/ is assumed to be the project root folder. File references beginning with "./" can be found in the project path from this root.
Building the Application
A war file need to be build before the application can be installed, follow
the steps below to build a war file. A war file is not provided with the
download because the database connection information and environment properties
could be different for each deployment.
- Update build.properties file located in directory <INSTALL_HOME>/src/java
- Update the hostname,port and SID that could be used to connect to caDSR repository.
- Please update the values for user and password with the username/password to be used to connect to caDSR repository.
- Update cdebrowser.properties located in directory <INSTALL_HOME>/config/properties/jboss
- Run the build script (jboss-build.xml) from directory src/java with target "dist_local"
eg. ant -f jboss-build.xml dist_local
- CDEBrowser.war, cdebrowser-oracle-ds.xml, cdebrowser-login-config.xml and cdebrowser-login-config-service.xml will be created under directory <INSTALL_HOME>/dist
Deploying Application
- Shutdown Jboss instance
- Copy file cdebrowser-oracle-ds.xml from <INSTALL_HOME>/dist to directory <JBOSS_HOME> server/default/deploy
If old file "oracle-ds.xml" already exists in <JBOSS_HOME> server/default/deploy, then delete that file
- Copy file cdebrowser-login-config.xml from <INSTALL_HOME>/dist to directory <JBOSS_HOME>/server/default/conf
- Copy file cdebrowser-login-config-service.xml from <INSTALL_HOME>/dist to <JBOSS_HOME>/server/default/deploy
- Copy file CDEBrowser.war from <INSTALL_HOME>/dist to <JBOSS_HOME>/server/default/deploy
- Edit log4j.xml in <JBOSS_HOME>/server/default/conf to added the xml snippet below to end of the file before
</log4j:configuration> closing tag
<!-- ====================== -->
<!-- Setup the CDE Browser Appender -->
<!-- ====================== -->
<appender name="CDEBROWSER_FILE" class="org.jboss.logging.appender.RollingFileAppender">
<errorHandler class="org.jboss.logging.util.OnlyOnceErrorHandler"/>
<param name="File" value="${jboss.server.home.dir}/log/cdebrowser.log"/>
<param name="Append" value="false"/>
<param name="MaxFileSize" value="1MB"/>
<param name="MaxBackupIndex" value="3"/>
<layout class="org.apache.log4j.PatternLayout">
<param name="ConversionPattern" value="%d %-5p [%c] %m%n"/>
</layout>
</appender>
<!-- ===================== -->
<!-- Setup the CDE Browser category -->
<!-- ===================== -->
<category name="gov.nih.nci.ncicb.cadsr" additivity="false">
<priority value="DEBUG"/>
<appender-ref ref="CDEBROWSER_FILE"/>
</category>
- Startup the Jboss instance
- Access the application using url http://<HOST>:<PORT>/CDEBrowser/
eg. http://localhost:8080/CDEBrowser/
- Users can login to the CDECart with 'guest'account.
If you need to create an account please use the admin tool or request app support team to create an account  | When deployed to a secure server enter https://<server>/CDEBrowser/. |
| The user must have access to the server and in some environments this may require running a Virtual Private Network (VPN) connection. |
| CDEBrowser Tool 4.0.0.0 has only been certified with IE 7 and above. Firefox and other browsers may be used but may not behave properly and may encounter Javascript issues. |
 | Optionally the software may be installed on a secure server as "https". When this is done it may be necessary to install trusted security certificates on multiple servers to allow for programmatic access between applications |
Runtime Options
Some of the CDE Browser Tool logic are controlled by configuration options stored in a table within the caDSR database. These options are set via the sql script cdebrowseroptions.sql located at 'cdebrowser/config/sql/' . Modify the sql script to specify tier where "@TIER@" can be stage, prod etc. The options contained in this script allow for dynamic changes without the need to build or deploy a CDEBrowser.war file.
The options are identified by the tool name and a property. For the CDEBrowser Tool the tool name in the script is always 'CDEBrowser'. Details of the property and values of the configuration options follow. Each is identified by the property name followed by a description of its use. In addition to the information provided here there are extensive comments in the load_tool_options.sql file concerning valid values for each property.
- URL
The URL to access the CDEBrowser, should be stored in the format - "https//<CDEBrowser Tool Alias>". E.g. NCICB production is https://cdebrowser.nci.nih.gov. If <CDEBrowser Tool Alias> does not exist it should follow this format: "http//<server_name>:<port>/CDEBrowser".
- XML_DOWNLOAD_DIR
The directory for file cache to download the forms to excel. E.g /local/content/cdebrowser/output/. This directory must exist in the application server.
- XML_PAGINATION_FLAG
A flag for the pagination for download action.
- XML_FILE_MAX_RECORDS
A Value set for maximum file records created for form download.
Required Technology
The product versions which follow were used during the development and system testing of the caDSR CDEBrowser Tool. Although new versions of the products have been released they have not yet been certified with the CDEBrowser Version 4.0.
| Deviating in any way from the products and versions listed below may cause errors. When attempting to deploy the CDEBrowser Tool to a different technology stack, please first deploy as documented in this Installation Guide and then begin the migration. |
Troubleshooting
Following is a list of known errors and resolutions that may occur during the build and deployment process. If you have a question or situation not covered in this document please contact the NCICB Help Desk via email at ncicb@pop.nci.nih.gov.
- Error Writing JSP result Uncaught Exception in CDEBrowser doPost()
- Verify that objectcart url is stored in tool options table and secure certificate for object cart is installed
- Verify the cadsrApi url is working and a valid url is stored in tool options table
- On the CDEBrowser Login screen a valid user name and password is not accepted.
- Verify the login credentials entered are valid.
- Verify the username and password entered in the build.properties (above) are valid.
- Recommend using an independent database application, e.g. SQL Plus, TOAD, etc, to verify the connection credentials.
- After the third attempt to login, user may have been locked out.
- Using Firefox, Mozilla and other web browsers.
- The CDEBrowser Tool has only been certified with Microsoft Internet Explorer version 7.0 and higher.
- java.net.bind.exception JVM_8080 port not available.
- Correct the JBoss installation.
- Error in CDE Cart Display.
- Make sure that objectcart url is stored in tool options table and secure certificate for object cart is installed.
- Data Element public id links display page cannot be found or display error.
- Make sure that CDE Browser is working and URL in the tool options is valid.
