Skip to content

HCM Server Connection

HCM (human Capital Management) involves strategic management practices related to an organization's workforce. Hire2Retire product uses SFTP (Secure File Transfer Protocol) server as the entry point to consume Employee extract files. Hire2Retire needs to set up the connection with HCM's SFTP server to import Employee Extract files.

Getting Your HR Data

HCM features various subscription products supporting either APIs or file export depending on the subscription type as explained in each section below.

File Based Extraction

One of the easiest ways to get your HCM data into Hire2Retire is by using HCM's SFTP export capability. To do this, you will first need to request SFTP Export from the HCM Reporting tool, which will allow Hire2Retire to import files from HCM's SFTP server.

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

Once the above details are ready, you can provide them in the HCM Connection setup form where you will fill out details to connect Hire2Retire to the SFTP server.

  • Connection Name - A user-defined nomenclature for your connection. By default, the connect name is "Connection-SFTP Password", you can change the name as per your preference.

  • Host - The host name to access the HCM's SFTP server.

  • Username - The Username of the SFTP server to be connected with Hire2Retire.

  • Password - The password to access the username of SFTP server.

  • Input 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 1. HCM Connection Set Up page - HCM Instruction


Once you have successfully configured the connections, you can continue with the Design section to configure the rest of the workflow following these steps in order.

  1. HR Data Definition
  2. Lifecycle Business Rules
  3. Employment Status
  4. HR to AD Profile Map
  5. Organizational Unit Assignment - Only defined in on-premise Active Directory
  6. Security Group Assignment
  7. Distribution List Assignment


Once your workflow has been setup, you have two optional features you can setup before deploying it.

Otherwise, you can proceed to deploy and test it on the Hire2Retire platform, see Deploy and Test Flow