Query Builder User Guide
General Instructions
Query Builder searches for data elements using the user's table and column selections and other search criteria.
Follow these four basic steps to search data elements:
STEP 1: Choose a Subject Area
The data in this database is classified by the subject area. Each subject area contains data tables, with each data table containing information related to the subject area. You may select only one subject area at a time. A brief description appears for each subject area name to help you determine which data to retrieve.
Click a subject area of your choice. You can search for this with the Search title/description filter. This selection will automatically bring you to Step 2: Select Fields.
STEP 2: Select Fields
You may select one or more columns based on your table selection. These columns, which will be used for your output, will change depending on which subject area you chose in Step 1. If you need to modify the output of data in this step, click the Back to Step 1 button or click the browser's back button.
To select the columns, which will be used for your output, click on the column name’s box. Click the Select All button to choose all the available columns. You can search for this with the Search title/description filter. Click the column’s box again to deselect for output or click the Clear Selection button to remove all column selections. After you have selected one or more desired columns, click on the Get Data button to go to Step 3: View Data.
STEP 3: View Data
The data based on the selected subject and fields displays on the page. Sort the data by clicking the column headers. If you need to modify the output of data in this step, click the Back to Step 2 button or the Select Fields header. Refer to the Step 4 section below for data viewing options.
STEP 4: Enter search criteria and organize output data
To create search criteria for each column header, click the filter icon in the column header. In the pop-up window, choose an operator and enter an applicable value for that operator. Finally, click the Apply button to create the search criteria. Repeat as needed for each column.
If you choose an operator more than once for a column, only the latest entry will be considered. Click the filter icon and the Clear button to delete a filter for a column. Click the Clear button in the upper right-hand corner of the table to remove all column filters.
Once you finish entering the column’s search criteria for the data output, click the Apply button. The data output refreshes with your applied criteria. You may modify any column filter by clicking the filter icon that appears above the column.
Once you finish entering the column’s search criteria for the data output, click the Apply button. The data output refreshes with your applied criteria. You may modify any column filter by clicking the filter icon that appears above the column.
To view all or modify the display of columns in the data table in a pop-up list, click the View Fields button. You may search for the columns with the Search title/description filter. Click the column’s checkbox to add or remove the column from the data table. Click the arrow located between the field checkbox and the field name to view the metadata description. Click the Export Field Metadata button to export all data columns’ metadata descriptions into a spreadsheet.
After selecting or deselecting the columns to display in the data output, click the Update Fields button. The data output refreshes with your applied columns added or removed.
Click the Save Query button to save the search query for future use. The generated URL can be used to view and share these results. Copy the generated Query URL to the clipboard. Afterward, click the X or the Close button to exit the pop-up screen.
To export the data, click the button for the desired format (options include CSV, Excel, JSON, and XML).
You can navigate the user interface data table by viewing by rows per page and using the data page navigation arrows.
At the bottom of the page is the GraphQL Query that lists the data outputs Query, its Query Variables, and its Endpoint. This data can be copied to a clipboard and pasted into a document for reference and troubleshooting or for retrieving the query results programmatically.