actionName | String The name of an action defined in the ActiveTransfer Server event. | |||
sourceFilter | String (Optional) The name of the file whose transfer will trigger this event. By default, ActiveTransfer Server considers all files. Note: You can use wildcard characters to filter the file names. For example, enter *.zip to trigger the event only when zip files are uploaded or downloaded. To trigger an event based on a name string in the zip files, use the name string in the Source Filter box, preceded and followed by wildcard characters. For example, enter *invoice*.zip to trigger the event based on the file URLs, when zip files containing the character string invoice in their file names are uploaded or downloaded. | |||
actionType | String The action type of the actions configured in the ActiveTransfer Server event. The actions could be one of the following: FindFile (default) CopyFile DeleteFile DecryptFile EncryptFile MoveFile RenameFile UnzipFile WriteToFile ZipFile ExecuteISService ExecuteScript ExecuteTNService SendBrokerNotification SendEmail WriteFileToDB Jump Exclude Note: If you are defining a scheduled event, make sure the “Find File” action is the first action you define. Otherwise, the scheduled event will fail. | |||
executeErrorAction | String (Optional) If you have defined an error action in the current action, specifies whether the error action should be executed. true - (default) Execute the error action if an error occurs in the current action. Note: You can use any of the event actions that ActiveTransfer Server offers as the defined error action. ActiveTransfer Server executes an error action if any of the configured actions for a event fail. false - Do not execute the error action. | |||
executeAsynchronously | String (Optional) Specifies if the actions should be run in different threads for all the files. This is to ensure that the actions do not interfere with each other. true - (default) Run the action in a different thread. false - Run the action in parallel with the action instance working on another file. | |||
isErrorAction | String Specifies if the action is an error action. false - (default) The action is a regular action. true - The action is an error action. | |||
isDisabled | String Specifies if the action is disabled or not. false - (default) The action is enabled. true - The action is disabled. | |||
properties | Object Specifies the properties of the action. The properties can take anyone of the following document types for action properties: |