Define filter criteria for an Adhoc report - HxGN SDx - Update 64 - Administration & Configuration

Administration and Configuration of HxGN SDx

Language
English
Product
HxGN SDx
Search by Category
Administration & Configuration
SmartPlant Foundation / SDx Version
10

When creating or editing an Adhoc report, you can filter the results to only objects with property values that match defined criteria. You can specify criteria on any number of properties.

  1. In the Edit Report Definition dialog box, find a property for which you want to define the criteria to be used to filter the report results.

  2. In the Criteria column, select Click Me in the row that corresponds with the property to open the Criteria Definition dialog box.

  3. In the Criteria Definition dialog box, use the Operator and Value boxes to define the criteria that must be met by an object before it can be returned by the report.

    What are the operators I can use to define the criteria?

    The Operator option allows you to specify search operators to refine your search to a specific set of objects. There are two sets of operators you can use, equals and like, depending on the property type selected.

    If the property is a value in a list available by default or if you use the words Null or Blank as the value, only the equals operator is available. The operator automatically changes to equals when you type Null or Blank.

    You can use wildcards to define search criteria for a string property that matches one or more characters using the like or equals operator.

    The following table shows the operators for strings, doubles, integers, small integers, and select lists:

    Parameter

    Function

    equals

    Includes items where this property value matches what you typed in the VALUE box, including wildcards.

    not equal to

    Includes items where the value of this property does not match what you typed in the VALUE box.

    less than

    Includes items where this property value is less than what you typed in the VALUE box.

    greater than

    Includes items where this property value is greater than what you typed in the VALUE box.

    less than or equal to

    Includes items where this property value is equal to or less than what you typed in the VALUE box.

    greater than or equal to

    Includes items where this property value is equal to or greater than what you typed in the VALUE box.

    like

    Includes items where this property value matches what you typed in the VALUE box, including wildcards.

    SHARED Tip The behavior of the equals and like operators is identical. You can use either of these when you are defining the search criteria using wildcards.

    • An asterisk (*) matches zero or more characters in your search. For example, if you specify pa*, the software returns objects where that property value contains words that start with the characters pa, such as pan, park, part, and so on.

    • You can use an underscore (_) or a question mark (?) to match a single character. For example, if you specify pi_ or pi?, the software returns pid, pit, and pip, but not pipe.

    • To search for objects where the property value includes an underscore, question mark, or asterisk character, enclose them in square brackets. For example, use 100[*] to return 100*, but not 100abc.

    • You can search for objects with a property that contains a single character in a specific range of characters by enclosing them in square brackets. For example, using [a-f] returns only objects where this property's value includes a to f in a set of characters. So, if you specify pi[a-p], the software returns objects where the property value is pid and pip, but not pit, as 't' is outside the range.

    • You can use a caret (^) character to search for objects where a property value does not include a character in a range or set. For example, if you specify pi[^a-p], the software returns objects where the property value is pit, but not pid or pip, as 'd' and 'p' are in the range a-p.

  4. Click Add Criterion to list the criterion in the Currently defined criteria box.

  5. If necessary, click either And or Or, and define additional criteria that must be met.

    SHARED Tip You can remove or modify added criteria by selecting them in the Currently defined criteria window and clicking Update Criterion, Delete All Criterion, or Update Selected Criterion.

  6. Click OK to return to the Edit Report Definition dialog box where you can further configure the results of the report. The Criteria column displays the criteria you defined in the appropriate row.

    • You can define filter criteria for multiple properties on the same report.

    • You can define filter criteria for a property when defining the report, or you can use the Prompt option to allow the user to provide criteria when they run the report.