You can create and set the format for dynamic components that can be added as a dropdown to offers or forms and allow candidates or users to select values pulled in from an integration for it.

Product dependencies

Requires: Conversational ATS + Forms +/- Offers

Use cases

• Clients who need more scalable dynamic offers.
• Clients who need dynamic components supported outside of compensation steps.

Best practices for implementation

The client must be using a third party system that sends us data in a nested structure. This will typically be used when a user must select from that group of data received in the integration.

Configuration

Step #1: Create an index

Indexes will be created to call on different attribute endpoints and will store the values received from the client’s integration. To create a new index, complete the steps below.

1. Navigate to the Indexes section of the Integration Center.
2. Click + Create Index.
3. In the slide-out drawer that opens, select the Key Attribute from all System Attributes that will be tied to the value you want pulled into the account.
4. Select the Expiration Time for the timespan that the value will be saved in the system before the integration will need to be reran to retrieve new values. Options include:
   • 1 minute
   • 5 minutes
   • 15 minutes
   • 30 minutes
   • 1 hour
   • 12 hours
   • 24 hours
5. Enter in a Property Name and Attribute associated with the index that will store the values selected by users when using a dynamic dropdown in the system. Each property will create a new column in the index based on the name set.
   • Note: Attributes can only be used once. Once a row of the index is selected by the user each property will save the to connected attributes.
6. Click + Add Property to add additional properties, as needed.
7. Click Save in the bottom right corner of the drawer to add the index.
8. Repeat this process for all values you want stored for dynamic components.

Edit index

1. Navigate to the Indexes section of the Integration Center.
2. You have two options for opening the edit drawer:
   1. Hover over the preferred index, click its ellipses icon, and then select Edit in its drop down selector.
      
      
       
   2. Click the preferred index in the list, and then in the new page that opens, select Edit next to the search bar.
      
      
       
3. A slide-out drawer will open where you can make the necessary updates to the index.
   • Note: Edited property names will need to be updated within the request Dropdown Optional Label as well.
4. Click Save to save the changes made.

Clear all index values

1. Navigate to the Indexes section of the Integration Center.
2. Click the preferred index in the list.
3. In the new page that opens, click Clear All next to the Edit button.
   
   
    
4. A warning modal will open, notifying you of the changes that will take place. Click Clear All to confirm the deletion of the index’s values.

Delete a property or index

In removing a property or index from the Integration Center, then all data that was stored under that property or index will also be removed and can never be retrieved. Properties that are configured in the Dropdown Option Label are displayed as empty values.

Step #2: Create a Dynamic Component Request

You will then need to build a response mapping for a Dynamic Component request.

1. Navigate to the Dynamic Component subsection of Requests in the Integration Center.
2. Click + Create New Request.
3. Create an outbound Dynamic Component Request by following the steps listed here. An additional Dynamic Dropdown Map section will be included in this request. Follow the steps below to update this section correctly.
   • Note: The regular response mapping section will work the same way an outbound request mapping works. Data will immediately be stored to those attributes when ran.
4. Once the Dynamic Dropdown Map section is completed, as outlined below, click Save or Save and Preview to finalize the request.
5. Repeat this process for all indexes.

Dynamic Dropdown Map section

This section is where you can select the index created and map its properties to response values using JMESPath. This has the capabilities of looping over the nested values. Each value will be stored in an array. 

• File example here.

An example of response value mapping is the following response is:

"env:Envelope"."env:Body"."wd:Get_Compensation_Grades_Response"."wd:Response_Data"."wd:Compensation_Grade"."wd:Compensation_Grade_Data"."wd:Compensation_Grade_Profile"[]."wd:Compensation_Grade_Profile_Data"."wd:Compensation_Pay_Range_Data"."wd:Compensation_Step"[]."wd:Compensation_Step_Data"."wd:Amount"

This will store values in the following format under the pay rate column in the index, with each value being it’s own row:

[
  "21.79",
  "23.09",
  "24.48",
  "25.95",
  "20.97",
  "22.23",
  "23.56",
  "24.98",
  "23.69",
  "25.11",
  "26.62",
  "28.21",
  "22.45",
  "23.79",
  "25.22",
  "26.73",
  "22.01",
  "23.33",
  "24.73",
  "26.21",
  "23.12",
  "24.5",
  "25.97",
  "27.53"
]

 

After selecting the index, enter in the Response Value for each property.

• Note: The Response Value field has a 1000 character limit.

View Details

Clicking View Details next to a selected index will open its details in a slide-out drawer. All details will be read-only.

Step #3: (Optional) Block use of expired data

Toggle on the Block Dynamic Components When Integration Errors setting in the Integration Settings section of the Integration Center to block dynamic components from being filled in a form or offer when data cannot be fetched.

Step #4: Add dynamic dropdown in forms and offers

The Dynamic Dropdown task/component will only display when one or more integrations are configured for the account.

Forms

1. Open a new or existing user or candidate form.
2. Add a Custom section.
3. Name the section.
4. Select Dynamic Dropdown from the question type selector.
   
   
    
5. In the Data Source selector that appears, select the integration that will provide data for this dropdown’s options.
6. Enter the preferred formatting for the dropdown’s options in the Dropdown Options Template field. You can do this by linking strings and index properties together.
   • Notes:
     • At least one index property is required.
     • Only index properties are available as tokens.
     • Each index row displays as separate options in the dropdown. The total number of options does not need to be specified and will be based on the rows for that request.
       
       
        
7. Save the section.
8. Repeat this process if you want to add additional dynamic dropdowns for other integrations.
9. Publish the form.

Offers

1. Open a new or existing offer.
2. Place your cursor where you want to add the dynamic dropdown.
3. Click Add next to the Add Dynamic Dropdown component.
4. A slide-out drawer will then open where you can enter a label for the dynamic dropdown.
5. Select the data source/integration that should populate the dropdown’s options.
6. Enter the preferred formatting for the dropdown’s options in the Dropdown Options Template field. You can do this by linking strings and index properties together.
   • Notes:
     • At least one index property is required.
     • Only index properties are available as tokens.
     • Each index row displays as separate options in the dropdown. The total number of options does not need to be specified.
       
       
        
7. Repeat this process if you want to add additional Dynamic Dropdowns for other integrations.
8. Click Add in the bottom right corner of the drawer.
9. Save the offer.

Dynamic dropdown experience

This section previews the forms and offers experience when they are sent to candidates or users.

Sending forms

The dynamic dropdown will be required to complete before sending a form. The options in the dropdown will reflect the formatting set within the Forms Builder.

• Note: This is similar to the candidate experience.

Sending offers

The dynamic dropdown component will be required to complete before sending an offer. The options in the dropdown will reflect the formatting set within the Offers Builder.

Resending forms/offers

If a form or offer is re-sent, then a selected value will remain. If the dropdown wasn’t opened previously, then no value will display. When the dropdown is opened at a later time, then the new values should display; however, attributes will only be updated if a user makes a new selection.

Failed integration

When an integration fails to refresh the index, then by default, the most recently stored data will be used as dropdown options. The user will be notified of the last refreshed time when it’s outside the specified expiration time at the top of this drop-down menu.

Dynamic dropdown integration trigger

The integration set for a dynamic component is triggered by:

• Offer drawer opening
• User form drawer opening
• Candidate form section loading

An integration will not run if values are already stored for it in an index. It only runs when the index values are expired or a new endpoint is added.

Multilingual capabilities

Users can configure multilingual versions of the dropdown label within the Forms and Offers Builders. Simply select the language for the form or offer and then update its label translation.

Additional logic

If an integration is deleted that contains an index used in a form or offer, then the question or component, respectively, will no longer function.

Permissions

The permissions for this enhancement will be based on a users permissions to the Form and/or Offer Builder and the Integrations Center.