Skip to main content

Write FTP File

Write FTP File writes content to a remote file through an FTP Connection resource.

Write Mode decides what happens when the file already exists — fail, replace it, or add to the end of it.

The activity has four tabs: Configuration, Advanced, Input, and Output.

Configuration

FieldRequiredDescription
NameRequiredName of the step, unique within this workflow.
DescriptionOptionalDescribe the purpose of this step.
FTP ConnectionOptionalResource to connect to the FTP or FTPS server.
FTP Auth ContextOptionalAuthorization context used for the FTP connection.
DirectoryOptionalRemote directory to write into.
File PathOptionalPath within the working directory.
File NameOptionalName of the file to write.
Write ModeOptionalCreate (fail if exists), Overwrite, or Append. Defaults to Overwrite.

Write Mode

OptionBehaviour when the file exists
Create (fail if exists)The operation fails.
OverwriteThe existing file is replaced. This is the default.
AppendThe content is added to the end of the existing file.

Advanced

FieldRequiredDescription
Create DirectoriesOptionalCreate the target directory path if missing. Defaults to selected.
EncodingOptionalText encoding used to write the content. Defaults to UTF-8.
RetryOptionalRetry the operation on failure.
Retry PolicyOptionalThe retry policy resource to apply.

Input

FieldRequiredDescription
InputsOptionalThe content to write, and any runtime overrides of the path fields.

Output

The activity returns a writeFileOutput object.

FieldData TypeDescription
contentLengthIntegerLength of the content written.
fileNameStringName of the file written.
filePathStringPath of the file written.