Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

Introduction

This is the third in a series of articles describing how to get started with using the the JADE Client via its Command Line Interface.

...

  1. Getting Started and Downloading files
  2. Simple File Selection
  3. More Advanced File Selection
  4. Checking files for completeness
  5. Public / Private Key Authentication

File Selection - More Complex Examples

Polling a source directory for a minimum number of files

JADE can poll a source directory at regular intervals until it finds a file name match or until a specified length of time has elapsed. If it finds a file name match with one or more files it will then transfer the matching file(s) and then stop polling.

...

JADE will transfer all those files it has found at the end of the polling interval if the minimum number of matches has not been reached.

Example

In the example profile listed below the function of the four poll_* parameters should be self-explanatory but the following should be noted:

...

Code Block
languagebash
jade.cmd -settings="%USERPROFILE%\jade_demo\jade_settings.ini" -profile="sftp_server_2_local_poll_minfiles"

Example behavior with poll_minfiles = 3  

  • JADE will transfer all the files found at the first polling - in this case the 5 test_*.txt files - as more than the minimum number of files has been found. Polling will then be stopped.
  • If no files were to be found then the JADE engine would throw an error as long as force_file = true has not been set.

Example behavior with poll_minfiles = 6

Change the poll_minfiles parameter in your settings file to 6, save the settings file and rerun the example.

  • JADE will find the five test_*.txt files when it polls but will not transfer the files as the minimum number of 6 has not been reached.
  • JADE will repeat polling until the time set in the poll_timeout parameter (in the example 1 minute) has expired.
  • Note that all the files that have been found will be transferred once the timeout has been reached.

File Transfer Examples

Renaming files

The following example combines two renaming possibilities:

  • Renaming files
  • Adding a date-stamp to file names

Example

The file name part(s) to be replaced is/are defined in the replacing parameter with round brackets () and the new part(s) in the replacement parameter, separated by semi-colons.

...

Code Block
languagebash
jade.cmd -settings="%USERPROFILE%\jade_demo\jade_settings.ini" -profile="replace_local_datestamp"

Behavior

The five test_*.txt files in the the a folder will be copied to the b folder and parts of their names will be replaced as described above.

File cumulation

JADE can cumulate the contents of individual files to a single target file:

  • Files matching the file_spec regular expression are cumulated together into a new file
  • The original files can be deleted if required
  • There is not a de-cumulate parameter available at the moment

Example

The example profile downloads the five text_*.txt files from our demo server and adds their contents successively to a cumulative file.

...

Code Block
languagebash
jade.cmd -settings="%USERPROFILE%\jade_demo\jade_settings.ini" -profile="sftp_server_2_local_cumulate"

Behavior

Opening the cumulative file text-files.txt in a text editor after transfer has been completed shows the order in which individual files were added to the cumulative file.

Note that this will not necessarily follow the order in which transfer of individual files was started.

File compression and decompression

JADE can compress individual files locally using a gzip-compatible compression. Compressed files can then be stored locally or forwarded to a further destination. JADE is not currently able to include a number of files in an unpackable container as is usually done with desktop zip archivers.

Example

The example profile will cause JADE to download the two PDF files on the remote host, compress them and then store them in the local directory a.

...

Code Block
languagebash
jade.cmd -settings="%USERPROFILE%\jade_demo\jade_settings.ini" -profile="sftp_server_2_local_compress"

Behavior

After transfer and compression the files are stored with the default suffix .gz. This suffix can be changed if required by setting a compressed_file_extension parameter.

The example files will be reduced in size to approximately 26 KB (lorem_ipsum_large.pdf) and 23 KB (lorem_ipsum_medium.pdf).

File decompression

The decompress_after_transfer parameter can be used to decompress files after transfer.

...