File Transfer Protocol (FTP) is a standard communication protocol used for the transfer of files from a server to an application or a computer. You can grab existing JSON, XML, CSV, and other files to upload them into a second application (such as Amazon Seller Central and Acumatica) or add files to the server from an application.
Start establishing a connection to FTP in either of the following ways:
-
From the Resources menu, select Connections. Then, click + Create connection at the top right.
– or –
-
While working in a new or existing integration, you can add an application to a flow simply by clicking Add source or Add destination/lookup.
In the resulting Application list, select FTP.
The Create connection pane opens with required and advanced settings.
At this point, you’re presented with a series of options for providing FTP authentication.
-
Name (required): Provide a clear and distinguishable name. Throughout integrator.io imports and exports, you will have the option to choose this new connection, and a unique identifier will prove helpful later when selecting among a list of connections that you’ve created.
-
Application (required, non-editable): A reminder of the app you’re editing.
-
Mode: Defaults to Cloud. Select On-premise to use an agent. Considerations when using on-premise agent FTP connections:
-
On-premise agent FTP connections have an import limit of 2 GB and an export limit of 500 MB
-
Active mode is not supported
-
Minimum requirements for the client machine hosting the agent
-
JDBC 3.3.0
-
FTP 5.4.0
-
-
You must whitelist relevant IP addresses when using S3.
-
Java Requirements:
-
Make sure Java 17 JDK (or higher) is installed on the client machine.
-
Set the following environment variables (Windows only):
JAVA_HOMEis set to the JDK installation directory (ex.,C:\Program Files\Java\jdk-17)PATHincludes<JAVA_HOME>\binin Windows machines (ex.,C:\Program Files\Java\jdk-17.0.1\bin) -
See also Setting JAVA_HOME for Oracle Java or OpenJDK documentation.
-
-
-
Agent: Choose the agent you would like to use for your FTP connection. This is only visible when On-premise mode is selected.
-
Host (required): Enter the hostname or IP address of the server to connect to. For example, ftp.mycompany.com or 100.200.300.1. Don't forget to whitelist the North American or European Union integrator.io FTP IPs.
-
Protocol (required): Choose the file transfer protocol (FTP, SFTP, or FTPS) for establishing the FTP connection. You can configure your FTP connection using the following protocols:
-
FTP, or file transfer protocol – not recommended due to lower security
-
SFTP, or secured file transfer protocol
-
FTPS, or file transfer protocol with SSL security
-
Username (required): Enter the username for your FTP server.
Password (required): Enter the password for your FTP account. Do not use spaces in your password. Any connections with spaces in passwords will fail authentication. Multiple layers of protection are in place, including AES 256 encryption, to keep your connection’s password safe. When editing this form later, you must generate this value again; it is stored only when the connection is saved and never displayed as text.
Note
SSL certificates with FTP is not possible, however SSH keys with SFTP is possible.
Username (required): Enter the username for your FTP account.
Password (required): Enter the password for your FTP account. Multiple layers of protection are in place, including AES 256 encryption, to keep your connection’s password safe. When editing this form later, you must generate this value again; it is stored only when the connection is saved and never displayed as text.
Authentication key (pem format, optional): An SFTP connection can use a password or an authentication key to authenticate a user trying to connect to the SFTP server. Use this field to store the RSA private key used for authentication. It must be in PEM format. You can use both a password and an authentication key, but servers that enforce a strict authentication order (ex. public key first, then password) are not compatible. If you're seeing authentication errors, confirm the authentication requirements with your server administrator. We do not support SSH keys with a passphrase. For more information, see Use SSH keys for SFTP connections.
Username (required): Enter the username for your FTP server.
Password (required): Enter the password for your FTP account. Multiple layers of protection are in place, including AES 256 encryption, to keep your connection’s password safe. When editing this form later, you must generate this value again; it is stored only when the connection is saved and never displayed as text.
Use implicit FTPS (optional): If the server supports Implicit FTPS (where the client and server always use an encrypted connection), check this box. The default is Explicit.
Before continuing, you have the opportunity to provide additional configuration information, if needed, for the FTP connection. The advanced settings for all the protocols are listed below; but, based on the protocol you selected, only some of these settings might show.
Port (required): This field is set to default port numbers based on FTP, SFTP, and FTPS protocols. You can change this field to any port number to override the default value.
Use passive mode (FTP & FTPS only): This field is checked by default to use passive mode instead of active mode. If you want active mode instead, uncheck this box.
User directory is root (optional): This field is used if the relative path used by a file export or import is relative to your FTP login’s user directory or to the server root folder.
For example, suppose your files are located on the server at /usr/local/iio/files/download – if your FTP server account places you in your user directory after login ( /usr/local/iio ), then check this box and enter /files/download as your relative path. If you go straight to the server’s root directory ( / ) after login, then leave this box unchecked and provide /usr/local/iio/files/download as your relative path.
Entry parser (optional): This field can be set if your FTP server is an uncommon type (not Windows or Linux), or it does not support the SYST command.
Require socket reuse (FTPS only, optional): If you selected FTPS as the protocol, this option is available under Advanced settings. FTPS servers are configured to use two sockets on two different ports for connections by default. If your FTPS server uses only one port for FTPS traffic you can check this box to tell Celigo integrator.io to reuse one socket to connect to this one port.
Enable PGP cryptographic: If this connection will be used to transfer and encrypt/decrypt files using PGP, enable this option and configure the settings.
Auto-recover rate limit errors: This setting is enabled by default with a predefined value for Target concurrency level. You can disable the setting if required. To set or make changes in any of these settings, you must have admin or manage permissions.
-
Target concurrency level: This field is shown only if Auto-recover rate limit errors is enabled. Change the predefined value as required to limit the number of concurrent API requests allowed by the connection resource. See also, setting currency level on a connection.
-
Concurrency level: When Auto-recover rate limit errors is checked, you can't modify the concurrency level because it matches the value set by the connected platform's runtime. When Auto-recover rate limit errors is not checked, you can enter a value to limit the number of concurrent API requests allowed by the connection resource. See also, Setting currency level on a connection.
Once you have configured the FTP connection, you have a few options for continuing:
-
Save – click this button to test the connection, commit the new connection so that it will be available to all integrations for your account
-
Save & close – click to test and save the connection and exit the Create connection pane
-
Cancel – click to exit without saving any new changes
-
Test connection – click this button to verify that your new connection is free of errors
When you test or save the connection, it is verified before continuing.
The new connection is now successfully added to your account. It will be applied to the current source or destination app if you created it within a flow. Otherwise, you can register the connection with an integration.