Overview
Queries created in the Query Tool can be published so they are available in My Reports and Data Exchange, allowing users to run, chart and export them in the same way as standard Vega reports.
Publishing a query involves three steps:
- Save the query and enable publishing.
- (Optional) Configure the default graph settings.
- Grant users access to the published query.
Note
The Add to My Reports/Data Exchange option only becomes available after the query has been saved with at least one output column. Vega needs to know what information the query returns before it can be published.
Step 1 – Save and Publish the Query
- Open an existing query or create a new query in the Query Tool.
- Add at least one output column.
- Click Save.
- Once the query has been saved, the Add to My Reports/Data Exchange checkbox will appear.
- Tick Add to My Reports/Data Exchange.
- Click Save again.
The query is now published and available to assign to users.
If no graph settings are configured, the query will appear in My Reports as a Grid report only.
Step 2 – Configure Graph Settings (Optional)
Once Add to My Reports/Data Exchange has been selected, the Graph Settings button becomes available.
Graph Settings define how the query will initially display when viewed in My Reports.
If this step is skipped, the query will still be available but will only display in Grid view.
Configure the graph
- Click Graph Settings.
- Select a Group Results By column.
- For example:
- Campaign
- Pay Type
- Payment Status
- For example:
- Select a Value Column.
- For example:
- Payment Amount
- Donation Value
- For example:
- Select an Aggregate:
- Sum
- Average
- Count
- Minimum
- Maximum
- Click Save.
When a user first opens the report in My Reports, these settings will be used as the default chart configuration.
Users can then customise the chart to suit their own reporting requirements without affecting the default settings.
About the Value Column
Only numeric fields are available as Value Columns.
Text fields cannot be measured and therefore do not appear in the list.
Identifier fields, such as:
- Vega ID
- Entity ID
are also hidden because they cannot be totalled or averaged.
If Count is selected as the aggregate, these identifier fields become available, allowing records to be counted instead.
If the Value Column list is empty
If no fields appear in the Value Column list:
- Add a numeric field to the query output (such as Payment Amount), or
- Change the Aggregate to Count, which does not require a numeric field.
Step 3 – Give Users Access
Publishing a query makes it available to be assigned—it does not automatically make it visible to users.
An administrator must grant access through the Edit User Wizard.
- Open the Edit User Wizard.
- Select the My Reports tab.
- Locate the published query in the Queries section below the standard reports.
- Tick the query for the required users.
- Save the user record.
The query will now appear in My Reports and Data Exchange for those users.
Related Article
See User Access Setup for more information about assigning reports and queries to users.
Troubleshooting
❓I can't see the Add to My Reports/Data Exchange checkbox
The query must be saved with at least one output column before the publishing option becomes available.
❓Graph Settings won't open
Save the query first.
Graph Settings require the query to have been saved so Vega can identify the available output columns.
❓I unticked Add to My Reports/Data Exchange
The query will immediately disappear from users' My Reports and Data Exchange.
The query itself is not deleted.
If you enable the option again, it will immediately become available again for users who already have access.
❓The query only shows as a grid
This usually means:
- Graph Settings have not been configured, or
- A Group Results By or Value Column has not been selected.
Both fields are required before chart views become available.
❓The query has been published but users can't see it
Publishing a query only makes it available for assignment.
Each user must still be granted access through the Edit User Wizard before it will appear in My Reports.
“Some content in this article may have been developed with the assistance of AI tools and reviewed by staff.”
Comments
0 comments
Please sign in to leave a comment.