Action types

Top   Previous   Next

There are several built-in action types that you may use when defining triggers.  These action types are documented below.

 

Action Summary

 

Action

Description

Ad Hoc Email File Transfer

Performs an ad-hoc email file transfer of up to 5 files.

Append File

Appends message to a file with a new line.

Check Email

Retrieves email from a POP or IMAP account and stores message and attachments locally.

Convert File

Converts file from one line encoding to another. For example, UNIX to Windows.

Copy Directory

Copies a source directory to a destination directory.

Copy File

Copies a source file to a destination directory.

Copy Regex File

Copies files matching a regular expression to a destination directory.

Create Directory

Creates a directory.

Delete Accounts

Deletes expired and disabled accounts.

Delete Directory

Deletes a directory.

Delete File

Deletes a file.

Delete Files

Deletes files from a local directory.

Directory Download Synchronization

Downloads sync of remote source directory to local destination directory.

Directory Upload Synchronization

Uploads synch of local source directory to remote destination directory.

File Transfer Script

Executes a file transfer script.

Ftp Create Directory

Creates directory on FTP server.

Ftp Delete Directory

Deletes remote directory and contents from FTP server.

Ftp Delete File

Deletes remote file from FTP server.

Ftp Dir Download

Downloads remote directory and contents recursively from FTP server.

Ftp Dir Upload

Uploads local directory and contents to FTP server.

Ftp File Download

Downloads file from FTP server.

Ftp File Upload

Uploads local file to FTP server.

Ftp Regex File Download

Downloads files from FTP server matching a regular expression.

Ftp Regex File Upload

Uploads files to FTP server matching a regular expression.

Ftp Rename File

Renames file on FTP server.

Ftps Create Directory

Creates directory on FTP server using FTPS (FTP over SSL).

Ftps Delete Directory

Deletes remote directory and contents from FTP server using FTPS (FTP over SSL).

Ftps Delete File

Deletes remote file from FTP server using FTPS (FTP over SSL).

Ftps Dir Download

Downloads remote directory and contents recursively from FTP server using FTPS (FTP over SSL).

Ftps Dir Upload

Uploads local directory and contents recursively to FTP server using FTPS (FTP over SSL).

Ftps File Download

Downloads file from FTP server using FTPS (FTP over SSL).

Ftps File Upload

Uploads local file to FTP server using FTPS (FTP over SSL).

Ftps Regex File Download

Downloads files from FTP server matching a regular expression using FTPS (FTP over SSL).

Ftps Regex File Upload

Uploads files to FTP server matching a regular expression using FTPS (FTP over SSL).

Ftps Rename File

Renames file on FTP server using FTPS (FTP over SSL).

Gunzip File

Gunzip the input archive.

Gzip File

Gzip the input file to an archive.

Http Request

Performs an HTTP request.

Judo Script

Executes a judo script.

Move Directory

Moves a source directory to a destination directory.

Move File

Moves a source file to a destination directory.

Move Regex File

Moves files matching a regular expression to a destination directory.

PGP Decrypt File

Decrypts file using PGP.

PGP Encrypt File

Encrypts and optionally signs file using PGP.

Rename Directory

Renames directory.

Rename File

Renames file.

Run Process

Executes a local command using system shell.

Run Report

Re-runs an existing report.

Scp File Download

Downloads file from SSH server using SCP (Secure Copy) protocol.

Scp File Upload

Uploads file to SSH server using SCP (Secure Copy) protocol.

Send Email

Sends an email message.

Sftp Create Directory

Creates directory on SFTP server.

Sftp Delete Directory

Deletes remote directory and contents from SSH server using SFTP protocol.

Sftp Delete File

Deletes remote file from SSH server using SFTP protocol.

Sftp Dir Download

Downloads remote directory and contents recursively from SSH server using SFTP.

Sftp Dir Upload

Uploads local directory and contents recursively to SSH server using SFTP.

Sftp File Download

Downloads file from SSH server using SFTP.

Sftp File Upload

Uploads file to SSH server using SFTP.

Sftp Regex File Download

Downloads files from SSH server matching a regular expression using SFTP.

Sftp Regex File Upload

Uploads files to SSH server matching a regular expression using SFTP.

Sftp Rename File

Renames file on SFTP server.

Sql Query

Performs an SQL insert, update or delete query.

System Configuration Backup

Creates ZIP backup of server configuration files.

System Out

Prints message to log file and to System.out.

Tar Directory

Creates a TAR archive of a directory.

Unzip File

Decompresses all files in zip archive to specified directory.

Zip Directory

Creates archive of directory using ZIP compression.

Zip File

Compresses input file to a zip file.

 

 

Action Properties

 

Ad Hoc Email File Transfer

 

Property

Description

Example

Login

The login username that this transfer will be initiated from.

jsmith

To

The recipient email address.

rjones@domain.com

From

The senders email address.

jsmith@domain.com

Subject

The email subject.

Some files for you

Message

The email message.

Here is a file

Protocol

The protocol to use for email link.

HTTP

File 1

The virtual path to file relative to Login root directory.

/path/to/file.txt

File 2

The virtual path to file relative to Login root directory.

/path/to/file.txt

File 3

The virtual path to file relative to Login root directory.

/path/to/file.txt

File 4

The virtual path to file relative to Login root directory.

/path/to/file.txt

File 5

The virtual path to file relative to Login root directory.

/path/to/file.txt

Expires

The number of days in which email links will expire.

5

 

 

Append File

 

Property

Description

Example

File

The file to append message to.

C:\output.txt

Message

The message to append.

test message

 

 

Check Email

 

Property

Description

Example

Hostname

The email server hostname or IP address.

mail.mydomain.com

Protocol

The protocol to connect with.  IMAP or POP

IMAP

Connection Type

The connection type to use.  PLAIN, SSL or START-TLS.

PLAIN

Port

The email server port.

110

Username

The email account username.

jsmith@mydomain.com

Password

The email account password.

secret

Private Decryption Key

Private key used for decrypting OpenPGP encrypted email messages.

mykey

Verification Key

Public key used for verifying OpenPGP signed email messages.

mykey

Message Directory

The directory in which to store retrieved email messages.

C:\tmp\messages

Attachments Directory

The directory in which to store retrieved message attachments.

C:\tmp\attachments

Delete Messages

Indicates whether messages should be deleted from server after retrieval.

true

Debug File

File to write debugging output to.

C:\tmp\output.txt

 

Convert File

 

Property

Description

Example

File

The input source file.

C:\input.txt

Destination

The output destination file.

C:\output.txt

Encoding

The character encoding used.

ISO-8859-1

Source Eol

The end of line encoding used in source file.

unix

Destination Eol

The end of line encoding used in destination file.

ms-dos

Delete Source

Delete source file after conversion.

true

 

Copy Directory

 

Property

Description

Example

Directory

The source directory.

C:\input

Destination Directory

The output directory.

C:\output

Copy

The level of copy to perform.

Directory and contents

 

Copy File

 

Property

Description

Example

File

The source file.

C:\input.txt

Destination Directory

The output directory.

C:\output

 

Copy Regex File

 

Property

Description

Example

Directory

The source directory.

C:\input

Regular Expression

The regular expression to use when selecting files from source directory.

.*\.txt

Destination Directory

The output directory.

C:\output

 

 

Create Directory

 

Property

Description

Example

Directory

The directory to create.

C:\output

 

Delete Accounts

 

Property

Description

Example

Delete Expired

If true expired accounts will be deleted.

true

Delete Disabled

If true disabled accounts will be deleted.

true

Delete Owned Accounts

If true, those accounts that are owned by deleted accounts will be deleted.

true

 

Delete Directory

 

Property

Description

Example

Directory

The directory to delete.

C:\input

Delete

The level of delete to perform.

Directory and contents

Delete Files Older Than

If greater than 0, will only delete files older than specified number of days.

30

 

Delete File

 

Property

Description

Example

File

The file to delete.

C:\input.txt

 

Delete Files

 

Property

Description

Example

Directory

The directory to delete files from.

C:\input

Regular Expression

Regular expression to use when deleting files.

.*\.txt

Delete Empty Directories

If true empty directories in this directory will be deleted.

true

Delete Files Older Than

If greater than 0, will only delete files older than specified number of days.  If 0 will delete all files.

30

Recursive

If true file deletion will apply to all subdirectories.  If false only the current directory will be processed.

true

 

Directory Download Synchronization

 

Property

Description

Example

Hostname

The remote server hostname or IP address.

192.168.1.1

Port

The server port.

21

Username

The server username.

jsmith

Password

The server password.

secret

Connection Type

The protocol connection type.

FTP

Source Directory

The remote source directory.

/home/users/jsmith

Destination Directory

The local destination directory.

C:\output

Transfer Mode

The transfer mode to use.  Valid values are auto, binary and ascii.

binary

Synchronization Mode

The synchronization mode to use.  Valid values are timestamp, filesize and checksum.  Checksum is not valid for SFTP protocol.

Sync Timestamp

Debug File

File to write debugging output to.

C:\output\log.txt

 

Directory Upload Synchronization

 

Property

Description

Example

Hostname

The remote server hostname or IP address.

192.168.1.1

Port

The server port.

21

Username

The server username.

jsmith

Password

The server password.

secret

Connection Type

The protocol connection type.

FTP

Source Directory

The local source directory.

C:\input

Destination Directory

The local destination directory.

/home/users/jsmith

Transfer Mode

The transfer mode to use.  Valid values are auto, binary and ascii.

binary

Synchronization Mode

The synchronization mode to use.  Valid values are timestamp, filesize and checksum.  Checksum is not valid for SFTP protocol.

Sync Timestamp

Debug File

File to write debugging output to.

C:\output\log.txt

 

File Transfer Script

 

Property

Description

Example

Script

The script to run.

set hostname = "host"

set username = "jsmith"

set password = "secret"

set protocol = "ftps"

set port = 2121

connect

del "file.txt"

disconnect

 

Ftp Create Directory

 

Property

Description

Example

Hostname

The FTP server hostname or IP address.

192.168.1.1

Port

The FTP server port.

21

Username

The FTP server username.

jsmith

Password

The FTP server password.

secret

Passive

Whether passive mode is enabled.

true

Remote Directory

The remote directory to create.

/home/users/jsmith

Debug File

File to write debugging output to.

C:\output\log.txt

 

 

Ftp Delete Directory

 

Property

Description

Example

Hostname

The FTP server hostname or IP address.

192.168.1.1

Port

The FTP server port.

21

Username

The FTP server username.

jsmith

Password

The FTP server password.

secret

Passive

Whether passive mode is enabled.

true

Remote Directory

The remote directory to delete.

/home/users/jsmith

Recursive

If true the directory files and subdirectories will be deleted.  Otherwise only directory files will be deleted.

true

Debug File

File to write debugging output to.

C:\output\log.txt

 

Ftp Delete File

 

Property

Description

Example

Hostname

The FTP server hostname or IP address.

192.168.1.1

Port

The FTP server port.

21

Username

The FTP server username.

jsmith

Password

The FTP server password.

secret

Passive

Whether passive mode is enabled.

true

File Name

The name of file to delete or a regular expression.

filename.txt

Remote Directory

The remote directory to delete file(s) from.

/home/users/jsmith

Regular Expression

True if File Name is a regular expression.  Otherwise false.

true

Debug File

File to write debugging output to.

C:\output\log.txt

 

 

Ftp Dir Download

 

Property

Description

Example

Hostname

The FTP server hostname or IP address.

192.168.1.1

Port

The FTP server port.

21

Username

The FTP server username.

jsmith

Password

The FTP server password.

secret

Passive

Whether passive mode is enabled.

true

Local Directory

The local directory to download to.

C:\output

Remote Directory

The remote directory to download.

/home/users/jsmith

Transfer Mode

The transfer mode to use.  Valid values are auto, binary and ascii.

binary

Perform Checksum

Whether to validate file integrity after download using XCRC checksum command.  XCRC may not be supported by all servers.

true

Retry Limit

The number of times to retry a failed file transfer before aborting process.

2

Retry Interval

The number of seconds to wait before performing retry.

60

Debug File

File to write debugging output to.

C:\output\log.txt

 

Ftp Dir Upload

 

Property

Description

Example

Hostname

The FTP server hostname or IP address.

192.168.1.1

Port

The FTP server port.

21

Username

The FTP server username.

jsmith

Password

The FTP server password.

secret

Passive

Whether passive mode is enabled

true

Local Directory

The local directory to upload.

C:\input

Remote Directory

The remote directory to upload to.

/home/users/jsmith

Transfer Mode

The transfer mode to use.  Valid values are auto, binary and ascii.

binary

Perform Checksum

Whether to validate file integrity after upload using XCRC checksum command.  XCRC may not be supported by all servers.

true

Retry Limit

The number of times to retry a failed file transfer before aborting process.

2

Retry Interval

The number of seconds to wait before performing retry.

60

Debug File

File to write debugging output to.

C:\output\log.txt

 

Ftp File Download

 

Property

Description

Example

Hostname

The FTP server hostname or IP address.

192.168.1.1

Port

The FTP server port.

21

Username

The FTP server username.

jsmith

Password

The FTP server password.

secret

Passive

Whether passive mode is enabled.

true

Remote File

The remote file to download from FTP server.

/home/users/jsmith/file.txt

Local File

The local file to download to.

C:\output\file.txt

Transfer Mode

The transfer mode to use.  Valid values are auto, binary and ascii.

binary

Perform Checksum

Whether to validate file integrity after download using XCRC checksum command.  XCRC may not be supported by all servers.

true

Retry Limit

The number of times to retry a failed file transfer before aborting process.

2

Retry Interval

The number of seconds to wait before performing retry.

60

Debug File

File to write debugging output to.

C:\output\log.txt

 

Ftp File Upload

 

Property

Description

Example

Hostname

The FTP server hostname or IP address.

192.168.1.1

Port

The FTP server port.

21

Username

The FTP server username.

jsmith

Password

The FTP server password.

secret

Passive

Whether passive mode is enabled.

true

Local File

The local file to upload

C:\input\file.txt

Remote Directory

The remote directory to upload file to.

/home/users/jsmith

Transfer Mode

The transfer mode to use.  Valid values are auto, binary and ascii.

binary

Perform Checksum

Whether to validate file integrity after upload using XCRC checksum command.  XCRC may not be supported by all servers.

true

Retry Limit

The number of times to retry a failed file transfer before aborting process.

2

Retry Interval

The number of seconds to wait before performing retry.

60

Debug File

File to write debugging output to.

C:\output\log.txt

 

Ftp Regex File Download

 

Property

Description

Example

Hostname

The FTP server hostname or IP address.

192.168.1.1

Port

The FTP server port.

21

Username

The FTP server username.

jsmith

Password

The FTP server password.

secret

Passive

Whether passive mode is enabled.

true

Regular Expression

The regular expression to use when downloading files.

.*\.txt

Remote Directory

The remote directory to download files from.

/home/users/jsmith

Local Directory

The local directory to download files to.

C:\output

Transfer Mode

The transfer mode to use.  Valid values are auto, binary and ascii.

binary

Perform Checksum

Whether to validate file integrity after upload using XCRC checksum command.  XCRC may not be supported by all servers.

true

Retry Limit

The number of times to retry a failed file transfer before aborting process.

2

Retry Interval

The number of seconds to wait before performing retry.

60

Debug File

File to write debugging output to.

C:\output\log.txt

 

Ftp Regex File Upload

 

Property

Description

Example

Hostname

The FTP server hostname or IP address.

192.168.1.1

Port

The FTP server port.

21

Username

The FTP server username.

jsmith

Password

The FTP server password.

secret

Passive

Whether passive mode is enabled.

true

Regular Expression

The regular expression to use when uploading files.

.*\.txt

Local Directory

The local directory to upload files from.

C:\input

Remote Directory

The remote directory to upload files to.

/home/users/jsmith

Transfer Mode

The transfer mode to use.  Valid values are auto, binary and ascii.

binary

Perform Checksum

Whether to validate file integrity after upload using XCRC checksum command.  XCRC may not be supported by all servers.

true

Retry Limit

The number of times to retry a failed file transfer before aborting process.

2

Retry Interval

The number of seconds to wait before performing retry.

60

Debug File

File to write debugging output to.

C:\output\log.txt

 

Ftp Rename File

 

Property

Description

Example

Hostname

The FTP server hostname or IP address.

192.168.1.1

Port

The FTP server port.

21

Username

The FTP server username.

jsmith

Password

The FTP server password.

secret

Passive

Whether passive mode is enabled.

true

Remote Directory

The remote directory that file exists in.

/home/users/jsmith

Remote File

Name of file to rename.

filename.txt

Destination File

Name to rename file to.

filename.txt.tmp

 

 

Ftps Create Directory

 

Property

Description

Example

Hostname

The FTP server hostname or IP address.

192.168.1.1

Port

The FTP server port.

21

Username

The FTP server username.

jsmith

Password

The FTP server password.

secret

Passive

Whether passive mode is enabled.

true

Remote Directory

The remote directory to create.

/home/users/jsmith

Connection Type

The connection type.  Valid values are auth tls, auth ssl and implicit ssl.

auth tls

Debug File

File to write debugging output to.

C:\output\log.txt

 

 

Ftps Delete Directory

 

Property

Description

Example

Hostname

The FTP server hostname or IP address.

192.168.1.1

Port

The FTP server port.

21

Username

The FTP server username.

jsmith

Password

The FTP server password.

secret

Passive

Whether passive mode is enabled.

true

Remote Directory

The remote directory to delete.

/home/users/jsmith

Connection Type

The connection type.  Valid values are auth tls, auth ssl and implicit ssl.

auth tls

Recursive

If true the directory files and subdirectories will be deleted.  Otherwise only directory files will be deleted.

true

Debug File

File to write debugging output to.

C:\output\log.txt

 

Ftps Delete File

 

Property

Description

Example

Hostname

The FTP server hostname or IP address.

192.168.1.1

Port

The FTP server port.

21

Username

The FTP server username.

jsmith

Password

The FTP server password.

secret

Passive

Whether passive mode is enabled.

true

File Name

The name of file to delete or a regular expression.

filename.txt

Remote Directory

The remote directory to delete file(s) from.

/home/users/jsmith

Connection Type

The connection type.  Valid values are auth tls, auth ssl and implicit ssl.

auth tls

Regular Expression

True if File Name is a regular expression.  Otherwise false.

true

Debug File

File to write debugging output to.

C:\output\log.txt

 

 

Ftps Dir Download

 

Property

Description

Example

Hostname

The FTP server hostname or IP address.

192.168.1.1

Port

The FTP server port.

21

Username

The FTP server username.

jsmith

Password

The FTP server password.

secret

Passive

Whether passive mode is enabled.

true

Local Directory

The local directory to download to.

C:\output

Remote Directory

The remote directory to download.

/home/users/jsmith

Connection Type

The connection type.  Valid values are auth tls, auth ssl and implicit ssl.

auth tls

Transfer Mode

The transfer mode to use.  Valid values are auto, binary and ascii.

binary

Perform Checksum

Whether to validate file integrity after download using XCRC checksum command.  XCRC may not be supported by all servers.

true

Retry Limit

The number of times to retry a failed file transfer before aborting process.

2

Retry Interval

The number of seconds to wait before performing retry.

60

Debug File

File to write debugging output to.

C:\output\log.txt

 

Ftps Dir Upload

 

Property

Description

Example

Hostname

The FTP server hostname or IP address.

192.168.1.1

Port

The FTP server port.

21

Username

The FTP server username.

jsmith

Password

The FTP server password.

secret

Passive

Whether passive mode is enabled.

true

Local Directory

The local directory to upload.

C:\input

Remote Directory

The remote directory to upload to.

/home/users/jsmith

Connection Type

The connection type.  Valid values are auth tls, auth ssl and implicit ssl.

auth tls

Transfer Mode

The transfer mode to use.  Valid values are auto, binary and ascii.

binary

Perform Checksum

Whether to validate file integrity after upload using XCRC checksum command.  XCRC may not be supported by all servers.

true

Retry Limit

The number of times to retry a failed file transfer before aborting process.

2

Retry Interval

The number of seconds to wait before performing retry.

60

Debug File

File to write debugging output to.

C:\output\log.txt

 

Ftps File Download

 

Property

Description

Example

Hostname

The FTP server hostname or IP address.

192.168.1.1

Port

The FTP server port.

21

Username

The FTP server username.

jsmith

Password

The FTP server password.

secret

Passive

Whether passive mode is enabled.

true

Remote File

The remote file to download from FTP server.

/home/users/jsmith/file.txt

Local File

The local file to download to.

C:\output\file.txt

Connection Type

The connection type.  Valid values are auth tls, auth ssl and implicit ssl.

auth tls

Transfer Mode

The transfer mode to use.  Valid values are auto, binary and ascii.

binary

Perform Checksum

Whether to validate file integrity after download using XCRC checksum command.  XCRC may not be supported by all servers.

true

Retry Limit

The number of times to retry a failed file transfer before aborting process.

2

Retry Interval

The number of seconds to wait before performing retry.

60

Debug File

File to write debugging output to.

C:\output\log.txt

 

Ftps File Upload

 

Property

Description

Example

Hostname

The FTP server hostname or IP address.

192.168.1.1

Port

The FTP server port.

21

Username

The FTP server username.

jsmith

Password

The FTP server password.

secret

Passive

Whether passive mode is enabled.

true

Local File

The local file to upload

C:\input\file.txt

Remote Directory

The remote directory to upload file to.

/home/users/jsmith

Connection Type

The connection type.  Valid values are auth tls, auth ssl and implicit ssl.

auth tls

Transfer Mode

The transfer mode to use.  Valid values are auto, binary and ascii.

binary

Perform Checksum

Whether to validate file integrity after upload using XCRC checksum command.  XCRC may not be supported by all servers.

true

Retry Limit

The number of times to retry a failed file transfer before aborting process.

2

Retry Interval

The number of seconds to wait before performing retry.

60

Debug File

File to write debugging output to.

C:\output\log.txt

 

Ftps Regex File Download

 

Property

Description

Example

Hostname

The FTP server hostname or IP address.

192.168.1.1

Port

The FTP server port.

21

Username

The FTP server username.

jsmith

Password

The FTP server password.

secret

Passive

Whether passive mode is enabled.

true

Regular Expression

Regular expression to use when downloading files.

.*\.txt

Remote Directory

The remote directory to download files from.

/home/users/jsmith

Local Directory

The local directory to download files to.

C:\output

Connection Type

The connection type.  Valid values are auth tls, auth ssl and implicit ssl.

auth tls

Transfer Mode

The transfer mode to use.  Valid values are auto, binary and ascii.

binary

Perform Checksum

Whether to validate file integrity after upload using XCRC checksum command.  XCRC may not be supported by all servers.

true

Retry Limit

The number of times to retry a failed file transfer before aborting process.

2

Retry Interval

The number of seconds to wait before performing retry.

60

Debug File

File to write debugging output to.

C:\output\log.txt

 

Ftps Regex File Upload

 

Property

Description

Example

Hostname

The FTP server hostname or IP address.

192.168.1.1

Port

The FTP server port.

21

Username

The FTP server username.

jsmith

Password

The FTP server password.

secret

Passive

Whether passive mode is enabled.

true

Regular Expression

Regular expression to use when uploading files.

.*\.txt

Local Directory

The local directory to upload files from.

C:\input

Remote Directory

The remote directory to upload files to.

/home/users/jsmith

Connection Type

The connection type.  Valid values are auth tls, auth ssl and implicit ssl.

auth tls

Transfer Mode

The transfer mode to use.  Valid values are auto, binary and ascii.

binary

Perform Checksum

Whether to validate file integrity after upload using XCRC checksum command.  XCRC may not be supported by all servers.

true

Retry Limit

The number of times to retry a failed file transfer before aborting process.

2

Retry Interval

The number of seconds to wait before performing retry.

60

Debug File

File to write debugging output to.

C:\output\log.txt

 

Ftps Rename File

 

Property

Description

Example

Hostname

The FTP server hostname or IP address.

192.168.1.1

Port

The FTP server port.

21

Username

The FTP server username.

jsmith

Password

The FTP server password.

secret

Passive

Whether passive mode is enabled.

true

Connection Type

The connection type.  Valid values are auth tls, auth ssl and implicit ssl.

auth tls

Remote Directory

The remote directory that file exists in.

/home/users/jsmith

Remote File

Name of file to rename.

filename.txt

Destination File

Name to rename file to.

filename.txt.tmp

 

 

Gunzip File

 

Property

Description

Example

File

The file to gunzip.

C:\input\test.tar.gz

Destination Directory

The destination directory

C:\input

Delete Source

Delete source file after gunzip.

true

 

Gzip File

 

Property

Description

Example

File

The file to gzip.

C:\input\test.tar

Destination File

The destination file.

C:\input\test.tar.gz

Delete Source

Delete source file after gzip.

true

 

Http Request

 

Property

Description

Example

Url

The URL to request.

http://www.domain.com/cgi-bin/test.pl

Method

The HTTP request method.

GET

Debug File

File to write debugging output to.

C:\output\log.txt

Parameter1

Optional name parameter.

name1

Value1

Optional value parameter

value1

Parameter2

Optional name parameter.

name1

Value2

Optional value parameter.

value2

Parameter3

Optional name parameter.

name1

Value3

Optional value parameter.

value3

Parameter4

Optional name parameter.

name4

Value4

Optional value parameter.

value4

Parameter5

Optional name parameter.

name5

Value5

Optional value parameter.

value5

Expected Response

Text to search for in response to indicate that request was successful.

Success!

 

Judo Script

 

Property

Description

Example

Script

The script to execute.

System.out.println("test");

 

Move Directory

 

Property

Description

Example

Directory

The directory to move.

C:\input

Destination Directory

The destination directory.

C:\output

 

Move File

 

Property

Description

Example

File

The file to move.

C:\input\test.txt

Destination Directory

The destination directory.

C:\output

 

Move Regex File

 

Property

Description

Example

Directory

The source directory.

C:\input

Regular Expression

The regular expression to use when selecting files from source directory.

.*\.txt

Destination Directory

The output directory.

C:\output

 

PGP Decrypt File

 

Property

Description

Example

File

The file to PGP decrypt.

C:\input\test.txt.pgp

Destination

The destination file.  If left blank it will trim the extension and place in the same directory as source file.

C:\output\test.txt

Private Decryption Key

The private key used for PGP decryption.

mykey

Verification Key

Optional public key to use for verification.

mykey

Delete Source

Delete the source PGP file after decryption.

true

 

PGP Encrypt File

 

Property

Description

Example

File

The file to encrypt.

C:\input\test.txt

Destination

The destination file.  If left blank file will be encrypted and placed in same directory as source file with .pgp extension.

C:\output\test.txt.pgp

Encryption Key

The public key to use for encryption.

mykey

Private Signing Key

Optional private key to sign encrypted file with.

mykey

Compress

Whether output should be compressed.

true

Use Pem Format

Whether encrypted file should be output in PEM (armor ASCII) format.

true

Delete Source

Delete the source file after PGP encryption.

true

 

Rename Directory

 

Property

Description

Example

Directory

The directory to rename.

C:\input

Destination

The destination directory.

C:\output

 

Rename File

 

Property

Description

Example

File

The file to rename.

C:\input\test.txt

Destination File

The destination file.

C:\input\test.txt.old

 

Run Process

 

Property

Description

Example

Program

Path of program to execute

C:\program\run.bat

Arguments

Any arguments to pass to program.

-arg1 value1

Success Return Value

Expected successful return value of process.  Default expected return value is 0, however you may use a regular expression to accept multiple values.

0|1|2

Error Stream

Path of where to store error stream.

C:\error.log

Input Stream

Path of where to store input stream.

C:\input.log

 

Run Report

 

Property

Description

Example

Report Name

The name of the report to run.

My Report

Directory

The output directory to save report to.

c:\output

Clear Directory

Delete existing directory contents before running report.

true

 

 

Scp File Download

 

Property

Description

Example

Hostname

The SSH server hostname or IP address.

192.168.1.1

Port

The SSH server port.

22

Username

The SSH server username.

jsmith

Password

The SSH server password.

secret

Private Key File

The private key file for public-key authentication.

C:\keys\openssh_rsa.prv

Private Key File Password

The password for the private key.

secret

Local Directory

The local directory to download to.

C:\output

Remote File

The remote file to download.

/home/users/jsmith/test.txt

Retry Limit

The number of times to retry a failed file transfer before aborting process.

2

Retry Interval

The number of seconds to wait before performing retry.

60

Debug File

File to write debugging output to.

C:\output\log.txt

 

Scp File Upload

 

Property

Description

Example

Hostname

The SSH server hostname or IP address.

192.168.1.1

Port

The SSH server port.

22

Username

The SSH server username.

jsmith

Password

The SSH server password.

secret

Private Key File

The private key file for public-key authentication.

C:\keys\openssh_rsa.prv

Private Key File Password

The password for the private key.

secret

Local File

The local file to upload.

C:\input\test.txt

Remote Directory

The remote directory to upload to.

/home/users/jsmith/

Retry Limit

The number of times to retry a failed file transfer before aborting process.

2

Retry Interval

The number of seconds to wait before performing retry.

60

Debug File

File to write debugging output to.

C:\output\log.txt

 

Send Email

 

Property

Description

Example

Hostname

The SMTP server hostname or IP address.

192.168.1.1

Port

The SMTP server port.

25

From

The From email address.

jsmith@domain.com

To

The To email address.

sjones@domain.com

Cc

The Cc email address.

rgosling@domain.com

Subject

The message subject.

Test Subject

Username

Optional SMTP server username.  Some SMTP servers require this for sending email.

jsmith@domain.com

Password

Optional SMTP server password.  Some SMTP servers require this for sending email.

secret

Encryption Key

Public encryption key to use for OpenPGP encrypting email.

mykey

Private Signing Key

Private signing key to use for OpenPGP signing email.

mykey

Connection Type

The type of SMTP connection to use.  Valid values are PLAIN, SSL and START-TLS.

PLAIN

Receipt Notification Email

Email address to notify upon recipient opening email message.  Not all email clients recognize or obey this header so it is possible that you will not receive email notification.

jsmith@domain.com

Body

The message body.

Test Body

Attachment 1

Optional attachment.

c:\tmp\file.doc

Attachment 2

Optional attachment.

c:\tmp\file.doc

Attachment 3

Optional attachment.

c:\tmp\file.doc

Debug File

File to write debugging output to.

C:\output\log.txt

 

Sftp Create Directory

 

Property

Description

Example

Hostname

The SSH server hostname or IP address.

192.168.1.1

Port

The SSH server port.

22

Username

The SSH server username.

jsmith

Password

The SSH server password.

secret

Private Key File

The private key file for public-key authentication.

C:\keys\openssh_rsa.prv

Private Key File Password

The password for the private key.

secret

Remote Directory

The remote directory to create.

/home/users/jsmith

Debug File

File to write debugging output to.

C:\output\log.txt

 

 

Sftp Delete Directory

 

Property

Description

Example

Hostname

The SSH server hostname or IP address.

192.168.1.1

Port

The SSH server port.

22

Username

The SSH server username.

jsmith

Password

The SSH server password.

secret

Private Key File

The private key file for public-key authentication.

C:\keys\openssh_rsa.prv

Private Key File Password

The password for the private key.

secret

Remote Directory

The remote directory to delete.

/home/users/jsmith

Recursive

If true then will delete all files and subdirectories in this directory. Otherwise only files will be deleted.

true

Debug File

File to write debugging output to.

C:\output\log.txt

 

Sftp Delete File

 

Property

Description

Example

Hostname

The SSH server hostname or IP address.

192.168.1.1

Port

The SSH server port.

22

Username

The SSH server username.

jsmith

Password

The SSH server password.

secret

Private Key File

The private key file for public-key authentication.

C:\keys\openssh_rsa.prv

Private Key File Password

The password for the private key.

secret

File Name

The name of the file to delete.

filename.txt

Remote Directory

The remote directory to delete file(s) from.

/home/users/jsmith

Regular Expression

Indicates whether File Name is a regular expression.

true

Debug File

File to write debugging output to.

C:\output\log.txt

 

 

 

Sftp Dir Download

 

Property

Description

Example

Hostname

The SSH server hostname or IP address.

192.168.1.1

Port

The SSH server port.

22

Username

The SSH server username.

jsmith

Password

The SSH server password.

secret

Private Key File

The private key file for public-key authentication.

C:\keys\openssh_rsa.prv

Private Key File Password

The password for the private key.

secret

Local Directory

The local directory to download to.

C:\output

Remote Directory

The remote directory to download.

/home/users/jsmith

Transfer Mode

The transfer mode to use.  Valid values are auto, binary and ascii.

binary

Retry Limit

The number of times to retry a failed file transfer before aborting process.

2

Retry Interval

The number of seconds to wait before performing retry.

60

Debug File

File to write debugging output to.

C:\output\log.txt

 

Sftp Dir Upload

 

Property

Description

Example

Hostname

The SSH server hostname or IP address.

192.168.1.1

Port

The SSH server port.

22

Username

The SSH server username.

jsmith

Password

The SSH server password.

secret

Private Key File

The private key file for public-key authentication.

C:\keys\openssh_rsa.prv

Private Key File Password

The password for the private key.

secret

Local Directory

The local directory to upload.

C:\input

Remote Directory

The remote directory to upload to.

/home/users/jsmith

Transfer Mode

The transfer mode to use.  Valid values are auto, binary and ascii.

binary

Retry Limit

The number of times to retry a failed file transfer before aborting process.

2

Retry Interval

The number of seconds to wait before performing retry.

60

Debug File

File to write debugging output to.

C:\output\log.txt

 

Sftp File Download

 

Property

Description

Example

Hostname

The SSH server hostname or IP address.

192.168.1.1

Port

The SSH server port.

22

Username

The SSH server username.

jsmith

Password

The SSH server password.

secret

Private Key File

The private key file for public-key authentication.

C:\keys\openssh_rsa.prv

Private Key File Password

The password for the private key.

secret

Remote File

The remote file to download

/home/users/jsmith/test.txt

Local File

The local file to download to.

C:\output\test.txt

Transfer Mode

The transfer mode to use.  Valid values are auto, binary and ascii.

binary

Retry Limit

The number of times to retry a failed file transfer before aborting process.

2

Retry Interval

The number of seconds to wait before performing retry.

60

Debug File

File to write debugging output to.

C:\output\log.txt

 

Sftp File Upload

 

Property

Description

Example

Hostname

The SSH server hostname or IP address.

192.168.1.1

Port

The SSH server port.

22

Username

The SSH server username.

jsmith

Password

The SSH server password.

secret

Private Key File

The private key file for public-key authentication.

C:\keys\openssh_rsa.prv

Private Key File Password

The password for the private key.

secret

Local File

The local file to upload.

C:\input\test.txt

Remote Directory

The remote directory to upload to.

/home/users/jsmith

Transfer Mode

The transfer mode to use.  Valid values are auto, binary and ascii.

binary

Retry Limit

The number of times to retry a failed file transfer before aborting process.

2

Retry Interval

The number of seconds to wait before performing retry.

60

Debug File

File to write debugging output to.

C:\output\log.txt

 

Sftp Regex File Download        

 

Property

Description

Example

Hostname

The SSH server hostname or IP address.

192.168.1.1

Port

The SSH server port.

22

Username

The SSH server username.

jsmith

Password

The SSH server password.

secret

Private Key File

The private key file for public-key authentication.

C:\keys\openssh_rsa.prv

Private Key File Password

The password for the private key.

secret

Regular Expression

The regular expression to use when downloading files.

.*\.txt

Remote Directory

The remote directory to download from.

/home/users/jsmith

Local Directory

The local directory to download to.

C:\output

Transfer Mode

The transfer mode to use.  Valid values are auto, binary and ascii.

binary

Retry Limit

The number of times to retry a failed file transfer before aborting process.

2

Retry Interval

The number of seconds to wait before performing retry.

60

Debug File

File to write debugging output to.

C:\output\log.txt

 

Sftp Regex File Upload        

 

Property

Description

Example

Hostname

The SSH server hostname or IP address.

192.168.1.1

Port

The SSH server port.

22

Username

The SSH server username.

jsmith

Password

The SSH server password.

secret

Private Key File

The private key file for public-key authentication.

C:\keys\openssh_rsa.prv

Private Key File Password

The password for the private key.

secret

Regular Expression

The regular expression to use when uploading files.

.*\.txt

Local Directory

The local directory to upload from.

/home/users/jsmith

Remote Directory

The remote directory to upload to.

C:\input

Transfer Mode

The transfer mode to use.  Valid values are auto, binary and ascii.

binary

Retry Limit

The number of times to retry a failed file transfer before aborting process.

2

Retry Interval

The number of seconds to wait before performing retry.

60

Debug File

File to write debugging output to.

C:\output\log.txt

 

Sftp Rename File

 

Property

Description

Example

Hostname

The SSH server hostname or IP address.

192.168.1.1

Port

The SSH server port.

22

Username

The SSH server username.

jsmith

Password

The SSH server password.

secret

Private Key File

The private key file for public-key authentication.

C:\keys\openssh_rsa.prv

Private Key File Password

The password for the private key.

secret

Remote Directory

The remote directory that file exists in.

/home/users/jsmith

Remote File

The file to rename.

filename.txt

Destination File

The name to rename file to.

filename.txt.tmp

Debug File

File to write debugging output to.

C:\output\log.txt

 

Sql Query

 

Property

Description

Example

Jdbc Url

The JDBC connection URL.

jdbc:mysql://localhost/test

Username

The JDBC username.

jsmith

Password

The JDBC password.

secret

Query

The query to execute.

update users set active = 0 where username = '%Username%'

 

System Configuration Backup

 

Property

Description

Example

Destination Directory

The directory to write ZIP backup file to. 

C:\backups

Server Directory

The JSCAPE Secure FTP Server installation directory.

C:\Program Files\JSCAPE Secure FTP Server

 

System Out

 

Property

Description

Example

Message

The message to write.

This is a test

 

Tar Directory

 

Property

Description

Example

Directory

The source directory to TAR.

C:\input

Destination

The destination file of TAR archive.

C:\output\input.tar

Delete Source

Delete the source file after creating .

true

 

 

Unzip File

 

Property

Description

Example

File

The file to unzip.

C:\input\test.doc.zip

Destination Directory

The destination directory to unzip to.

C:\output

Delete Source

Delete the source zip file after unzipping.

true

 

Zip Directory

 

Property

Description

Example

Directory

The directory to ZIP.

C:\input

Destination

The destination file to ZIP to.

C:\output\input.zip

Delete Source

Delete the source file after zipping.

true

 

Zip File

 

Property

Description

Example

File

The file or directory to zip.

C:\input\test.doc

Destination

The destination file to zip to.

C:\output\test.doc.zip

Delete Source

Delete the source file after zipping.

true

 

See also

 

Adding triggers

Event types

Defining custom action types