Skip to main content

Write File

The Write File activity writes data to a file on the local file system.

Configuring the Write File Activity

To configure the Write File activity, fill in the required fields in the activity panel.

Configuration

FieldRequiredDescriptionExample
NameRequiredUnique name for this WriteFile activityMyActivity
DescriptionOptionalOptional description of this activity's purposeReads a file from S3
ResourceOptionalDrag and drop a S3Connection resource from the workspace.
DirectoryOptionalThe target folder or directory pathmy-data-bucket
File PathOptionalFull path (including file name) where the content will be writtendata/reports/2024/
File NameOptionalFile name to use if not part of the file pathreport-2024.csv
Encryption TypeOptionalOptional encryption to apply to the output file Options: NONE, PGP, SSL.NONE, PGP, SSL
Encryption ResourceOptionalEncryption certificate used to encrypt the file
Content TypeOptionalThe format in which content will be written to the file Options: CSV, JSON, XML, TEXT, BINARY.CSV, JSON, XML
Compression TypeOptionalOptional compression method to apply to the file Options: NONE, ZIP, GZIP.NONE, ZIP, GZIP
Select ContextOptionalSelect the select context for this activity.
Create Directory If Not ExistsOptionalCreate the directory path if it does not already exist
OverwriteOptionalIf true, any existing file with the same name will be replaced
AppendOptionalAppend content to an existing file instead of replacing it
Write New LineOptionalAdds a new line after the written content

Input

FieldRequiredData TypeDescriptionExample
File PathOptionalStringFile path.data/reports/2024/
File NameOptionalStringFile name.report-2024.csv
Create DirectoryOptionalBooleanWhen true, create directory if not exists.
ContentOptionalObjectData content.

Output

FieldRequiredData TypeDescriptionExample
SuccessOptionalBooleanWhether the operation succeeded.false
Bytes WrittenOptionalNumberNumber of bytes written.0