Chapter 18. Configuration

QuickRev can be configured in different ways via configuration files.
Most options can be configured via the Preferences dialog as well, but there are general configuration items which have to be defined via configuration files. These configuration items allow to add different input fields (like text areas, check boxes, etc.) to the Information and Conclusion panes, which can differ between the initial review cycle and following once. A stylesheet can be specified which will be written to the project files to transform them into readable html-pages when opening them in the browser. Furthermore the values for the Severity and State can be changed and the used date format can be configured as well.
Other configuration items like email client settings and general tool definitions can be done individually by every QuickRev user, but it may useful to provide a default configuration for the email client settings or define default tools to be available for all users without additional configuration.
Configuration files can be loaded either via command line options or packaged into the QuickRev.jar file to be available for all users without additional command options.

Loading configuration files via command line options is done as follows:
java -jar QuickRev.jar --config <config-file-name(s)> The config file can be given as local file or a remote one (http://).

Command Line Options for syntax.

A built in configuration file has to be named config.xml and has to be copied into the QuickRev.jar:/resources/ directory.

Add Built-In Config File to QuickRev.jar for a detailed description.

Even the default input fields can be changed.

See Changing the Default Configuration.

Config File Structure

The config file has to have the following structure.
Except of the root element all other elements are optional. The order of the elements is not relevant. You can use a different configuration file for every topic, so you can e.g. create a users.xml file with all known users and there email addresses and another config file for general settings.

Name			use	Description	These settings can be changed via the QuickRev menu as well
QuickRev			required	The root element of a config file.	no
-	Preferences		optional	Defines general settings.	yes
-	-	EmailNotification	optional	Defines general templates to be used for email notifications.	yes
-	-	Tools	optional	Defines general tools.	yes
-	-	FindProjects / Excludes	optional	Defines paths to be excluded during search for open reviews or configuration or history database.	yes
-	-	SortFiles	optional	Defines a default sort order when adding review files to a project.	yes
-	Users		optional	Defines users and their email addresses to be selected easily.	yes
-	VCS		optional	Defines settings and commands of the used version control system.	yes
-	SVN		optional
-	ClearCase		optional
-	Configuration		optional	Defines which files will not be shown as text (e.g. pdf / doc / etc.).	yes
-	-	Output	optional	Defines which stylesheet (if any) has to be references in the project files.	yes
-	-	Date	optional	Defines the date format to be used.	no
-	-	Severities	optional	Defines the values to be selected for the Severity and State of a comment.	no
-	-	States	optional		no
-	-	Information	optional	Defines additional input fields (i.e. TextField, TextArea, Choice, Decision, TimeField, DateField) for the Information tab and the Conclusion tabs.	no
-	-	Conclusion	optional
-	-	FollowUpConclusion	optional
-	-	EmailClientSettings	optional	Defines the email client settings (SMTP).	yes

Add Built-In Config File to QuickRev.jar

If a default configuration file will be found under /resources/config.xml in the jar-file it will be loaded during startup.
To copy the config file into the jar-file you can open the jar file with a packager of your choice (e.g. 7-Zip) and copy the config.xml file into the resources directory of QuickRev.jar.
Alternatively you can use the jar command delivered with your java environment as follows:

$> mkdir resources
$> cp MyConfigFile.xml resources/config.xml
$> jar -uf QuickRev.jar resources/config.xml

To list the content of the jar-file use the following command.

$> jar -tf QuickRev.jar

...
net/tomse/util/xml/Reader.class
net/tomse/util/xml/Elem.class
resources/config.xml

After start of QuickRev the name of the configuration file will be displayed on the left side of status bar.

Changing the Default Configuration

To change the default fields at the Information and Conclusion tabs modify or remove the default configuration file located in the jar-file under /resources/default.xml.

18.1. Element: QuickRev

	Name	Use	Values	Changeable via the QuickRev menu	Description
Element	QuickRev	required	Preferences?, Users?, VCS?, ClearCase?, SVN?, Configuration? (any order)		The root element of a QuickRev configuration file.
Attributes	configName	optional	string	no	The name of the configuration file. The name will be shown on the left side of the status bar. "default" is a reserved name which should not be used.

<?xml version="1.0" encoding="UTF-8"?>
<QuickRev configName="name">
  <Preferences>
    <EmailNotification/>
    <Tools/>
  </Preferences>
  
  <Users/>
  <VCS/>
  <ClearCase/>
  <SVN/>

  <Configuration>
    <Output/>
    <Date/>
    <Severities/>
    <States/>
    <Information/>
    <Conclusion/>
    <FollowUpConclusion/>
    <EmailClientSettings/>
  </Configuration>
</QuickRev>