ATS Field Mappings

Recruitment Marketing Public

Recruitment Marketing's ATS integrations map standard fields from the ATS data model to related fields within the Recruitment Marketing data model. Occasionally, it is required to map non-standard job data from the ATS to Recruitment Marketing job data. This can be solved with ATS field mappings with the following steps:

  1. Make the data available in the ATS API responses. This may require assistance from the ATS vendor.
  2. Create an ATS field mapping, described below
  3. Run the ATS Job sync process within Recruitment Marketing
  4. If everything has been configured correctly, the job template fields will be populated with the ATS data.

ATS data can be mapped either to job template fields or job component fields. Both of these approaches are described below.

Note: It is recommended to work with a Customer Success Manager to validate any changes made to ATS Field Mappings.

Creating ATS field mappings to job template fields 

There are two distinct ways that a value from the ATS can be mapped to a job template field:

  • Assign ATS value - the values from the ATS are considered to be the source of truth, and are added to the Recruitment Marketing database each time. In the case of a dropdown field, if a new value is received which doesn't currently exist in the dropdown field, that additional item will be added to the dropdown field options. This is the most popular way to create an ATS field mapping
  • Assign dropdown field option - any jobs received via this ATS integration are automatically assigned the selected value for this field.

More information on Job Template Fields is available here. To create the ATS field mapping:

  1. From the side menu, under Integrations click ATS.
  2. Click the link under the Field Mappings heading for the ATS Integration you are looking to add the field mapping to.
  3. Click New.
  4. Select the Type of Mapping based on the descriptions above.
  5. Select the Language used for mapping - this defines how Recruitment Marketing should derive the value from the ATS vendors API response. Available options are: Liquid (which utilises the Liquid query language) and Classic (which uses proprietary syntax to specify the path to the data field - see examples below). It is recommended that Liquid is chosen as the preferred language.
  6. Depending on the ATS, there may be an option for Type of field mapping. Choose Template Field.
  7. Select the Job Template Field you wish to map the ATS value to.
  8. If the selected language is Liquid (recommended):
    • ATS UID Liquid expression - enter the Liquid which represents the Unique Identifier for the relevant field
    • ATS name Liquid expression - enter the Liquid which represents the display name or value for the relevant field
  9. If the selected language type is Classic:
    • What is the path to the ATS UID field - enter the path of the node which represents the Unique Identifier for the relevant field
    • What is the path to the ATS Name field - enter the path of the node which represents the display name or value for the relevant field
  10. If the type of mapping is Assign dropdown field option, then select the relevant field from the Dropdown field option list.
  11. Click Save.

Creating ATS field mappings to job component fields

It is possible to map ATS data to built-in job component fields such as department, category, employment type, and level. To date, only Greenhouse and SAP Success Factors support this feature.

  1. From the side menu, under Integrations click ATS.
  2. Click the link under the Field Mappings heading for the ATS Integration you are looking to add the field mapping to.
  3. Click New.
  4. Select Assign ATS Value from Type of Mapping 
  5. Select the Language used for mapping - this defines how Recruitment Marketing should derive the value from the ATS vendors API response. Available options are: Liquid (which utilises the Liquid query language) and Classic (which uses proprietary syntax to specify the path to the data field - see examples below). It is recommended that Liquid is chosen as the preferred language.
  6. Select the Type of field mapping and choose Component field.
  7. Select the Job Component you wish to map the ATS value to e.g. Department, Category
  8. If the selected language is Liquid (recommended):
    • ATS UID Liquid expression - enter the Liquid which represents the Unique Identifier for the relevant field
    • ATS name Liquid expression - enter the Liquid which represents the display name or value for the relevant field
  9. If the selected language type is Classic:
    • What is the path to the ATS UID field - enter the path of the node which represents the Unique Identifier for the relevant field
    • What is the path to the ATS Name field - enter the path of the node which represents the display name or value for the relevant field
  10. Click Save.

Liquid mapping syntax

The following are examples of the liquid mapping syntax.

Example 1: a node called department exists at the root level:

{{department}}

Example 2: a node called custom_field exists at the root level, and contains a child note called name:

{{custom_field.name}}

Example 3: a collection of jobReqLocales exists. The externalTitle from the first result in the collection should be used:

{{jobReqLocale.results[0].externalTitle}}

For examples of ATS field mappings for Workday see the Job Template Fields section of Workday API Integration

Classic mapping syntax

The following are examples of the classic mapping syntax.

Example 1: a node called department exists at the root level:

department

Example 2: a node called custom_field exists at the root level, and contains a child note called name:

custom_field->name

Example 3: a collection of jobReqLocales exists. The externalTitle from the first result in the collection should be used:

jobReqLocale->results->[0]->externalTitle

Troubleshooting

The challenging part of creating an ATS field mapping is knowing what syntax to enter.

Suggestions:

  1. Check the Recruitment Marketing Knowledge Base for articles about your ATS integration. For example, the Workday API Integration describes liquid syntax for mapping different Workday data points
  2. Check with a Customer Service Manager. In some cases, they can examine the API responses that are being sent to Recruitment Marketing and can assist in understanding which fields should be mapped, and what syntax should be used.

Comments

0 comments

Article is closed for comments.