Advanced options

Encrypt URL

Dropbox Business User Email:

Passive? ASCII Transfer Simple Mode Data channel secure Don't translate OS/400 paths Force CWD before doing listings Avoid use of 'STAT' command. Use STAT* with item lookups

Upload blob type:

Shared access signature token:

Encryption Mode:

Active Port Range:

Custom Script

Custom Scripts:

Script Type:

DFS Enabled

Delete local representation after upload

Upload using compression Upload using multi segments Download using compression

SSH Private Key: Browse

Key Password: Two factor auth

User Delegation Settings:

Client ID:
Client Secret:
Tenant:	Error: Special characters not allowed
Refresh Token:

Upload buffer size: MB

Max upload threads:

Connection Timeout: (in milliseconds)

Write Timeout: (in milliseconds)

Read Timeout: (in milliseconds)

Required signing

Verify SSH key

Add new key on first occurrence

Known host file: Browse

Store JWT JSON file

JWT config:

Client Id:

Enterprise Id:

Public Key Id:

Private Key:

Private Key password phrase:

Authentication security

User realm:

Kerberos config file: Browse

Data Lake Storage Gen2

Use below options only when SSL client authentication is required.

Keystore: Browse

Keystore Password:

Key Password:

Accept any SSL certificate

S3 API

Don't check bucket at login

Canned ACL: Storage class:

Server Side Encrypt?

Type:

Accelerate

Fast S3 item lookup SHA256 enabled on signing (Signing Version 4) Include SHA256 to request headers (Signing Version 4 related) SHA256 checksum Show partial uploads Use bucket in the path
Don't check bucket at login List version 2 Lookup custom modified date (this is slow)

KMS Key Id:
(Optional, formatted as: arn:aws:kms:region:acct-id:key/key-id)

Assume Role ARN:

Assume Role Region:

Use Random ID?

Multithreaded S3 Uploads?

Upload Threads:

Upload Buffer: MB

Multithreaded S3 Downloads?

Download Threads:

Download Buffer: MB

Max Download Buffer: MB

Add meta data : MD5 and uploaded by user

Store files split into segments.

Enable Team Drive

Keep File ID on Overwrite

Enable MDTM

Corpora variable name:

S3 API

Don't check bucket at login

Tenant:

User id or User principal name:

Shared files

Share file name:

Site id:

Site Path:

Drive name:

Conflict Behaviour:

Use full url for rename

Events: Task Designer

Enabled Debug Save state between steps Logging enabled Save results of job at end Copy to New Job Version:

Folder Traversal Filter: Multi Threaded

On error, jump to task named:

Config
Variables
Logging
Help

Options
Signing
Encryption

Async MDN Use compression

Sign Message: Encrypt Message:

MIC Algorithm: It is very unusual to change this value at all.

MDN Wait Timeout: (In Seconds)

Delay between sends: (In Seconds)

From Partner:

To Partner:

From Email:

Subject:

Response URL:

Recipient URL:

Route connection through DMZ when possible:

Keystore Path: Browse

Keystore Format:

Keystore Password:

Key Password:

Key name (alias):

Keystore Utility

Keystore Path: Browse

Keystore Format:

Keystore Password:

Key name (alias):

Keystore Utility

Convert to Copy Task Convert to Move Task

Destination: Browse Test

Destination path must have a file name or variable at the end

Encryption

Write

	PGP Decrypt
Private Key Path:	Browse Test
Private Key Password:
Verify
Public key to use for Verification: Browse Test

	PGP Encrypt ASCII Armor
	Sign Add hinted decrypted size
Private key for Signing:	Browse Test
Private Key Password:
Public Key Path:	Browse Test
Encryption cypher:
Test Key

Temp name while in transit:

Rename source after copy:

Wait x seconds to see if the file has changed:

Give up after x seconds:

Retry failed moves x times: Retry failed copies x times: Retry delay: (in seconds)

Slow down retries with each failure.

Max Threads:

Move Unique Copy Unique - Optional pattern:

Append Preserve modified date Resume Resume only on failure

Validate transfer size matches server reported size?

Connection Pool Source

Connection Pool Destination

Block overwrite pattern:

Convert Line Endings (Warning: only use on ASCII files):

Remove item from list after transfer

After copying, add to list for future tasks.

Be especially careful when using delete task as you could delete the original and copy.

Route connection through DMZ when possible:

Keep trying for x seconds: Ignore folders

Delete threads:

Item: Browse

Route connection through DMZ when possible:

From: To:

Reply To:

CC: BCC:

Subject:

Body Format: HTML Plain Text

Body:

Attach Files? Loop through items? Delay between loops in seconds:

Use custom SMTP settings Load and use mime types for email attachments.

SMTP Server Used for Emailing:

SMTP Server Username: SSL/TLS HTML

SMTP Server Password: Test SMTP Settings

Get mail refresh token Learn more: SMTP Google Mail Integration Get Refresh Token Learn more: OneDrive/Sharepoint Setup

Retry times with seconds delay.

Command: Examples:

Argument: Separator:

Working Directory:

Environment Variables:

Ignore Error Result

Execute on DMZ:

Example: If the command was "cp" and the argument was "{real_path};/archive/{name}"

Then, if a file was uploaded to "/uploads/stuff.zip", it would be copied to "/archive/stuff.zip"

Note the purpose of the ";" (semicolon) in that, it separates arguments to the command.

If an item matches the filter, it will be excluded from the future task processing.

Limit items list count to:

Find URL: Browse Test

Ignore CWD errors on subfolders.

Find Filter: The filter is based on the entire URL, not just the name. To filter by name, use enough unique info from the URL so you can match the name at the end. Example: file://files/folder1/abc_folder/abc.txt using a filter of "*/abc*" would match all items in that folder. Using "*/abc_folder/abc*"would match just this item.

Don't Add Folders Verify files are not changing, Wait for all files to stop changing

Use absolute paths Find deleted items Fail if no files are found

Depth: Max Items to Find:

FindCache name to use:

Last modified:

Newer Older

Days: Hours: Minutes: Log comparisons

Skip 2nd listing if there are files out of the date range on the 1st listing.

Keep checking for up to x minutes: Seconds delay between scans:

Slow down retries with each failure.

Adjust time by hours.

Route connection through DMZ when possible:

Cache Name:

Path to store cache file: Browse Test

Mode: Read Write

Leave both fields blank to always be a true condition.

Jump to task:

On True condition: On False condition:

Make Jump act like if/else scenario passing all items.

Jump using if/else logic passing all items if there is any true result instead of passing just the true items to the true task, and just the false items to the false task.
If there are no true items, then pass all items to the false scenario.

URL:

HTTP Username: HTTP Password:

HTTP Method:

Retry x times on failure: Retry delay: milliseconds.

Maximum of files in seconds before delay of milliseconds.

POST Data:

Timeout: (In Seconds)

Only use most recent item.

Save response to file?

Local path to save to: Browse Test
Add local file to list for future tasks.

Don't log HTTP result.

Expected Response Codes: (comma separated list of acceptable codes)

Request Headers:

Add Header

Header: Value:

Route connection through DMZ when possible:

Tunnel Action: Tunnel Name:

Server URL:
Only http and https urls allowed.

HTTP Username:

HTTP Password:

Directory Name: Browse Test

Route connection through DMZ when possible:

CMS jks/pfx file: Browse Test

Method:

Private key password:

Key store password:

Certificate alias:

Delete Original?

Route connection through DMZ when possible:

Private Public Key file: Browse Test

Method:

Encryption cypher:

Add hinted decrypted size.

Sign

Private key to use for Signing: Browse Test

Key password (if any):

Decrypt file name:

Verify

Public key to use for Verification: Browse Test

ASCII Armor? Delete Original?

Route connection through DMZ when possible:

Protocol: Host: Port: StartTLS

Mail Username: Mail Password: Mail Inbox:

Google Client ID:

Google Client Secret:

Get mail refresh token Learn more: SMTP Google Mail Integration

Get Refresh Token Learn more: OneDrive/Sharepoint Setup

After processing copy message to this mailbox: Test Mailbox Settings

Only process unread messages? Mark messages as read after processing?

Delete messages after processing? Log only first 10 skipped messages

Subject Filter:

From Filter:

To Filter:

Download files here: Browse Test

File Name: Save attachments? Save body of email as file?

Accept any SSL certificate Look inside attached messages

Filename Filter: Minimum file size in bytes:

Route connection through DMZ when possible:

Log Microsoft Graph response

Client ID:

Client Secret: Get admin consent Test

Tenant: Log only first 10 skipped messages

Username: Based on user id

Folder:

Search query: Ex: from:example@email.com subject:project attachment:catalog.md Learn more

Filter query:

After processing copy message to this mailbox:

Mark messages as read after processing?

Delete messages after processing?

Download files here: Browse Test

File Name: Save attachments? Save body of email as file?

Filename Filter: Minimum file size in bytes:

Max messages:

Route connection through DMZ when possible:

Request this file be processed by the Preview function in the CrushFTP prefs.

New Name:

Keep trying for x seconds: Skip sub items if parent is renamed.

Set modified date to now. Overwrite. Update keywords.

Route connection through DMZ when possible:

User Connection Group:

Find Username Filter:

Exclude Username Filter:

Only users in groups:

Exclude users in groups:

Users with VFS URL pattern:

Task to call with user info:

Variable Name:

Variable Value:

Item used for variable reference: Last item First item Remove Item

Delete original .zip

Allow stored entries with data descriptor

Skip not readable files

tar and tar.gz are also supported formats. They will be handled if the extension of the file is either .tar or .tar.gz

Internal Unzipping External 'unzip' Unzipping

File name filter.

Unzip into its own folder.

Output Location: Browse Test

Retry failed unzip x times: Retry delay: (in seconds)

Slow down retries with each failure.

Route connection through DMZ when possible:

Wait:

Until the following condition is true:

Wait for previous threads to finish.

File Path: Browse

Route connection through DMZ when possible:

Overwrite? Loop through items? Add to the list for future tasks

New File
Add Before
Add After
Find / Replace

Contents:

Find:

Contents:

Find:

Contents:

Append Only

Find Text:

Replace With:

Zip Output Path: Browse Test

Internal Zipping External 'zip' Zipping

tar and tar.gz are also supported formats. They will be handled if the extension of the file is either .tar or .tar.gz

Zip64

Delete Original?

Exclude zip from list?

Zip each file into their own zip file. (Be careful your zip filename is unique such as {stem}.zip.)

Route connection through DMZ when possible:

Learn more: Kafka Task

Load custom client config:

Host: Port:

Username: Password: SSL

Use below options only when SSL client authentication is required.

Keystore: Browse

Keystore Password:

Truststore: Browse

Truststore Password:

Topic name:	Custom Topic
Key:
Message:

Custom config:

DB Driver:

DB driver jar files are no longer dynamically loaded. They must be present in the CrushFTP folder/plugins/lib folder at startup time to be available for usage. if you see a ClassNotFound error, please ensure you have the driver jar files copied to that folder and restart CrushFTP.

DB Driver File: Browse

DB URL:

DB User: DB Pasword:

Query:

Rollback if a transaction fails.

Test DB Settings

First line of file contains column names.

Read entire file as:

None {file_contents}, no parsing. Properties

Column Separator:

Text Encoding:

Max lines to parse:

Provide atleast one column information to parse file properly.

Index	Column Name	Size
1

Add more..

File Path: Browse

Compression Type: Delete original

File Path: Browse

Decompression Type: Delete original

Retry failed action x times: Retry delay: (in seconds)

Slow down retries with each failure.

Glacier Vault: Browse

Wait till complete

End job with:

Link To:

Continue on and skip linked job when there are no items.

Run as external job (same as clicking test and run on that job).

Pass current filtered items to linked job.

Run job async and don't wait for it.

Route connection through DMZ when possible:

Fully qualified class: Help

Parameters:

Add Parameter

Key: Value:

This class needs to extend the "tasks.Task" class from the CrushTask.jar file in your plugins folder.

Example task:

package tasks;

import java.util.Properties;
import java.util.Vector;

public class BreakpointTask extends Task
{
    public BreakpointTask(Properties prefs, Vector items, Properties info, Vector threads)
    {
        super(prefs, items, info, threads);
    }

    public Task go()
    {
        run();
        return null;
    }

    public void run()
    {
        try
        {
            newItems.addAll(items);
            tracker.put("status", "paused");
            CrushTask.Start.checkStatus(tracker, this);
        }
        catch (Exception e)
        {
            error = e;
            msg(e);
            log(false, e.toString(), null);
        }
    }
}

Item key:

Direction: Sort Type:

Learn more: Java Message Service

Producer Consumer

Destination (Topic or Queue) Name:

Max messages:

Read timeout: (In milliseconds)

File Name:

Download messages (Less than 10 MB) here: Browse Test

Advanced options

Persistent

Time to live: (In Seconds)

Priority:

Custom Message

Loop through items?

Message:

Text Message

Bytes Message

Send files as messages. (Less than 10 MB)

JNDI Config:

Variables can be used for filenames, as part of an email address, email body, subject, or event as part of the command for the Execute task.

Please refer: https://www.crushftp.com/crush11wiki/Wiki.jsp?page=CrushTaskVariables

Log Success?

File:

Line:

Log Failure?

File:

Line:

Here is an example of what you might use this plugin for.

When files are uploaded to your server, you want them backed up to another server, and an email notification sent out letting someone know about the files on the alternate server. So here are the tasks:
MakeDirectory: filter=* /archived_{MM}{dd}{yy}/
Copy: filter=* destination:ftp://myuser:pass@192.168.1.65/newFiles/
Move: filter=* destination: /archived_{MM}{dd}{yy}/
Email: filter=*192.168.1.65*