In this article, you are going to learn about configuring a "remote SFTP server" gateway, where DEXMA Platform accesses an external SFTP server and retrieves data from it. Note this is not the most "natural" way of inserting data to DEXMA Platform, for more information please refer to the Generic FTP/SFTP Gateway article.
- What is "remote SFTP server"?
- The "remote SFTP server" gateway
- Register an SFTP Gateway in the EMS
- Additional information and logs
What is "remote SFTP server" gateway?
The remote SFTP server gateway uses the same protocol as the Generic FTP/SFTP gateway. The main difference is that configuring a remote SFTP server gateway, DEXMA Platform implements a mechanism to access a remote SFTP server to download remote files to the Platform to insert data (you have to provide credentials so that DEXMA Platform can access your SFTP server). The icon of the gateway is reflected in the following image.
The remote SFTP server
For this gateway to work, the EM Platform requires from an SFTP server on your side available for us to retrieve data files.
The remote SFTP server integration from the EM Platform recognises a list of File Formats mapped that can be used. Depending on the format, the data must be inserted in one way or another for the EMS to understand what's being inserted.
These File Formats are called Parsers.
Register a remote SFTP server Gateway in the EMS
To register this gateway, follow these steps and select the remote SFTP server Gateway.
Once in the settings of the gateway, you have to give it a name in the Platform, write your SFTP server URL and select which connection mode you want to use:
- RSA key: The EM Platform provides an RSA public key to set up the connection with the remote SFTP server. To use it, the remote SFTP server must have a user named "dexcellsftp".
- User/password: You should provide a user and password for the EM Platform to be able to connect to your remote SFTP server.
After this setup, you have to select your timezone, and select the File Format, from the list of available formats, that you are going to use to insert data into the Platform.
Additional information and logs
Maximum file size allowed
Please note that the maximum file size that the remote SFTP server can process is 10MB.
Inside the Platform, in the remote SFTP server gateway section, there's a tab dedicated to the logs in the gateway, where you can easily visualize when the EMS is properly processing the files that are being taken from the remote SFTP server server.
This can be very useful to discover if the reason why the data is not being inserted is that the format used doesn't match the chosen one on the Gateway.