Setting up the XRadar development environment

1. Understand the basic configuration

Setting up the XRadar developement environment is very similar to Configuring an XRadar project in ant . Since most of the code is interpreted (xslt), no build process is needed, unless you intend to build javacode (which there is very little of).

Hence, we STRONGLY recommend that you have installed and configured the XRadar by download and have followed the documented steps for configuring the XRadar before checking out from svn. Put the project under a temp-strucure and validate that the testproject looks OK. When complete, you know that all the prerequisites for the XRadar are configured correctly.

2. Check out XRadar-base from SVN

Checking out from svn is described under SVN on the XRadar Sourceforge project page . See more for instructions there. See below for intructions on project paths and so on.

If you work on a windows system, the simplest way to do developement is to define a project strucure that complies with the default project strucure. That means that you define a workspace under c:/projects/xradar where you put all the xradar svn projects. In this way, you would get a strucure as the following: 


c:/projects/xradar
                   /xradar                : base module in SVN
                   /xradar-maven          : xradar-maven (maven 1) module in SVN
                   /maven-xradar          : xradar-maven (maven 2) module in SVN
                   /[other module]        : other xradar module in SVN
In eclipse, under this structure, your workspace would be defined under c:/projects/xradar and each import from svn would be checked out (by import) directly underneath.

But, the likelyhood is high that you are a stubborn developer that like your own project structure (I am sure I would be too ;) ). In this case the base structure would be the same: 

[XRADAR_WORKSPACE]
                   /xradar                : base module in svn
                   /xradar-maven          : xradar-maven (maven 1) module in SVN
                   /maven-xradar          : xradar-maven (maven 2) module in SVN
                   /[other module]        : other xradar module in svn
In this case, it is absolutely necessary that you define user.properties files instantly after checkout under xradar/ and xradar/testproject/ that you use to override the config-properties ("ant.lib" under base/ and "xradar.home" under base/testproject/). If you start changing the properties in the project.properties files, these changes could easily - by accident - be commited to svn, causing unecesarry problems for other developers.

3. Do a one-time build and project test

Once the base project is checked out, you are ready to build the system (I assume here that you have already configured the system properly as defined under Configuring an XRadar project in ant ). Run the following ant command: 

[XRADAR_WORKSPACE]/xradar/ ant build_java_source.
You have know build the xradar.jar file and put it into the lib-catalog. The next step is to run the following command: 
[XRADAR_WORKSPACE]/xradar/testproject/ ant statics_all dynamics_all
The project should have completed successfully. Look at the testproject and check if it looks OK. Thereafter, read through the log on the command screen and check if there were no strange warnings during the process.

4. Develop

The system should now be ready to do changes to. See development process for more on guidelines on developing the XRadar.