Facets

In this article you will find:

Facets

Facets are used in the left-navigation to narrow down results within established fields based on the user's selections. Once the data is added to the field and the field has been configured in the workbench, you can set up the corresponding facet in this section of the workbench. 

Navigating to the Facet Administration Page

Open

1. To navigate to the Facet Administration Page, click on the "Workbench" tab in the top navigation.

2. Select "Data Configuration" from the left navigation

3. Choose "Facets" from the subcategories.  

Facet Administration Page

Open

The Facet Administration page allows you to control the functionality of the facets displayed within the left navigation of your search page. You can edit a facet using the green pencil button, or you can delete a facet using the red trash can icon. You can also change the sort order of your facets by simply clicking on the sorting button, then dragging and dropping the facet to the position you want it to appear in on your left navigation.

1. Facets marked in Yellow color are hierarchical facets with pre-defined parent value.

2. Enabling Facet automate ordering, switch the toggle to "on". This feature will automatically order the display of facets based on number of clicks.

3. The numbers in the red circle represent the order of popularity of the facets based on clicks. When Enable facet automate ordering is "on," this is the order that the facets will display.

4. To manually reorder the way facets will display, click on the double arrow icon and drag the facet to the desired position on the list. Note that you also have to ability to override facet display for a particular landing page under the Merchandising section in the Landing Pages sub-category.

5. If you would like to edit one of the facets, you can do so by clicking the pencil icon. To delete a Facet, click the trash can icon. To copy a Facet, click the paper icon. 

6. To add a new Field, click on the "Add Facet" link.
   
   

General Options

1. First, give your facet a name by typing it into the "Display Name" field.

2. Next, type in the name that you wish to display on the Facet Administration Page by typing it into the "List Name" field.

3. You will then need to select a Facet Field Type to represent the data from the drop down menu. There are three options that will alter the parameters you can customize on the rest of the page. (For example displays see Facet Type Examples)

STRING

1. Use the string facet for Alphanumeric values that you wish to display in a list.

2. Choose the previously established Field that should be associated with the Facet from the drop down menu.

3. Then, select the Facet Type from the drop down menu. (For example displays see Facet Type Examples)
   
   

   • Checkbox- Displays filters with a check box

   • Link List- Displays filters as a link

   • Rating- If you are using Hawksearch HTML to render, this will provide a "stars" rating format

   • Nested Checkbox- Used for facets with parent/child relationship, displays a checkbox

   • Nested Linklist- Used for facets with parent/child relationship, displays filter as a link

   • Swatch- displays images for colors/patterns, this requires coordination with the Hawksearch team.

   • Size

4. To establish a parent/child relationship for the facet, select the parent Facet from the drop down menu.

5. Tool tip is used to provide a hover tip for users in Facet that may not be self-explanatory. Ex. Unusual sizing.

6. When "Is Visible" is switched to "on" the facet has the capability to display in left navigation.

7. "Is Collapsible" gives you the option to display a "minus" and "plus" icon on the Facet that will collapse or expand the Filters when a user clicks.

8. When you turn "Is Collapsible" to "on" you will be given the option to choose whether you would like the Facets to display "Expanded" or "Collapsed" by default.

RANGE

1. This type of Facet Field displays data that represents a range of values. Ex. Price increments

2. Then, select the Facet Type from the drop down menu. (For example displays see Facet Type Examples)
   
   

   • Checkbox- Displays filters with a check box

   • Link List- Displays filters as a link

   • Slider- Displays values as a sliding spectrum

3. Choose the previously established Field that should be associated with the Facet. Note that in order for a field to be used as a facet, the field must be saved "as is." Refer to Fields for more information.

4. URL Parameter allows you to customize the segment that applies to the field.

5. When "Is Visible" is switched to "On" the facet has the capability to display in left navigation.

6. "Is Collapsible" gives you the option to display a "Minus" and "Plus" icon on the Facet that will collapse or expand the Filters when a user clicks.

7. When you turn "Is Collapsible" to "on" you will be given the option to choose whether you would like the Facets to display "Expanded" or "Collapsed" by default.

8. Tool tip is used to provide a hover tip for users in Facet that may not be self-explanatory. Ex. Unusual sizing

SEARCH

1. Select "Search" from the drop down menu. This is a widget that allows the user to search within the results. It can be placed anywhere along the left navigation.

2. Then, select the Facet Type from the drop down menu.
   
   

   • Search Within

   • Recent Searches

   • Related Searches

3. Tool tip is used to provide a hover tip for users in Facet that may not be self-explanatory. Ex. Unusual sizing

4. When "Is Visible" is switched to "on" the facet has the capability to display in left navigation.

Facet Type Examples

Checkbox & Link List Options

These options are only available for "String" or "Range" facet field types when the facet type has not been set to "slider".

The "Display Type" field dictates the way the list of facet values will be displayed. There are three different choices that will determine what fields you will need to define in order to configure the facet. (See Display Type Examples for sample images)

Default Display Type

1. The default display will list all options within a given facet. (See Display Type Examples for sample images)

2. If the facet is a "string" type, you will then need to choose a Sorting order from the drop down menu.
   
   

   • Alphabetical- Alphanumeric values will be sorted alphabetically. In cases where the number is the leading value, custom sort orders may need to be put into place.

   • Count- This displays the filters in the facets based on the number of items in each filter from most to fewest (in cases where counts are equal, facets will display in alpha order).

   • Custom-This requires additional information that is synced with the Hawksearch Tech Team.

3. If the facet type is not nested, you will need to determine the Max Number of Filters that will be displayed in a facet at any given time.

4. Determine the minimum count of filters the facet must possess in order to be displayed as an option. If you enter one, the filters will display when there is one value populating the face, even if clicking on them will return no additional items.

5. "Is Search Enabled" allows you to include a search field at the top of each facet that will search the filters within a given facet.

6. When Search is enabled, you must also specify a search threshold that defines the number of products a filter must contain to be included in the search. The "Search Threshold" field will appear once you  enable Search and click anywhere on the screen.

7. The "Expand Selection" option controls the way the facet is displayed after a selection within a facet has been made by a customer. When Expand Selection? is turned to "on" the filters within the selected filter will continue to display. When turned "off" the facet will truncate down to the one filter within the facet that has been selected.

8. If the Facet is a "nested" type, you will have the option to Preload Children. This will give you the option to expand the list of children on the page without having to reload after clicking.
   
   

Truncating Display Type

1. Truncating facets only display a specified number of options within a facet and give the customer the option to expand the list by clicking the "Show More" link. (See Display Type Examples for sample images)

2. If the facet is a "string" type, you will then need to choose a Sorting order from the drop down menu.
   
   

   • Alphabetical

   • Count Descending- This displays the filters in the facets based on the number of items in each filter from most to fewest (in cases where counts are equal, facets will display in alpha order).

   • Top Facets by Count & Alpha, then Alpha- Before expanding, the top number of filters based on count will display alphabetically. After expanding, the additional filters will display alphabetically.

   • Top Facets by Count & Alpha, then score- Before expanding, the top number of filters based on count will display alphabetically. After expanding, filters will display in count descending order.

   • Custom- This requires additional information that is synced with the Hawksearch Tech Team.

3. Determine the Max Number of Filters that will be displayed in a facet at any given time.

4. Determine the minimum number of filters that still contain items a facet must possess in order to be displayed as an option. If you enter one, the filters will display when there is one value populating the facet, even if clicking on them will return no additional items.

5. "Truncate Threshold" allows you to define how many values should be displayed in the truncated facet before providing the option to "Show More".

6. "Is Search Enabled" allows you to include a search field at the top of each facet that will search the filters within a given facet.

7. When "Search" is enabled, you must also specify a search threshold that defines the number of products a filter must contain to be included in the search.

8. The "Expand Selection?" option controls the way the facet is displayed after a selection within a facet has been made by a customer. When Expand Selection? is turned to "on" the filters within the selected will still display and allow the customer to make multiple selections within that facet. When turned "off" the facet will truncate down to the one filter within the facet that has been selected.

9. If the Facet is a "Nested" type, you will have the option to Preload Children. This will give you the option to click and expand the list of children in nested facets without having to reload the page.

Scrolling Display Type

1. Scrolling facets will display a limited number of options within a filter, similar to truncated facets, but allow the user to scroll though the available options. (See Display Type Examples for sample images)

2. If the facet field type is "string" you will then need to choose a Sorting order from the drop down menu.
   
   

   • Alphabetical

   • Count- This displays the filters in the facets based on the number of items in each filter from most to fewest (in cases where counts are equal, facets will display in alpha order).

3. Determine the "Max Number of Filters" that will be displayed in a facet at any given time.

4. Determine the minimum count of filters the facet must possess in order to be displayed as an option. If you enter one, the filters will display when there is one value populating the face, even if clicking on them will return no additional items. 

5. When selecting a scrolling filter, you will need to define the dimension of the "Scroll Height".

6. "Scroll Threshold" indicates the minimum item count a filter must have in order to be displayed.

7. "Is Search Enabled" allows you to include a search field at the top of each facet that will search the filters within a given facet.

8. When Search is enabled, you must also specify a search threshold that defines the number of products a filter must contain to be included in the search.

9. The "Expand Selection" option controls the way the facet is displayed after a selection within a facet has been made by a customer. When "Expand Selection" is turned to "on" the filters within the selected will still display and allow the customer to make multiple selections within that facet. When turned "off" the facet will truncate down to the one filter within the facet that has been selected.

Display Type Examples

Slider Options

These options are only available when Facet Field Type is "Range" and Facet Type is "Slider".

1. "Is Currency" indicates that the range is a monetary amount.

2. "Show inputs" displays fields on either side of the ranges that will allow a user to type in specific range values.

Ranges Options

These options are only available when the Facet Field Type is "Range" and the Facet Type is not "Slider".

1. "Ranges Contain Numeric Values" toggle determines whether the range you've selected contains numeric values. 

2. Range Display Type
   
   

   • Text

   • Image

   • Both (Image & Text)

3. When you select "Image" for the "Display Type" you will need to decide whether to show the item count by switching the toggle to "On" or "Off".

4. You can add as many ranges as you would like by clicking the "Add Range" button.

5. Enter the Label for the range in the first text box. This is what will display on the front end.

6. Determine the value for the Lower Bound and the Upper Bound of the range that will display.

7. To rearrange the order in which the Ranges will display, click the "double arrow" icon and drag the range to a new position in the list.

8. To delete a range, click the "Trash Can" icon.

Boost & Bury Options

These options are only available when the Facet Field Type is "string" and the Facet Type is either "Checkbox List" or "Link List".

1. Enter any filter values that you would like to boost or bury on the list of displayed filters by typing them into the text box and clicking the "Add" button.

2. To delete a filter from the boosted or buried values, click the "trashcan" icon.

3. To change the order in which the filters are boosted, click on the double arrow button and drag the filter to a new position on the list.

Swatch Data Options

These options are only available when the Facet Field Type is "String" and the Facet Type is "Swatch".

Adding a Swatch

You can add swatch data by either uploading an image or using a color picker to select the color.

1. To add swatch data click on the orange "Add" button. A pop up screen will appear.

2. Enter the value in the first field. Ex. Red

3. Is default should be applied to the swatch image you want to appear when no image has been specified.

4. To do a direct upload, choose the radio button for "Direct upload" next to "Image source." The option to select a file will appear and you can then choose that file from it's location (see above).
   
   To upload an image via URL, choose the radio button for "URL" next to "Image source". You will then be provided with a text box to enter your URL

To choose your swatch by color, select the radio button "Color picker" next to "Input type." You will then have the option to enter a hex code or select the color visually.

1. Click the orange "Add" button and then "close". You should see your new swatch appear in the Swatch Data field. 

Display Rule

When turned on, the facet will always display. To customize when the facets will display disable the Always Visible feature.

1. To disable the "Always Visible" feature, switch the toggle to "off". You will then be prompted to set up conditions as to when the facet will or will not appear.

2. Determine if you want "ALL" conditions to be met in order for the banner to display, or if it is enough that "ANY" one of the conditions be met. Select your choice from the drop-down. 

3. Click the "Add Condition" button.

4. Select the Field that will apply to the Display Rule from the drop down menu.

5. Select a corresponding operator from the drop down menu.

6. Enter the value that will satisfy the condition to display the facet.

7. To add a sub-condition click the ">" button next to the existing condition. Then click the "Add Condition" button that appears within the window.

8. To delete a condition or sub-condition, click the minus sign next to the condition you wish to delete.

9. To add an additional independent condition click the "Add Condition" button in the lower left hand corner.

Saving A Facet

1) Once you have made all of your changes, click the save button. You should see your new Facet displayed in the list on the Facet Administration Page.

2) To see when the facet was created and when it was last modified, hover over the "?" icon.

Adding a Facet from the Field Administration Page

When viewing the list of fields in the Data Configuration Section of the workbench, you can also easily create a facet from a field by using the "new facet" button. Clicking the button will take you into the screen for creating a new facet with the field preselected. Fields that are already used in a facet will have a new button that links to the edit screen for the facet.