Event types

Top   Previous   Next

There are several event types that you may listen for when defining triggers.  These event types are documented below.

 

Event Summary

 

Common Event Properties

 

Event

Description

Account Deleted

Fired when an account is deleted.

Account Disabled

Fired when an account is disabled.

Account Updated

Fired when an account is created or updated.

Command Received

Fired when client command is received by server service.

Current Time

Fired every minute while the domain is running.

Directory Change

Fired when client attempts to change current working directory.

Directory Create

Fired when client attempts to create a directory.

Directory Delete

Fired when client attempts to delete a directory.

Directory Monitor Deleted

Fired when a directory monitor is deleted.

Directory Monitor File Added

Fired when a file is added to a monitored directory.

Directory Monitor File Changed

Fired when a file in a monitored directory is changed.

Directory Monitor File Deleted

Fired when a file in a monitored directory is deleted.

Directory Monitor Updated

Fired when a directory monitor is created or updated.

Domain Started

Fired when attempting to start a domain.

Domain Stopped

Fired when attempting to stop a domain.

Email File Retrieved

Fired when a file that was emailed using ad-hoc email transfer is retrieved by recipient.

Email File Sent

Fired when a file is emailed using ad-hoc email transfer.

External File Download

Fired when an action in response to a trigger downloads a file and stores locally.

External File Upload

Fired when an action in response to a trigger sends a local file to remote user or file transfer service.  This event is NOT fired when using File Transfer Script action.

Failover Synchronization

Fired when failover synchronization is performed.

File Delete

Fired when attempting to delete a file.

File Download

Fired when attempting to download a file.

File Download Aborted

Fired when FTP/S client aborts file transfer by sending ABOR command.  Many clients do not send ABOR command but instead simply close the connection.  In this event no event is fired.

File Download Started

Fired when server receives request from client to download a file.

File Rename

Fired when attempting to rename a file.

File Upload

Fired when attempting to upload a file.

File Upload Aborted

Fired when FTP/S client aborts file transfer by sending ABOR command.  Many clients do not send ABOR command but instead simply close the connection.  In this event no event is fired.

File Upload Started

Fired when server receives request from client to upload a file.

Group Deleted

Fired when a group is deleted.

Group Updated

Fired when a group is created or updated.

IP Access Rules Updated

Fired when IP Access rules are updated.

IP Blocked

Fired when a client IP address is blocked and added to IP Access list.

Log Rotated

Fired when log file is rotated.

Log Updated

Fired when log file is updated.

Reply Sent

Fired when server sends reply to client.

Report Completed

Fired when a report has completed processing.

Reverse Proxy Deleted

Fired when a reverse proxy is deleted.

Reverse Proxy Updated

Fired when a reverse proxy is created or updated.

Service Start

Fired when a service is started for a domain.

Service Stop

Fired when a service is stopped for a domain.

Trigger Error

Fired when an action within a trigger fails execution.

User Connect

Fired when a user connects to service.

User Disconnect

Fired when a user disconnects from service.

User Login

Fired when user attempts authentication with service.

User Logout

Fired when user logs out of session with service.

User Password Changed

Fired when user changes password.

 

 

Event Properties

 

Common Event Properties

 

The following is a list of properties that are available in all events.

 

Property

Description

DomainName

The name of the domain for which this event occurred.

Hour

The current hour of the day.  Valid values are 0-23.

Minute

The current minute of the hour.  Valid values are 0-59.

Second

The current second of the minute.  Valid values are 0-59.

Millisecond

The current millisecond of the second.  Valid values are 0-999.

WeekOfMonth

The current week of the month.  Valid values are 1-5.

WeekOfYear

The current week of the year.  Valid values are 1-52.

Month

The current month of the year.  Valid values are 1-12.

Year

The current four-digit year.

DayOfMonth

The current day of the month.  Valid values are 1-31.

DayOfWeek

The current day of the week.  Valid values are 1-7 with first day starting on Monday.

DayOfYear

The current day of the year.  Valid values are 1-365 (366 in leap year).

 

Account Deleted

 

Property

Description

Login

The username for this account.

Name

The full name of the account user.

 

Account Disabled        

 

Property

Description

Username

The username that was disabled.

UsernameEmail

The email address of the user.

UsernameName

The full name of the user.

 

Account Updated

 

Property

Description

Login

The username for this account.

Name

The full name of the account user.

 

Command Received

 

Property

Description

ServerPort

The server port that this command was received on.

ClientPort

The client port that this command was sent from.

Username

The username that sent this command.

UsernameEmail

The email address of the user.

UsernameName

The full name of the user.

Command

The command that was sent.

ServerIP

The server IP address this command was received on.

ClientIP

The client IP address that this command was received on.

 

Current Time

 

Property

Description

Hour

The current hour of the day.  Valid values are 0-23.

Minute

The current minute of the hour.  Valid values are 0-59.

WeekOfMonth

The current week of the month.  Valid values are 1-5.

WeekOfYear

The current week of the year.  Valid values are 1-52.

Month

The current month of the year.  Valid values are 1-12.

Year

The current four-digit year.

DayOfMonth

The current day of the month.  Valid values are 1-31.

DayOfWeek

The current day of the week.  Valid values are 1-7 with first day starting on Monday.

DayOfYear

The current day of the year.  Valid values are 1-365 (366 in leap year).

 

Directory Change

 

Property

Description

Success

Whether or not directory change was successful.

Local

Whether or not the directory is a directory local to the server.

ServerPort

The server port that this directory change was received on.

ClientPort

The client port that this directory change was sent from.

NewName

The new directory path after directory change was executed.

Username

The username that sent the directory change request.

UsernameEmail

The email of the user.

UsernameName

The full name of the user.

CurrentDir

The current working directory when sending the directory change request.

LocalPath

The local directory path of current working directory when sending the directory change request.

Name

The name of the current working directory when .

ServerIP

The server IP address the directory change request was received on.

ClientIP

The client IP address the directory change request was received on.

 

Directory Create

 

Property

Description

Success

Whether or not directory creation was successful.

Local

Whether or not the directory created is a directory local to the server.

ServerPort

The server port that this directory creation was received on.

ClientPort

The client port that this directory creation was sent from.

Username

The username that sent the directory creation request.

UsernameEmail

The email of the user.

UsernameName

The full name of the user.

CurrentDir

The virtual directory path after sending directory creation request.

LocalPath

The local directory path after sending directory creation request.

LocalDir

The local directory path of the parent directory of the directory created.

Name

The name of the directory used when sending directory creation request.

ServerIP

The server IP address the directory creation request was received on.

ClientIP

The client IP address the directory creation request was received on.

 

Directory Delete

 

Property

Description

Success

Whether or not directory deletion was successful.

Local

Whether or not the directory deleted is a directory local to the server.

ServerPort

The server port that this directory deletion was received on.

ClientPort

The client port that this directory deletion was sent from.

Username

The username that sent the directory deletion request.

UsernameEmail

The email of the user.

UsernameName

The name of the user.

CurrentDir

The virtual directory path after sending directory deletion request.

LocalPath

The local directory path after sending directory deletion request.

LocalDir

The local directory path of the parent directory of the directory deleted.

Name

The name of the directory used when sending directory deletion request.

ServerIP

The server IP address the directory deletion request was received on.

ClientIP

The client IP address the directory deletion request was received on.

 

Directory Monitor Deleted

 

Property

Description

MonitorName

The name of the directory monitor.

 

Directory Monitor File Added

 

Property

Description

Monitor

The name of the directory monitor.

File

The path of the file added.

 

Directory Monitor File Changed

 

Property

Description

MonitorName

The name of the directory monitor.

File

The path of the file changed.

 

Directory Monitor File Deleted

 

Property

Description

MonitorName

The name of the directory monitor.

File

The path of the file deleted.

 

Directory Monitor Updated

 

Property

Description

MonitorName

The name of the directory monitor.

 

Domain Started

 

Property

Description

DomainName

The name of the domain started.

 

Domain Stopped

 

Property

Description

DomainName

The name of the domain stopped.

 

Email File Retrieved

 

Property

Description

Local

Whether file downloaded was local or belonged to a reverse proxy.

Success

Whether the file download was successful.

ServerPort

The server port from which the file download request was received on.

ClientPort

The client port from which the file download request was sent from.

Bytes

The local path of file downloaded.

Recipient

The email address of the recipient.

Username

The username of the user that sent the ad-hoc email transfer.

UsernameEmail

The email of the user.

UsernameName

The full name of the user.

LocalPath

The local path of the file downloaded.

LocalDir

The local directory path of the parent directory of the file downloaded.

CurrentDir

The directory from which the file was downloaded.

Name

The name of the file downloaded.

ServerIP

The server IP address the file download request was received on.

ClientIP

The client IP address the download request was sent from.

 

Email File Sent

 

Property

Description

Local

Whether file sent was local or belonged to a reverse proxy.

Success

Whether the file send was successful.

ServerPort

The server port from which the file was sent.

ClientPort

The client port from which the file file was sent.

Bytes

The local path of file sent.

Recipient

The email address of the recipient.

Username

The username of the user that sent the ad-hoc email transfer.

UsernameEmail

The email of the user.

UsernameName

The full name of the user.

LocalPath

The local path of the file sent.

LocalDir

The local directory path of the parent directory of the file sent.

CurrentDir

The directory from which the file was sent.

Name

The name of the file sent.

ServerIP

The server IP address the file was sent from.

ClientIP

The client IP address the file was sent from.

 

External File Download

 

Property

Description

Attachment

Whether file downloaded was as an email attachment.

ServerPort

The server port from which file was downloaded.

Bytes

The number of bytes in file.

ServerIP

The server IP or hostname from which file was downloaded.

LocalPath

The local path of file downloaded.

Name

The local filename of file downloaded.

 

External File Upload

 

Property

Description

Attachment

Whether file uploaded was sent as an email attachment.

ServerPort

The server port to which file was uploaded.

Bytes

The number of bytes in file.

ServerIP

The server IP or hostname to which file was uploaded.

LocalPath

The local path of file uploaded.

Name

The local filename of file uploaded.

 

Failover Synchronization

 

Property

Description

Success

Whether failover synchronization was successful.

ErrorMessage

Error message received in the event of synchronization failure.

 

File Delete

 

Property

Description

Success

Whether or not file delete was successful.

Local

Whether or not the file delete is a file local to the server.

ServerPort

The server port that this file delete was received on.

ClientPort

The client port that this file delete was sent from.

Username

The username that sent the file delete request.

UsernameEmail

The email of the user.

UsernameName

The full name of the user.

CurrentDir

The virtual directory path that file delete request was sent from.

LocalPath

The server local path of file delete.

LocalDir

The local directory path of the parent directory of the file deleted.

Name

The name of the file used when sending file append request.

ServerIP

The server IP address the file append request was received on.

ClientIP

The client IP address the file append request was received on.

 

File Download

 

Property

Description

Success

Whether or not file download was successful.

Local

Whether or not the file download is a file local to the server.

ServerPort

The server port that this file download was received on.

ClientPort

The client port that this file download was sent from.

Bytes

The number of bytes received in download.

Username

The username that sent the file download request.

UsernameEmail

The email of the user.

UsernameName

The full name of the user.

CurrentDir

The virtual directory path that file download request was sent from.

LocalPath

The server local path of file download.

LocalDir

The local directory path of the parent directory of the file downloaded.

Name

The name of the file used when sending file download request.

ServerIP

The server IP address the file download request was received on.

ClientIP

The client IP address the file download request was received on.

 

File Download Aborted

 

Property

Description

Success

Whether or not file download was aborted successfully.

Local

Whether or not the file download is a file local to the server.

ServerPort

The server port that this file download was received on.

ClientPort

The client port that this file download was sent from.

Username

The username that sent the file download request.

UsernameEmail

The email of the user.

UsernameName

The full name of the user.

CurrentDir

The virtual directory path that file download request was sent from.

LocalPath

The server local path of file download.

LocalDir

The local directory path of the parent directory of the file download aborted.

Name

The name of the file used when sending file download request.

ServerIP

The server IP address the file download request was received on.

ClientIP

The client IP address the file download request was received on.

 

File Download Started

 

Property

Description

Success

Whether or not file download was started successfully.

Local

Whether or not the file download is a file local to the server.

ServerPort

The server port that this file download was received on.

ClientPort

The client port that this file download was sent from.

Username

The username that sent the file download request.

UsernameEmail

The email of the user.

UsernameName

The full name of the user.

CurrentDir

The virtual directory path that file download request was sent from.

LocalPath

The server local path of file download.

LocalPath

The local directory path of the parent directory of the file download started.

Name

The name of the file used when sending file download request.

ServerIP

The server IP address the file download request was received on.

ClientIP

The client IP address the file download request was received on.

 

File Rename

 

Property

Description

Success

Whether or not file rename was successful.

Local

Whether or not the file rename is a file local to the server.

ServerPort

The server port that this file rename was received on.

ClientPort

The client port that this file rename was sent from.

Username

The username that sent the file rename request.

UsernameEmail

The email of the user.

UsernameName

The full name of the user.

CurrentDir

The virtual directory path that file rename request was sent from.

LocalPath

The server local path of file rename.

LocalDir

The local directory path of the parent directory of the file renamed.

Name

The name of the file used when sending file rename request.

ServerIP

The server IP address the file rename request was received on.

ClientIP

The client IP address the file rename request was received on.

 

File Upload

 

Property

Description

Success

Whether or not file upload was successful.

Local

Whether or not the file upload is a file local to the server.

ServerPort

The server port that this file upload was received on.

ClientPort

The client port that this file upload was sent from.

Bytes

The number of bytes sent in upload.

Username

The username that sent the file upload request.

UsernameEmail

The email of the user.

UsernameName

The full name of the user.

CurrentDir

The virtual directory path that file upload request was sent from.

LocalPath

The server local path of file upload.

LocalDir

The local directory path of the parent directory of the file uploaded.

Name

The name of the file used when sending file upload request.

ServerIP

The server IP address the file upload request was received on.

ClientIP

The client IP address the file upload request was received on.

FormDataFound

Whether or not form data was included as part of file upload.

UploadFormName

The name of the upload form used if form data is found.

 

File Upload Aborted

 

Property

Description

Success

Whether or not file upload was aborted successfully.

Local

Whether or not the file upload is a file local to the server.

ServerPort

The server port that this file upload was received on.

ClientPort

The client port that this file upload was sent from.

Username

The username that sent the file upload request.

UsernameEmail

The email of the user.

UsernameName

The full name of the user.

CurrentDir

The virtual directory path that file upload request was sent from.

LocalPath

The server local path of file upload.

LocalDir

The local directory path of the parent directory of the file uploaded.

Name

The name of the file used when sending file upload request.

ServerIP

The server IP address the file upload request was received on.

ClientIP

The client IP address the file upload request was received on.

 

File Upload Started

 

Property

Description

Success

Whether or not file upload was started successfully.

Local

Whether or not the file upload is a file local to the server.

ServerPort

The server port that this file upload was received on.

ClientPort

The client port that this file upload was sent from.

Username

The username that sent the file upload request.

UsernameEmail

The email of the user.

UsernameName

The full name of the user.

CurrentDir

The virtual directory path that file upload request was sent from.

LocalPath

The server local path of file upload.

LocalDir

The local directory path of the parent directory of the file upload started.

Name

The name of the file used when sending file upload request.

ServerIP

The server IP address the file upload request was received on.

ClientIP

The client IP address the file upload request was received on.

 

Group Deleted

 

Property

Description

GroupName

The name of the group deleted.

 

Group Updated

 

Property

Description

GroupName

The name of the group added or updated.

 

IP Access Rules Updated

 

Property

Description

 

There are no properties for this event.

 

 

IP Blocked

 

Property

Description

IP

The IP address that was blocked.

 

Log Rotated

 

Property

Description

OldPath

The old path of the log file.

NewPath

The new path of the log file.

 

Log Updated

 

Property

Description

ServerPort

The server port used.

ClientPort

The client port used.

Date

Timestamp returns the number of milliseconds since January 1, 1970, 00:00:00 GMT.

InboundBytes

The number of bytes received by server.

OutboundBytes

The number of bytes sent by server.

ServerStatus

Server status message.

Username

Username of user who issued request.

ServerMessage

Server extended message.

ClientRequest

Client request message.

ClientMessage

Client extended message.

 

Reply Sent

 

Property

Description

ServerPort

The server port that this reply was sent from.

ClientPort

The client port that this reply was received on.

Username

The username that received the reply.

UsernameEmail

The email of the user.

UsernameName

The full name of the user.

Reply

The reply from the server.

ServerIP

The server IP address that reply was sent from.

ClientIP

The client IP address that reply was sent to.

 

Report Completed        

 

Property

Description

Success

Whether or not report was successfully generated.

ReportName

The name of the report.

 

Reverse Proxy Deleted

 

Property

Description

Port

The port of the reverse proxy.

ReverseProxyName

The name of the reverse proxy.

Host

The hostname or IP of reverse proxy.

 

Reverse Proxy Updated

 

Property

Description

Port

The port of the reverse proxy.

ReverseProxyName

The name of the reverse proxy.

Host

The hostname or IP of reverse proxy.

 

Service Start        

 

Property

Description

Success

Whether or not service was started successfully.

ServerPort

The port this service started on.

ServerIP

The IP address this service was started on.

ClientIP

The IP address this service was started from.

 

Service Stop        

 

Property

Description

ServerPort

The server port this service stopped on.

ServerIP

The server IP address this service was stopped on.

ClientIP

The client IP address this service was stopped from.

 

Trigger Error

 

Property

Description

TriggerName

The name of the trigger that experienced an error.

ActionClass

The action class that experienced an error.

ActionMessage

The error message received when executing the action class.

TriggerErrorMessage

The optional Trigger Error Message property passed along from the executing action.

 

 

User Connect

 

Property

Description

ServerPort

The server port this user connected to.

ClientPort

The client port this user connected from.

ServerIP

The server IP address this user connected to.

ClientIP

The client IP address this user connected from.

 
User Disconnect

 

Property

Description

ServerPort

The server port this user disconnected from.

ClientPort

The client port this user disconnected from.

ServerIP

The server P address this user disconnected from.

ClientIP

The client IP address this user disconnected from.

 

User Login

 

Property

Description

Success

Whether user was able to login successfully.

ServerPort

The server port this user connected to.

ClientPort

The client port this user connected from.

Username

The username of this user.

UsernameEmail

The email of the user.

UsernameName

The full name of the user.

ServerIP

The server P address this user connected to.

ClientIP

The client IP address this user connected from.

 

User Logout

 

Property

Description

ServerPort

The server port this user disconnected from.

ClientPort

The client port this user disconnected from.

Username

The username of this user.

UsernameEmail

The email of the user.

UsernameName

The full name of the user.

ServerIP

The server P address this user disconnected from.

ClientIP

The client IP address this user disconnected from.

 

User Password Changed

 

Property

Description

Username

The username of this user.

UsernameEmail

The email of the user.

UsernameName

The full name of the user.

Password

The new password for this user.

 

 

See also

 

Adding triggers

Action types

Defining custom action types