Query Preview

Overview

Query Preview lets PocketQuery administrators test and validate a Query in the administration area before it is used on a Confluence page. The preview runs the Query that is currently in the edit form - including a Query that has never been saved, and a saved Query with unsaved changes. A preview never creates or updates the Query.

How to Use Query Preview

1. Test the Datasource Connection

• Go to PocketQuery Administration via the Apps menu in Confluence.

• Open the edit form of a Query you want to test. You can also start from a new, unsaved Query.

• Below the Datasource selection, click the Test Connection link to verify that your Datasource is connected properly:

• Result: a message will indicate whether the connection was successful.
  

  
  

2. Preview your Query (with Converter)

• In the Query edit form, scroll down to the Query Preview section.

• Click the Run Query Preview button.

  • If your Query uses parameters, make sure to fill them in first.

  • After you edit a Query, the preview runs the edited version in front of you - not only the last saved version.

• If successful, the preview will display the results of your Query, including any applied Converter:
  

3. Preview your Template

• Enable the Apply Template checkbox.

• Click the Run preview button.

  • If your Query uses parameters, make sure to fill them in first.

• The preview will display how your Query results appear when combined with the selected Template:
  

Actions in the Preview

Once your preview is displayed, you can perform the following actions:

Button	Action
	Copy your table / JSON to the clipboard
	Download your result as CSV-file
	Display the preview in full-screen mode
	Switch between Table and JSON view