Visual Editor
When you sign in to Lucidworks Platform, select the workspace, click Commerce Studio, and select the ecommerce configuration instance to manage. The Visual Editor screen is the default display. For example:
Build Visual Editor components
Build the components of Visual Editor in the following order:
-
Create a page that reflects your website’s search experience.
-
Create rules for the selected page.
-
Add query rewrite functions such as synonyms and misspelling corrections.
Visual Editor features
The Visual Editor lets you perform the following features:
-
Select the page format for the configuration you want to view and test.
-
Use the search section to enter information to search, link to edit the page, test and preview results before you publish to your production site, publish the configuration to production, and view factors that impact result ranking.
-
View and manage your rules and the corresponding results in the actions, search results, changes, and published rules sections.
Search
The Search section of the Visual Editor screen lets you:
-
Enter text and search your site based on the rules and query rewrite configuration.
-
Click
Edit page to modify the page configuration.
-
Click Preview Live to test various terms and phrases for the rules and query rewrite configuration so you can refine the results returned before you publish the campaign for your customers.
-
Click Publish to activate the campaign on your production customer site.
-
Click Ranking Factors to view criteria such as sorting, relevance, and query processing that impact the results.
Actions
The Actions section of the Visual Editor screen lets you set actions for rules.
You can only apply one action per rule.
Commerce Studio alerts you if you create multiple rules with conflicting actions. For example, a conflict occurs if you create rules that boost, block, and bury the same item. |
Type | Description |
---|---|
Add Banner |
Returns an image outside of the search results that can be displayed in the frontend. |
Block Items |
Blocks the associated values from appearing in the search results. |
Boost Attributes |
Boosts products with specific attributes in a search. Boosts can be one of the following:
|
Boost Items |
Boosts products with a large multiplicative boost so the products appear at the top of the results. Larger boosts can override this action. |
Bury Items |
Buries products with the selected values. This action minimizes certain products without blocking them. |
Rerank Items in Group |
Changes the ranking of a group of items. You can boost, pin, bury, or block an entire group of items instead of reranking items individually. |
Filter Items |
Applies filter queries ( |
Set JSON Blob |
Returns a JSON blob to your frontend when a condition is met. The JSON blob displays outside of the search results. |
Pin Items |
Puts a product in a specified order within the search results. You also have the option to use Query Elevation Component. |
Redirect |
Displays a message that the frontend can use to redirect a user to a specific URL. You can use this action to send users to dedicated landing pages or campaigns. If you have queries that return zero results, you may opt to create a dedicated page to redirect those queries. |
Set Response Value |
Sends an arbitrary value to the frontend or pipeline to trigger another action. This action can be combined with other actions within the same rule. For example, an ecommerce website may use the response value action to display an advertisement. |
Set Facets |
Customizes the facets (categories of groups) returned in the query response. For example, if your site sells clothing, you may set a number of facets as different colors (black, blue, red, yellow, and so on) so the customer can select a specific color for items they want to view. |
Set Params |
Sets a parameter name and value to a search query. For example, the sort order for the results, or a filter that affects results. |
Query Elevation Component (QEC) applies the rule action to the top results regardless of the product’s (document’s) score.
Enabling QEC does not boost the document’s score. QEC only supports elevation through the id field.
Your Solr cluster must be configured to enable QEC. Contact your Lucidworks representative for more information.
|
Search Results
The Search Results section of the Visual Editor screen displays information about individual items and lets you perform the following actions.
Add or edit facets
Use the Facets button to add, modify, or delete facets for the search. The calculated Facets display with the results.
View and modify item
An example of an individual item result is:
-
Item rank. The number of the rank displays, as well as an indicator if the rule that returned that item is unpublished. The example is ranked #1 and the rule that returned it is published. If the rule is unpublished, the text "Unpublished" displays next to the ranking number.
-
Add. Click Add and then boost, pin, bury, block, enter a number of rank, rerank the item in the group, or delete that item. You can also hold the pointer over the item, then click the Drag icon and drag the item to reorder its rank.
-
Metrics. Metrics display if Inline analytics are configured for the card.
-
Add Rule. Select the checkbox in one or more items to enable the + Add Rule option to boost, bury, and block the selected items. For more information, see Create a rule in Visual Editor.
Results List
The Results List section lets you change the item card display and apply tags.
Change Item Card Display
To view the settings or change what displays on each result item card, click Results List and select Change Item Card Display.
On the Item Card Settings screen, the format of the card displays based on the configuration. If you change the fields or metrics values, the format displays the changes.
Fields
The fields defined in the example include the product image and name.
To add a new field such as price
, click Add Field and then enter information in the:
-
Field Name. The name of the field, such as
price_s
. -
Field Style. The style of the field, such as price. The options are
price
to display money amounts,url
to display the URL where the item is located, orgeneric
to display text. -
Field Display Name. The title of the field on the card. For example, the Field Display Name for the
product_title_s
field isProduct Name
. If you add theprice_s
field, the Field Display Name can be any text such asPrice
.
In the default image field, you can select the Show Variants checkbox to enter an alternative to the specified field. If the checkbox is selected, you can enter an alternate product image or color as the variant.
-
Example 1:
-
Variant Field Name. The dataset field name for the product image. For example,
image_s
. -
Variant Field Type. For a product image, the value is image.
-
Variant SKU ID. The unique identifier for the product. The product image is associated with this ID. For example, the SKU varies based on long-sleeved T-shirt versus a short-sleeved T-shirt.
-
-
Example 2:
-
Variant Field Name. The dataset field name for the color of product. For example,
color_s
. -
Variant Field Type. For product color, the value is color.
-
Variant SKU ID. The unique identifier for the product based on color. For example, the SKU varies if the T-shirt is red as opposed to blue.
-
Inline Analytics
In Commerce Studio, metrics from Analytics Studio can be displayed directly on product cards. This integration enables you to make data-driven decisions when curating your search results.
For instance, RPV (revenue per visitor) can highlight products generating significant revenue but lacking sufficient visibility in search results. Such insights help identify opportunities to boost underperforming high-profit items, ensuring they are prioritized appropriately to maximize revenue potential.
To view key metrics captured by Analytics Studio for each item returned in the results, complete the following fields:
-
Click Inline Analytics to display the metrics on each item card. If this is not selected, metrics do not display on the items.
-
Select a value in the Metrics Duration field. For example,
Last 30 Days
. This determines the amount of time calculated in the metrics. The duration displays on the item above the corresponding metrics. -
In the Document ID Field, enter the field to be used as the document ID when retrieving metrics from the Signals Store. The default is
id
. -
In the Add Up to 3 Metrics field, you can select any or all of the following metrics to display for the item (and the amount of time selected in the Metrics Duration field):
-
ATC. Add to cart is also referred to as cart add rate. The cart add rate measures the percentage of clicks that result in an item being added to the shopping cart. This metric highlights the effectiveness of product pages and user readiness to purchase.
-
Purchases. Displays the number of purchases related to this item.
-
Revenue. Displays the revenue related to this item.
-
RPV. Revenue per visit displays the average revenue received per visit for the item for the time period specified in the Metrics Duration field. This metric allows users to assess the effectiveness of driving revenue through individual customer visits, aiding in optimizing user engagement and marketing efforts.
-
CVR. Conversion rate is also referred to as search conversion rate. The search conversion rate measures the percentage of searches that result in a completed purchase. This metric represents the final step in the user journey from query to conversion, offering a clear indicator of overall search effectiveness and customer satisfaction. For example, a conversion rate of 5% means that 5 out of every 100 searches lead to a purchase.
For more information, see Analytics Studio and Commerce Studio and Metrics.
-
Apply tags
To apply rules by tag to this section, click Results List and select Apply Tags. On the Apply Tags screen, tags entered on rules created in Ranking Rules display. You can select the tags you want to apply to the section and click Apply.
Changes
This section displays the latest rule changes that affected the results displayed in the Visual Editor. The Condition
, Action
, Precedence
, Target
and Last edited on
fields display for each rule change.
You can click the pencil icon to edit the rule using the Rule Wizard, or click the trash can to delete that rule.
For more information about rules, see Ranking Rules.
Published Rules
This section displays the published rules for the results in Visual Editor.
Select the checkbox of one or more rules and the number of published rules displays above the items. Click Published Rules and the rules associated with the selected items display. The Condition
, Action
, Precedence
, Target
and Last edited on
fields display for each rule.
The actions you can perform include:
-
Unpublish the rule. Select the checkbox for the rule and click the down arrow to unpublish the rule.
-
Delete the rule. Select the checkbox of one or more rules and click the trash can to delete those rules. You can also select the checkbox for an individual rule, then hold the pointer over the rule, and click the trash can for that individual rule to delete it.
-
Edit the rule. Hold the pointer over an individual rule and click the pencil icon to edit the rule using the Rule Wizard.
For more information about rules, see Ranking Rules.