10. Custom Reports Training Guide - Version 2 Home | Best Practices | Appendix | Full Training Guide    
image.gif
10.7 Appendix
ON THIS PAGE
Appendix A: Run-time Parameters
Appendix B: Regular Expressions
Appendix A: Run-time Parameters
Parameters are criteria used to extract records from the database. The parameter could be a project, a date, a lot, or even a street name. You define the parameters when you create the report template; the parameters defined depend on the data field.

The parameters often selected are:
Selection Meaning
Run-time parameter You want to enter the criterion when you run the report template.

For example, if you have defined project as the run-time parameter, you may enter a specific project or choose Ignore This Parameter for all projects when you run the report template.

In most reports, the run-time parameter is the date of the report so that you can output a current report.
Not a parameter You don't want this data field to restrict the records in your report output.


The other parameters you can select are:
Usually found in data fields with dates
Before or After
Enter the before or after date in the "From Date" box. This date limits the records that will show up in the report.
Between
Enter the two dates in the "From Date" and "To Date" boxes given. These two dates determine which records will show up in the report.
On a particular date
Select Between and enter the same date in the "From Date" and "To Date" fields.


Note: If you want a report that always shows the current data, you probably should define date as a runtime parameter so the date gets entered each time the report template is run.
Usually found in data fields with numbers or amounts (e.g. number of days or invoice value)
Select Not a parameter if you do not want to restrict the data on a given field.
Greater Than, Less Than, etc.
Enter the number or amount to determine which records will show up in the report.

For example, if you want to see records with warranty amount exceeding $100.00, select Greater Than and enter 100 in the input field.
Between
Enter the two numbers or amounts in the boxes given, for example, warranty deficiency between 10 and 20 days old or invoice amount between $100.00 and $200.00. These two values determine which records will show up in the report.

Note: If you want to print a report that satisfies some number or amount to be determined when running the report template, define the data field as a run-time parameter.
Found in textual or alphanumeric data fields such as project, lot number, street name or deficiency description
In Selected List
Enter a single value, for example, a division (AT) or a project (EM16).

You can also enter a list of values, for example, a list of divisions (AT, DL, OR) a list of projects (EM14, EM15, PB12). Commas must separate the members in the list.
Equal To
Enter one criterion, for example, a project ID, a lot number or a name. Records that match exactly the criterion will show up in the report.
Not Equal To
Enter one and all records except the records that match this criterion will show up.

The following parameters are suitable for statements or description.
Contain
Enter a word. The program will search for this word in the text and print only records that have this word.

For example, if you are searching for deficiency description that contains the word "mold", select Contain and enter "mold" in the box given.
Not Contain
Enter a word. The report will not show records that have this word in the description.
For more sophisticated form of searching textual fields, see Regular Expression/Not Regular Expression in Appendix B.


Appendix B: Regular Expressions
A regular expression is a string of characters. In the simplest form, it's a word or a phrase.

For example, you want to find lots with either "leak" or "mold" in their deficiency description. So, you select Regular Expression and enter "leak|mold". The program searches for either "leak" or "mold" in the description and returns only those lots.

Below are examples of some common search strings. For more information and examples, visit Wikipedia - The Free Encyclopedia.

.

Search for any single character.

Example
To search for "cat" or "hat", enter ".at". The program searches for any 3-letter words ending with "at".

[]

Search for a single character that is contained within the brackets.

Example
To search for "Smith" or "Smyth", enter "sm[iy]th". The program will search for "Smith" or "Smyth".

If you enter "sm[a-z]th", the program searched for "Smith", "Smyth", "Smoth", "Smath", etc.

*

Example
To search for "screen door off track" or "screen door track broken", pick the two key words "screen" and "track", and enter "screen.*track".
Updated January 27, 2009