Creating a Pull Watch Folder

In a remote-to-local (pull) Watch Folder scenario, the destination node (managed node receiving files) runs the Watch Folder service. The destination node remotely monitors the source directory on the source node using the Node API. If the destination node detects new files in the source directory, it transfers those files to the configured, local directory on the destination node.

Important: Pull-type Watch Folders require both source and destination nodes run HSTS version 3.8 and later.

To use Watch Folders, you must enable the feature (Configuration > Defaults and select Enable Watchfolder management) and add Watch Folder-enabled nodes to Console as managed nodes. For instructions on enabling Watch Folders on a node, see IBM Aspera High-Speed Transfer Server Admin Guide: Watch Folders and the Aspera Watch Service.

  1. Go to Activity > Watchfolders and click Create New Watchfolder.
  2. Enter a name for your watch folder in the Name field.
  3. Select Pull for the Watch Folder type.
  4. Configure the destination node and directory. Files dropped into the source directory are transferred to this node and this directory.
    1. Select your target node from the drop-down menu. Only Watch Folder-configured nodes appear in the list.
    2. Select the destination directory.
      You can Browse and select the destination directory, or enter the source path.
      Important: The destination directory is relative to the associated system user's docroot. For example, if you enter project1/final and the user's docroot is /aspera/projects, the source path is /aspera/projects/project1/final.
  5. Enter authentication credentials for the source node in the Source pane.
    1. Enter the IP address or hostname of the source node.
    2. Choose the type of credentials you want to use for authentication. Enter the credentials to authenticate to the destination node and authorize transfers.
      Pull Watch Folders must use the Node API or the Shares API to authenticate to the source node. The source node must be running HSTS 3.8.0 and later.
      Authentication Type UI Option Credentials
      HTTPS with Node API Node API Node API user and Node API password
      HTTPS with Shares API Shares Aspera Shares API user and Aspera Shares API password
  6. If you want, you can also enter a token string to authenticate the transfers, with the syntax "Basic token_string".
    For instructions on creating an access key on the remote node and generating a token from it, see the IBM Aspera High-Speed Transfer Server Admin Guide: Access Key Authentication.
  7. If you want to specify an Aspera forward proxy for the Watch Folder, enter the proxy address in the following format: 
    dnat://login:password@address:port

    For more information on forward proxies, see the IBM Aspera Proxy Admin Guide.

  8. Set ports for Node API connections, and for fasp™ (UDP) connections.
    Target Authentication Default Ports
    Node API

    Node API Port: 9092
    UDP: 33001
    Shares API

    Shares API Port: 443
    UDP: 33001
  9. Select the source directory.
    You can Browse and select the source directory, or manually enter the source path.
    Important: Just like for the destination path, the source path is relative to the associated system user's docroot.
  10. Configure additional watchfolder settings. See Watchfolder Options.
  11. Click Create.
  12. Test your watch folder.

    Add files to the source directory. Watch Folder detects the new files and transfers the new files to the target directory. You can see the transfer on the Activity Overview page.