Watch Folder configuration reference

On file systems without file notifications, such as object storage, mounted storage (NFS), and AIX® file system scans triggered by the scan period are used to detect file changes. In this case, set the scan period to frequently scan for changes. On operating systems that support file notifications (Linux, Windows, macOS), asperawatchd uses the file notifications as the primary means for detecting changes, and the scan period serves as a backup. In this case, the default value of 30 minutes is usually acceptable and no change is necessary. To never scan, and rely entirely on file notifications, set to "infinite".

For pull Watch Folders, file systems scans that are triggered by scan_period are the sole means for detecting changes in the source directory.

Lower scan periods detect changes faster but can result in greater resource consumption, particularly for object storage.

• HSTS or HSTE authenticated with an SSH user: Enter the IP address or hostname of the endpoint for the host, then enter the SSH user and their password or public key. (Note: This method is not supported for pull Watch Folders)
• HSTS or HSTE authenticated with Node API or access key credentials: Enter the node URL as https://ip_address_or_server_url:9092/. If a different HTTPS port is configured, replace 9092 with the correct port. Enter the Node API username or access key ID as the User and the Node API user's password or the access key secret as the Password.
  Note: Node API authentication uses HTTPS, even if HTTP is specified in the node URL.
• IBM Aspera on Cloud (including IBM Aspera on Cloud transfer service nodes) and IBM Aspera Transfer Cluster Manager nodes: Enter the endpoint URL as https://ip_address_or_server_url:443/ and provide the access key ID and secret for the User and Password. (Note: These remote endpoint types are not supported for pull Watch Folders)
• IBM Aspera Shares: Enter the URL of the Shares server as https://ip_address:443 and provide the Shares login credentials.

For Shares hosts, enter the Shares user's password.

For node authentication, enter the Node API user's password or access key secret.

For access key authentication, the path is relative to the storage specified in the access key.

• Cool off only: The drop includes new files that are added to the source folder within the cool off period.
• Top level files: Create a drop for each file added to the top level of the source folder.
• Top level dirs: Create a drop for each directory added to the top level of the source folder. The drop includes new subdirectories and files in the top-level directory.

Click to add a filter.

Setting an Include filter protects matching files from subsequent Exclude filters. Filters are applied in order. Watch Folders supports glob and Regex filters. The glob filter system is the same as Ascp; see Using filters to include and exclude files.

aspera:watchfolder:watchfolder_id:watchfolder_name:drop-id:drop_name

• watchfolder_id: The Watch Folder ID.
• watchfolder_name: The Watch Folder name (as specified for Watch Folder name in the Watch Folder settings).
• drop_id: The drop ID that is automatically generated by Watch Folders.
• drop_name: The drop name. Unless otherwise specified, the drop name is generated from the file name.

You can override the default values by specifying your own.

To disable content protection, clear the checkbox.

• Compare file attributes - Compares the sizes of the existing and original file. If they are the same, then the transfer resumes, otherwise the original file is transferred again.
• Compare sparse file checksums - Performs a sparse checksum on the existing file and resumes the transfer if the file matches the original, otherwise the original file is transferred again. (Default)
• Compare full file checksums - Performs a full checksum on the existing file and resumes the transfer if the file matches the original, otherwise the original file is transferred again.

When resuming file transfer is enabled, select an overwrite rule for when the same file exists at the destination. Click the drop-down menu for If a complete file already exists at the destination.

File archiving (Automatically move source files to an archive folder) is not supported for sources in object storage.

• Do nothing: Source files remain in the Watch Folder after transfer.
• Automatically move source files to an archive folder: Move source files to the specified archive folder. The archive path can use the following variables:
  • {$TIMESTAMP} (Drop creation time in seconds since epoch)
  • {$DAY_OF_MONTH} (Time format for drop's creation time)
  • {$MONTH}
  • {$YEAR}
  • {$HOUR}
  • {$MINUTE}
  • {$SECOND}
  • {$DATETIME} (alias for {$YEAR}{$MONTH}{$DAY_OF_MONTH}-{$HOUR}{$MINUTE}{$SECOND})
  • {$UUID}
  • {$NAME}
  • {$STATE}
  • {$FILE::STATE} (such as SUCCEEDED, FAILED)
• Automatically delete source files (once drop is done): Delete source files after the entire transfer session is complete and successful.
• Automatically delete source file (immediately after transfer): Delete source files as they are successfully transferred, rather than waiting for the entire session to complete before deleting files.

Click to delete a filter.

• List: The package file is transferred last after all files in the package file successfully transfer.
• Last file in list: The last file in the package file is transferred last.

Identify package files as the ones that match the specified filters. Click to add a filter. Set an Include filter that matches your package files. Filters are applied in order. Watch Folders supports glob and Regex filters. The glob filter system is the same as Ascp; see Using filters to include and exclude files.

Click to delete the filter.