Skip to main content

FTP Connector

How to set up and use the FTP & SFTP Connectors in Creative Force.

Written by Viviana
Updated yesterday

Creative Force supports both FTP (File Transfer Protocol) and SFTP (SSH File Transfer Protocol).


Getting Started

Enable Connector

By default, these Connectors will be automatically enabled when your studio account is first set up.

If, for any reason, they have been disabled, head to Studios Settings β†’ Connectors β†’ FTP or SFTP, and select to re-enable.

πŸ“ Notes:

  • Creative Force does not support keyboard-interactive (Interactive) authentication mode.

  • We support two logon types: Normal and Key File mode.

Data Source

With the FTP & SFTP Connector, you can add connected files stored in an FTP as importable data for your Productions.

General Setup

For general information and a walkthrough on adding a new Data Source, first review our related article on Data Source Setup & Configuration.

FTP Specific Setup

The next sections will cover specific configuration options for FTP/SFTP that are not covered in the general article.

πŸ—£οΈ Tip: Depending on your permissions and familiarity with the technology/interface, you may need to request the following information from your internal IT Team.

Connection Option

Function

Protocol

Define the connection protocol. Select from one of the following:

  • FTP

  • SFTP/SSH

  • SFTP/SSH & Private Key

Port

Define the connection port.

Encryption

Only an option when selecting the 'FTP' method. Select from one of the following:

  • TLS/SSL Explicit

  • TLS/SSL Implicit

  • Plain FTP

Host

Enter the host domain.

Example: ftp.yourdomain.com

Username / Password

Enter the FTP Username and Password with which Creative Force will connect.

File Path

Specify the file path within the FTP where Creative Force can access the file or files.

Type '/' to denote a subfolder path.

Delivery Location

With the FTP & STFP Connectors, you can deliver finished assets to a central location of your choice.
​

General Setup

For general information and a walkthrough on adding a new Delivery Location, first review our related article on Delivery Locations.

FTP Specific Setup

The next sections will cover specific configuration options for the FTP/SFTP Method that are not covered in the general article.

πŸ—£οΈ Tip: Depending on your permissions and familiarity with the technology/interface, you may need to request the following information from your internal IT Team.

Configuration Option

Function

Protocol

Define the connection protocol. Select from one of the following:

  • FTP

  • SFTP/SSH

  • SFTP/SSH & Private Key

Encryption

Only an option when selecting the 'FTP' method. Select from one of the following:

  • TLS/SSL Explicit

  • TLS/SSL Implicit

  • Plain FTP

Port

Define the connection port.

Host

Enter the host domain.

Example: ftp.yourdomain.com

Username/Password

Enter the FTP Username and Password with which Creative Force will connect.

⚠️ Important: If you are choosing SSH File Transfer Protocol with private key, the maximum length of the private key allowed is 4096 bits.

Post-Production

With the FTP & STFP Connectors, Creative Force can connect directly to a vendor of your choice by utilizing an FTP server.

General Setup

For general information on setting up and configuring a new external post-production vendor, please see our dedicated article at the link below.

The next sections will cover setup and configuration options that are unique when utilizing the FTP connection type as an External Post-Production option.

Connection Settings

In the Connection Settings tab of the Add Vendor menu, you will need to provide specific credentials to facilitate the connection from Creative Force to your vendor.

πŸ—£οΈ Tip: Depending on your permissions and familiarity with the technology/interface, you may need to request the following information from your internal IT Team.

Connection Field

Function

Protocol

Define the connection protocol. Select from one of the following:

  • FTP

  • SFTP/SSH

  • SFTP/SSH & Private Key

Encryption

Only an option when selecting the 'FTP' method. Select from one of the following:

  • TLS/SSL Explicit

  • TLS/SSL Implicit

  • Plain FTP

Port

Define the connection port.

Host

Enter the host domain.

Example: ftp.yourdomain.com

Username/Password

Enter the FTP Username and Password with which Creative Force will connect.

Upload Folder

Set the file path where Creative Force will deposit the assets when delivering to the FTP.
​
​

Select the folder icon to browse the FTP structure and select a location directly.

Download Folder

Set the file path where Creative Force will check for the assets when returning them from the FTP.

Select the folder icon to browse the FTP structure and select a location directly.

⚠️ Important: If you are choosing SSH File Transfer Protocol with a private key, the maximum length of the private key allowed is 4096 bits.

Transfer Settings

In the Transfer Settings tab of the Add Vendor menu, you will need to specify how you want Creative Force to act when performing file transfers both to and from the vendor.

πŸ—£οΈ Tip: It is generally recommended to select 'Filename Mode' as the Transfer Method when configuring new vendors. Filename mode offers greater flexibility, customization, and is easier to troubleshoot in the event that an issue should occur.

Setting Field

Function

Transfer Method

Choose the method for how Creative Force should verify assets when checking that they are completed.
​
Select between:

  • Filename Mode

  • Legacy Mode (Metadata)

File Return Mode

Select between:

  • Filename Only: The filename must be correct as per the Style Guide setup.

  • Filename+Folder: Both the filename and the folder path must be the same as per the Style Guide setup.

When File Exists

Choose how Creative Force should handle files with duplicate naming.


Select between:

  • Keep Both:

  • Replace Existing:

Clean-Up

Choose the clean-up behavior for when Creative Force has completed returning assets from the vendor.

Select between:

  • Archive: Move assets to a designated 'archive folder' that Creative Force will create in the rootpath.

  • Delete: Creative Force will delete the assets from the FTP location.

Expected Return Files Settings

πŸ”“ Filename: This section of the Transfer Settings tab will only appear when 'Filename Mode' is set at the Transfer Method. Set the behavior for how

Setting Field

Function

Expected Return Files List

Control whether Creative Force will send an additional file along side the assets. The file will contain a full list of all the files and their requirements, which Creative Force will need in order to progress forward.

  • Toggle On/Off

Include Preset Specifications

When enabled, preset specifications such as DPI, Color Profile, and more will be included within the Expected Return Files list that is sent to this vendor.

Only applies to fan-out steps.

File Format

Set the format that the created return list will be sent to the vendor as.
​
Select between:

  • .txt

  • .json

File Name - Ecomm

Set a defined naming structure for the return file list when related to Ecom productions.
​
​ Use tokens to insert values from properties into the file name.

File Name - Editorial

Set a defined naming structure for the return file list when related to Editorial productions.
​
​ Use tokens to insert values from properties into the file name.

Transfer Log Settings

πŸ”“ Filename: This section of the Transfer Settings tab will only appear when 'Filename Mode' is set at the Transfer Method. Set the behavior for how

Setting Field

Function

Transfer Log

Deliver an additional log file for every upload once the transfer is completed.
​

The transfer log contains a list of all uploaded files, including their directories on the FTP server.

  • Toggle On/Off

File Name - Ecomm

Set a defined naming structure for the Transfer Log when related to Ecom productions.
​
​ Use tokens to insert values from properties into the file name.

File Name - Editorial

Set a defined naming structure for the Transfer Log when related to Editorial productions.
​
​ Use tokens to insert values from properties into the file name.

For additional details and explanations on how the Transfer Settings can affect productions in Creative Force, please see our dedicated article at the link below.

Explore Connectors

To review a list of all available connectors in Creative Force and their functions, select the button below.

Did this answer your question?