PDL Client Install Instructions

« Back to User Guide


System Requirements

PDL Client Downloads

Versions and Release Notes can be found on GitHub: https://github.com/usgs/pdl/releases

Download and unzip ProductClient.zip This includes shell scripts for unix and a batch file for windows. https://usgs.github.io/pdl/ProductClient.zip

You can upgrade to the latest version by replacing ProductClient.jar and restarting the process. https://usgs.github.io/pdl/ProductClient.jar


Automatic Scheduling

For Linux users, the PDL client can be started automatically on client machine reboot. This requires adding PDL's init.sh shell script to be added to the Crontab table. Calling the init script from the crontab will automatically start, or restart if the process isn't running, the PDL client application.

To add an entry to the crontab table, execute:  sudo [pdluser] crontab -e

...where [pdluser] is the client machine's user ID for running PDL.

After asking for your password, this will bring up the crontab table using your system's default editor (you must be listed in your system's sudoers table to perform this operation. See this link for adding a user to sudoers) Add the following to crontab, where PDL_CLIENT_DIR is the location of the ProductClient PDL Client directory:

# start (if not already running) every five minutes
*/5 * * * * PDL_CLIENT_DIR/init.sh start >/dev/null 2>&1 &

In the above crontab snippet, the five asterisks specify the runtime minute, hour, day-of-month, month and day-of-week. Under Linux systems, "*/5" will evaluate to "run every 5 minutes." This should also work on BSD Unix systems such as Mac OS X. An alternative syntax explicitly names the minutes after the hour in a comma-separated list:

# start (if not already running) at 5, 10, 15, ...minutes after the hour
5,10,15,20,25,30,35,40,45,50,55 * * * * PDL_CLIENT_DIR/init.sh start >/dev/null 2>&1 &

The redirect to dev/null throws away standard output and the 2>&1 redirects standard error output to the same stream as standard output (throw away). The ending ampersand launches init.sh in the background.

NOTE: the init script assumes java is on the system PATH. You may need to configure a crontab path, or update the init script to use an absolute path for java.

Downloaded File List

The directory unzipped from the download, containing all the other files
A simple text file containing instructions for a receipt of PDL products
A Unix/Linux shell script that executes receipts and sends of PDL products
A Windows batch file version of run.sh
A shell script for starting and stopping the PDL Client, as well performing a status inquiry
A file containing PDL client configuration information. By default, it configures the sending and receiving of all product types.
The archive file containing all the Java code necessary for running the PDL client.