The connection configuration creates a connection with the SFTP location. The connection configuration has one or more upload/download actions.
Connection Configuration Explained
The Connection Configuration is the main configuration that defines the connection with one SFTP location. The SFTP Connector allows you to create as many connections as needed. Under the Connection Configuration, you can create separate download or upload connections. These connections will contain the logic that is used for upload/download.
Create a New Connection Configuration
To create a new connection navigate to Setup > ZoneReconcile Setup > Connectivity SFTP > New (in the old SFTP installation, the navigation path was defined as Setup > SFTP Connector > Connection Configuration > New). There are three kinds of connections possible to create on this page. The SFTP host can be a host that connects only with a username and password, username and a key pair, or the SFTP host uses a combination of username, key pair and a password.
Section Primary Information
Provide a name in the field Name. Make sure that the naming convention easily identifies the purpose of the connection. The NetSuite IP address will be populated after saving the Connection Configuration. This can be used by the SFTP host to whitelist the connection. Whitelisting is only possible when you don’t use the PGP Encryption or Secure Envelope protocol. Please note that the IP from NetSuite is not static and is subject to change (recommended Setup IP Change Reminder).
Section Credentials
In this section, the credentials are entered to connect to the SFTP host. This connection can be a simple username and password connection, username and a private key, or 'multi-factor' connection (username, key pair and password).
Username & Password Connection
To connect with only a username and password you must first enter the username provided by your SFTP host in the field "User".
The next step is storing the password securely. For this purpose, navigate through Setup > Company > API Secrets.
Click on 'Create new' to create a new Secret. Provide a name that would identify the Password purpose, the ID and then enter the connection's password as provided by your host.
Under restrictions, provide a restriction to a script or domain. If not applicable, then select the checkboxes to allow access to all. Updating the owners and SuiteApp's availability are optional.
Once saved, copy the ID of the secret and store it on the Connection configuration under 'Secret'.
This way, the password for the connection, provided by your host is securely stored in NetSuite.
Username & Private key Connection
To connect with a username and a private key you must first enter the username provided by your SFTP host in the field “User”. After this enter the ID of the private key that is stored inside NetSuite (Documentation).
Username, Private key & Password Connection (Multi-factor authentication)
The Multi-factor authentication approach is a combination of the two previously mentioned connection types. Follow the instructions on safely storing your connection password under API Secrets (Setup > Company > API secrets), and add the connection details following the 'Username & Private key' instructions too. Below is an example of this type of connection.
Section Host Key
In this section you set a host key type and a host key. The type is defaulted to RSA and can’t be changed to other connection types. In the Host Key you must enter the host key that is usually provided by your SFTP host. If this is not the case, then you can obtain this manually. If the record is saved with a host under the section "Connection Details" then our solution will show you an additional field that holds a Shell command. You can execute this shell command to obtain the host key. Normally the SFTP provider will provide you this, but with the shell command it is possible to retrieve it manually.
Section Connection Details
In this section we define the SFTP server and root a folder access
- Enter in the field "HOST" the IP address of the server.
- Enter in the field "PORT" the port on which the SFTP is listening. In most cases, this will be port 22 but your SFTP host will provide both values.
Section PGP Encryption
In this section you can set the PGP encryption if this is needed by the SFTP host. PGP provides an additional signature or encryption on the transferred data. The data that you enter in this section must be provided by a combination of the SFTP host and Customer.
Private Key: It is the responsibility of the customer to generate the PGP Key, a Passphrase is mandatory during creation.
- PGP Private Key (the private key generated by the customer)
- PGP Private Key File (select here the private key generated by the customer which is stored in the file cabinet - only if provided for save storage read Store Safely The Private Key)
- PGP Private Key Passphrase (populate the Passphrase exactly as specified during creation of the key, using the update GUID button)
Public Key: It is the responsibility of the SFTP Host to provide the PGP Key.
- PGP Public Key (select here the provided public key from the SFTP host that is stored in the file cabinet - for save storage read Store Safely The Private Key)
- PGP Encryption Algorithm (select in this field the PGP encryption type - if unknown then leave the field empty and the system will use the most common type)
Section Secure Envelope (Nordea)
In this section you can set the Secure Envelope setting for your connection. This is mostly used by Nordea but could be present on other SFTP providers.
- Certificate File ID (select here the provide certificate from the SFTP host that is stored in the file cabinet - only if provided for save storage read Store Safely The Private Key)
- Nordea Customers ID (populate with the customer ID provided by your SFTP host)
- Nordea Target ID (populate with the provided target ID by your SFTP host)
Proceed to the next topic Configure Statement & Files retrieval Configuration.