ÃÛ¶¹ÊÓƵ

DocumentationWorkfrontWorkfront Guide

SFTP modules

Last update: Thu Nov 21 2024 00:00:00 GMT+0000 (Coordinated Universal Time)

CREATED FOR:

  • User

The ÃÛ¶¹ÊÓƵ Workfront Fusion SFTP modules allow you to monitor file changes in a selected folder/subfolder, upload new files to the desired folder, modify, or delete existing files that are already in a folder, or change file permissions.

Access requirements

You must have the following access to use the functionality in this article:

ÃÛ¶¹ÊÓƵ Workfront plan*
Pro or higher
ÃÛ¶¹ÊÓƵ Workfront license*
Plan, Work
ÃÛ¶¹ÊÓƵ Workfront Fusion license**

Current license requirement: No Workfront Fusion license requirement.

Or

Legacy license requirement: Workfront Fusion for Work Automation and Integration

Product

Current product requirement: If you have the Select or Prime ÃÛ¶¹ÊÓƵ Workfront plan, your organization must purchase ÃÛ¶¹ÊÓƵ Workfront Fusion as well as ÃÛ¶¹ÊÓƵ Workfront to use functionality described in this article. Workfront Fusion is included in the Ultimate Workfront plan.

Or

Legacy product requirement: Your organization must purchase ÃÛ¶¹ÊÓƵ Workfront Fusion as well as ÃÛ¶¹ÊÓƵ Workfront to use functionality described in this article.

To find out what plan, license type, or access you have, contact your Workfront administrator.

For information on ÃÛ¶¹ÊÓƵ Workfront Fusion licenses, see ÃÛ¶¹ÊÓƵ Workfront Fusion licenses.

Prerequisites

In order to use SFTP with Workfront Fusion, it is necessary to have an SFTP account (such as GoDaddy web hosting).

Connect SFTP to Workfront Fusion connect-sftp-to-workfront-fusion

To connect your SFTP account to Workfront Fusion you need to enter the target Host and the SFTP credentials (user name and password or user name and key) to the module’s Create a connection dialog.

Connection name
Enter the name for your SFTP connection.
Host
Enter the host name of the SFTP server you want to connect.
Port
Enter the SFTP server port. For example, 22.
Auth type

Select the authorization method you want to use for connecting to the SFTP server.

  • User name and password: Enter your credentials.

  • User name and key: Enter your user name and the private key/certificate

    Upload the private key to use the client-side authorization or upload your certificate (P12 or PFX file) if you want to use TLS using your self-signed certificate. If you're using the client-side certificate authorization, you can enter your CA certificate here.

    Workfront Fusion does not retain or store any data (files, passwords) you provide here. File and password are only used to extract a private key/certificate.

After entering the connection information, click Continue to establish a connection.

SFTP modules and their fields

When you configure SFTP modules, Workfront Fusion displays the fields listed below. Along with these, additional SFTP fields might display, depending on factors such as your access level in the app or service. A bolded title in a module indicates a required field.

If you see the map button above a field or function, you can use it to set variables and functions for that field. For more information, see Map information from one module to another in ÃÛ¶¹ÊÓƵ Workfront Fusion.

Triggers

Watch Files in a Folder

Returns files with details when a file is created or changed in a specified folder.

Connection
For instructions about connecting your SFTP account to Workfront Fusion, see Connect SFTP to Workfront Fusion in this article.
Folder
Enter or map the folder you want to watch. You can specify an absolute path such as /home/user/. Or you can specify a relative path pointing to a specific folder of the logged in user, such as ./.
Buffer Size [B]
Enter the buffer size in bytes. The value defines the size of transferred chunks from the server. Some servers may cause problems or corrupt files when the value is too high.
Maximum number of returned files
Set the maximum number of files that Workfront Fusion will work with during one cycle

Watch Subfolders in a Folder

Returns folders with details when a folder is created or changed in a specified folder.

Connection
For instructions about connecting your SFTP account to Workfront Fusion, see Connect SFTP to Workfront Fusion in this article.
Folder
Enter or map the folder you want to watch. You can specify an absolute path such as /home/user/. Or you can specify a relative path pointing to a specific folder of the logged in user, such as ./.
Maximum number of returned files
Set the maximum number of folders that Workfront Fusion will return during one cycle.

Actions

List a folder’s content

Connection
For instructions about connecting your SFTP account to Workfront Fusion, see Connect SFTP to Workfront Fusion in this article.
Show
Select whether you want to retrieve files, folders, or both.
Folder
Enter or map the folder that contains the files or folders you want to list. You can specify an absolute path such as /home/user/. Or you can specify a relative path pointing to a specific folder of the logged in user, such as ./.
Search
Enter or map the search term. For example, if you want to search for files with the file extension .txt, enter .txt.You can also enter or map the name of the file you want to search for.
Sort By
Select whether you want to sort results by file name, size, last access date, or last modified date.
Sort Order
Select whether the result should be returned in ascending or descending order.
Continue the execution of the route even if the module returns no results
Enable this option to ensure that this module does not stop the scenario if it returns no results.
Maximum number of returned results
Set the maximum number of results that Workfront Fusion will return during one cycle.

Get Files

This module lists files from a specified folder.

Connection
For instructions about connecting your SFTP account to Workfront Fusion, see Connect SFTP to Workfront Fusion in this article.
Buffer Size [B]
Enter the buffer size in bytes. The value defines the size of transferred chunks from the server. Some servers may cause problems or corrupt files when the value is too high.
Folder
Enter or map the folder that contains the files or folders you want to list. You can specify an absolute path such as /home/user/. Or you can specify a relative path pointing to a specific folder of the logged in user, such as ./.
Search
Enter or map the search term. For example, if you want to search for files with the file extension .txt, enter .txt.You can also enter or map the name of the file you want to search for.
Sort By
Select whether you want to sort results by the file name, size, last access date, or last modified date.
Sort Order
Select whether the result should be returned in ascending or descending order.
Continue the execution of the route even if the module returns no results
Enable this option to ensure that this module does not stop the scenario if it returns no results.
Maximum number of returned results
Set the maximum number of files that Workfront Fusion will return during one cycle.

Get a File

This module retrieves file details, including a file’s data.

Connection
For instructions about connecting your SFTP account to Workfront Fusion, see Connect SFTP to Workfront Fusion in this article.
Buffer Size [B]
Enter the buffer size in bytes. The value defines the size of transferred chunks from the server. Some servers may cause problems or corrupt files when the value is too high.
File Path
Enter the path to the file. You can specify an absolute path such as /home/user/file.txt. Or you can specify a relative path pointing to a specific folder of the logged in user, such as ./file.txt.

Upload a File

This module allows you to upload a file to the SFTP server.

Connection
For instructions about connecting your SFTP account to Workfront Fusion, see Connect SFTP to Workfront Fusion in this article.
Folder
Specify an existing folder as the storage location for the file. You can specify an absolute path such as /home/user/. Or you can specify a relative path pointing to a specific folder of the logged in user, such as ./.
Source File
Map the source file from a previous module, such as Dropbox > Get File. You can also enter or map the file name and file data.
Permissions

Set the desired permissions for the file or folder. Use chmod parameters. For example: 777 or -rwxrwxrwx.

For more details about chmod, please refer to the .

Rename a File

Renames a file.

Connection
For instructions about connecting your SFTP account to Workfront Fusion, see Connect SFTP to Workfront Fusion in this article.
File Path
Enter the path to the file you want to rename. You can specify an absolute path such as /home/user/file.txt. Or you can specify a relative path pointing to a specific folder of the logged in user, such as ./file.txt.
New file name
Enter the new name for the file, including the file extension.

Move a File

Connection
For instructions about connecting your SFTP account to Workfront Fusion, see Connect SFTP to Workfront Fusion in this article.
File Path
Enter the path to the file you want to move. You can specify an absolute path such as /home/user/file.txt. Or you can specify a relative path pointing to a specific folder of the logged in user, such as ./file.txt.
New Folder
Enter the path to the file's new location. You can specify an absolute path such as /home/user/. Or you can specify a relative path pointing to a specific folder of the logged in user, such as ./.

Delete a File

Connection
For instructions about connecting your SFTP account to Workfront Fusion, see Connect SFTP to Workfront Fusion in this article.
File Path
Enter the path to the file you want to delete. You can specify an absolute path such as /home/user/file.txt. Or you can specify a relative path pointing to a specific folder of the logged in user, such as ./file.txt.

Update file permissions

Allows you to change permissions of the file.

Connection
For instructions about connecting your SFTP account to Workfront Fusion, see Connect SFTP to Workfront Fusion in this article.
File Path
Enter the path to the file you want to move. You can specify an absolute path such as /home/user/file.txt. Or you can specify a relative path pointing to a specific folder of the logged in user, such as ./file.txt.
Permissions

Set the desired file permissions. Use the chmod parameters. For example, 777 or -rwxrwxrwx.

Must match pattern /(.?([r-][w-][x-]){3})|[0-7]{3}/.

For more details about chmod, please refer to the .

Create Folder

Creates a new folder in the specified location.

NOTE
If the folder already exists, the module will throw an error. To continue the flow uninterrupted, attach an error handler route to the module to catch the error and employ the Resume directive to continue the flow. For information about attaching an error handler route, see Error handling in ÃÛ¶¹ÊÓƵ Workfront Fusion. For information about the error handler route, see Directives for error handling in ÃÛ¶¹ÊÓƵ Workfront Fusion.
Connection
For instructions about connecting your SFTP account to Workfront Fusion, see Connect SFTP to Workfront Fusion in this article.
Folder
Specify an existing folder as the storage location for the new folder. You can specify an absolute path such as /home/user/file.txt. Or you can specify a relative path pointing to a specific folder of the logged in user, such as ./.
Folder Name
Enter the folder name.
Permissions

Set the desired folder permissions. Use chmod parameters. For example, 777 or -rwxrwxrwx.

Must match pattern /(.?([r-][w-][x-]){3})|[0-7]{3}/.

For more details about chmod, please refer to the .

Delete a Folder

Connection
For instructions about connecting your SFTP account to Workfront Fusion, see Connect SFTP to Workfront Fusion in this article.
Folder Path
Specify the path to the folder you want to delete. You can specify an absolute path such as /home/user/. Or you can specify a relative path pointing to a specific folder of the logged in user, such as ./.
recommendation-more-help
5f00cc6b-2202-40d6-bcd0-3ee0c2316b43