This tool is located on the RIMS section of the Reports tab.
Function
The RIMS Advanced Query interface () provides a set of tools to create user defined queries.
Layout
The interface mirrors the Advanced Reports interface in layout. There are two main sections in this interface: Query Builder and Report Columns.
Query Builder
The Query Builder section is used to specify a combination of available data elements for creating a custom query. Before using the Query Builder table, the user can enter a name for the query in the "Report Title" textbox and choose DEL, RIMS, or USR in the "Category" picklist.
Query Builder Columns
A selection in the Category picklist will narrow the Information Type column options in the table. This important column, and the others stored in the Query Builder, are described below.
Column | Used To... |
Add/Remove | Add additional criteria to the query (+) or remove criteria from a query (X). |
Join | Group or create conditional queries using "AND/OR" options; used in conjunction with the parentheses controls. |
Parentheses () | Group or create conditional queries; used in conjunction with the join control. |
Information Type | Select the Information Type refined by a selection in the Category picklist. |
Item | Select an Item refined by the Information Type selection. |
Logical | Provide query operators (equals, exists, etc.). |
Value | Select valid values for the data column or type in where set values do not exist. |
Include Additional Items
If the user wishes to include certain attributes that are typically excluded from search results, they can utilize the "Include Additional Items" link below the Query Builder table. The user can select the desired attribute checkboxes and clarify these selections using the available radio buttons. Then, they can click the "Save" button to confirm their selections and include those attributes in the report. Alternatively, the user can click the "Clear Selections" button to discard their choices. The image below shows the "Include Additional Items" pop-up.
Run Report
Once the table fields and "Include Additional Items" are satisfactorily filled, the user can click the "Run Report" button to view the query data in an Excel or HTML file. If over a thousand rows will result from the current query, an HTML file cannot be created, but the user will still have the option to generate an Excel file for the data. For these larger queries, a pop-up will appear on the user's screen before the report is generated. This pop-up will tell the user how many query rows exist and allow the user to specify certain content qualifiers for the Excel file. There are three checkboxes on this pop-up: Include Length Columns, Format for mapping in ITMS, and Include Code Names. After selecting the desired checkboxes, the user can click the "Export" button to generate an Excel file.
Controls
There are two additional controls on the Query Builder section of the RIMS Advanced Query interface:
Control | Used To... |
Reset Criteria Button | Clear the current selections and revert the interface to its initial display. |
SQL Syntax Button | Open a pop-up showing the SQL Syntax (standard language for actions related to data in databases) for the current selections. |
Report Columns
The Report Columns section is primarily used to select the columns to include in the report. Often, columns are automatically implemented as selections are made in the Query Builder. However, the user can change these selections by using the Available Columns table, Output Controls, and Selected Columns table.
Add, Remove, and Remove All Columns
To add columns to the report, the user can follow these steps:
- Use the plus signs in the Available Columns table to locate the desired column types.
- Click one or more column types. A column type row will appear yellow when it is selected.
- Click the "Add >" button located between the two tables.
- View the new report columns in the Selected Columns table.
To remove columns individually from the report, the user can follow these steps:
- Locate the column type that you wish to remove in the Selected Columns table.
- Click one or more column types. A column type row will appear yellow when it is selected.
- Click the "< Remove" button located between the two tables.
- View that the Selected Columns table no longer contains these column types. All removed column types will be stored in the Available Columns table and can be added to the report again if desired.
To remove all columns from the report, the user can follow these steps:
- Click the "<< Remove All" button located between the two tables.
- View the blank Selected Columns table. All removed column types will be stored in the Available Columns table and can be added to the report again if desired. The user must add at least one column back into this table in order to run a report.
Column Display Order
The Selected Columns table shows the exact order of the columns in the report. To change this column display order, the user can click a column type and utilize the arrows beside the Selected Columns table. These arrows serve different purposes:
Arrow | Used To... |
Double Up Arrows | Move the selected column type to the top of the list. |
Up Arrow | Move the selected column type up one row. |
Down Arrow | Move the selected column type down one row. |
Double Down Arrows | Move the selected column type to the bottom of the list. |
Links
There are some link controls located on the Report Columns section of the RIMS Advanced Query interface:
Link | Used To... |
Unselect All | Unselect all currently selected column types in the table below; located above the Available Columns and Selected Columns tables. |
Load User Query | Open the current user's previously saved queries in the interface for editing/running purposes. |
Save User Query | Save the current query as a user query; this query can now be accessed in the "Load User Query" pop-up. |
Delete User Query | Delete one of the current user's stored queries. |
Crash Rank from Excel File |
Select an Excel File to rank its records. |
Load Standard Query | Open a standard query stored in the RIMS Standard Query interface into this interface for editing/running purposes. |
Save Standard Query | Save the current query as a standard query; this query can now be accessed in the RIMS Standard Query interface and the "Load Standard Query" pop-up. |
Delete Standard Query | Delete a standard query from the list and application. |
User Query Links
To load a user query, the user can follow these steps:
- Click the "Load User Query" link.
- Select a saved query in the "Choose User Query" table.
- Click the "Load" button to view the query on the RIMS Advanced Query interface.
To save a user query, the user can follow these steps:
- Click the "Save User Query" link.
- Enter a "User Query Name" and "Report Title" in the textboxes.
- Click the "Save" button. This query will now be available in the "Load User Query" interface.
To delete a user query, the user can follow these steps:
- Click the "Delete User Query" link.
- Select a saved query in the "Choose User Query" table.
- Click the "Delete" button to remove the query from the system.
Standard Query Links
To load a standard query, the user can follow these steps:
- Click the "Load Standard Query" link.
- Select a saved query in the "Choose Standard Query" table.
- Click the "Load" button to view the query on the RIMS Advanced Query interface.
To save a standard query, the user can follow these steps:
- Click the "Save Standard Query" link.
- Enter a "Standard Query Name" and "Report Title" in the textboxes.
- Click the "Save" button. This query will now be available in the "Load Standard Query" interface and RIMS Standard Query interface.
To delete a standard query, the user can follow these steps:
- Click the "Delete Standard Query" link.
- Select a saved query in the "Choose Standard Query" table.
- Click the "Delete" button to remove the query from the system.
Comments
0 comments
Please sign in to leave a comment.