Reference documentation for how to configure the Ad Hoc Report Creator embeddable client via HTTP query parameters in order to set the current report, filters, sort, and more.
The Pull Reports™ Ad Hoc Report Creator responds to HTTP parameters encoded within the browser's location.
Use these parameters to construct a URL to load a specific
within the creator, set filters, and sort or include columns.
For instance, if the web page into which the Ad Hoc Report Creator is embedded is
http://www.mycompany.com/reports/index.html, then a url structured
will load the
mycatalog and apply
@id > 100.
Boolean value which sets the "Distinct" checkbox of the Result Preview panel.
Designates the filters to be applied to the results within the
and Filter Summary panels. The
filter parameter value is formatted identically to the Export Report REST API
Designates the result limit of the
Result Preview panel.
Allowable values are
Designates the result offset of the Result Preview panel.
id to load.
If specified, the
catalogId parameter must also be specified,
reportId parameter must correspond to a report within the
Most operations within the Pull Reports™ Ad Hoc Report Creator are responsive to the browser's back and forward buttons. This allows a user to undo/re-do an operation such as adding or removing a filter by simply using the back and forward buttons.
Since the current state of the Ad Hoc Report Creator is captured within the browser's
location, a user may bookmark or email the creator URL to a colleague. When a user
returns to the creator, it will read the component state from the browser's location
and return the creator to its expected state.
An exception to this behavior is if the underlying
<report> configuration changes
in a way that is incompatible with the saved state. Examples of such incompatible changes
are the removal of a
<table> or the change of an
Similar to the creator, the export results are also bookmark-able since the export parameters are encoded within the bookmarked URL. Additionally, each time the export is rerun, the values are fetched again from the database, so the results are always current.
However, also like the creator, the export result bookmarks will potentially break
due to incompatible
<report> configuration changes.