Slate supports retrieving files from a remote SFTP server. However, this practice is generally discouraged, because the import process fails if the remote SFTP server becomes unavailable (such as with a network connectivity or maintenance issue). It is generally recommended that files be delivered to the Technolutions SFTP servers, where we can provide high availability. These best practices aside, Slate does support the pulling of files from a remote SFTP server if this is useful to your business process.
The recommended procedure to retrieve from a remote server is to use the Secure File Transfer Protocol (SFTP) with certificate-based authentication to provide the highest level of security.
Standard FTP is not an encrypted transfer protocol, which means that all data is sent in clear text. Therefore, FTP is not recommended.
Outbound connections are initiated from the following IP addresses:
These IP addresses must be allowed at the remote SFTP server.
Create a Remote Service Account User
The service account you create will store an SSH Private Key that will be used by any source formats configured to import files from a remote server for the User ID for this account.
Note: The Security Administrator exclusive permission (not inherited by any roles, even the Administrator role) is required to create or edit user accounts.
- Select Database on the top navigation bar and select User Permissions.
- Click New User.
- If you do not already have a key pair to use, you can use an SSH key generator, like this one.
Note: The corresponding public key needs to be installed on the remote server for this User ID.
- Since this is a service account, enter a name that clearly states this as a service account, rather than providing the name of a person who is already a Slate user.
- Enter the email address of a real user or distribution group able to receive email notifications.
- Change the User Type to Service Account (Remote).
- Provide a User ID (this should match the User ID created in the remote system).
- Enter the SSH Private Key.
- Be sure to select Enable account for access.
Schedule Imports using a Source Format
- Select Database on the top navigation bar.
- Under Import, select Source Formats.
- To create a new source format:
- Select New Source Format.
- Set the Status to Active.
- Enter a Name.
- Set the Remap as of Date to the current date.
- Select Save.
- Select the Source Format created above, or select another existing Source Format.
- Select Edit.
- Select the Import Automation tab.
- Enter the import path on the remote server as well as the file Mask of the files you will be retrieving.
- Enter the Server information in the Import Remote Server field.
If using certificate-based authentication, provide:
(For example: sftp://email@example.com)
Be sure to set the username as the User ID of the service account you created in the previous steps. The hostname should be the remote server address.
If using password authentication, provide the protocol, username, password and hostname (for example, sftp://remoteuser:firstname.lastname@example.org).
If a port number must be specified, the port is appended to the the Server information in the Import Remote Server field (for example, sftp://remoteuser:email@example.com:22).
The settings on the Import Automation Tab are optional and will not apply to every Source Format. The Import Path/Mask field tells Slate that you want to pull in files automatically. In this field, include the file name pattern that Slate should use to locate the file to be imported using this Source Format. We recommend appending the file name with a date, rather than using the exact same file name each time. Slate retains files in a Processed directory in the /incoming folder for a period of time, so creating a file with a date-appended name prevents the overwriting or deleting of existing files (and subsequent data loss) with each import.
An example value for the Import Path/Mask field would be: SIS_to_Slate_*.txt. With this value, Slate would automatically import any file in the /incoming directory that contained that file name pattern, including: SIS_to_Slate_09032013.txt.