Skip to main content
Appia® Knowledge Center

Query Builder for custom reporting

In this article:

You can build reports based on your requirements using the Query Builder process in the Appia service. You can set filter report parameters to find more information about project items than a standard Appia report. Each query can be saved for future use.

The project overview fields are available for the header of the report. Fields for the body change depending on which element was selected for the query.

Query Builder

Once you decide what element to query on, the header fields and the body display. The list of body fields change depending on the element selected. You can also use a saved query.

query (1).png

  1. Select the element to query in the Query On drop down list or select a saved query from the Use Saved Query field. 

  2. Decide the orientation for the final report.

If you select a saved query and want to create a new query instead, click the X in the Use Save Query field.

Build the header

The Header lists the fields available in the report overview. The header is built vertically.

mceclip0.png

  1. Click the field you want in the header.

  2. Repeat the process until you have all the header information you want for the report.

  3. Rearrange the fields by dragging the field to the order where you want it displayed.

Delete the field by clicking the X.

Build the body

The Body lists the column headers available for the selected element. The body is built horizontally.

Text fields are left justified. Number fields are right justified.

mceclip1.png

  1. Click the field you want in the body.

  2. Repeat the process until you have all the fields you want for the report.

  3. Rearrange the fields by dragging the field to the order where you want it displayed. 

Delete the field by clicking the X.

Save or delete

You can save the report for future use or delete it if you're not using it anymore. Users who have access to the Under Construction project can use and change the query.

mceclip2.png

  • Click Actions and click Save to save the query. Enter a query name and click Yes, save query.

  • Click Actions and click Delete to delete the query.

Run the report

When you have the header created and the body contains all necessary information, run the report.

mceclip3.png

  • Click Report to run the report in your internet browser.

  • Click Preview to see what the report will look like.

  • Click Actions and click Export to create a .csv file of the report.