Skip to navigation
ExtensibilityWorkflowCreate and manage workflow definitionsWorkflow referenceWorkflow task referenceUpload: SFTP

Upload: SFTP - Task settings

View as Markdown

Use this reference to understand the task settings of the Upload: SFTP task.

The Upload: SFTP task uploads one or more files from Workflow to a specified SFTP server. You configure this task on the Setup, Files, and Options tabs.

Specify the required SFTP server information

On the Setup tab, select SFTP as the connection type and enter the required information for the SFTP server, including credentials and the target folder location on the server.

Connection details

Specify the SFTP server host name or IP address, and the port number.

Credentials

Enter your credentials for the SFTP server. The task supports the following authentication methods:

  • A username and a password.
  • A username and a raw private key in PEM format.

File path

Specify the target folder location on the SFTP server where the files will be uploaded. You can optionally configure the task to create the folder if it does not already exist. Do not include a trailing slash (/) at the end of the path. For example, use: /folder_a/folder_b/folder_c instead of: /folder_a/folder_b/folder_c/

Specify the files to be uploaded

On the Files tab, specify the files to be uploaded. File names can include variables using Liquid syntax, so that you can generate dynamic file names based on workflow data.

You can provide files from two sources:

  • Zuora Files: Specify file IDs for files generated in Zuora but outside Workflow.
  • Workflow Files: Files produced by preceding workflow tasks are listed automatically.

Select the files that you want to upload to the SFTP server. You can change the file names before upload if needed. For Workflow Files, the key shown next to each file corresponds to the index in the payload file name where the file originates.

Specify the algorithms to be used (Options tab)

On the Options tab, specify the algorithms used for the SFTP connection and the permissions applied to uploaded files. Hover over each field in the UI to see the list of supported algorithms.

  • Key Exchange Algorithm: The algorithms responsible for establishing secure methods of exchange. AutoDiscover means the Zuora SFTP client and your SFTP server will negotiate which key exchange algorithm to use during the SFTP session.

  • Host Key: The cryptographic key algorithm used for authenticating with the SFTP server. AutoDiscover means the Zuora SFTP client and your SFTP server will negotiate which host key algorithm to use during the SFTP session.

  • Encryption: The encryption algorithm used for the content in file transfer. You can select either of the following options.

    • AES128-cbc: Uses a 128-bit AES encryption algorithm.
    • AutoDiscover: The Zuora SFTP client and your SFTP server will negotiate which encryption algorithm to use during the SFTP session.

Permissions

The file permission assignment, using Linux read (r), write (w), and execute (x) syntax for the file. If this field is not configured, Zuora will use permissions set on the target directory on the SFTP server.