Tools Installation

Overview

This document describes how to install following PDS Registry tools:

  • Harvest is a command-line tool to crawl and extract metadata from PDS4 labels. Extracted metadata is stored in an "intermediate" JSON or XML data files. JSON data files can be loaded into Elasticsearch by Registry Manager.
  • Registry Manager is a command-line application to create Registry indices in Elasticsearch and to load, delete and export registry data.
  • Supplementer is a command-line tool to load supplemental metadata into PDS Registry.

Download and unpack the package

Download pds-registry-app archive in ZIP or TAR.GZ format from Github (tar.gz zip).

Extract it to a directory without spaces, such as /home/pds:

% unzip pds-registry-app-1.0.3-bin.zip
or
% tar -xzvf pds-registry-app-1.0.3-bin.tar.gz

The following directory will be created: pds-registry-app-1.0.3. It has the following structure:

  • harvest-3.5.2/

    This directory contains Harvest command-line tool.

  • registry-4.3.1/

    This directory contains Registry Manager command-line tool.

  • supplementer-1.0.1/

    This directory contains Supplementer command-line tool.

  • test/

    This directory contains reference test datasets to validate the deployment.

  • LICENSE

    The Apache License, Version 2.0

  • README.txt

    A README file with some high level information on the project and how to view more detailed documentation.

  • VERSION.txt

    A VERSION file contains the version of the project.

Configure your environment

Update PATH environment variable to be able to run Harvest and Registry Manager from any directory.

Unix

For example, if you are using BASH, add the following to your .bash_profile.

# Update path as needed
HARVEST_HOME=/path/to/pds-registry-app-1.0.3/harvest-3.5.2
REGISTRY_HOME=/path/to/pds-registry-app-1.0.3/registry-manager-4.3.1
export PATH=${PATH}:$HARVEST_HOME/bin:$REGISTRY_HOME/bin

Windows

Open the Start Menu and begin typing "environment". Select "Edit environment variables for your account".

Environment Variables dialog will open where you can edit "Path" variable.

Add Harvest and Registry Manager "bin" directory to "Path" variable.

Next Steps

The registry tools are deployed. You can now setup API Server.