Invicta Usage

1.  General
2.  Invicta Properties
3.  Running Using Script
4.  Implicit Running
5.  Running Manually

1. General

According to properties set, running Invicta invokes requested Dumpers.  This results in the creation of output files, the most common of which is ANT's build.xml.

Note that Invicta will not always process.  For efficiency reasons, it will first check if running is necessary.

You may refer to Creating a new project for more details.

Return to top

2. Invicta Properties

Before actually running Invicta, it is important to verify that Properties definitions are set properly.  The invicta.properties file consists of a list of project definition locations (comma-separated list, each item is either a file or a directory all whose .xml files will be used). The same goes for the property of the list of Type definition locations.

All Dumpers are disabled by default.  To get adumper to be activated in the next run, you need to set the enabled property of the dumper: invicta.dumpers.<dumper_name>.enabled.  Another important property to set is the file property for the dumpers activated, which tells Invicta where to write the output file to. Multiple dumpers can be activated in a single Invicta session.

Return to top

3. Running Using Script

Run one of the following:

  1. runInvicta.tcsh.

  2. runInvicta.bat

  3. ant -f invicta.build.xml

  4. Implicit Running

  5. Running manually

If error messages appear, your definition files may contain errors such as incorrect syntax, addressing non-existent components due to typos, etc. Fix your files according to the error messages.

If Invicta ran successfully, use the generated output files.  In most cases, you would now activate ANT on the generated build.xml.

Return to top

4. Implicit Running

Once you have a build.xml file generated by AntDumper, running ANT on it in attempt to build the project will invoke Invicta first.  Invicta will check whether it should run again before ANT's build session is continued.  Among the scenarios in which Invicta would indeed run are the changing of definition or type files, missing output files, and the changing of Invicta properties.

Return to top

5. Running Manually

Invicta is a standard Java application. You need to set the JVM classpath, provide the required system properties and specify the class name.

The following are standard commands for running Invicta manually on Unix and Windows. They uses the environment variable INVICTA_HOME.

Unix:

java -classpath ${INVICTA_HOME}/lib/invicta.jar:${INVICTA_HOME}/lib \
     -Dinvicta.dir=${INVICTA_HOME} \
     -Dlocal.env.dir=. \
     net.sf.invicta.Invicta

Windows:

java -classpath %INVICTA_HOME%\lib\invicta.jar;%INVICTA_HOME%\lib
     -Dinvicta.dir=%INVICTA_HOME% 
     -Dlocal.env.dir=.
     net.sf.invicta.Invicta

Return to top