Skip to content

SFTP Bulk Publishing Assistant


Publish extracted data to an SFTP server on a schedule in bulk uploads

This assistant allows the upload of a number of files to an SFTP server according to a schedule. Configure the assistant to specify upload requirements.

You can list a component in the marketplace, and define if you want it to be a template.

❌ Not available in Marketplace

✅ Can be used as a template to create a new component

What is an Assistant?

Assistants are the building blocks of the automation system. They are the components that decides the actual work of the automation system. They can be used to perform a wide variety of tasks, from sending notifications, building pipelines and organizing workflow.


Below are the options for this assistant.

Option Name Default Required? Type Description
host_name None True string The hostname of the server
username None True string The username for the server
password None True password The password for the server
is_key None False boolean Toggle on to use an SSH key or password
remote_path / False string The remote path to check
port 22 False number The port number of the FTP/SFTP server (default: 22)
data_store None True tableStore The data store to extract from
document_store None True documentStore The document store to look for new documents in
query not exists(labels.label: 'sftp_published') True string The query to run to find documents to publish
add_label None False string The label to add to the document after publishing successfully
batch_size 100 False number Maximum number of documents to upload in a single batch
format json True string The format of the data to publish
root_name False string For XML documents, the root element name is required; if blank, it will be DataObjects.
delete_after_publish False False boolean Delete the document and extracted data after publishing
pretty_printing False False boolean Allow pretty printing of JSON and XML output
## Scheduling

This assistant can be scheduled to run at a specific time or periodically.