Find Units using Query

From SysCAD Documentation
Jump to: navigation, search

Navigation: User Guide -> Edit Command Summary -> Find -> Find Units Using Query

This section shows the Find Commands in SysCAD 9.3.

Related Links:

Introduction

This feature allows user to search Any SysCAD variable using TagSelect with user defined criteria, and display the results on screen for analysis.

This feature can be accessed in a number of ways:

  1. Using Menu Command Edit - Find :
    • select predefined/User defined query from the list and press "Find"
    • The search results will be displayed in the Find Results List
    • Results displayed via this method will be filtered by the "criteria"
  2. From Access Window
    • Open the access window that contains the variable you are interested in
    • Right click on the variable to bring up the popup menu
    • Select "Open Find Results" or "F8".
    • The search results will be displayed in the Find Results List
    • Results displayed will be for the matching unit type only, with no other filtering. User can refine the search by modifying or adding search criteria.

Example use for this feature:

  • Search the project for all Inputs (Feeders and excluding any cross page connectors)
  • Search the project for all outputs (Sinks and excluding any cross page connectors)
FindInAndOut.png
User will be able to view the results on the screen, these results can also be copied onto the clipboard and pasted into other software for reporting. Please see Find Results List and Find Results Report Options for more information.
FindInAndOut1.png

Other example use of Find Query are:

How to Search the Project

This is best explain using a query example.

Example: Search Project for any models containing reactions

This example shows the search results for the Nickel Copper Demo Project using TWO methods:

Method 1: Using the Predefined Query from Find with Query

  • Menu command: Edit - Find : double click on the predefined "Reactions" search criteria
  • This find query will search the project for any unit models using the reaction block sub model
  • The results displayed in the picture below shows Six (6) unit models with the reaction sub model ON.
SearchResults1.png

Method 2:Using "Open Find Results" from Access Window

  • Right Click on a process unit to open the access window. (In this case, Tank)
  • Right Click on the SysCAD Tag and choose Open Find Results from the popup menu. (In this case, Tank Unit, RB Tab, Variable "On")
  • SysCAD will search all the current unit type (in this case Tank) and displays results for the selected variable on the screen, as shown below:
SearchResults2.png
  • The results displayed in the picture above shows Four (4) units with reaction sub model ON. This is different to the results we saw from the first method. The difference is due to the second method searched TANK unit type only, where as the first method searched all unit types, the extra two units with Reactions ON are of the TIE unit type.
  • We can refine or expand the search to cover all model types, to do so:
    1. Open up criteria editing pane by pressing the More button (bottom left corner)
    2. modify the criteria to expand the search to cover all model types (by removing the unit type filter) and only display results if the reaction sub model is on (adding the Reaction On criteria), as shown below:
SearchResults3.png

Find

Command Button FindButton2.png

Command Path: Edit - Find

Short Cut Key Ctrl+Shift+F

This command allows the user to find a list of unit operation / streams based on some criteria. The command has multiple dialog box / results boxes, these are:

  1. Find Query List
  2. Find Results List
  3. Query Editor / Viewer
  4. Find Results Report Options

Find Query List

When the Find command is activated, it will open the "Find" dialog box:

Find02.png
Button Small 1.png Use this list box to change the graphics filter option
  • All graphics
  • Active Graphics - All activate graphics pages, not including inactive graphics page.
  • Current Graphics - The current graphics page in view
  • User selected graphics page, can be multiple pages. Use the Filter Selection Dialog box to select the required graphics page.
Button Small 2.png Shows the result of the Find Query.
  • Use this filter option to select specific graphics page via the Filter Selection Dialog box.
Button Small 3.png Choose from a list of predefined queries to run the find query - the description of the query is listed on the bottom of the dialog.
  • In this example, the criteria of the query is to find all unit operation / streams that has the environment heat exchanger sub model switched on.
  • Please see Query Editor / Viewer
Button Small 4.png Pin the Find Query List - is not Pinned, the Find dialog will close when the Find button is pressed.
Button Small 5.png Press the Find button to run the selected query. This will open the Find Results List, please see the next heading.
Button Small 6.png Press the Close button to close the Find dialog box.

Find Results List

The Find Results Window can be opened via:

  1. Edit - Find : Results for the search
  2. Access Window Variable Right Click - Open Find Results : Listing all units containing the variable


Find03.png
Button Small 1.png Shows the result of the Find Query.
  • Single left click on an item in the Find Results List will show the unit on the graphics window;
  • Double clicking on the item will bring out the access window of the unit.
  • The find options can be changed via General Options Find Tab.
Button Small 2.png FindPrev.pngFind Prev and FindNext.png Find Next. Finds the previous or next unit from the list on the graphics page respectively.
Button Small 3.png RefreshFind.png Refresh - The values on the list is not updated while the project is solving, press this to update the values.
Button Small 4.png QueryFind.png Opens the Find Query List
Button Small 5.png ShortenFind.png Shorten the results list, allowing more room to view the units on the graphics window (useful when using Find Next and Find Prev).
Button Small 6.png Use the Tag filter option to narrow down the search.
Button Small 7.png More Button.png Show more - allows modifications to the query criteria. See right image and items 12 - 14.
Button Small 8.png FindReportOptions.png Opens the Report Options.
Button Small 9.png ApplyFilter.png Opens more filter options. User can select additional unit type filters. Pressing RemoveFilter.png removes the extra filter options.
Button Small 10.png SaveFindQuery.png Allows user to save and make modification to the current query. See Query Editor / Viewer
Button Small 11.png ExpandVertically.png Fits the Find results list to SysCAD application Window's vertical length.
Button Small 12.png Field: The find list will show one variable, user can change this field to suit the purpose of the search. For example, for the EHX search we have displayed the heat exchanged value. NOTE: The value of the variable will be displayed in the "Default Unit". To see the variable in another unit, please change the default using Conversions - Defaults and Displays...
Button Small 13.png criteria - one or more criteria can be entered here, normal SQL syntax are accepted, see Query Editor / Viewer for more information.
Button Small 14.png Graphics and Tag filters can be change here as well.
Button Small 15.png Less Button.png Show Less - The query criteria will be hidden to allow more room for the results section. See left image.

Query Editor / Viewer

Find04.png
Button Small 1.png The Query Name, the current record will be replaced when changes are saved.
Button Small 2.png The Description of the query
Button Small 3.png Clicking [ ] button will bring up the Group Filter Editor, to save the query as part of a group. To enable sorting by group, choose Show Query in Tree in Find General Options.
Button Small 4.png Search Field - This is the variable being displayed in the results list. NOTE, this is a display field, NOT the criteria variable
Button Small 5.png Criteria - User can add one or more criteria for the query. Normal SQL syntax applies here.
  • The SysCAD variable syntax are: [variable (conversions)],
  • Valid Operators are (, ), <, <=, ==, !=, <>, >=, >, AND, OR, NOT, LIKE
Button Small 6.png The sorting order options
Button Small 7.png The query Status - displays any syntax errors or test search status.
Button Small 8.png Test Search button - pressing this button will display the search result.
Button Small 9.png Use the Previous OR Next buttons to cycle through the Find Query List
Button Small 10.png Use the Save or Cancel buttons to Save or Cancel the changes respectively.

Find Results Report Options

CopyToClipboard.png

This dialog box allows the user to copy the Find Result List to the Clipboard, user can then paste the clipboard contents into MS Excel worksheets for reporting. The behaviour of this is similar to QuickView Reports.

Each of the following report options are available in Vertical (Primary Tag as Row Headings) or Horizontal (Primary Tag as Column Headings) format:

Tag List Only This will copy the tag names only as a list.
Full Table This will copy the contents of the Find List as a Table.
Excel Report (All Tags) Ordered by Graphic, Tag This will copy the contents of the Find List as a TagSelectReport, ignoring any UnitType or Tag filters, Ordered by graphics and Tag (these will be added to the report even if they are not displayed in the Find Results List).
Ordered as Seen This will copy the contents of the Find List as a TagSelectReport, ignoring any UnitType or Tag filters, Tag Order will be as per Find Results List.
Excel TagList Report (EHX.HeatFlow) This will copy the results as a TagList Report.
Excel Report (Filtered) Ordered by Graphic, Tag This will copy the contents of the Find List as a TagSelectReport, any UnitType or Tag filters will be built into the TagSelect statement, Ordered by graphics and Tag (these will be added to the report even if they are not displayed in the Find Results List).
Ordered as Seen This will copy the contents of the Find List as a TagSelectReport, any UnitType or Tag filters will be built into the TagSelect statement, Tag Order will be as per Find Results List.
OptinsButton.png This opens the Find Options Dialog box.

Manage Find Query List

Command Path: Edit - Manage Find Query List

Short Cut Key Ctrl+Shift+Q

This command allows the user to manage the find query list, this includes adding new queries and deleting user defined queries that are no longer required.

When the Find command is activated, it will open the "Query Management" dialog box:

QueryManagement.png
Button Small 1.png This section shows a list of existing queries in SysCAD. User can see the details of the selected query in the viewing section Button Small 2.png
Button Small 2.png Shows the details of the currently selected Find Query.
Button Small 3.png Use these buttons to Add or modify queries. The Query Editor / Viewer will be opened.
Button Small 4.png Use this button to delete any unwanted user specified queries.
Button Small 5.png This opens the Find Options Dialog box.
Button Small 6.png Press the Close button to close the Query Management dialog box.

Please note the Report Extension section is yet to be implemented.