 |
|
|
 |
Software Documentation
- About Validate Tool
- Release Notes
- Installation
- Operation
Download
Project Documentation
Installation
This section describes how to install the Validate Tool software contained in the validate package. The following topics can be found in this section:
System Requirements
The Validate Tool was developed using Java and will run on any platform with a supported Java Runtime Environment (JRE). The software was specifically developed under Java version 1.6 and has only been tested with this version. The following commands test the local Java installation in a UNIX-based environment:
% which java
/usr/bin/java
% java -version
java version "1.6.0_26"
Java(TM) SE Runtime Environment (build 1.6.0_26-b03-384-10M3425)
Java HotSpot(TM) 64-Bit Server VM (build 20.1-b02-384, mixed mode)
The first command above checks whether the java executable is in the environment's path and the second command reports the version. If Java is not installed or the version is not at least 1.6, Java will need to be downloaded and installed in the current environment. Consult the local system administrator for installation of this software. For the do-it-yourself crowd, the Java software can be downloaded from the Oracle Java Download page. The software package of choice is the Java Standard Edition (SE) 6, either the JDK or the JRE package. The JDK package is not necessary to run the software but could be useful if development and compilation of Java software will also occur in the current environment.
Unpacking the Package
Download the validate package from the PDS FTP site. The binary distribution is available in identical zip or tar/gzip packages. Unpack the selected binary distribution file with one of the following commands:
% unzip validate-0.4.0-bin.zip
or
% tar -xzvf validate-0.4.0-bin.tar.gz
Note: Depending on the platform, the native version of tar may produce an error when attempting to unpack the distribution file because many of the file paths are greater than 100 characters. If available, the GNU version of tar will resolve this problem. If that is not available or cannot be installed, the zipped package will work just fine in a UNIX environment.
The commands above result in the creation of the validate-0.4.0 directory with the following directory structure:
- README.txt
A README file directing the user to the available documentation for the project.
- LICENSE.txt
The copyright notice from the California Institute of Technology detailing the restrictions regarding the use and distribution of this software. Although the license is strictly worded, the software has been classified as Technology and Software Publicly Available (TSPA) and is available for anyone to download and use.
- bin/
This directory contains batch and shell scripts for executing the tool.
- doc/
This document directory contains a local web site with the Validate Tool Guide, javadoc, unit test results and other configuration management related information. Just point the desired web browser to the index.html file in this directory.
- lib/
This directory contains the dependent jar files for the tool along with the executable jar file (validate-0.4.0.jar) containing the Validate Tool software.
Configuring the Environment
In order to execute the Validate Tool, the local environment must first be configured appropriately. This section describes how to setup the user environment on UNIX-based and Windows machines.
UNIX-Based Environment
This section details the environment setup for UNIX-based machines. The binary distribution includes a couple shell scripts that must be executed from the command-line. Setting the PATH environment variable to the location of the scripts, enables the shell scripts to be executed from any location on the local machine.
The following command demonstrates how to set the PATH environment variable (in Bourne shell), by appending to its current setting:
% export PATH=${PATH}:${HOME}/validate-0.4.0/bin
In addition, the shell scripts require that the JAVA_HOME environment variable be set to the appropriate location of the Java installation on the local machine. The following command demonstrates how to set the JAVA_HOME environment variable:
% export JAVA_HOME=/path/to/java/home
The system administrator for the local machine may need to be consulted for this location. The path specified should have a bin sub-directory that contains the java executable. This variable may also be defined within the scripts. Edit the scripts (files without the .bat extension) and change the line in the example above to represent the local Java installation.
Windows Setup
This section details the environment setup for Windows machines. The binary distribution includes a couple batch scripts that must be executed from the command-line. Setting the PATH environment variable to the location of the files, enables the batch scripts to be executed from any location on the local machine.
The following command demonstrates how to set the PATH environment variable, by appending to its current setting:
C:\> set PATH = %PATH%;C:\validate-0.4.0\bin
In addition, the batch scripts require that the JAVA_HOME environment variable be set to the appropriate location of the Java installation on the local machine. The following command demonstrates how to set the JAVA_HOME environment variable:
C:\> set JAVA_HOME = C:\path\to\java\home
The system administrator for the local machine may need to be consulted for this location. The path specified should have a bin sub-directory that contains the java executable. This variable may also be defined within the scripts. Edit the scripts (files with the .bat extension) and change the line in the example above to represent the local Java installation. Additional methods for setting Windows environment variables can be found in the Windows System Properties section. If viewing this document in PDF form, see the appendix for details.
Configuring Alternate Core Schemas
This section details how to configure the Validate Tool to use core schemas from an external directory rather than the core schemas loaded internally with the tool.
The Java system property, core.schema.dir, can be used to load core schemas from an external directory. At this time, any external directory used must have a sub-directory named 0500g with the schemas under this sub-directory. For example, if specifying an external directory named /home/pds/schemas, the directory must have the following structure:
- 0500g/
This directory will contain the list of core schemas to load into the tool. This overwrites the internal core schemas used for validation.
The sections below detail how to add this system property into the Validate Tool launch scripts.
UNIX-Based Users
Open the Validate shell script and go to the last line in the file. It should look like the following:
${JAVA_HOME}/bin/java -jar ${VALIDATE_JAR} "$@"
Add the core.schema.dir Java system property using the -D Java flag option and set it to the location of the schemas. For example, making the following change to the launch script allows the Validate Tool to load core schemas from a directory named /home/pds/schemas:
${JAVA_HOME}/bin/java -Dcore.schema.dir="/home/pds/schemas" -jar ${VALIDATE_JAR} "$@"
Windows-Based Users
Open the Validate batch and go to the last line in the file. It should look like the following:
"%JAVA_HOME%"\bin\java -jar "%VALIDATE_JAR%" $*
Add the core.schema.dir Java system property using the -D Java flag option and set it to the location of the schemas. For example, making the following change to the launch script allows the Validate Tool to load core schemas from a directory named c:\pds\schemas:
"%JAVA_HOME%"\bin\java -Dcore.schema.dir="c:\pds\schemas" -jar "%VALIDATE_JAR%" $*
 |
 |
|
 |
|