FTP Server Activity

A FTP Server Activity event trigger executes when a file is uploaded or downloaded using the FTP server.

Nodes have a FTP server that can be used to upload files to or download files from the staging browser area of the node.

To cause a trigger that uses this event to fire, you can do the following:

  • Enable the FTP Server from the Administration > FTP Server tab in the Workbench.
  • Connect to the FTP server using an FTP client application and valid Workbench credentials.
  • Put or get a file that matches the pattern you used in the Path Contains parameter in the trigger.

The FTP Server Activity event is part of the Advanced package

This event is part of the Advanced package.
See Packages for information on obtaining and installing the package.

Defining a FTP server activity event trigger

To define a FTP Server Activity event trigger, follow these steps:

  1. From the Workbench left pane, expand the node where you want to define the FTP Server Activity event trigger.
  2. Select the Project icon to display the Projects window, right-click a specific project tab to display its pop-up menu, and then select New.
    You also can select the New button at the bottom of the Projects window when a specific project tab has already been selected.
  3. The new Trigger window appears.
    Name the trigger. The trigger name can be up to 64 characters and include letters, numbers, and the underscore character. Spaces are allowed.
  4. From the Event tab, select the Trigger Event Type down-arrow, expand the Networking category, and then select FTP Server Activity.

    The Event tab becomes active with parameters that accommodate the FTP Server Activity event.
Parameter Description
Fire When Selects the type of FTP activity to cause the trigger event. The options are:
  • File Uploaded - to specify a file being transferred to the staging browser.
  • File Downloaded - to specify a file being transferred from the staging browser.
Path Contains Optional. A string can be specified to filter only FTP activity where the full path name of the file uploaded or downloaded matches the specified string.
This does not support the use of wildcard characters or regular expressions.
For example, the Path Contains values of "How", "Are", "AreYou" or ".txt" will match the file name "HowAreYou.txt".

FTP Server Activity event type trigger event variables

The input event variables available to a FTP Server Activity event trigger are:

Event variable Data type Description
Command STRING The FTP command that was actually executed, typically this will be a "GET" or "PUT" command string. You can find a list of valid FTP commands here.
Directory STRING The directory on the node of the file being uploaded from or downloaded to. This directory is a relative path to the root of staging browser directory.
Filename STRING The name of the file being uploaded or downloaded. This file name will not contain the directory.
Full Path STRING The concatenated Directory and Filename.
Remote Address STRING The IP address and port number of the client that is interacting with the FTP server. The format will be similar to "192.168.2.65:43223".
Related topics

FTP Server