| Insert excerpt |
|---|
| Reusable Excerpts - Master |
|---|
| Reusable Excerpts - Master |
|---|
| name | Contact - CPFM |
|---|
| nopanel | true |
|---|
|
Queries allow for users to search in AiM with a defined set of criteria. The query results will display a specific set of data based on the criteria selected. The search criteria fields contain operators that can be used to search records in different ways, such as “Starts with”, “Ends with”, or “Contains”.
| Table of Contents |
|---|
| minLevel | 1 |
|---|
| maxLevel | 6 |
|---|
| outline | false |
|---|
| style | none |
|---|
| type | list |
|---|
| printable | true |
|---|
|
🔖 Page Summary
| Info |
|---|
The Page Summary section serves as a quick reference point of the steps, after going through the detailed Step-by-Step Tutorial with screenshots. |
...
\uD83D\uDCD8 Step-by-Step Tutorial
...
Query
...
Overview
Why will a Query help me? When using a database full of information you will want to retrieve very specific records. These records can be obtained by utilizing a query.
| Expand |
|---|
| title | Click here for 👉 What is a Query? |
|---|
|
| Info |
|---|
A search exists for every single record in AiM Query example - You have a $5,000 budget and 12 employees have charged time to this work order and we are currently at $5,800. Create a query that will tell you - All the jobs that are over budget or I wanna see all the jobs that are 25% of going over budget. |
| Info |
|---|
Throughout the AiM system, you can create a New Query. Queries are built inside of a search screen. You can access a Query/Search screen in a couple of ways: Clicking on a magnifying glass icon at any level within the AiM platform. Inside any Record that you have open, click on the blue Search button. This will take you to the Query/Search screen for that specific Record and the Module it’s in.
|
Queries do not work like Google, Yahoo, and other search engines where you can use multiple words in a single field and get related results. Though the results will be different, every Query screen will have the same buttons and options for building and saving the search. The part that changes is the data being searched for within the record. A query is a custom search for details about records in AiM. After executing a query it will display a "Browse" list of all the records that match the different search elements. Queries can be built for a single search or saved for future use. Queries can be shared with other people or groups of people. Saved Queries can be made into a Dashboard Widget and shared with a group. Saved Queries can be used for Highcharts. These are visual displays of the results in the form of a chart or graph. These charts can be added to Dashboard Widgets. 👉 There is no limit. If the data is in the system, you can query it!
| Info |
|---|
A personal query is a custom search for desired information based specifically on the user creating it.
Optionally, it may be associated to a role for more global usage. |
Show all Work Orders for a specific building. Show all Work Orders assigned to a specific person. Show all Purchase Orders to a specific vendor. List all active properties. Find my "Employee Profile". Display all emergency or high priority Work Orders.
|
...
| Expand |
|---|
| title | Click here for 👉 Anatomy of a Query/Search Screen |
|---|
|
1. From the WorkDesk, you can click on any module in the left hamburger icon Menu. In the next screen, you will find additional left menu options, some of which have a magnify glass icon next to them. Click on a magnify glass icon next to your menu choice for which you would like to create a query for. These three buttons can be found at the top-left of a query screen:
 Basic vs Advanced Search
Basic Search - Gives the user a limited number of options for searching. This is often sufficient for more users.
Advanced Search - Gives the user access to more query options to do more complex queries. | Info |
|---|
By default, all users start with Basic Search. Your System Administrator can change your default for you. |
Below is a screenshot of the search page for Asset Package, under the Asset Management module. Under Action in the left menu, you will find the link to open and begin creating a New Query. Below Action, View will be empty until the Query has been saved.
| Info |
|---|
Queries you have already created can also be edited and either replace the original query or saved as a completely new query. |
 |
...
| Expand |
|---|
| title | Click here for ➡️ Starting a Search |
|---|
|
From your WorkDesk, click on the hamburger icon on the left to expand your top-most search options/how you want to start your search. The Module - The top level category of records The + Sign - Starts a New Record The Magnify Glass - Takes you to the search screen The Record Name (under the Module) - Takes you to a new blank screen
 |
...
| Expand |
|---|
| title | Click here for ➡️ Opening & Starting a Search from a Record |
|---|
|
What the screen looks like after opening with the Record Name (under the Module level of data) In the next screen, the Record Name can be found at the top: In this example, Personal Query is the record name. Next you would click on Search to dive deeper into this screen.
 See the previous section, Anatomy of a Search/Query Screen, for more details. Execute - This will run the query. Basic/Advanced Search - Toggling between the two will show which option you will go to, NOT which option you are on. Reset - Resets the entire query screen.
Under Action on the left of the query screen, click on New Query.  |
The New Query Screen
| Expand |
|---|
| title | Click here for ➡️ The New Query Screen |
|---|
|
In the New Query screen, first complete the Title field. The Description field below it is optional. When Query Listing and Query Count are set to Yes, the Query can be displayed on the Dashboard. Setting the yellow and/or red flag fields will make the query flag turn yellow or red on the WorkDesk or when it reaches the set number. These fields are optional. The Chart Type will identify the different charting options to display a visual representation of the data you are about to build a query for. When you are finished and click on Done, the search will open in build mode.
 After all criteria are entered, click Save to save the query. Selecting Execute will take you to the results/Browse View of the query.
 |
Query/Search Results (aka Browse View)
| Expand |
|---|
| title | Click here for ➡️ Query/Search Results Query/Search Results |
|---|
| (Browse View) |
In your query search results, click on a Record link to display the details of that record.
 You can also click the blue Search button to return to the Query screen for the name you chose on the record level under the module you chose (in this example, Personal Query).
 |
...
| Expand |
|---|
| title | Click here for ➡️ How the Query Screen Looks After Saving 1+ Queries |
|---|
|
Before we saved a query, the only option under Action was New Query. Now, Edit Query has been added. Under View, there were previously no options. But after saving 1 or more queries, those saved queries are listed under this section.
Queries can be built and saved for future use. Queries you have already created can also be edited and either replace the original query or saved as a completely new one.  |
...
| Expand |
|---|
| title | Click here for ➡️ Query Screen Structure & Display Order |
|---|
|
Some query screens might have multiple tables involved. The primary table is listed first. After that, additional tables will have its own headings. If the header is indented, the table is subordinate to the table above it.
 Display Order functionality allows you to specify which fields you want to see and the order you wan to see them in, in the Query Results screen.  Ascending (Asc) or Descending (Dsc) are additional Display Order options.  |
Special Operators
| Expand |
|---|
| title | Click here for ➡️ Special Operators Special Operators |
|---|
|
Special Operators will be used with new WorkDesk queries to make them easier to share across the units. These operators (=, <, >, null, …) work with dates and allow the query to use the characteristics of dates to pull records in a more focused manner.
 |
...
| Expand |
|---|
| title | Click here for 👉 Personal Queries |
|---|
|
| Info |
|---|
Personal Queries can be created under any Module in AiM. |
You can also view All Personal Queries created under All Modules From the WorkDesk, click on the hamburger icon on the left and click on the System Administration Module Click on the Magnify Glass icon next to Personal Query
 In the next screen, click Execute to view all your Personal Queries. You will see a list of your personal queries (example screenshot, below).
 Click on one of the Query links to open that page. Here, you can Edit the chosen query and share the query to group(s).
By default, Personal Queries are “personal” to the user that created them. Personal Queries are not visible to other logins.  |
...