Field Query

Field Queries allow to search for Field Instances and bundle the information in one place, no matter where they hide in the jungle of Confluence pages. Thereby, Confluence’s permissions system is fully accounted for by displaying user-dependent results. Keep track of all Field Instances or limit the query to those with specific values and/or in a certain Confluence space.

Create a new Field Query

A Field Query allows you to create reports on over the existing Field Instances of a certain Field Definition. Simply create a Manage Data Fields Macro on your Confluence page and choose Field Query. After selecting the Field Definition you want to create a report for, you may also define some filtering values. If no value filter is applied, the Field Query will retrieve all corresponding Field Instances, irrespective of their value.

Find more information on how to apply a value filter here:

Moreover, you can restrict the query to Field Instances on a certain Confluence space.

Edit an existing Field Query

To apply a (different) value filter to an existing Field Query, restrict its search to a certain Confluence space, or change the queried Field Definition completely, simply edit the Field Query macro via the Confluence page editor.

The Field Query Report

Once created, the Field Query is permanently present on your Confluence page and creates an up-to-date report of the Field Instances that match your applied filter criteria. The report is updated on every page refresh.

By default, all retrieved Field Instances are presented in tabular format. Columns include the linked Confluence page, Confluence space, and all Data Attributes along with their current values. The report can be exported as .csv file.

The currently applied value filter can be investigated by clicking on the “Value” dropdown, as shown on the right. If a value filter is applied for a Data Attribute, it is shown with a check mark. In the example on the right, only those Field Instance with Jane Doe as process owner will be retrieved.

Besides the Table View, the Field Query results can also be presented as diagrams. Click on “Chart View” → “Configure Charts” to create charts for Data Attributes of interest. By default, an example chart is present which can be replaced.

Learn how to configure charts here:

In the example below, three charts for the Data Attributes Document Status, Business Impact, and Process Cost have been created. Note that these all belong to the same Field Definition “Process Definition”.







← Back to Homepage