Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

Insert excerpt
Reusable Excerpts - Master
Reusable Excerpts - Master
nameContact - CPFM
nopaneltrue

...

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

...

AIM IQ is a reporting and data analytics solution for AiM users who need to align decisions and activities to business objectives using AiM data.

Out-of-the-Box reporting makes your AiM data immediately useful to understand Facilities processes and performance. Equipped with the flexible and intuitive BI tools in AiM, AiM IQ empowers individuals and their institutions to multiply business success.

...

“Starts with”, “Ends with”, or “Contains”.

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

Expand
titleWhat is a Query?

asdf

asdf
Expand
titleQuery Screens Overview

Expand
titlePersonal Queries

\uD83D\uDCD8 Step-by-Step Tutorial

What is a Query?

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
titleClick here for Query Overview details👉 What is a Query?
Expand
Info

A search exist exists for every single record in AiM.

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

What is a

query?

Query?

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

Examples of some common Queries

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.

Examples of some common Queries

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

Framework of a Query

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.

Anatomy of a Search

Action is where you will find the link to open and begin creating a New Query. View will be empty until the Query has been saved. 

<AJ - From the dashboard

/Query Screen 

  1. From the WorkDesk, you can click on any

main topic
  1. module in the left

menu called
  1. hamburger icon Menu.

  2. In the next screen, you will find additional left menu options, some of which have a magnify glass icon next to them.

  3. Click on a magnify glass icon next to your menu choice for which you would like to create a query for.

>
  1. These three buttons can be found at the top-left of a query screen:

image-20241120-193506.png
  • Execute - Runs the query

  • Basic Search/Advanced Search - This is a toggle. The button will show which option you will go to by clicking it. NOT which option you are on.

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.

  • Reset - Resets the entire query screen. This is useful when your search results appear to be wrong. You can click Reset and start over knowing all fields have been reset to their default settings.

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

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

Query Screens Inside the AiM Platform

asdf

screenshot-search-query-screen_aj.jpgImage Added

Query Screens

...

Overview

Below are detailed descriptions for navigating the screens found when creating a

...

Query.

Expand
titleClick here for 👉 Query Screens Overview

Query Screen Descriptions

Search Menu in AiM <How to get to this screen?>

The Magnify Glass - Takes you to the search screen.

Starting Your 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. <Can’t find + sign. Has this changed to new document icon?>--> <<Jude - This looks like the updated work desk that we don’t use. It looks similar to new hire work desks, and LeAnna always asks Pedro to change them over to classic view.>>

  • The Magnify Glass - Takes you to the search screen

  • The Record Name (under the Module) - Takes you to a new AiM blank screen.

QueryOverview1-cropped.jpg

Open

Opening a Record

  • Image found What the screen looks like after opening with “The Name” → <If you choose to click on the magnifying glass icon, you will have access to the following options:>

    • Basic Search/Advanced Search options

    • Create a New Query (under Actions in the left menu)

    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. <Personal query is for any search, not record name?>

  • Next you would complete a search click on Search to dive deeper into this screen. Click on New Query. This will bring you to a new Personal Query screen.

QueryOverview2-cropped.jpgImage RemovedButton on the Screen
QueryOverview2-cropped.jpgImage Added

The Search/Query Screen (for the Record Name Selected: Personal Query)

See the previous section, What is a Query? > Anatomy of a Search/Query Screen, for more details.

  • Execute - This will run the query.

  • Basic

Search
  • /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.

QueryOverview3 - cropped.jpg

asdfOn this screen: Complete the Title Field - A description

New Query Screen

  1. In the New Query screen, first complete the Title field. The Description field below it is optional.

  2. When Query Listing and Query Count are set to Yes,

allows for
  1. the Query

to display
  1. can be displayed on the Dashboard.

  2. Setting the yellow

flag <What do you enter in the fields by yellow or red to set the status?>
  1. and/or red flag fields will make the query flag turn yellow or red on the WorkDesk or

dashboard
  1. when it reaches the set number.

This and the Red Flag
  1. These fields are optional.

  2. The Chart

Types
  1. Type will identify the different charting options to display a visual representation of the data you are about to build a query for.

After selecting DONE
  1. When you are finished and click on Done, the search will open in build mode.

image-20241120-231120.png
    asdf
    1. After all criteria

    is
    1. are entered, click

    the SAVE button
    1. Save to save the query.

    2. Selecting Execute will take you to the results/Browse View of the query

    .This will redirect to the “Browse” view of the results
    1. .

    image-20241120-231514.png

    asdfSelect

    Query/Search Results (Browse View)

    1. In your query search results, click on a Record link to display the details of that record.

    Hit
    QueryOverview6 - cropped.jpgImage Added
    1. 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

    Query Screen
    1. module you chose (in this example, Personal Query).

    QueryOverview6 - cropped.jpgImage RemovedQueryOverview7.jpg

    asdf
    • On this screen you will find Action and View Menus.

    • The Action Menu link will open a New Query or allow you to Edit a Query.

    • The View will have a list of created Personal Queries.

    image-20241120-232028.pngImage Removed

    asdf

    A query screen

    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.

    image-20241120-232028.pngImage Added

    Query Screen Structure

    • Some query screens might have multiple tables involved.

    • The primary table is listed first.

    • After that each , additional table tables will have its own heading barheadings.

    • If the header is indented, the table is subordinate to the table above it.

    image-20241120-232226.pngImage RemovedQueryOverview10.jpgImage RemovedQueryOverview11.jpgImage Removed

    asdf

    Special operators image-20241120-232226.pngImage Added

    Display Order

    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.

    QueryOverview10.jpgImage Added

    Ascending/Descending Display Order

    Ascending (Asc) or Descending (Dsc) are additional Display Order options.

    QueryOverview11.jpgImage Added

    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.

    QueryOverview12 - cropped.jpgImage Removed
    QueryOverview12 - cropped.jpgImage Added

Personal Queries

Personal Queries are “personal” to the user that created them. Personal Queries are not visible to other logins.

Expand
titleClick here for 👉 Personal Queries

Filter by label (Content by label)
showLabelsfalse
max5
spacescom.atlassian.confluence.content.render.xhtml.model.resource.identifiers.SpaceResourceIdentifier@14ef7
sortmodified
showSpacefalse
reversetrue
typepage
labelskb-how-to-article
cqllabel = "kb-how-to-article" and type = "page" and space = "WCC"