Field | Description |
Task name | Type a unique name for the task. |
File filter | Type the name of the file if you want to filter files with specific names. By default, ActiveTransfer Server considers all files. If you want to use regular expression, specify a valid regular expression in File filter and select Use regular expression option. Note: You can use wildcard characters to filter the file names. For example, type *.zip to trigger the action only when ZIP files are uploaded or downloaded. To trigger an action based on a name string in the ZIP files, use the name string in the File filter box, preceded and followed by wildcard characters. For example, type *invoice*.zip to trigger the action based on the file URLs, when ZIP files containing the character string invoice in their file names are uploaded or downloaded. If you define a File filter for a task, the task acts only on files that are filtered out. Few examples for regular expressions are:  ^(?!.*purchaseorder).*$: Excludes files with the file URL containing purchaseorder.*/out/.*: Include files with the file URL containing the folder out.^abc(.*)123$: Includes anything that starts with abc and ends with 123. Matches abc123, abcxyz123, but not abcxyz123def.NEW-((*.doc)|(*_backup_*)): Includes anything starting with NEW- that either ends in .doc, or is followed by the string _backup_. |
Destination location | Select one of the following options to configure the location where the file will be copied to: Local file path, if the destination location is on your local machine, type or browse to the location. To specify a file URL for a shared location, use the FILE:////host/SharedFolder/ syntax. Make sure that the OS user running the ActiveTransfer Server instance has full access to the shared location.Remote path, if the destination location is on a remote server, select a protocol (transport mechanism) from the list, and type or browse to the file path location. For example, protocol://<host>:<port>/DestinationFolder/.Note: If you want to find and copy files from remote, third-party HTTP(S) servers, ensure that the you provide appropriate file path here. Type the User name and Password for the remote system.Select Use proxy if you want to route file transfers to remote servers through a proxy server, and select one of the following options:Global proxy settings, if you want ActiveTransfer to use the default proxy server alias set up in Integration Server or ActiveTransfer.Select proxy alias, if you want to use a specific proxy server alias for the folder, then select the appropriate proxy server alias to use from the available list.Select if you want ActiveTransfer Server to recover from a download that was not completed.Click Test Connection to check the connection to the remote server with or without a proxy server.Tip: If you want to connect to a remote server using a secure protocol (FTPES, FTPS, HTTPS or SFTP) and want to configure authentication using secure key exchange, create a folder for the remote server and configure the Keystore, Keystore password, and Key password parameters. You can then use the folder that you configured in the Virtual folder option of the Destination location in the task. Virtual folder: To specify a folder, type or browse to the location of the folder. If you want to point to a subfolder within the folder, append the URL in the box with the details of the subfolder.Note: The folder that you select should be configured on the same ActiveTransfer Server instance on which the action is configured. |
Execute error task | Select this option to execute an error task if the file operation fails. For more details, see
Error Task Configuration. |
Advanced | |
Rename file to | Select this option to rename the file to the specified name in the box. |
Check if the file exists at destination | Select this option to check if the file already exists at the destination and perform one of the following options: Skip the transfer if file exists: This option skips the file transfer if the file with the same file name exists at the destination. However, further actions will not be performed on that particular file at the destination.Example: Consider you want to perform Copy and Rename tasks respectively on a file. The Copy task skips that particular file if the file already exists at the destination. Additionally, the Rename task also will not be performed on that particular file. Fail the action if file exists: This option fails the action if a file with the same filename exists at the destination location. In this case, the execution of the action stops and is a marked failure.During parallel execution, only the particular file which is already at the destination will not be processed. However, the remaining files will complete their processing and is transferred to the destination. Example: For parallel execution:Let us consider that you want to perform Copy and Rename tasks on multiple files. Also, one of the files is already at the destination. So, the Copy and Rename tasks fail only for that particular file which is at the destination. However, ActiveTransfer will continue processing the remaining files for Copy and Rename tasks respectively. For non-parallel execution:Let us consider that you want to perform Copy and Rename tasks on multiple files. Also, one of the files is already at the destination. So, the Copy and Rename tasks fail only for that particular file which is at the destination. However, ActiveTransfer will copy the remaining files but will not process the Rename task for these files. Additionally, any subsequent task for these files will not be performed. Note: If you rename a particular file using Rename file to option, then Fail the action if file exists option checks for the renamed filename at the destination. The renamed file will be added to the destination only if it does not match the rest of the filename. |
Use temporary file name | Select this option and type a temporary name for the file to use while copying the file. The file is renamed to its original name after the copy file operation is complete. |
Preserve file modification date | Select this option to retain the time stamp indicating when the file was last modified. |
Check for stability | If you want the file operation to check its progress at regular intervals, specify the time in seconds in the following format: Every [ ] seconds up to [ ] seconds, where, [ ] is the text box to type the value in seconds. |
Retry [ ] times at an interval of [ ] seconds | Select this option to retry a failed copy operation for the specified number of times at the interval specified in seconds. |
Resume transfer from the point of interruption | Select this option to resume an interrupted or failed copy operation from the point of interruption. |
Command before upload | If you want to execute a SITE command before copy task, then choose this option. For example, while working with Mainframe servers, value for record size and block size can be sent to the server before upload by setting the following value to this new configuration field: SITE LRECL=<record_size> BLKSIZE=<block_size>. |
Simple mode | Select this option to change the file transfer mode to simple mode and if you are transferring files to AS/400 systems. This mode is applicable to FTP, FTPS, or FTPES protocols. |
ASCII mode | Select this option to change the file transfer mode to ASCII mode and select one of the following Convert line endings options for ActiveTransfer Server to change the line endings of the file: CRLF - Windows, CR - MAC OS Classic, LF - Unix, or No change. This mode is applicable for FTP, FTPS, or FTPES protocols. By default, ActiveTransfer Server uses the Binary file transfer mode for the copy operation. |
Assign partner | Select this option if you want to assign a partner for the action and do one of the following: Select the partner to assign from the list of configured partners in ActiveTransfer.Type a parameterized value for the partner in the following format: [partner_name], where [partner_name] is a server variable or an action parameter that contains the actual partner name during the execution of an action.Note: For virtual folders, use this option only if you want to override the partners configured for the folders. |