Scheduling actions to run based on events

You can configure your system to run actions based on a trigger created when certain events occur. When the trigger is created, the action runs immediately. Note that, by default, actions configured to be triggered for an FTP server (under a Users host or a Local FTP Users host) are not triggered immediately. They are triggered when the connected FTP client issues another command or the session is closed. See Trigger At Upload Completion in Local FTP users mailbox advanced properties.

Triggers are generated when:

  • a new file arrives in a folder
  • a new file fails to arrive in a folder
  • a user session ends successfully
  • a user session fails to end.
Important: Only actions that are in scope of the triggering event are actually run. The trigger event's scope is limited to actions whose host is in the same host folder as the trigger's mailbox or in a parent host folder of the trigger's mailbox.

When you schedule an action to be run based on a trigger, the Scheduler window displays the triggering event in the Scheduled column. If there are multiple events, they are displayed in the Scheduled column as a comma-separated list.

  1. In the Scheduling dialog box, select Run this action automatically check box and then select when ANY of the following events occur.
  2. Select the events you want to trigger actions. Choose from the following:
    New file arrives
    Runs the action when a new file arrives in the folder. You can choose successful or failed file transfers or both to trigger the action.
    This event type is valid only for FTP and SFTP uploads, AS2 and HSP receives, and LCOPY commands.
    For a Commands action scheduled for new file arrives, the Commands action will be run only if at least one of the sources of the PUT or LCOPY commands in the action match the path of the new file. And then at runtime, all of the sources of the PUT, LCOPY, LDELETE, and LREPLACE commands that match the new file's path are modified to explicitly point to the new file.
    User session ends
    Runs the action when an FTP or SFTP user session ends. Choose successful or failed session end or both to be the trigger event.
    Note: This option is available only for JavaScript actions.
    Note: For both new file arrives and user session ends triggers, the trigger object is accessible in the JavaScript action via ISessionScript.getTrigger(). The user session end trigger includes all the relevant new file arrives triggers that occurred during the session.
  3. Click OK.
    When the trigger event occurs, the action runs.