The tools contained in the
product-tools
package were developed using Java and will run on any platform with a supported Java Runtime Environment (JRE). The tools were specifically developed under Sun Java version 1.4, so the tool will execute correctly under versions 1.4 or 1.5.
Since the tools are developed using Sun's Java, this is the preferred Java environment for operation. The Sun Java package can be obtained from the
Su
n Java
web site. Other Java environments are relatively compatible with Sun's Java. Testing has been performed with GNU's Java environment. The result is that release 4.1.1 at a minimum is required for nominal operations.
With this release of VTool, the requirement of using the provided PDS data dictionary is no longer necessary. Through the efforts of many, the anomalies found in past versions of the data dictionary have been corrected in release
1r64
. So, this release or later of the data dictionary is required for VTool. Release
1r66
of the data dictionary supports the validation of explicit FILE objects. The latest version of the PDS data dictionary can be retrieved from the
PDS Data Dictionary Lookup
web page.
Download the
product-tools
package from the
PDS Software Download
web page. The binary and source distributions are available in identical zip or tar/gzip packages. Unpack the selected file with one of the following commands (where X.X.X is the current version):
[node: ~] unzip product-tools-X.X.X.zip
or
[node: ~] tar -xzvf product-tools-X.X.X.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 above commands result in the creation of the
product-tools-X.X.X
directory with the following directory st
ructure:
-
LICENSE.txt
The copyright notice from the California Institute of Technology detailing the restrictions regarding the use and distribution of this software.
-
bin/
This directory contains the executable jar file containing the Validation Tool software along with a batch and shell script for executing the tool.
-
docs/
This document directory contains a local web site with the Product Tools Guide, javadoc, unit test results and other configuration management related information. Just point your favorite browser to the
index.html
file in this directory.
-
lib/
This directory contains the dependent jar files for the tool along with the jar file (product-tools-X.X.X.jar) containing the Validation Tool software.
A batch file,
VTool.bat
, and shell script,
VTool
, are included in the
product-tools
package to provide an easy way of running the Validation Tool on Windows and Unix-based environments, respectively.
In both the batch file and shell script, there is a variable named
jarpath
that needs to be modified before the scripts can be executed. The variable needs to be set to the correct location of the executable
product-tools
jar file.
The following demonstrates the
jarpath
being set to the product-tools jar file location. The example contains
X.X.X
, which should be replaced with the current version of the
product-tools
package.
Note: The example has been broken into multiple lines for readability.
set jarpath = \
"/home/user/product-tools-X.X.X/bin/product-tools-X.X.X-app.jar"