|
Classic file types are no longer available for use as of January 2021. You can transition your classic files or download a PDF. Learn More

Workiva Support Center

Create queries

Create queries

  • Last updated on

To aggregate and segment data based on specific criteria, you can create queries based on data stored in the Workiva platform as tables and spreadsheets. For example, you can create queries to analyze income by location or for year-over-year comparisons.

To create a query, you can:

  • Define its criteria in a drag-and-drop Builder . define-query-fields_1.gif
  • Compose its definition as syntax, if comfortable with Structured Query Language (SQL) .

When you create a query, you define the sources and criteria of the data to include in its results:

  • Fields, which provide the information to display in the query results
  • Filters, to include only records that meet selected criteria, such as to focus on specific accounts, regions, or time periods
  • Calculations, which return values based on multiple columns, such as to sum their amount or concatenate strings
  • Relationships, to join related data from multiple sources

Step 1. Create the query

To create the query, start from scratch, or base it on an existing query.

  1. From Wdata Home, click Create , and select Query .
  2. From the Query Properties panel, set the query's properties: query-properties.png
    • To help identify the query and its intent, enter its unique name and description.
    • In Limit, enter the maximum number of records to return.
    • To return only records with different values, such as to avoid duplicates, select Show only distinct rows.
  3. To specify who can view and collaborate on the query, click Permissions , and select each collaborator's access.
  4. Click Save .
  5. Edit the query's name and description as necessary.
  6. Select the folder to save the query in, and click Save Query.

To ease creation, you can save a copy of a query as the starting point for a similar query.

  1. Copy the existing query from itself or Home :
    • From the query, click Save , Save As.
      query-save-as.png
    • From Home, select Copy from the query's menu.
  2. Enter the name, description, and location for the new query.
  3. Click Save Query.
  4. In the new query, click Permissions , and select each collaborator's access.
  5. Click Save .

Step 2. Select the query's sources

To select the data to use in the query, you include columns from tables, query results, and spreadsheets you have permission to access in the Workiva platform.  From the Sources left panel, click New source, and select the data to include in the query.

2024-06-25_11-00-09.png

If the query has multiple sources, on the Relationships tab, define how to combine—or join—their records.

Note: When you save the query, it automatically removes any sources that appear as Needs Relationship . To retain these sources, define their relationship with other sources.

Step 3. Add any parameters

To define values for the query's filters or calculations when the query runs, such as to slice-and-dice its data in real time, add parameters for their values. From the Parameters panel, you can:

manage-query-parameters_04.png

Step 4. Define the query results

You can define a query's results in a drag-and-drop Builder or—if familiar with SQL syntax—a SQL editor.

Tip: To undo changes in either Builder or SQL Editor and return to the query's previously-saved version, click Reset . If you collaborate on the query with others, its last-saved version may not be your last save.

To define your query, we recommend the drag-and-drop Builder, especially if you aren't familiar or comfortable with SQL syntax.

  1. To specify data to include in the query results, select the columns under Sources, and click Add to Fields or drag them to under Fields.
    add-to-query-builder.png
    • To browse the Sources panel, click Expand All or Collapse All to show or hide all columns.
    • To find a specific source or column, click Show Filters and search by its name.
  2. After you add the query's fields, from the Field Properties panel, define the properties or calculation of each as necessary.
  3. On the Filters tab, create filters to set the criteria of the source data to include in the results, such as to focus on specific accounts or time periods.
    Tip: To choose the criteria when you run the query, such as to slice-and-dice the data in real time, use parameter values with filters or calculations.

If you're familiar with SQL, click SQL and Edit SQL to compose the query's SQL statement in an editor.

Note: To help preserve your SQL syntax, the editor opens in a read-only status by default. Depending on the complexity of your query, you may not be able to retain the syntax if you click Builder after you start in the SQL editor.

While not every query includes every clause, each part of the SQL statement executes in a particular sequence:

  • FROM and JOIN, to determine the sources of the data being queried
  • WHERE, to include only data that meets specific criteria
  • GROUP BY, to summarize data based on common values
  • HAVING, to include only data from aggregated rows that meet specific criteria
  • SELECT or SELECT DISTINCT, to further specify which source data to include
  • ORDER BY, to specify how to sort the data in the results
  • LIMIT and OFFSET, to specify how many—and which—records from the query to include

To ensure data integrity, the SQL editor supports read-only statements like SELECT, but not read/write statements like INSERT or DELETE.

To quickly reference a source column in the syntax, from the Sources panel, right-click it and select Add to Query.
add-to-query-editor.png

  • To browse the Sources panel, click Expand All or Collapse All to show or hide all columns.
  • To find a specific source or column, click Show Filters and search by its name.
Note: To scope the query results to specific records, define the filter criteria as SQL syntax. To set a filter's value when the query runs, reference a parameter.

Step 5. Lay out the results

By default, the query results appear unsorted and flat, with all fields as separate columns like a table. To help clarify the data, you can sort the query results based on a field's data.

Tip: To further summarize and pivot the results, lay them out as a cross-tabulation with rows, columns, and values.

To sort the query results, on the Sort tab, move the fields to sort by to Sorted, and select whether to arrange the data in ascending or descending order.

layout-query-results_03.png

To sort the query results, use an ORDER BY keyword, such as ORDER BY field_header ASC. To sort according to multiple fields, separate each with a comma; ORDER BY field_header1 ASC, field_header2 DESC.

Step 6. Verify and use the results

To view a query's results, click Run Query . If the query includes parameters, set their values, and click Run Query.

After you verify the query results appear correctly, use them throughout the Workiva platform:

To aggregate and segment data based on specific criteria, you can create queries based on data stored in the Worki...