Install Documentation for the ADL webclient

NEW INSTRUCTIONS FOR GOOGLE WEBCLIENT INSTALL

• checkout module 'mw2_wc_google' from CVS. (Should be under piru under the /cvsroot directory)
• create your build.properties file
  • build.properties.example should be an adequate starting point.
  • change mw.machine to the path of the machine that the app will be installed on- example: 'client.alexandria.ucsb.edu'
  • change database passwords as needed.
  • acquire a new Google maps API key and place it in the file.
• get collections, put into adl_collections directory.
  • check collections.properties, make sure that the collections directory name matches (adl_collections)
  • edit web/hierarchies/collections-opml.xml- remove any collections that you are not running on your server.
• run ant install
  • if it fails, switch build.xml with build.xml.tomcat5-tested, and run ant deploy

Important Note: These instructions are not up to date! Ant/build file installations deprecate this!

Needed software:

• java 1.4 or greater
• java application server (suggested Apache Jakarta Tomcat)
• ability to connect out on network ports. The demo uses Java RMI to connect the operational ADL servers, and runs queries on them. No database is required.

Needed software for demo based on local data:

• java 1.4 or greater
• java application server (suggested Apache Jakarta Tomcat)
• Database with JDBC driver

___
Configuring the Software
This uses tomcat. For other web servers, you will need to modify the instructions as needed.

1. download XXX.zip and expand
2. cd XXX/adlmw
3. edit two files
   1. javascript/domain.js
      • change to your domain
   2. WEB-INF/config/webclient.conf
      • edit WEBAPP_URL: @mw.machine@@app.path@/
4. Place the JDBC Drivers for your database in tomcat/common/lib
   • Generally ok to place the JDBC driveers in WEB-INF/lib if you cannot get your system admin to place them in the tomcat lib
     • The side effects occur when using jsp pages to generate ADL reports
5. two ways to make tomcat aware of the webapp
   • 1) copy adlmw to tomcat/webapps
   • 2) use a tomcat context file that points at the directory. Place the sample below in tomcat/webapps, and a file name adlmw.xml (or any other name)
6. start tomcat server
7. go to the URL specified in WEBAPP_URL

# WEBAPP_URL: http://localhost:8080/webclient/
#  mw.machine&app.path configured in build.properties
WEBAPP_URL: http://YOUR_MACHINE_NAME:8080/adlmw/

<Context path="/URL_PATH" docBase="FILESYSTEM_PATH"
        debug="0" >
<!-- place where you want your web server log files to go --> 
<Logger className="org.apache.catalina.logger.FileLogger"
             prefix="mw_tc_log." suffix=".txt"
          timestamp="true"/>
<!-- query and collection logs are configured in the collection configurations --> 
	
</Context>

To make index.jsp, the default home page, edit the WEB-INF/web.xml, and change welcome.jsp to index.jsp

	<!-- welcome file list -->
	<welcome-file-list>
		<welcome-file>index.jsp</welcome-file>
	</welcome-file-list>

___
TODOS:

• make a jsp page to edit the domain.js
• make webclient.conf reloadable (use a configuration service objet)
  • page to edit webclient.conf
• page to point collections at a differnet location
• configuration directory backup/restore tasks.