Robo-FTP User's Guide > Robo-FTP Framework > Job Definitions > Built In Steps

Note: First see Working with File Sets for a discussion on how data flows through step to step.

The Decrypt step decrypts PGP (or GPG) encrypted source files in the current file set. The decrypted output files replace the encrypted source files in the current file set that is passed on to the next step in the job.

Friendly Name	INI Variable	Required?	Description
File Filter	specification	optional	file mask limiting which files this step should process
Search Pattern	pattern	optional	regex search string to match characters in decrypted file name
Replace Pattern	replace	optional	regex replacement string for matched characters in output filename
Archive Files	archive_files	optional	keep archival copies of created or imported files

The decrypted output files are named using the filename embedded in the PGP file itself, as given in an internal header. If you require a different name for these files, you can do so by using the regular expression-based "Search Pattern" and "Replace Pattern" to rename the target file. For example, we can ignore the embedded filename and ensure the decrypted file has the same name as the .pgp file itself, minus the actual ".pgp" extension, using the following example:

decrypt_with_rename

Note: For this step to work, the correct private key and its passphrase must be imported into the Robo-FTP Configurator.

Example Usage:

step_decrypt

The following example uses regular expression Search and Replace patterns to drop the .pgp / .gpg extension and add a prefix containing the current date to the decrypted file:

framework_decrypt_example_search_replace