event

event

Description:

  • Process triggers only

    Gives access to information about the current event. Accessed via the global variable event. This variable is only available when the script has been invoked by a process trigger.

Properties

PropertyTypeDescription
clientIP String

IP of the client (if any) making the request that triggered the event.
fileName String

Name of the file that the event was triggered on.
filePath String

Virtual file-system path of the file that the event was triggered on (same as virtualPath).
folderPath String

Virtual file-system path of the parent folder containing the file or folder that the event was triggered on (same as virtualFolder).
loginEmail String

Email of the user making the request.
loginFullName String

Full name of the user making the request.
loginUserName String

User-name of the user making the request.
osFileName String

Local OS file-name of the file or folder that the event was triggered on (usually the same as fileName).
osFolder String

Local OS path of the parent folder containing the file or folder that the event was triggered on.
osPath String

Local OS path of the file that the event was triggered on.
ownerEmail String

Email of the user that is the owner of the folder in which the event was triggered.
ownerFullName String

Full name of the user that is the owner of the folder in which the event was triggered.
ownerUserName String

User-name of the user that is the owner of the folder in which the event was triggered.
processRule String

Name of the process trigger being triggered.
protocol String

Protocol via which the request was made.
serverName String

Name of the server to whicht the request was made.
siteName String

Name of the site to whicht the request was made.
time Date

Time at which the request.
transferStatus String

Transfer status of the request.
type String

Type of the process trigger event (e.
virtualFolder String

Virtual file-system path of the parent folder containing the file or folder that the event was triggered on (same as folderPath).
virtualPath String

Virtual file-system path of the file that the event was triggered on (same as filePath).
windowsFileName String

Local OS file-name of the file or folder that the event was triggered on (usually the same as fileName).
windowsFolder String

Local OS path of the parent folder containing the file or folder that the event was triggered on.
windowsPath String

Local OS path of the file that the event was triggered on.

Property Details

(static) clientIP :String

Description:

  • IP of the client (if any) making the request that triggered the event.

IP of the client (if any) making the request that triggered the event.

Type:
  • String

(static) fileName :String

Description:

  • Name of the file that the event was triggered on.

Name of the file that the event was triggered on.

Type:
  • String

(static) filePath :String

Description:

  • Virtual file-system path of the file that the event was triggered on (same as virtualPath).

Virtual file-system path of the file that the event was triggered on (same as virtualPath).

Type:
  • String

(static) folderPath :String

Description:

  • Virtual file-system path of the parent folder containing the file or folder that the event was triggered on (same as virtualFolder).

Virtual file-system path of the parent folder containing the file or folder that the event was triggered on (same as virtualFolder).

Type:
  • String

(static) loginEmail :String

Description:

  • Email of the user making the request.

Email of the user making the request.

Type:
  • String

(static) loginFullName :String

Description:

  • Full name of the user making the request.

Full name of the user making the request.

Type:
  • String

(static) loginUserName :String

Description:

  • User-name of the user making the request.

User-name of the user making the request.

Type:
  • String

(static) osFileName :String

Description:

  • Local OS file-name of the file or folder that the event was triggered on (usually the same as fileName). Alias for event.windowsFileName.

Local OS file-name of the file or folder that the event was triggered on (usually the same as fileName). Alias for event.windowsFileName.

Type:
  • String

(static) osFolder :String

Description:

  • Local OS path of the parent folder containing the file or folder that the event was triggered on. Alias for event.windowsFolder.

Local OS path of the parent folder containing the file or folder that the event was triggered on. Alias for event.windowsFolder.

Type:
  • String

(static) osPath :String

Description:

  • Local OS path of the file that the event was triggered on. Alias for event.windowsPath.

Local OS path of the file that the event was triggered on. Alias for event.windowsPath.

Type:
  • String

(static) ownerEmail :String

Description:

  • Email of the user that is the owner of the folder in which the event was triggered.

Email of the user that is the owner of the folder in which the event was triggered.

Type:
  • String

(static) ownerFullName :String

Description:

  • Full name of the user that is the owner of the folder in which the event was triggered.

Full name of the user that is the owner of the folder in which the event was triggered.

Type:
  • String

(static) ownerUserName :String

Description:

  • User-name of the user that is the owner of the folder in which the event was triggered.

User-name of the user that is the owner of the folder in which the event was triggered.

Type:
  • String

(static) processRule :String

Description:

  • Name of the process trigger being triggered.

Name of the process trigger being triggered.

Type:
  • String

(static) protocol :String

Description:

  • Protocol via which the request was made.

Protocol via which the request was made.

Type:
  • String

(static) serverName :String

Description:

  • Name of the server to whicht the request was made.

Name of the server to whicht the request was made.

Type:
  • String

(static) siteName :String

Description:

  • Name of the site to whicht the request was made.

Name of the site to whicht the request was made.

Type:
  • String

(static) time :Date

Description:

  • Time at which the request. was made.

Time at which the request. was made.

Type:
  • Date

(static) transferStatus :String

Description:

  • Transfer status of the request.

Transfer status of the request.

Type:
  • String

(static) type :String

Description:

  • Type of the process trigger event (e.g. UploadFile or SiteStart).

Type of the process trigger event (e.g. UploadFile or SiteStart).

Type:
  • String

(static) virtualFolder :String

Description:

  • Virtual file-system path of the parent folder containing the file or folder that the event was triggered on (same as folderPath).

Virtual file-system path of the parent folder containing the file or folder that the event was triggered on (same as folderPath).

Type:
  • String

(static) virtualPath :String

Description:

  • Virtual file-system path of the file that the event was triggered on (same as filePath).

Virtual file-system path of the file that the event was triggered on (same as filePath).

Type:
  • String

(static) windowsFileName :String

Description:

  • Local OS file-name of the file or folder that the event was triggered on (usually the same as fileName). Also available as event.osFileName.

Local OS file-name of the file or folder that the event was triggered on (usually the same as fileName). Also available as event.osFileName.

Type:
  • String

(static) windowsFolder :String

Description:

  • Local OS path of the parent folder containing the file or folder that the event was triggered on. Also available as event.osFolder.

Local OS path of the parent folder containing the file or folder that the event was triggered on. Also available as event.osFolder.

Type:
  • String

(static) windowsPath :String

Description:

  • Local OS path of the file that the event was triggered on. Also available as event.osPath.

Local OS path of the file that the event was triggered on. Also available as event.osPath.

Type:
  • String