Learn about the various components of the embeddable Ad Hoc Report Creator client and how to create your own Ad Hoc report.
The Ad Hoc Report Creator is a client of the Export Report REST API which allows a user to create ad hoc reports and data exports. The Report Creator has the following components:
The header displays the current
<report> name and the full screen button.
The Columns panel presents the
<report>'s tree graph of related
<column>s available within each table. Additionally, the Columns
panel has controls to add columns to the Export Report REST API result, filter
columns, and view catalog configuration metadata.
The Columns panel focuses one table within the tree graph at a time. Navigate to a different table via the table tree graph popover or table path breadcrumbs.
The Columns panel indicator highlights when the columns panel is active.
The first two table navigation buttons support back and forward navigation through the history of tables visited in the Columns panel. The buttons are disabled if a particular navigation direction is not available.
The third table navigation button supports navigating up to the parent table in the report table tree graph. The button is disabled if the report's base table has focus within the panel.
Clicking the table tree graph button displays the report's table tree graph in a popover. Within the popover, the focused table is indicated in bold font. Clicking any other table focuses the Columns panel to that table.
The table path breadcrumbs show the relational join path of the focused table. The focused table is listed at the end of the path in bold font. Clicking any other table within the breadcrumbs focuses the Columns panel to that table.
Clicking the search columns input changes the Columns panel to search mode.
Clicking the close button closes the panel.
The Columns panel body lists the
<column>s of the currently focused table and provides
controls to add columns to the report export, create filters, and view metadata.
Click or drag column labels into the
to add them to the export results. Clicking a label adds the column
as the last column in the
Results Preview. Dragging a column allows the
column to be precisely positioned. The column labels are
taken from the
When the column is included the export results, a check icon is displayed to the right
of the column name. Shift+click a column label to remove that column from the
Any columns attributed as
are listed separately under the
Non-exportable Columns label.
They may be filtered but not added to the export results.
Add filter menu item to open the Filters panel, Create Filter form
with the column pre-selected.
Show Metadata menu item to view the
<column> metadata such
Clicking the Metadata button again closes the metadata.
Add all button to add all exportable columns
from the focused table to the end of the export results.
The Column order toggle button toggles the column order between
alphabetical (the default) and the native order in which
<column>s are listed within the
The additional tables section lists the child
<relationship> tables of the
<table>. Clicking a table name focuses the Columns panel to the table.
Any additional table with a
many will appear stacked.
The description section displays the table resource path and
description, if specified.
The Columns panel search mode supports full text searching of
displayName attributes and
Tables and columns within the search results contain controls to add columns to
the export result and create filters.
Click a table search result to focus the table within the Columns panel.
Column search results contain the same controls for adding the column to the export result, filtration, and metadata viewing as does the Columns panel, normal mode. Additionally, the column's parent table name and path display below the column control to provide additional context.
The return button returns to Columns panel normal mode.
The Filters panel supports creation and editing of
parameters to be applied to the Export Report REST API export.
The Filters panel indicator reflects the number of filters
applied to the Export Report REST API export
as a superscript to the
New button to create a new filter to be logically
AND'ed together with other filters.
Each filter term's column, operator, and value information display
within the Filters panel with accompanying
Remove buttons. Multiple filter terms within the
same filter are logically OR'ed together. Multiple filters are logically
Click the hyperlinked table name within a filter term to focus the table within the Columns Panel.
Add OR term button to create a new term
to be logically OR'ed to the existing terms in the filter.
<pre_filter>s applied to the report
display as non-editable filters
with a lock icon instead of edit controls.
Clicking the close button closes the panel.
Drop down list of the
<table> elements available for filtration.
Drop down list of the table's
<column> elements available for filtration
based on the selected table.
Drop down list of the filter operators
available based on the selected
User supplied value for the filter if applicable for the selected operator.
<column>s with a child
the user will be able to select one or more of the pre-defined values from a select list.
Save button to persist the filter term but not apply the filter
criteria to the Results Preview.
Save button when creating multiple filters to prevent unnecessarily
refreshing the Results Preview. Then use the Results Preview
to refresh the preview after completing all filter configuration.
Save & Refresh to both persist the filter and refresh
the Results Preview.
The Results Preview displays a limited preview of the export results and contains controls to export the
report to any export
By default, the Results Preview displays the first 100 records within the exported report.
Refreshes the export results from the database.
The Refresh button turns dark blue to indicate that the current export results are stale due to the creation or editing of a filter or addition of a new column.
Toggles the Results Preview between table and map view.
The View mode buttons are only available if the
<report> may be exported
Displays the Structured Query Language (SQL) and query parameters to be used when creating the report export.
The export format select list displays the available export
parameter values. The
Export button exports the full report to a new browser window
in the chosen format.
Export button turns red and becomes disabled if the total number of results exceeds the configured
The export URL dialog button button reveals the Export Report REST API URL
and HTTP parameters to be used when the
Export button is clicked.
The pagination indicator and controls display the current page of export results with links to navigate to the previous and next page. The page size is 100 records.
The total number of results displays red if it exceeds the configured
Table cell headers are above adjacent columns within the same table. Re-position all columns under the header by dragging the table cell header to the left or right. Click the remove button to remove all columns under the header from the export results.
Column cell headers are above each column. Re-position a column by dragging the column cell header to the left or right.
Column cell headers display an ascending or descending indicator if the respective sort is applied to the column.
Click the Column cell header remove button to remove the column from the export results. Click the Column cell header menu button to display additional controls for column sorting, filtering, and positioning.
Column cell headers display a filter icon if the column is used within a filter.
The cross join indicator displays within a table cell header when the table contributes to a cross join in the report export. Cross joins happen when multiple tables in a to-many join relationship to the base table are included in the report export without a join condition.
Clicking the indicator button opens a dialog which explains the cross join and possible courses of action.
Reference documentation for how to configure the Report Creator embeddable client via HTTP query parameters in order to set the current report, filters, sort, and more.
The Pull Reports™ 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 Report Creator is embedded is
http://www.mycompany.com/reports/index.html, then a url structured
will load the
mycatalog and apply
@id > 100.
id to load.
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 offset of the Result Preview panel.
id to load.