DocumentationWorkfrontWorkfront Guide

FTP modules

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

CREATED FOR:

  • User

FTP modules let you monitor file changes in a selected folder, upload new files to the desired folder, and modify or delete existing files that are already in a folder.

Access requirements

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

Adobe Workfront plan*
Pro or higher
Adobe Workfront license*
Plan, Work
Adobe 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 Adobe Workfront plan, your organization must purchase Adobe Workfront Fusion as well as Adobe 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 Adobe Workfront Fusion as well as Adobe 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 Adobe Workfront Fusion licenses, see Adobe Workfront Fusion licenses.

Prerequisites

In order to use [Fusion App] with Workfront Fusion, you must have an FTP account.

Create a connection in an FTP module create-a-connection

Connection name
Enter the name for your FTP connection.
Host
Enter the FTP server hostname. E.g. myftp123.server.com
Port
Enter the FTP server port number. E.g. 21
User name
Enter your FTP account user name.
Password
Enter your FTP account password.
Use a secure connection (TLS)

Select whether you want to use a secure connection.

No

The connection is not secured.

Explicit encryption or Implicit encryption

The connection is secured using SSL.

Reject unauthorized certificates

Enable this option to verify the FTP server certificate. If the verification fails, the connection will not be created. To pass the verification, the certificate must meet one of the following criteria:

  • be signed by a Root Certificate Authority
  • be signed by an Intermediate Certificate Authority (see e.g. How certificate chains work for further explanation). In this case all the Intermediate Certificates should be installed on the FTP server.
  • be a Self-Signed Certificate supplied in the Self-signed certificate field (see below)

If this option is disabled, the FTP server certificate is not verified. We strongly advise against disabling the option as it renders the connection insecure and poses a serious security risk.

Self-signed certificate

Click the Extract button to open the upload dialog.

Upload the certificate to use the TLS with your self-signed certificate. Workfront Fusion does not retain or store any data you provide, such as files and passwords. File and password are used only to extract the certificate.

FTP modules and their fields

Triggers

Watch files

Watch files is the only trigger module for FTP. It monitors the file content of the selected folder. The trigger is executed when a new file is inserted into the specified folder.

Connection
For instructions on establishing a connection to the FTP account, see Create a connection in an FTP module in this article.
Folder

Select the folder you want to watch.

Note: Only one folder per scenario is allowed. Subfolders are ignored.

Tip: To keep track of multiple folders, create an independent scenario for each of them.

Maximum number of returned files
Set the maximum number of results that Workfront Fusion will work with during one cycle. If the value is set too high, the connection may be interrupted on the side of the given third-party service (timeout). Workfront Fusion has no influence on this. We recommend that you set a lower value and either define a higher value for the maximum number of cycles or run the scenario more frequently.

Actions

Change permissions

This action module changes permission settings of a file or folder.

Connection
For instructions on establishing a connection to the FTP account, see Create a connection in an FTP module in this article.
Change permission settings of
Select whether you want to change settings for a file or folder.
File path
Enter or map the file path to the folder or file.
Permissions

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

Permissions must match the pattern /(.?([r-][w-][x-]){3})|[0-7]{3,4}/.

Create a folder

This action module creates a new folder.

Connection
For instructions on establishing a connection to the FTP account, see Create a connection in an FTP module in this article.
Folder path
Enter or map the file path to the new folder.
New folder name
Enter or map a name for the new folder.

Delete a file

Deletes a file from the specified folder.

Connection
For instructions on establishing a connection to the FTP account, see Create a connection in an FTP module in this article.
Folder
Select the FTP folder you want to delete a file from.
File name
Enter the filename, including file name extension. Example: image.png

Delete a folder

This action module permanently deletes the specified folder.

Connection
For instructions on establishing a connection to the FTP account, see Create a connection in an FTP module in this article.
Folder
Select the FTP folder you want to delete a file from.

Get a file

Retrieves a file from the FTP server which can be further processed, e.g. uploaded to the Dropbox.

Connection
For instructions on establishing a connection to the FTP account, see Creating the FTP Connection in this article.
File path
Enter the path of the file you want to get.

List of files in a folder

Retrieves file and/or folder information.

Connection
For instructions on establishing a connection to the FTP account, see Creating the FTP Connection in this article.
Folder
Select the FTP folder you want to search in.
Show
Select whether you want to retrieve information about files or folders, or both.
Search
Enter the search term. If no search term is entered all files and folders from the specified folder will be retrieved.
Maximum number of returned files
Set the maximum number of retrieved files by this module.

Move a file or folder

This action module moves a file or folder to a different location.

Connection
For instructions on establishing a connection to the FTP account, see Create a connection in an FTP module in this article.
Old file path
Enter the path that you want to move the file from. Example: /folder1/document.txt.
New file path
Enter the path that you want to move the file to. Example: /folder2/document.txt.

Upload a file

Uploads a file to the FTP server.

Connection
For instructions on establishing a connection to the FTP account, see Creating the FTP Connection in this article.
Folder
Select the FTP folder you want to upload the file to.
Source file
Select a source file from a previous module, or map the source file's name and data.
Append to an already existing file
If this option is enabled and the file already exists on the FTP server, the contents of the file are appended to the existing file. If this option is not enabled, the content of the file will be overwritten.
Create folders if don't exist
If this option is enabled and the folder you have entered to the Folder field does not exist on the FTP server, the module creates the folder

Troubleshooting troubleshooting

If you are experiencing issues with the FTP app either during the connection creation or during a module’s operation, try to use one of the popular FTP clients, and try to perform the same action (for example, create a connection or list files in a folder). with the FTP client. If you are experiencing the same issues also with the FTP client, the reason might be a misconfiguration of the FTP server.

recommendation-more-help
5f00cc6b-2202-40d6-bcd0-3ee0c2316b43