Templating API

• Create a template
• Add zones to the template
• Conditionally trigger the template
• Test the template in the Predictive Merchandiser screen

LucidAcademyLucidworks offers free training to help you get started.The Course for Predictive Merchandiser: Template Manager focuses on how to use the templates included in Predictive Merchandiser and create your own custom templates:

Visit the LucidAcademy to see the full training catalog.

​

Create a new template

1. From the Templates screen, click the New Template button:
2. In the Template Name field, enter a unique name. In this example, the value Cyber Monday is assigned.
3. Select a value in Template Type. This example uses the landing template type. This value is read-only and for informational purposes only.
4. Click the Save button to save the new template:

• Templates UI configuration options
• Templating API configuration reference

​

Add a zone to a template

1. Click Existing to add an existing zone. In this example, the Main Results List zone is added by selecting the zone and clicking Apply.
   The Main Results List zone is the default zone. This zone can be edited but cannot be deleted.
2. Create a new zone by clicking the New button:
3. In the Display Name field, enter a unique name for the zone. For this example, the value is Promoted.
4. In the Query Profile file, select a value. This example uses a query profile named promotional-results. This query profile is configured with rules that pin products to the top of the results.
5. In the Zone Type field, select a value. This example uses main-results-list. This value is read-only and for informational purposes only.
6. Set the configuration options for the product image, title, and description per your preference.
7. Click the Save button to save the new zone:

​

Edit an existing zone

1. Click Start Task.
2. Click the pencil icon to edit the page.
3. Click the wrench icon to edit the zone.
   To delete a zone, click the trash can icon.
4. Edit the zone as needed and click Save.

​

Set triggering options

​

Date range

1. In the Triggering section, click 0 Active.
   If there are active triggers, this button changes to reflect that number. For example, this button will read 3 Active when 3 triggers are active.
2. Click the date range selector and select a start and end date. For this example, choose a date range that includes today’s date.
3. Click the Save button to save your changes:

​

Search terms

1. In the Triggering section, click 0 Active.
2. Click the Trigger button:
3. In the Search Terms field, enter cyber monday.
4. Set the Match Mode field to phrase.
5. Click Add.
6. Repeat the process to add a second trigger with Search Terms set to sales event and Match Mode to phrase.
7. Click the Save button to save your changes:

​

Test the template

1. Access Predictive Merchandiser.
2. Enter one of the search terms you configured in set triggering options. This example used the search terms cyber monday and sales event.
   If today’s date does not fall within the template’s date range trigger, the template will not load.