Templating API
Used for template operations.
Use this API for CRUD operations on templates and zones. This API also assists with retrieving and rendering templates for particular navigation states.
For more information, view the API specification.
To learn how to use templates in the UI, see Use Predictive Merchandiser templates.
Use Predictive Merchandiser templates
Use Predictive Merchandiser templates
This article teaches you how to use the Templates feature in Predictive Merchandiser, including how to:
- 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:
Create a new template
-
From the Templates screen, click the New Template button:
-
In the Template Name field, enter a unique name. In this example, the value
Cyber Mondayis assigned. -
Select a value in Template Type. This example uses the
landingtemplate type. This value is read-only and for informational purposes only. -
Click the Save button to save the new template:
Add a zone to a template
Zones enable Managed Fusion users to create rules designed for specific query profiles. Combined with templates, this allows a search application to display results from multiple query profiles in the same view.In this example, two new zones are created for the Cyber Monday template.-
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.
-
Create a new zone by clicking the New button:
- In the Display Name field, enter a unique name for the zone. For this example, the value is Promoted.
- 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.
- In the Zone Type field, select a value. This example uses main-results-list. This value is read-only and for informational purposes only.
- Set the configuration options for the product image, title, and description per your preference.
-
Click the Save button to save the new zone:
Edit an existing zone
To edit a zone that is already added to a template, complete the following:- Click Start Task.
- Click the pencil icon to edit the page.
-
Click the wrench icon to edit the zone.
To delete a zone, click the trash can icon.
- Edit the zone as needed and click Save.
Set triggering options
Triggers describe conditions that must be met for a template to display. Trigger options include a set date range and specific search terms.For more information, see Triggering configuration options.Date range
-
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. - Click the date range selector and select a start and end date. For this example, choose a date range that includes today’s date.
-
Click the Save button to save your changes:
Search terms
- In the Triggering section, click 0 Active.
- Click the Trigger button:
- In the Search Terms field, enter
cyber monday. - Set the Match Mode field to
phrase. - Click Add.
- Repeat the process to add a second trigger with Search Terms set to
sales eventand Match Mode tophrase. - Click the Save button to save your changes:
Test the template
- Access Predictive Merchandiser.
-
Enter one of the search terms you configured in set triggering options. This example used the search terms
cyber mondayandsales event.If today’s date does not fall within the template’s date range trigger, the template will not load.
ImportantUse
/api/ before the templating operation, particularly if you are using this API for load testing. For example, use /api/templating/render/APP_NAME instead of /templating/render/APP_NAME. This ensures the API call does not go through the Managed Fusion UI, which can slow down your response time.