Navigation

 ·   Wiki Home
 ·   Wiki Help
 ·   Categories
 ·   Title List
 ·   Uncategorized Pages
 ·   Random Page
 ·   Recent Changes
 ·   RSS
 ·   Atom
 ·   What Links Here

Active Members:

Search:

 

Create or Find Page:

 

View Quick Filters Cell Filters and User Filters

Category:HWeb Dispatcher

Quick Filters

*****This Article being edited / revised January 2012…. check back for updates*******

Quick Filtering is a technology that can be used to apply filters “on-the-fly” to any default or custom grid in HWeb Dispatcher by using an easy to see pull down menu. To download a sample grid that may be used while viewing the remainder of this article, and which has examples of various types of quick filters see the link immediately below.  Save this gdf file to your standard network Hudson Templates folder.  Once saved, you can launch your HWeb Dispatcher application, select File—> Open—> and then browse to and select the sample.gdf file.

 

Click this link to download the sample grid:File:QuickFiltersSample.gdf  If this link does not work for you, select the link below and follow some additional steps.
Click this link to view the sample grid:QuickFiltersSample

If you have had to use this second link, your browser should have displayed a page that shows a large amount of text.  This is the “essence” of content of a Grid Definition File (gdf).  Here is how you can create your own local gdf file, manually:

     
  1. Highlight the entire page ( CTRL + A keys )
  2.  
  3. Copy the highlighted content (  CTRL + C keys )
  4.  
  5. Using Notepad or similar application on your computer, create a new blank document on your computer named QuickFilterSample.txt
  6.  
  7. Open this new black text document and then paste the content from the web page displayed above (  CTRL + V keys)
  8.  
  9. Click File—> Save
  10.  
  11. Move the QuickFiltersSample.txt document and place in your Hudson \  HWeb \ Templates directory
  12.  
  13. Right click on the file and select—> Rename
  14.  
  15. Change the name to QuickFiltersSample.gdf

 

*************************************

These are the current Quick Filters to be explained:

  • Cell Filter
  • Quick Filter
  • User Filter

Cell Fliter

A cell filter allows a user to click any single cell in a displayed grid, select the Cell Filter command, and the rest of the grid will refresh, showing ONLY those records where the data in that same column will match the selected cell. 
Examples:

  • Applying a Cell Filter to a Flight Number field will force the grid to only display other reservations with that same Flight Number
  • Applying a Cell Filter to a Pickup Date will force the grid to then only display other reservations with the same Pickup Date

After the information has been reviewed, you may simply “clear” the Cell Filter, and the grid reverts to its original or default condition.  To enable and configure Cell Filter:

  1. Open your grid
  2. Right click on any one of the column headers and select Grid Properties
  3. Select the tab labeled “Quick Filters”
  4. In the Filter column enter the uppercase word (with per cent symbols immediately before and after the word CELLFILTER): CELLFILTER
  5. In the Caption column type the name that will appear in your quick filter pull-down menu: “Filter on Cell: CELLFILTERTITLE” or something similar. NOTE: You must put a percent symbol immediately before and after the word CELLFILTERTITLE
  6. The next column Default? will automatically be checked, which indicates that the default grid title column color will be used. If you want to apply a different color when the quick filter is in use (strongly suggested), uncheck Default? and select a color in the Title color column
  7. The final column is Description and is not a required field. It may be used as a way of noting what the entered filter is designed to do.

Save the changes to your grid before proceeding.
Close and reopen the grid.
Click on any cell in your grid - the one that you want to use as your filter (ex: Airline, Flight Number, etc.).
If you now look at the grid, you will see a small, downward facing arrow in the top right corner of the grid, adjacent to the “X” and Pushpin icons.
If you use your mouse to click this down arrow, you should see:

  • Clear current selection
  • Filter on Cell

Select the Filter on Cell option.  After clicking, your grid should refresh and display only records that match the originally selected value. Note that there is a colored border around your grid indicating that this is a “filtered” grid and that the Caption at the top of the Grid has been modified as well and reads Filter on Cell: Airline United Airlines (or similar).
To remove the Filter, click the down facing arrow again and user your mouse to select “Clear current selection.”

Quick Filter

Similar to a Cell Filter above, a Quick Filter allows you to pre-determine the cells you might want to be able to filter on and then present them to users as a menu of preconfigured filtering options to select from. Currently 10 distinct Quick Filters can be applied to any single grid definition file. To apply a quick filter:

  1. Open your grid
  2. Right click on any one of the column headers and select Grid Properties
  3. Select the tab labeled “Quick Filters”
  4. In the Filter column enter your desired custom filter string (e.g. Direction=’A’, will show arrivals only)
  5. In the Caption column type the name that will appear in both your quick filter pull-down menu and in the caption of the grid when the filter is applied (e.g. Arrivals Only)
  6. The next column Default? will automatically be checked, which indicates that the default grid title column color will be used. If you want to apply a different color when the quick filter is in use (strongly suggested), uncheck Default? and select a color in the Title color column
  7. The Text column Override is used if you want to override an existing filter. For example if the quick filter Direction=’A’ is used and your grid already had a primary filter of Direction=’D’ the result would be the display of BOTH arrivals and departures. Unless the Override column contained the column direction which would indicate that the grid show ONLY show arrivals.
  8. The final column is Description and is not a required field. It may be used as a way of noting what the entered filter is designed to do.

Save the changes to your grid before proceeding.
If you now look at the grid, you will see a small, downward facing arrow in the top right corner of the grid, adjacent to the “X” and Pushpin icons.
If you use your mouse to click this down arrow, you should see:

  • Clear current selection
  • Arrivals Only

Select the Arrivals Only option.  After clicking, your grid should refresh and display only records that match the selected menu value (Arrival Reservations).
To remove the Filter, click the down facing arrow again and user your mouse to select “Clear current selection.”
Quick filters are a great addition to both default and customized grids; they save you time from creating multiple grids to display the same columns with different filters applied. The filter syntax in Quick Filters can be complex, so if you wish to utilize a complex Quick filter, simply email support@hudsonltd.com with your desired end result and someone from Tech support will format the filter and email back to you. For example, if you were to build a primary grid that is filtered on TODAY, but you want to see tomorrow’s records, you would type (int(PickupTOD)=#%TOMORROW%#) into your filter column of quick filter, and type PickupTOD into your Override column.

User Filter

Ver 1.93 Build 4893
The more robust User Filter, allows you to build more complex and robust grid filtering on-the-fly. NOTE: User Filters are not saved.  You use this functionality on a grid to obtain the desired results, but do not save the filtering criteria for later use!  If you want to be able to save the filter for others to see and use, you should consider the Quick Filter option, outlined above.

The first step is to define which Items or Fields in your Grid you want to be able to dynamically filter on. For our example we will say that we want to include:

     
  • PickupTOD
  •  
  • ProfileIDParent
  •  
  • ServiceType
  •  
  • Name

Right click on any one of the grid column headings and select “Grid Layout”
Locate the first field to be included in the filter (e.g.  PickupTOD)
Scroll across the layout options and make the following settings:

     
  1. Quick View Filter Show? = checked
  2.  
  3. Quick View Filter priority = 0 (will be displayed first / at top of window)
  4.  
  5. Quick View Filter Prompt ovr (override) = From,To (or Start Date,End Date; Begin,End or whatever you want your date range labels to be)
  6.  
  7. Quick View Filter suppress NL (New Line)? = leave unchecked and the next filter option will be displayed beneath this one. Check this box and the next filter option will be displayed next to (the right of) this one. For this example, leave unchecked.
  8.  
  9. Quick View Filter width ovr (override) = leave blank to accept default field width values**. Change to a new or different value if you want the field width to be less than or greater than default field width values**.
  10.  
  11. Repeat these same column settings for the other fields to be included in the list, but change the Priority for each (1, 2, 3, etc. to adjust its position relative to the other filters), Change the Filter Prompt ovr to change the name of the column label (ex: Group Profile (instead of ProfileParentID), Vehicle (instead of ServiceType), etc.

Now that the fields have been selected and defined above, to enable the User Filter(s):

     
  1. Open your grid
  2.  
  3. Right click on any one of the column headers and select Grid Properties
  4.  
  5. Select the tab labeled “Quick Filters”
  6.  
  7. In the Filter column enter the uppercase word (with per cent symbols immediately before and after the word USERFILTER/li>  
  8. In the Menu column type the name that will appear in your quick filter pull-down menu: Filter Range,  USERFILTERTITLE or something similar. NOTE: You must put a percent symbol immediately before and after the word USERFILTERTITLE
  9.  
  10. The next column Default? will automatically be checked, which indicates that the default grid title column color will be used. If you want to apply a different color when the quick filter is in use (strongly suggested), uncheck Default? and select a color in the Title color column
  11.  
  12. The final column is Description and is not a required field. It may be used as a way of noting what the entered filter is designed to do.

Save the changes to your grid before proceeding.
Close and reopen the grid.
If you now look at the grid, you will see a small, downward facing arrow in the top right corner of the grid, adjacent to the “X” and Pushpin icons.
If you use your mouse to click this down arrow, you should see:

     
  • Clear current selection
  •  
  • Filter on Cell
  •  
  • Filter Range

Select the Filter Range option.  A Quick View dialog box will now open, and will display the fields that may be included in your filter: Start Date, End Date, Group Profile, Vehicle, etc., allowing you to set one or more filtering criteria. You will note in this example you have applied a very quick and easy Pickup Date.  Click “OK” when the filtering criteria are set and your grid will redraw and display the desired informatio
n.
To remove the Filter, click the down facing arrow again and user your mouse to select “Clear current selection.”

KnowledgeBase Tip - Discovering Filter Strings!

As mentioned several places above, you need to enter a Filter String when creating a Quick Filter. In the example above, we used ‘Direction=‘A’  when building a Quick Filter. Well what should you do if you don’t happen to know that this was the string of text that you needed to use?  There is a solution that may help you.  Try this example…

     
  1. In HWeb Dispatcher, click File—> New—> Reservations View
  2.  
  3. Locate and right click on the column heading Operation
  4.  
  5. Select “Filter Column”
  6.  
  7. Set 1st drop list = EQUAL,  2nd drop list = Cancelled
  8.  
  9. with the grid now refreshed and filtered on cancelled reservations, right click again on any of the column headings and select “Grid Layout”
  10.  
  11. Select “View Filters”
  12.  
  13. Note the syntax and format of the string displayed: Operation=‘C’
  14.  
  15. Write down or copy this displayed string. This is how the Filter will be entered in the Quick Filter instructions noted above.

Repeating for other column headings you wish to create filters for will allow the system to generate and display for you the proper filter command or syntax. After a little practice, you will become familiar with the most common filtering strings. If you are having trouble coming up with the desired filter string / syntax, send Hudson Tech Support an email and we would be pleased to assist.

 

Categories: