Run a report with a prompt (Query) - HxGN SDx - Update 64 - Help

HxGN SDx Help

Language
English
Product
HxGN SDx
Search by Category
Help
SmartPlant Foundation / SDx Version
10

You can provide search criteria for a few reports before they run, which allows you to view different data in a report without creating multiple reports. For more information about defining a report that uses criteria to filter the results of a report, see Define filter criteria for an Adhoc report and Define criteria and prompts.

Reports are made available in the Web Client by an administrator, who relates relevant reports to the appropriate feature sets. For more information, see Expose Adhoc reports in the Web Client and Expose summary reports in Web Client feature sets.

  • Criteria - It allows you to add filter criteria to a report. A report administrator can only add it during the report configuration process and modify it later when required.

  • Prompt - It allows you to add run-time filter criteria to the report output using properties. To use this functionality, a report administrator must enable the Prompt option in the report property column.

  1. Provide criteria by entering the appropriate parameters and values in the Operator and Value boxes to return a targeted set of data in the result.

  • Click to add a row to provide multiple criteria for a property.

  • Select AND or OR when you want to provide multiple criteria for a property in a report.

  • You can run a report without providing any input, if you do not want to filter the result.

    What are the operators I can use to modify the query?

    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 the 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.

  1. Click RUN REPORT to run the report.

For example, you can filter the report result by entering parameters for the following properties, as shown in the image below: