Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

...

Expand
titleSTEP 2: Set up the component configurations
image-20241107-200641.pngimage-20241107-200658.pngimage-20241107-200711.png

Fields marked with an asterisk * are required.

Connection Configurations:

Field

Description

Default Value

Protocol *

Specifies the protocol you’ll be using. Supports: FTP, FTPS, or SFTP

FTP

Server *

The server you will be connecting with

-

Port *

The port to use

-

Username *

The remote user to login as.

This account will need permissions to read, delete, and/or move files to the specified FTPDirectory

-

Password

The password to authenticate with.

-

Certificate

The name of your certificate file, if in use.

By default, this should be a PEM certificate. The default configurations can be changed by modifying the net.[protocol].init function directly in the script. See Adapting the Component.

This configuration is only applicable for FTP and FTPS.

-

PrivateKey

The name of your private key file, if in use.

By default, this should be a PEM certificate and not be password-locked. The default configurations can be changed by modifying the net.[protocol].init function directly in the script. See Adapting the Component.

-

RetryCount

The number of times to retry the connection if it drops. Default is set to 3 attempts.

3

FTP Workflow Configurations:

Field

Description

Default Value

FTPDirectory *

The target directory on the FTP server you’ll be writing files toFTP

-

OutputFileMask *

The name and extension of the output files (local and on the FTP server).

%Y (year), %m (month), %d (day), %H (hour), %M (minute), %S (second) and %f (millisecond)

output_%Y_%m_%d_%H_%M_%S.txt

OneFilePerMessage

Specifies whether each inbound message will have its own file. If set to false, the file will only be uploaded to the FTP server once the component rolls over to the next file.

true

OutputEncoding *

The encoding used in the output file.

If left blank, encoding will be updated to the default according to OS. See Supported File Encodings

Western (Windows-1252) for Windows

Western (ISO-8859-1) for Linux/Mac OS

Escape8BitCharacters

Specifies whether to escape non-ASCII characters in outbound messages.

Ex. "é" would be sent as "\XE9\" (in Latin-1 or Windows-1252) or "\XC3\\XA9\" (in UTF-8).

false

UseRemoteTempFiles

Specifies whether to use temporary files while uploading to the FTP server.

When true, it will append “.tmp” to files currently being written until the component is done writing to them. It will only remove the .tmp extension when a new file is written in.

false

OverwriteFTP

Specifies whether files on the FTP server will be overwritten.

false

Local File Workflow Configurations:

Field

Description

Default Value

DestinationDirectory *

The local directory that the files will be written to from the component before uploading to the server.

-

UseTempFiles

Specifies whether to use temporary files while writing.

When true, it will append “.tmp” to files currently being written until the component is done writing to them. It will only remove the .tmp extension when a new file is written in.

true

KeepLocalFiles

Specifies whether to keep local files or delete them once the files have been uploaded to the FTP server.

false

...

Expand
titleCustomize the FTP/FTPS/SFTP connection

By default, the FTP/FTPS/SFTP connection is authenticated using username and password authentication and uses the default configurations. In some cases, additional configurations may be desired, such as:

  • Specifying a FTP(S) mode

  • Using public and private key authentication

  • Disabling verify_peer or verify_host

  • Increasing the timeout

  • and more. Full details can be found by accessing the net.ftp.init, net.ftps.init, or net.sftp.init function help in the Translator

These configurations can be customized by modifying the Input parameter table in FTP/FTPprocess.lua:

image-20241107-202653.png