TimeFrameFilter Command |
|
Use the TimeFrameFilter command in a Logic Template to filter out records that meet a specific criteria.
When dealing with large amounts of data it is often more efficient to use a timeline index to narrow the search. The TimeFrameFilter command can then be used to fine tune the result set.
The beginning and end points of the time frame are loaded into a single HTML variable by an HTML form or within the Logic Template. The HTML variable is passed to the command as an argument.
To execute a Time Frame Filter request, use the TimeFrameFilter command with two or three:
TimeFrameFilter( dtm, frm ); or TimeFrameFilter( dtm, frm, flag );
TimeFrameFilter Arguments
Argument |
Description |
dtm |
The name of the data field to be tested. |
frm |
The name of the HTML variable containing the time frame used for filtering. |
flag |
Indicate ( drop or keep ) special processing for records with a value of zero for dtm. |
Access the TimeFrameFilter Dialog Box by selecting Date-Time->Time-Frame menu item under the Filtering category of the Logic Template editor command menu.
Examples
Command |
Description |
TimeFrameFilter( EventDate, TimeFrame ); |
Pass records containing, in the field named "EventDate", a date and time value that occurs during the time frame identified by the HTML variable "TimeFrame". |
TimeFrameFilter( EventDate, TimeFrame, keep); |
Pass records containing, in the field named "EventDate", either nothing or a date and time value that occurs during the time frame identified by the HTML variable "TimeFrame". |