Skip to content

ATS Data Definition

An Applicant Tracking System (ATS) is a software used by organizations to manage and streamline the recruitment process. It helps in collecting, sorting, and tracking job applications and candidate information, making it easier for recruiters to screen and evaluate candidates.

In this step, you will define the file structure of the employee extract that the ATS platform will send to the Hire2Retire workflow. At runtime, the workflow will validate the file structure before further processing individual employee records.

CSV Filename

You need to give a target CSV file name or pattern that Hire2Retire integration is listening to for the incoming ATS Data.

For example, if ATS report come with pattern employee_.csv, then you could provide CSV file name pattern as employee_*

CSV Filename Pattern Scan

Figure 1. CSV Filename Pattern Scan

Select Delimiter

Choose the delimiter which is used in your delimited file. If the delimiter of choice is not available in the dropdown, you can write a custom one using the "Other" option.

CSV Filename Pattern Scan

Figure 2. Choose Delimiter

Upload CSV

Entering all the headers manually can be a tedious task. You can upload a sample CSV file from your device and all the header name in the CSV file will automatically added. The uploaded file should use the same delimiter which is selected in above menu item.

Process leave user in AD

Figure 3. Upload CSV File

Headers details of CSV file

Set up all the values of the column header which you will find at the top row in your CSV file.

You can add column headers along with column header type by clicking the plus button and delete the incorrect column header value by clicking the minus button.

Headers details of CSV

Figure 4. Headers details of CSV File


Please make sure the column headers you put match the header column in the CSV file. The Hire2Retire service will reject the file if the headers in the actual file do not match the column headers defined in workflow.

Monitor receipt of scheduled ATS extract

To address potential delays in employee file extraction due to connection issues or ATS system issues, Hire2Retire now supports a File Extract Check that ensures timely reporting by checking if Hire2Retire successfully receives reports from ATS systems at the scheduled time. Users will receive alerts after the 30 minutes of scheduled time if no file has been processed since last one hour. For example, if File Receipt is scheduled at 09:30, then an alert message will be generated at 10:00 if the File Extract is not received in between 09:00 to 10:00.

To set up the Monitoring of File Extract on Hire2Retire, you need to be aware of when your ATS system generates the report, including the time zone, and drops it on the SFTP server for processing.

Setting up Monitor Receipt of Scheduled ATS Extract

By default, this feature is enabled and you are given flexibility to make this disable according to your requirement. To setup this feature follow the steps mentioned below.

  • Please select time, weekdays and timezone of your region according to the matching time of your ATS System on the ATS Data Definition step.

    Select time, weekdays and timezone

    Figure 5. Select time, weekdays and timezone

Apply Filter

Hire2Retire enables you to process specific events and filter out the rest by defining filter criteria. On clicking the "Apply Filter" button, you will be able to set up conditions using employee attributes. Only employees who match the conditions will be processed.

Headers details of CSV

Figure 6. Event Filtering for ATS Data.