Menu option filtering is an advanced feature that can be used to provide fine-grained control over which options are available for individual items on the Chewzie menu.
Selection of menu item options (specifically extras and composite options) is primarily controlled by defining option groups (Extra Groups and Composite Option Groups). Generally speaking, if a menu item requires a different set of options, a different option group is created.
Sometimes multiple menu items have largely the same set of options, but with specific limitation for some items, which can lead to excessive duplication of option groups. There are also common scenarios where certain extras should be made available for selection only if other extras are selected. Menu Option Filtering can assist in either of these scenarios.
What is Tag Filtering?
Menu Option Filtering is built around the concept of tag filtering. Tag filtering works by classifying items or options with a list of "filter tags" or keywords. These tags can have any meaning, but typically define a "class" or sub-group of items or options that share some sort of characteristic. For example, in a "Sauce" extra group, there might be certain sauces which are tagged as "Vegan", or "Spicy", (or both).
Items and options are considered "matched" if they share one or more filter tags. For example, if we had a "Vegan Burger" menu item, but we wanted to limit the sauce selection to only vegan sauces, we would also apply the "Vegan" filter tag to that item. Similarly, if we had a "Spicy Burger" menu item, it might be tagged as "Spicy" to limit its selection of sauces.
Configuring Option Filtering
Option filtering is configured on the Web Ordering Menu screen in Chewzie Back Office. Please note that these settings are part of the menu rather then tied to the products, extra groups, or composite option groups themselves. Open the menu (Web Ordering/Menus) and enable Advanced Settings in the bottom left of the page.
Tagging an Extra Option
Extra options may be tagged for filtering against menu items or composite options which include extra groups containing those options.
Expand Item Options below the Category panel, then select Extra Options.
Locate the extra item that you want to add filter tags to, and view its details by selecting the control to the left of the name (this will be either a radio button or an ellipsis icon (three dots)). The item details will be displayed either in the right-hand details panel (if a radio button is shown), or in a popup (if the ellipsis icon is shown). The same details are displayed either way.
Scroll down to Item Options. If you have enabled Advanced Settings (see above), the Option Filtering fields will be shown.
- Filter Tags
Enter your tag keywords into this field as shown. If no tags are entered, the extra option is available on all relevant menu items.
- Include on untagged items
This setting controls whether the extra option will appears on menu items that do not specify any tags.
When ticked (the default setting), it means that this option will be available on menu items which do not specify any filter tags. Such menu items effectively opt-out of tag filtering for this extra option.
When unticked, it means that this option will not be available for menu items without filter tags. In this case, we are requiring menu items to explicitly opt-in to showing this extra option. This is important for Setting up Conditional Extras.
- Apply filter tags to item when selected
This setting is used for Setting up Conditional Extras.
The use of filter tags for conditional extras is typically not required for common use cases. Conditional extras are typically handled by enabling nesting in the extra group definition.
Tagging a Menu Item
Menu items are tagged to filter the item options which are available.
Locate the menu item that you want to add filter tags to, and view its details by selecting the control to the left of the name (this will be either a radio button or an ellipsis icon (three dots)). The item details will be displayed either in the right-hand details panel (if a radio button is shown), or in a popup (if the ellipsis icon is shown). The same details are displayed either way.
Scroll down to Item Options. If you have enabled Advanced Settings (see above), the Option Filtering fields will be shown.
- Filter Extra Options
When unticked (the default setting), this product does not participate in the filtering of extra options. All extra options in it's specified extra groups will be shown, even if they are not included in the Extra Options of the menu.
When ticked, this means that extra options for this product are subject to filtering. As a base, only those extra options included in the Extra Options of the menu will be available, regardless of filter tags.
- Filter Tags
Enter your tag keywords into this field as shown.
If tags are entered, they are matched against included extra options to determine their availability for this menu item. NOTE: extra options without filter tags match everything - i.e. they opt-out of filtering.
If no tags are entered, all extra options included in the menu are available unless explicitly disabled for untagged menu items (See Tagging an Extra Option).
Tagging a Composite Option
Composite options may be tagged for filtering against menu items in much the same way as extra options (see Tagging an Extra Option). At the same time, composite options are themselves products which can in turn also specify their own extra groups. As such, composite options participate on both "sides" of tag filtering.
Expand Item Options below the Category panel, then select Composite Options.
Select the required option and scroll to Item Options, and observe the Option Filtering fields.
- Filter Extra Options
When unticked (the default setting), this product does not participate in the filtering of extra options. All extra options in it's specified extra groups will be shown, even if they are not included in the Extra Options of the menu.
When ticked, this means that extra options for this product are subject to filtering. As a base, only those extra options included in the Extra Options of the menu will be available, regardless of filter tags.
- Filter Tags
Enter your tag keywords into this field as shown.
If tags are entered, they are matched against menu items to determine if the composite option is available, and against included extra options to determine their availability for this composite option. NOTE: extra options without filter tags match everything - i.e. they opt-out of filtering.
If no tags are entered:
- The composite option is available on all relevant menu items; and
- All extra options included in the menu are available unless explicitly disabled for untagged menu items (See Tagging an Extra Option).
Tag Matching Examples
The following examples may help to gain an understanding of how tag matching is applied to extra options.
| Menu Item | Extra Option | Extra Option is Available? | ||
| Filter Extra Options | Filter Tags | Include on Untagged | Filter Tags | |
| N | n/a | (all for extra groups) | Y | |
| Y | none | Y | any or none | Y |
| Y | none | N | none | Y |
| Y | none | N | Tag1 Tag2 | N |
| Y | Tag3 | Y/N | Tag1 Tag2 | N |
| Y | Tag1 Tag3 | Y/N | Tag1 Tag2 | Y |
| Y | Tag1 | Y/N | none | Y |
Filter Tag Naming
- Use meaningful names for filter tags.
- Tag names shouls clearly identify a "class" or sub-group.
- Could be a class of options e.g. "Spicy Sauce", or a class of menu items e.g. "Mains".