Implementing a Q&A Module | Yext Hitchhikers Platform

What You’ll Learn

In this section, you will learn:

• How to set up the Org Entity
• How to add Q&A to the frontend
• How to ensure questions flow into the Yext platform

Overview

Once you’ve received sign-off from the brand, it’s time to implement the Q&A component! The setup process is straightforward; at a high level, the steps are the following:

• Enable and add the Org Entity for your brand
• Add the Q&A feature pack
• Add Q&A to the frontend on each page where it should display

1. Enable the Org Entity Type in Knowledge Graph > Configuration > Entity Types.

2. Add a new Org entity for your brand, or multiple Orgs if there are more than one.

   a. The entity name is included in the email and in the UI when the brand responds to questions. If your brand name is Yext, your entity name could be something like “Yext Organization”.

3. Add a Q&A feature pack for your Org entities by going to Entity Search, selecting the entity/entities and choosing from More Actions > Add Services. Follow the instructions for adding the First Party Q&A Feature.

4. For each page you want to include the Q&A:

   a. Update the pages > [pageName].html.hbs file to include the markup and script for QASubmission component. These are likely commented out.

    {{> templates/vertical-standard/script/qasubmission}}
    {{> templates/vertical-standard/markup/qasubmission}}

   b. Update the config > [pageName].json file to include the QASubmission object in ComponentSettings. You are required to specify the entity ID of your Org entity you want to use on that page, e.g., “org-1”. You can optionally modify more settings by including in the same object, like the privacy policy URL. You can find the full list of settings in the SDK documentation .

      "QASubmission": {
      "entityId": "org-1",
      "privacyPolicyUrl": "www.yext.com/privacypolicy" 
      },

5. Commit your code, monitor the build for errors and publish your page.

6. QA your Q&A (now that’s a tongue twister!). Submit a question and make sure it properly is submitted to Q&A in the product (in Reviews > Q&A).

Customizing Q&A

If you want to customize the component further, you can do so in a few different ways.

1. Check the SDK documentation to see what settings are built into the library. You can do things like change the various text strings or set the default accordion behavior (e.g., whether it’s expanded or collapsed by default). You can add these settings in directly in the QASubmission object in componentSettings in your [pageName].json file.

2. You can modify the styling by adding CSS to the static > scss > answers.scss file.

3. You can modify the placement of the component in the handlebars templates.