Step 6: Install the Frontend Module

This step will walk you through how to add Yext AI Search to your site.

1. To get started, navigate to the App Directory in your Yext account, find the Yext AI Search for Acquia app, and click Install. This will redirect you to the Yext module on Drupal.

2. Download the module and install it into your Drupal account as you would any other module.

   • Note: if you are already logged in, you can click “Extend” in your Acquia Sites view and click “Install new Module” to install the Yext module.

3. Once the module is installed, you will have access to 2 new blocks: Yext Search Bar and Yext Search Results.

4. Click on the Structure tab and then click on Block Layout.

5. On one page click Place Block in the section on the page that you would like the search bar to be in and choose the Yext Search Bar from the list of Blocks.

6. When you place the Block you will be prompted to fill out the following fields, which you can grab from your Yext account:

   • API Key - Found in the Yext platform, under Search > General Settings.
   • Experience key - Found in the Yext platform, under Search > General Settings.
   • Experience Version - This will be the version of your search experience, i.e., PRODUCTION or STAGING.
   • Account ID - Found in the Yext platform, under Account Settings > Account ID (or, it’s the string of numbers seen in the URL anywhere in the Yext platform).
   • Locale - This is the locale of your search experience (i.e en, de, etc).
   • Redirect URL - This is the URL of the page where the search results will redirect to on your Drupal site.
   • Search Placeholder - Add what text you want to appear in the search bar when the search bar loads on the page before a user has searched.
   • Visibility - Choose which page you want this to appear on.
   • Collapsible - Set the block collapse behavior.

   

   

7. Click Save Block.

8. Navigate back to your page. In the content section, add the Search Results block. This time you will be prompted to add in:

   • Yext Search Page - This is your Production URL, which is found in the Yext platform, under Pages > All Sites. Your Production URL will be in the “Domain” column of the site you want to use.
   • Visibility - Choose which page you want this to appear on.
   • Collapsible - Set the block collapse behavior.

   

   

9. Click Save Block.

You’re done! You’ve successfully added Yext AI Search to your Drupal site.