R U N N I N G   X A R C H
XArch has been implemented as a stand-alone Java application. The main user interface for the archive management system is the XArch Command Center. Complete the following steps to run the Command Center on your local machine:
1.Make sure that you have Java Runtime Environment (JRE) 6.0 or later installed on your machine.
2.Unzip and extract the content of the XArch binary distribution into a local directory.
3.Run the Command Center from the command line using the following command:
java -jar [-mxXXX] XArchCC.jar [-d] [config-file]
It is suggested to run the Command Center with at least 256MB of Java heap space (i.e., -mx256M). When displaying large query results, 512MB of Java heap space or more is recommended.
The Command Center accepts the following (optional) command line parameter:
-d Activates the debugging mode that will print Java stack traces for exeptions.
config-file An optional config-file setting and maintaining the Command Center properties. If the specified file does not exist it will be created automatically.
4.Make sure that you are connected to an archiver instance.
Archiver Instance

An archiver instance is one of the central concepts when working with the Command Center. In general, an archiver instance is a collection of archives and related information. In practice, an archiver instance is a directory on your local machine and a instance configuration file containing a set of properties that control the Command Center's runtime behavior.

You always have to be connected to a specific instance before being able to create and query archives. A new archiver instance can be created using the menu Extras > Archiver instance ... > New .... The properties of the current instance may be modified using menu Extras > Archiver instance ... > Edit ....

The properties of an instance are stored in a configuration file and can be set or modified when creating or editing the instance. The properties are:
INSTANCE NAME The name of the instance.
HOME DIRECTORY The home directory of the instance on the local file system. This directory is used by the archiver to create necessary files for its operation. It is recommended to use an empty directory as an instance home directory. It is required to use different directories for different instances.
TEMP. FILE DIRECTORY An optional directory where temporary files will be stored when merging new database versions into an archive. If this property is not set the systems standard directory for temprorary files will be used.
NODE BUFFER SIZE Size of the node buffer used when merging new database versions into an archive.
SORT HEAP SIZE The fraction of the Java heap space (in bytes) to be available for sorting when merging new document versions into an archive. A value between 80% - 95% of the Java heap space (see above) is recommanded.

To connect to an instance use Extras > Archiver instance ... > Open ... or specify the instance configuration file as the default instance in the Command Center properties. Complete the following steps in order to run the Command Center using a default instance:

1.Create an empty directory on your local machine.
2.Run the Command Center from the command line using the following command:
java -jar -mx512M XArchCC.jar -d config-file
Make sure to specify a valid config-file. If the file does not exist it will be created automatically.
3.Open the instance properties window using menu Extras > Archiver instance ... > New ....
4.Specify an instance name, e.g., MYINST, and enter the name of the directory created in step 1.) into the HOME DIRECTORY field.
5.Save the instance configuration by clicking on the Ok button.
6.Open the Command Center config-file using menu Extras > Properties.
7.Insert the name of the instance configuration file into the DEFAULT INSTANCE field.
8.Save the Command Center properties by clicking on the Ok button.
9.Close the Command Center and re-run command 2.).