Dynamically Change Parameters

If you’ve migrated from PocketQuery for Server/DC, you might be already familiar with this Macro option, often referred to as a Change params template.

Let’s consider the following Query:

Note that we have 3 numeric parameters: excluded_author_1, excluded_author_2, and maximum_results. We want to exclude two IDs from our result and restrict the maximum number of results.

Sometimes, we want to make our Queries dynamic and give the users an option to change them directly from the Confluence page. From now on, we can solve this problem easily in the Macro configuration:

Switching to Include Change Parameters Template results in the following:

Note that we received 3 records because of the maximum results restriction and we excluded authors with IDs 1 and 3.

We can change this configuration by inserting new values into the form and hitting the Reload button:

Additional Form Controls: Clear and Reset to Default

As of version 12.31.0, PocketQuery adds two additional buttons to parameter forms:

• Clear - Removes all input values from the form fields.

• Reset to Default - Restores default values defined by the query creator.

These buttons are available alongside the Reload button and are useful when working with larger forms (e.g. 4–6 fields), or when users want to reset the form after multiple changes.

Parameter Names

In Query statements, we usually name our parameters using keys or camel case strings. However, in the template form, we want to have a human-readable label. PocketQuery automatically converts the key format to a label. All underscores (_) are considered whitespaces and the next letter is capitalized. For example, parameter my_first_id displays as My First ID.