SFTP Server Connection¶

Many HR system support SFTP for pushing file extract reports with HR information. Hire2Retire product uses SFTP (Secure File Transfer Protocol) server as the entry point to consume Employee extract files. Other need to set up connections with the target SFTP server to send Employee Extract files.

Create a Connection¶

In order to connect Other to SFTP, you must provide the public key of your RSA key pair (SSH key).

Hire2Retire requires the following details to create a connection with your Other server:

Connection Name - A user-defined nomenclature for your connection. By default, the connect name is "Connection-RSA Key", you can change the name as per your preference.
Public Key of the RSA key pair - The public key of your RSA key pair (SSH key).
Folder Name - A new folder for the current workflow will be created by default. You can also select folders using dropdown option from existing workflows.

Connection page

Figure 1. Other Connection Set Up page - Create Connection

How to create ssh key pairs on MacOS or Linux¶

Step 1: Open your terminal and enter the below command:

$ ssh-keygen

Step 2: You can provide key name like hire2retire with your preferred location. And no passphrase is required. In the example below, the public key will be in /home/<username>/.ssh/hire2retire.pub and your private key will be in /home/<username>/.ssh/hire2retire.
Note - In your file path, <username> will be replaced with your username.

Output:

Generating public/private rsa key pair.
Enter file in which to save the key (/home/<username>/.ssh/id_rsa): /home/<username>/.ssh/hire2retire

Step 3: Now the key pair is ready, and you can provide the public key in Other Connection Set Up form.

How to create ssh key pairs on Windows 10 (OpenSSH)¶

Step 1: Open the window command prompt and enter the below command.

$ ssh-keygen

Step 2: You can provide key name like hire2retire with your preferred location. And no password is required. In the example below, the public key will be located in `C:\Users\<username>/.ssh/hire2retire.pub and your private key will be located in C:\Users\<username>/.ssh/hire2retire.
Note - In your filepath, <username> will be replaced with your username.

Output:

Generating public/private rsa key pair.
Enter file in which to save the key (C:\Users\<username>/.ssh/id_rsa): C:\Users\<username>/.ssh/hire2retire

Step 3: Now the key pair is ready and you can provide the public key in Other Connection Set Up form.

How to connect to the Hire2Retire SFTP server to drop the HR Data¶

You will find the details to connect to the Hire2Retire SFTP server on the Other Connection setup page.

Hostname - The host name provided is the IP address of Hire2Retire SFTP Server.
Port - The TCP/IP port on which the Hire2Retire SFTP server is listening.
Username - SFTP username to connect to the Hire2Retire SFTP server.
Folder Name - SFTP folder for the current workflow. The current Hire2Retire workflow will listen to the incoming extract files from the given folder path.

Connection page detail

Figure 2. Other Connection Set Up page - Other Instruction