Breadcrumbs

FTP - Upload Files from Workflows

Overview

Easily import one or more files directly into an FTP Server, no matter how big they are. The match type selected greatly affects how this Blueprint works.

This Blueprint requires write permissions in order to upload to the FTP server.

Note: This Vessel cannot be used to upload a local file from your computer.

Recommended Setup:

  1. A Vessel built with this Blueprint should typically run after a Vessel that either downloads a file to Workflows or generates a file with code.

Variables

Name

Reference

Type

Required

Default

Options

Description

Host

FTP_HOST

Alphanumeric

None

-

Domain or IP address of the FTP server to connect to.

Port

FTP_PORT

Integer

21

-

Number for the port to connect to. `21` is used by default.

Username

FTP_USERNAME

Alphanumeric

None

-

Value of the configured username in the FTP server.

Password

FTP_PASSWORD

Password

None

-

Value of the configured password associated to the username on the FTP server.

Workflows Folder Name

FTP_SOURCE_FOLDER_NAME

Alphanumeric

None

-

Name of the local folder on Workflows to upload the target file from. If left blank, will look in the home directory.

Workflows File Name Match Type

FTP_SOURCE_FILE_NAME_MATCH_TYPE

Select

exact_match

Exact Match: exact_match

Regex Match: regex_match

Determines if the text in "Workflows File Name" will look for one file with exact match, or multiple files using regex.

Workflows File Name

FTP_SOURCE_FILE_NAME

Alphanumeric

None

-

Name of the target file on Workflows. Can be regex if "Match Type" is set accordingly.

FTP Folder Name

FTP_DESTINATION_FOLDER_NAME

Alphanumeric

None

-

Folder where the file(s) should be uploaded. Leaving blank will place the file in the root directory of the FTP.

FTP File Name

FTP_DESTINATION_FILE_NAME

Alphanumeric

None

-

What to name the file(s) being uploaded. If left blank, defaults to the original file name(s).

YAML

Below is the YAML template

YAML

source:
  template: FTP - Upload Files from Workflows
  inputs:
    FTP_HOST:
    FTP_PORT: '21'
    FTP_USERNAME:
    FTP_PASSWORD:
    FTP_SOURCE_FOLDER_NAME:
    FTP_SOURCE_FILE_NAME_MATCH_TYPE: exact_match
    FTP_SOURCE_FILE_NAME:
    FTP_DESTINATION_FOLDER_NAME:
    FTP_DESTINATION_FILE_NAME:
  type: TEMPLATE
guardrails:
  retry_count: 1
  retry_wait: 0h0m0s
  runtime_cutoff: 1h0m0s
  exclude_exit_code_ranges:
    - 202
    - 205
    - 210