Requirements
Java 1.6
Running / Configured Workflow System
Maven
MySQL with Bootstrap and Workflow Data
Tomcat 6
Setup
Maven Info
It is likely that when you first run maven commands you will see a lot of jars being downloaded. There is one un-distributable jar that is required which must be obtained from Oracle directly. Once you have this jar, you can install it with the following maven command:
mvn install:install-file -DgroupId=com.oracle -DartifactId=ojdbc14 -Dversion=10.2.0.3.0 -Dpackaging=jar -Dfile=/path/to/file
Data Population
Bootstrap the TK database - If you have a full SQL dump to use as a bootstrap, you can use this:
mysql -u tk -ptk_tk_tk tk < tk-bootstrap.sql
SQL Bootstrap can be found in:
src/main/config/sql
Liquibase can also be used to populate the bootstrap, though at this time we do not have the bootstrap data fully configured with liquibase.
Local Configuration
Kuali projects look for configuration in:
~/kuali/main/[dev] : where [dev] is the current deployment mode, ie, 'dev', 'stg', 'prd', etc.
You can find these files in the source directory:
src/main/config/local
Copy them to the local home directory of the user you will be running the project from and modify the tk-dev-config.xml and tk-test-dev-config.xml files to match your local database settings and container deployment settings.
cp -r src/main/config/local/kuali ~
You should end up with a kuali/ directory under your home directory if you've copied the files correctly.
There are two keystore files that need to be copied as well. For security reasons, they are not checked into the revision control system. Contact a KPME developer to obtain these files. One of these files is rice.keystore
, the other webservices-keystore
. rice.keystore
should be placed in ~/kuali/main/dev/
while the webservices-keystore
is placed in ~/kuali/main/dev/settings/tk/
XML Ingestion into Workflow
Workflow document configuration needs to be ingested into your locally running workflow instance. Workflow files are located:
src/main/config/workflow/*.xml
Building Project for deployment
If you've successfully configured the project, you can use maven to build a war file that is ready for deployment into your tomcat container.
NOTE: The local configuration mentioned above needs to be in the home directory of the user you are using to run the tomcat process.
To build the WAR file:
mvn -Dmaven.test.skip=true clean package
Depending on the version, it will create a file:
target/time-and-attendance-1.1-SNAPSHOT.war
Copy this file to your webapp container directory, renaming it to tk-dev.war:
mv target/time-and-attendance-1.1-SNAPSHOT.war /somewhere/webapps/tk-dev.war
You can monitor the tomcat log output for any errors in configuration you may have.