How to create Item Filters
This document will show you how to create Item Filters. An item filter is a named list of items that other parts of Sail can use, such as discounts, Kitchen Video All Day Counts and Online Ordering hours.
To Navigate to Item Filters
- Backoffice --> POS --> Settings --> Item Filters --> Click New Item Filter

To create a new Item Filter
- Fill out the window. The numbers match the picture:

- Name (required): Name the filter so it's easy to find when you pick it on a discount or a Kitchen Video station
- Description: Add more details about what this filter is for
Item filters can be created in many different ways. In the Include Filters box, an item that matches any one of your choices is in the filter:
- Reporting Groups: Every item in the reporting groups you pick
- Tax Types: Every item with the tax types you pick
- Item Categories: Every item in the categories you pick
- Items: Single items you pick. You can also pick modifier items
- Available Online: Every item that is available online
- Variable Price: Every item that asks for its price when it's rung in, like Open Food and Open Liquor
- Refund Item: Every refund item
- Management Editable: Every item that has Allow Management To Edit turned on
- Exclude Filters: The same choices. An item that matches any of them is taken back out of the filter, even when it matches the Include Filters. The Exclude Filters are always checked after the Include Filters
- Click the Filtered Items Preview tab to check that everything you want is in the filter, and nothing you don't want is. It shows your changes even before you save (see the examples below)
- Click Save
Where Item Filters can be used
Once you've made an item filter, you can pick it in any of these places:
- Discounts: Under Item Discount, so an item discount only works on the items in the filter (POS --> Settings --> Discounts --> the discount, Details tab). See Example #1 below
- Discount requirements: On a discount's Requirements tab, so the order needs items from the filter before the discount can be used, instead of picking each item by hand (POS --> Settings --> Discounts --> the discount, Requirements tab)
- Kitchen Video All Day Counts: Counts every item in the filter on a Kitchen Video station (POS --> System Setup --> Kitchen Setup --> Kitchen Video --> the kitchen --> Stations tab --> the station, All Day Count Items tab). See Example #2 below
- Online Ordering hours: Picks which items can be ordered online during an hour rule (POS --> Online Ordering --> Site Configuration --> the site, Schedule tab --> Hours)
- Label Print Rules: Prints labels for every item in the filter, along with any items you pick on the rule (POS --> System Setup --> Kitchen Setup --> Label Print Rules)
- Shortcuts and terminal buttons: The Price Adjust Item, Add Modifier and Select Items actions can be limited to the items in the filter
- Ingage Rewards: Picks which items earn Rewards points at each location (POS --> System Setup --> Integrations --> Ingage Rewards)
- Reports: Reports that have an Item Filters choice can be narrowed to the items in the filters you pick
Item Filter Example #1 (Discounts)
- This Item Filter is going to be used to allow a discount on Liquor Items, but they do not want the discount to apply to their signature cocktails!
- I start with the Include section on the left:
- I use the Reporting Groups filter to pick just the Liquor reporting group, because I'd like this discount to include almost all of the liquor items.
- Then I use the Exclude section on the right:
- I use the Item Categories filter to exclude everything that is in the Signature Cocktails category
- I also want to make sure that it is not allowing the discount on the "Open Liquor" button or the "Refund Alcohol" button, so I exclude those as well with the Items filter.
- I start with the Include section on the left:


- Now that my filter is created I want to double check to make sure everything I want in it is there, and nothing I don't want in it is there.
- To do this, I click on the "Filtered Items Preview" tab at the top.

- To do this, I click on the "Filtered Items Preview" tab at the top.
- Last I am going to attach this item filter to my discount
- Navigate to the Discounts: POS --> Settings --> Discounts --> either click New Discount or click the name of an existing discount
- Item filters can only be applied to "Item discounts"
- They can NOT be applied to a check level discount
- Under Item Discount, once "Can apply to Items" is turned on you will get an Item Filter drop down to select the Item filter you created for this discount. Then click Save.
- Item filters can only be applied to "Item discounts"
- Now when you use this $1 Off discount on an item, it will only work on the Liquor items you put in this item filter!

Item Filter Example #2 (KVS ADC)
- This filter is going to be used for an All Day Count (ADC) on the Kitchen Video Screen (KVS).
- I would like an ADC on my expo screen to show how many salsas I need
- I start by using the Include section.
- Because there are not very many items that need a salsa, I'm just going to use the "Items" filter to find the 3 items that are served with a salsa. (Keep in mind that you can also select modifier items.)
- Because I only selected the 3 items I need, I don't need to use the Exclude section on the right.
- I start by using the Include section.

- Now that my filter is created I want to double check to make sure only the 3 items I selected are on the filter.

- Last, I need to go apply this filter to the Expo Screen
- To find this: POS --> System Setup --> Kitchen Setup --> Kitchen Video --> Click on the kitchen's name

- Click on the Stations Tab --> Click on the Expo Station

- Click on the All Day Count Items tab --> Click New All Day Count Item
- In the "Text" box, type what will show up on the KVS expo screen. So shorter words are better.
- Now use the "Item Filter" drop down to find the filter you created for this.
- Click Save. Now anytime one of those three items is rung in, the ADC will go up on the Expo Screen

To see what uses an Item Filter
- Open the item filter (click its name on the Item Filters screen) and click the Usage tab. It lists every discount, Kitchen Video All Day Count, Online Ordering hour, shortcut and anything else that uses this filter.
- An item filter that is being used can't be deleted. Take it off the things on the Usage tab first.

No Comments