Installation Notes

Ver. 2.3.1

Steps to install ITCWorks

1. Download and save itcworks2_2_X.zip or itcworks2_2_X.tar.gz (version number may vary) to a directory on local machine.

Unzip contents into a directory, say myItc. The contents are described below:

myItc

bin -- Command line helpers to run the junit tests, object sql

mapper and sql batch processor

docs -- All ItcWorks documentation and docs.zip which contains

the javadoc

lib -- all required jars to run ItcWorks applications

src -- The ItcJunit and ItcWorks source files (includes javadoc in

docs.zip)

2. Under src should are the following zip files:

itcjunitsrc.zip

itcworkssrc.zip

3. Unzip each of the above into a separate folder, say itcjunit and

itcworks

4. Create 2 new projects in your favorite ide, say itcjunit and itcworks and import the contents into them.

5. Include the jars found under myItc (or whatever name you chose) in the classpath of each of the projects. Make sure to also add the resources folder (if you’re running from an ide) in each project to the classpath. Properties and other documents will not be found if this step is omitted. This primarily applies to the itcjunit project assuming you have expanded the source into your ide’s project space.

6. Edit the junit.properties file found under resources/resource/properties of the itcjunit project and replace “Your install path” with your project path, in this case “itcworks”.

7. You will need to edit the DatasourceDrvers.xml document found in the resources/resources/docs folder of the itcjunit project for your database configuration. Please refer to the ItcWorksORM.pdf document for details on this process.

9. You should be able to run all the test cases under the junit project

with the exception of those under the test.itc.db and test.itc.mail

packages, which are database/smtp server specific.

Getting Started:

Recommended reading:

The ITC-WorksWhitePaper.pdf document gives a good breakdown of what is in ItcWorks Application Developers Kit (ADK). This is the best place to start. The ItcWorksORM++.pdf document describes the ItcWorks object relational mapping in detail. It is both a reference and users guide. For XML applications, the

Itc-JSchemaUserGuide and ITC-JWSDLUserGuide pdf documents describe those frameworks and tools. The ITC-JspTaglib-TechincalReference,pdf document provides the details on the very rich new set of JSP tags for Web development.

Source code:

The ItcJunit source code found in the itcjunitsrc.zip package is recommended to view as it provides the API context examples on incorporating ItcWorks into your applications.