Learn about the various components of the embeddable Report Creator client and how to create your own Ad Hoc report.
The Report Repository is the default view of the Pull Reports™ Report Creator. It displays the
hyperlinked name and description of all configured
<report>s within their respective
<catalog>. Additionally, the hyperlinked name and description of all
<canned_query> and user query configurations display beneath the associated report.
When a user clicks on a report name within the Report Repository, the
report opens in the Ad Hoc Report Creator. The Ad Hoc Report Creator allows
the user to interact with the full power of the
Pull Reports REST API to create a report export from a
When interacting with the Ad Hoc Report Creator, all interactions are persisted
within the browser's location, so it is easy to bookmark and return to a particular
column, sort, and filter selection.
When a user clicks on a query name within the Report Repository, the query opens in the Query Viewer. The Query Viewer allows the user to select filter values and change the order and sort of columns within the report export. The Query Viewer is easier to use than the Ad Hoc Report Creator and provides quick access to pre-configured or "canned" report exports.
When a user saves a new user query or clicks a user query edit link in the Report Repository, the query opens in the User Query Editor. The user may then change and re-save the query.
Most operations within the Pull Reports™ 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 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.