AX1828

Using the Report Builder

Using the Report Builder, you can create and edit web reports using a drag-and-drop interface. Web reports are intended to be intuitive for report builders to create and easy for report viewers to use.

Web reports support two different ways to display reporting data in a grid:

  • Dynamic rows: Dynamically display data rows based on a specified dimension or grouping.
  • Fixed rows: Use predefined fixed row structures to organize data rows into sections with headers, totals, and subtotals.

The Report Builder opens when you do either of the following:

Overview of the Report Builder

The Report Builder is organized into three tabs:

  • Build: Use this tab to design the report data and configure report properties. This is the default tab.
  • Parameters: Use this tab to enable and configure interactivity for the report. Report users can dynamically change the data that displays in the report using report parameters.
  • Filters: Use this tab to define report-level filters, to limit the data shown in the report.

In the Build tab, the Report Builder has three main areas:

  • The Data Panel on the left side is where you select the data to include in your report.

  • The Report Canvas in the middle is where you build the report. Columns can be dragged and dropped from the Data Panel to the Report Canvas. You can also create calculations to display in the report columns, and define column groups.

  • The Configuration Panel on the right side is where you define properties for the report, the data grid, and the individual columns. You can configure properties such as report titles, drilling options, and column formatting.

Overview of the Report Builder

As you build and configure the report, a preview of the grid displays in the Report Canvas area. Several options are available to control how data is shown in this grid. For more information, see Changing data display options for the Report Builder.

Building a report in the Report Builder

The following is an overview of how to build a report in the Report Builder:

  • Define a data context: Each report must have a specified primary table to determine the data context for the report. Once the data context is defined, you can build the report using columns from the primary table and from related tables.

  • Define report titles: You can define report title text and an optional report description.

  • Define the grid rows: Web reports can use dynamically generated rows based on a dimension, or they can use a fixed row structure. Do one of the following depending on the type of report that you want to make:

  • Add data columns and calculated columns: Drag and drop table columns out to the grid to define the data columns for the report, and define calculated columns as needed. You can also define column groups to create grouped headers in the report.

  • Configure grid properties: Configure grid properties such as the total row and user interaction options, including enabling and configuring drilling options as needed. You can also adjust the default formats for various column types.

  • Configure column properties: Configure properties for each column such as alignment, width, number format, and column filters.

  • Define report filters: You can define general and table-specific filters to limit the data shown in the report grid.

  • Define report parameters: You can optionally create and configure report parameters to allow end users to dynamically change the data shown in the report.

Changing data display options for the Report Builder

As you build and configure the report, a sample of the grid data displays in the Report Canvas area. You can choose how data displays in the sample grid as you build the report.

NOTE: The sample grid is intended to give you an idea of how the report data will display to report viewers, but it is not intended to be an exact representation of the final report. To see the report as it will appear to report viewers, use the Preview feature.

To change how data displays in the Report Builder:

  1. On the Build tab of the Report Builder, click the gear button at the top of the page to load the Report Configuration properties.

  2. Select one of the following options for Report data:

    • Live data with manual refresh (default): Live data is shown in the grid, however, you must manually refresh the data after making configuration changes that affect the data shown. This is for performance reasons, so that you do not have to wait for data queries to complete in order to continue working on your report. When using this option, data updates are handled as follows:

      • If you add a new column, or make a configuration change that would affect the data shown in the column, the column will be blank. To populate the grid for data in this column, click the Refresh Data button.

      • If you make a configuration change that would affect the data shown in the entire grid, the grid will be blank. To populate the grid with the current data, click the Refresh Data button.

      The Refresh Data button is only available when using this option.

    • Live data with automatic refresh: Live data is shown in the grid, and the data automatically updates after you make any configuration changes. Generally speaking, this option should only be used when the report queries a small set of data so that updates will be quick, or when you do not expect to be making many configuration changes that affect data.

    • Mock data: Mock data is shown in the grid. When using this option, you can get a basic idea of how the report columns and format will display to the user, without viewing actual data. This is a good option if you do not need to made configuration changes that affect the data, or if you do not need to view the data while you are making these changes.

Data display options for the Report Builder

Even if you are viewing live data, keep in mind that the grid shown in the Report Canvas is simply meant as a guide to help you build the report—it is not intended to be a fully functional representation of the report. If you want to see how the report will display to report viewers, click the Preview button.

NOTE: The Report data option is not saved in the report, and your selection is not saved for future Report Builder sessions. Every Report Builder session defaults to using live data with manual refresh.

Previewing a report

The sample grid in the Report Canvas accurately reflects some report configuration details such as column headers and number format. However, other configuration details are not reflected in the sample grid. For example:

  • Column width may not be accurately reflected in the sample grid. Initially, the grid will expand to fit the available space. Once there are enough columns to fill the space, the column width will be honored.

  • The sample grid only shows up to ten rows of data (when using dynamic rows) and does not display paging options.

  • Drilling options are not available in the sample grid.

  • Report viewer options to sort and filter column data are not available in the sample grid

  • Report parameters cannot be used on the sample grid.

If you want to see how the report will display to end users in the report viewer, including all user interaction options for the report, click the Preview button at the top of the Report Builder.

The report preview opens in a separate dialog that overlays the Report Builder. Using this preview, you can view the report data and try out end-user features like sorting, filtering, and drilling the report. When you are done viewing the preview, click Close at the bottom of the dialog to return to the Report Builder (or click the X in the top right corner).

The report preview does have a few limitations. Export and share options are not available in the report preview. Additionally, if hyperlinks are used in the report, the hyperlinks will always open in a new tab, even if they are configured to open in the same tab—this is done so that clicking a hyperlink will not close the Report Builder.

Saving a report

Use the Save button at the top of the Report Builder to save the report. If the report is a brand new report, you will be prompted to define a name and folder location for the report. Otherwise, the existing report is saved.

If you have opened an existing report for editing and you want to save a copy of it with a new name, click the down arrow to the right of the Save button and select Save As.

Save button with Save As option

NOTE: The Create Web Reports security permission is required in order to use Save As.

If you have made changes to the report but have not yet saved, you will be prompted to save when you attempt to close the browser tab or navigate to a new location.