Requirement Notes:

• at least j2sdk-1.4.1
• jakarta-tomcat-4.1.x OR jakarta-tomcat-5.0.x

Deploy Notes:

1. The system has been tested under tomcat-4.1.18 and tomcat-5.0.28 and this build includes only tomcat specific configuration xml. To run this code under a different web application server you are on your own and you should build the system from cvs.
2. NOTE: the 0.9.5 version and higher of coefficient uses jfreechart to generate graphs for project statistics. If you are running your server in an environment where there is no windowing enviroment you must start the JVM with the -Djava.awt.headless=true property.
3. Setup your database and include the JDBC jar in the common/lib directory so tomcat can see it in its classpath
4. You must Make sure that your hibernate.properties is setup to reference the database that you setup in the last step. A sample hibernate.properties can be found in the root directory of this installation. Five properties must be changed:
   hibernate.connection.username={username_for_your_db}
   
   hibernate.connection.password={password_for_your_db}
   
   hibernate.dialect={hibernate_dialect_for_your_db}
   
   hibernate.connection.driver_class={driver_class_for_your_db}
   
   hibernate.connection.url={jdbc_url_for_your_db}
   The other properties can stay unchanged.
5. Once your hibernate.properties file is correct you must insert it into the war. The scripts updateHibernatePropertiesWeb.bat and updateHibernatePropertiesWeb.sh expect that the files coefficient.war and hibernate.properties are in the same directory that you are running the script from. It also expects that 'jar' is available to the system. Executing this script simply re-packages the .war placing the props file in the correct place.
6. To deploy the system unjar the coefficient.war files to the {TOMCAT_HOME}/webapps/ directory. All modules of the system are deploy in this single .war since we can not support hot-deploy of modules within tomcat.
7. Because we use the apache bean factory to create our modules and to resolve objects through JNDI you must copy the contents of server.xml.snippit into the {TOMCAT_HOME}/conf/server.xml file. Make sure that this context block goes within the Host block defined for your host (localhost if running a default installation).
8. You should configure tomcat to use the version of the xerces jar that comes with coefficient. If not done then the workflows will not work since Castor is unable to unmarshall the xml in the system. This step is not required if you do not intend to use the workflows.
9. Start the tomcat server.
10. You should be up and running. Point your browser at whatever url you have configured tomcat to run on, the context for the project is setup as coefficient the entry servlet responds to index.html , usually: http://localhost:8080/coefficient/index.html
11. The system will initially prompt for some needed properties before you can start using it. These are a valid email address to use as site administrator and from address and smtp host: MAIL_SMTP_HOST={my.smtp.host} MAIL_SENDER_ADDRESS={my.email.address} NOTE: the system will be unable to send user confirmations or project confirmations if these are not set. You may want to modify the location that uploaded files are stored, this can be done by setting the property: FILEUPLOAD_SAVE_PATH={path.to.where.you.store.fileUploads}
12. Fill these in and click save. Do not change JNDI, JMS settings since this binary build has deployment descriptors pointing to the default values.
13. The default password and username is 'admin', 'admin'
14. If you want to create a workflow project then you must upload a workflow file. Coefficient currently ships with a simpleWorkflow.xml that uses the task, fileUpload, vote, and discussion modules to force a Readme to be created before the project begins. To upload this file:

    • login as admin
    • choose the 'Workflow Administration' link from the AdminNavigate menu
    • use the browse button and find the file called simpleWorkflow.xml that is in the root of this deployment
    • click the upload button
    • now when you choose to create a workflow project you will have the option for a simpleWorkflow

15. Enjoy !