Overview
To use this template, you need an Alli Cloud Storage setup that uses Amazon S3 behind the scenes. You must have an active Amazon Web Services account with valid access credentials and permission to read and download files from the target storage location.
Unlike with the Upload and Move operations, you do not need to worry about the uploading prefix that gets prepended to your target file's path. You can download a file from any path within the S3 bucket.
Do not include a leading slash in your folder path!
Variables
|
Name |
Reference |
Type |
Required |
Default |
Options |
Description |
|---|---|---|---|---|---|---|
|
Source File Name Match Type |
SOURCE_FILE_NAME_MATCH_TYPE |
Select |
➖ |
exact_match |
Exact Match: exact_match
|
How to interpret the source file name: use 'exact_match' for an exact file name or 'regex_match' to treat it as a regular expression for multiple files. |
|
Source Folder Path |
SOURCE_FOLDER_PATH |
Alphanumeric |
➖ |
- |
- |
Folder path under the client's S3 bucket where the target file is located. Leave blank to search directly in the bucket's root. Do not include the client's S3 bucket or a leading slash in the path (this will be handled by the code). Also, do not include the file in the path - save that for the following input. |
|
Source File Name or Pattern |
SOURCE_FILE_NAME |
Alphanumeric |
✅ |
- |
- |
Alli Cloud Storage file name or regular expression pattern to select files to download. Just provide the name or pattern - no folder path needed for this input. |
|
Destination Folder Name |
DESTINATION_FOLDER_NAME |
Alphanumeric |
➖ |
- |
- |
You can specify a local folder path where the downloaded file(s) will be saved; if you leave this blank, they will be saved to your workflow’s root directory. |
|
Destination File Name |
DESTINATION_FILE_NAME |
Alphanumeric |
➖ |
- |
- |
You can optionally enter a custom name for the downloaded file; if you leave it blank, the original filename will be used. When regex matching returns multiple files, your custom name serves as the base and “_1”, “_2”, etc., are appended to each file—if only one file matches, it uses your name unchanged. |
YAML
Below is the YAML template
source:
template: Alli Cloud Storage - Download Files to Workflows
inputs:
SOURCE_FILE_NAME_MATCH_TYPE: exact_match
SOURCE_FOLDER_PATH:
SOURCE_FILE_NAME:
DESTINATION_FOLDER_NAME:
DESTINATION_FILE_NAME:
type: TEMPLATE
guardrails:
retry_count: 1
retry_wait: 0h0m0s
runtime_cutoff: 1h0m0s
exclude_exit_code_ranges:
- 13
- 14
- 101
- 104