Module Assessment | Yext Hitchhikers Platform

Background

Imagine you are just starting your work for the Turtlehead Tacos team. Instead of starting from scratch, like you did in the Knowledge, Pages and Search tracks, you want to install the Restaurants solution template as your starting point.

Your Challenge

When you generate your challenge account, note that your account is empty. Remember, this is a new starting point with a fresh account.

1. Navigate to Apps > Solutions

2. Click on the Food Solution

3. Click to View Solution to view the solution’s configuration files in the Admin Console and to start the installation flow

4. Once in the Admin Console, click into a few files from the directory on the left to become more familiar with the template. Try to find the following files and take a look:

   • km/entity-type/ce_menuItem.json - this is the file for the Menu Item Entity Type configuration. You’ll see the fields, whether each one is required or not, and metadata like the type’s display name and plural name.

   • km/field/c_primaryCTA.json- this is the file for the Primary CTA custom field. You can see the field is using the field type CTA.

   • pages/yextsite-config/Answers-Food.json - this is the file for your Search site. You can see things like the site’s name, and the staging site’s credentials (test/test). The repo configuration links to another file (pages/repository/smolder-commuting-override-f9211.json), which shows the Github Template Repository used to generate the repo and the URL you want the new repository you’re creating to live at. You’ll learn more about this in step 9.

   Feel free to click around to see even more.

5. You decide that you want to modify the files before you apply them, which you are always welcome to do! Remember that any changes that you make in your browser won’t impact the global solution template – they’re just saved locally in your browser. Navigate to the km/entity-type/ce_menuItem.json file and add in a description for the Menu Item entity type:

   This entity type is to store the menu items for our brand, including fields like allergens and calories. 

6. When you’re ready, click the Apply button in the top right corner of the screen

7. Enter your Account ID of your Challenge account. You can find this in the URL path (e.g., /s/[accountID] in the url of your account or by navigating to Account Settings > Personal Settings and searching for Account ID). You can leave the Namespaces field empty. Click Continue.

8. Now you need to authenticate into your account. Click the link to “Start Authorization Flow”. Once authorized, close the tab and then click Continue.

9. The solution contains a variable for the businessId (this is used to set the GitHub Repository name for your Search site repository as food-template-answers-site-${{businessId}}. This is the same name you would provide if you clicked Create Repository within your selected site after navigating to Pages > All Sites. businessId is the same as Account ID. Like in step 7, you can find your account ID in the URL or by navigating to Account Settings > Personal Settings and searching for Account ID field).

10. You’ll be prompted to View Diffs to review the changes you will be applying to your account. Click into a few files. Specifically, look at:

    • An example of adding a new file: km/entity/Menu1.json
    • An example of updating a file: km/entity-type-extension/job.json

    If you see something on the diff that you don’t want to apply, you can click cancel and modify the files in the Admin Console. Otherwise, click Continue.

11. Review your changes one last time. Click Confirm to proceed.

12. Monitor the application in the Console. If there are any errors, review the error message and take any necessary actions. If you aren’t sure, reach out to hitchhikers-support@yext.com or post in the Community

13. Go back to your account and check out:

    • New entity types in your account by visiting the Entity Types screen
    • New sample entities by navigating to Knowledge Graph > Entities
    • New Pages by navigating to Pages > All Sites
    • New Search experience configuration by going to Search > All Experiences