ADL Library Software Developers build: This is a build of the adl middleware plus webclient software. It is not polished. while this middleware is used in the production for the adl digital libary this user interface developers build is not used in production. The present "webclient" provides a good example of how a client should use the library services. Things you can do * You can develop collection configuration files with this build, and we will be able to add your collections to the library. * You can use this webclient code to develop your own library * You can develop other clients on the middleware interfaces. Future Plans: * Bring map applet service up to test level quality. * Improve servlets to make them more configurable. * Improve UI to make it simple to build non-frame example * documentation beyond the javadoc available Notes/MISSING stuff: * when in doubt type: ant Basically, every time you make a configuration file change you need to copy the changes to the build directory. This is what the ant task does. * when things appear really broken: ant remove; ant clean; ant install this will remove the app (so if 's not loaded, the task will fail, which is ok) then remove the old build (if this fails, try once more, then stop your tomcat server, try again, start server) then will reinstall the application (if this fails, is tomcat running, is your admin/manager password correct). * The default is configured to use localhost on port 8080. Before other users can test from othe machines, you need to change the mw.machine and bp.billz.mapserver * details about the webclient customization are in CUSTOMIZING_WEBPAGES.txt. The only part customizable is the query_page servlet. It uses apache velocity templates. * Much of the Webclient is still the original servlets for UCSB Map and Imagery Laboratory. Basically, any customization of the result set is done by recoding the result set servlet. ** Highlight in map does not work (need to get the result set servlet customizable). * Details about the genericMetadataReport used in the report generation of the examples are in the Middleware Javadoc on the ADL middleware documentation site. * WINDOWS: ** For the developers version, please use cygwin (www.cygwin.org) ** Sometimes windows Internet explorer may be picky about applets. ** You must have a Sun JDK installed, and Java(Sun) Use Java 2 .... must be checked.. ** When in doubt, Try Netscape 6 or Mozilla. *CONFIGURATION FILE NOTE: ** Beware of continuation lines, line ending in back slashes \ **************There can be NO spaces after these******************** You cannot put a comment on the line following a continuation You cannot put a comment after a continuation * METADATA REPORTS ** Be wary of just copying a bucket configuration file. Things are bound to frustratingly not work if reports listed in metatada.views are not working. ** build reports up one at a time. Any error in a report configuration can cause a error when in doubt, disable a report by removing it from the metatada.views property. ADL middleware documentation: http://Alexandria.sdc.UCSB.edu/%7Egjanee/middleware/ I. REQUIRED Software: * You need to install the following software: ** Java 1.4 (1.4 is needed for the webclient, and not just the middleware) ** Tomcat 4.1 (http://jakarta.apache.org/) *** manager password needs to be configured in tomcat-users.xml ** Ant 1.5 (http://jakarta.apache.org/) ** This software II. set environment vars ANT_HOME JAVA_HOME CATALINA_HOME II.1 setup tomcat managers users password. edit [CATALINA_HOME}/conf/tomcat-users.xml add line like: II.2 move catalina ant tasks to ant library copy [CATALINA_HOME]/server/lib/catalina-ant.jar to [ANT_HOME]/lib/ III. Start Tomcat IV. build webapp tar -zxvf mw_webclient-0.91-dev.tar.gz cd adl_mw_wc cp build.properties.example build.properties vi build.properties catalina.home=[path_to_tomcat] manager.username=[for this machine] manager.password=[for this machine] app.name=mw_[your_name] wc.document.domain.statment= document.domain=[yourhost] VI. compile ant NOTE: EVERY TIME YOU MAKE A CHANGE, type: ant this copies the changes over to the build area. if you change a [file]_opml.xml, you will need to reload the web application VII. install in running tomcat ant install VIII. Make sure app is running http://localhost:8080 click on the Tomcat manager there should be an application with a path of mw_[your_name] click on it, and you will be in the directory click on test_forms.html IX. Test webclient A. Open browser to http://localhost:8080/mw_[your_name] B. Go to test-form.html. Click configuration button to see if client is running (It's XML, so you may only see a line of text in NS6) C. Go through all features of test forms which will query ADL catalog We need to supply documentation for this X. Test webclient with applet click on example_aims.html XI.. ADL is now installed, and runs on your system. XI.1. Rough Admin interface is available at: http://localhost:8080/mw_[your_name]/admin/configuration.jsp XII. Build a collection (see docs in demo collection) A. At present, collection metadata must reside in a database. Sample mysql database, load scripts and files are supplied with distribution. B. Need JDBC to ODBC connection 1. Place jdbc driver for your db of choice in the WEB-INF/lib/ directory Note: There might be able to use an ODBC to JDBC bridge. But this only works with windows installs, and local data on windows box. C. Make configuration files for your database schema 0. [top level directory]/collections/[collection-name] directory 1. Create translator.py file 2. Create bucket99 file 3. Copy middlware from adl_catalog D. Write xml report templates E. Rebuild web application 1. move files to build location ant prepare 2. ant reload Note: optional method for when things don't seem work: ant remove install E. Configure web interface 1. Edit collection_opml.xml. Add collection to collection hierarchy. 2. restart service ant remove install ****************************************************** Building the library Notes: All build ant maintainance tasks are done through ant. The goal is to make local and remote maintainance possible through the same interface. You can type "ant -projecthelp" to get a list of tasks that done through the ant build system ------------------------------ $ ant -projecthelp Buildfile: build.xml Main targets: all Clean build and dist directories, then compile clean Delete old build and dist directories compile Compile Java sources dev ADL: Create developer (tar) distribution dist Create binary distribution install Install application to servlet container install_production ADL: Production Install application to servlet container javadoc Create Javadoc API documentation list List installed applications on servlet container prepare Rrepare and Copy files over to build directory reload Reload application on servlet container remove Remove application on servlet container tar ADL: Create a tar distribution. Calls dev tar-all ADL: Tar's all files. Does not ignore any\n for local back and transfer ONLY. Default target: compile ----------------------------- If you change the colleciton_opml.xml, you will need to reload the web application ant prepare reload this can also be done with ant remove install If you want to redo everyting, and the app is running ant remove clean install