5 Managing Reports

Manage the reports in your reporting application by creating, editing, and linking reports based on the associated datasets.

• About Supported Reports
  Create reports on datasets associated with the reporting application.
• Report Examples
  View example reports.
• About the Data Reporter Developer Toolbar
  Learn about the Data Reporter Developer toolbar.
• Creating and Editing Reports
  Administrators or editors can create and edit reports on the Data Reporter Application home page.
• Understanding Report Publishing
  Reports must be published to be visible to Data Reporter users.
• Copying a Report
  Copy a report from the report detail page.
• Deleting a Report
  Delete a report from the report detail page.

5.1 About Supported Reports

Create reports on datasets associated with the reporting application.

The type of reports available depend on the tables and views in the associated datasets. Report types include:

• Interactive Report
• Faceted Search with List
• Faceted Search with Table

When an administrator creates a report, the report is unpublished and can only be viewed by administrators and editors. When administrator or editor creates a report, the report is unpublished and cannot be viewed by viewers. Once the report is ready, the administrator or editor publishes the report. The report is then available to reporting application users.

5.2 Report Examples

View example reports.

The following examples are based on the Project Data sample dataset. For information on installing sample datasets, see Using Sample Datasets in Oracle APEX SQL Workshop Guide.

• Example Interactive Report
  View an interactive report based on the EBA_PROJECTS table.
• Example Faceted Search with Table
  View a faceted search with table based on the EBA_PROJECT_TASKS table.
• Example Faceted Search with List
  View a faceted search with list based on the EBA_PROJECT_TASKS table.
• Example Drill Down
  View a faceted search with list from an interactive report using a Drill Down.

5.2.1 Example Interactive Report

View an interactive report based on the EBA_PROJECTS table.

Users can customize how and what data displays. By default, interactive reports include a search bar, an Actions menu (), column heading menus, and a View Row Detail icon in the first column of each row. Using options on the Actions menu, users can alter the report layout by hiding or exposing specific columns and applying filters and alter the format by creating control breaks, adding highlighting, and determing the number of rows that display on each page. They can also create aggregations, charts, group bys, and add their own computations. Once customized, the report can be saved as either a private or public report.

Description of the illustration dr_eg_ir.png

5.2.2 Example Faceted Search with Table

View a faceted search with table based on the EBA_PROJECT_TASKS table.

The following example features a faceted Search region and report. The Search region displays on the left side of the page and enables users to narrow down the search result by selecting facet values. Narrowing the search result, makes it easier for users to find the data they want. The right side of the page features a Search Results region which can display as a classic report.

This example is built on the EBA_PROJECT_TASKS table. In this example the Assignee, Bernard Jackman, is selected and the report displays 13 rows. The cursor is positioned over the Add Filter. Selecting Add Filter displays Add Filter dialog.

Description of the illustration dr_eg_faceted_table.png

5.2.3 Example Faceted Search with List

View a faceted search with list based on the EBA_PROJECT_TASKS table.

The following example features a faceted Search region and list. The Search region displays on the left side of the page and enables users to narrow down the search result by selecting facet values. Narrowing the search result, makes it easier for users to find the data they want. The right side of the page features a Search Results region displayed as a list.

This example is built on the EBA_PROJECT_TASKS table. In this example, the total row count is 13.

Description of the illustration dr_eg_faceted_list.png

5.2.4 Example Drill Down

View a faceted search with list from an interactive report using a Drill Down.

You can use Drill Down functionality to connect two reports together. The following example shows an interactive report built on EBA_PROJECTS_V. The Tasks column features a drilldown links to another report.

Description of the illustration dr_eg_drilldown.png

5.3 About the Data Reporter Developer Toolbar

Learn about the Data Reporter Developer toolbar.

When you run a reporting application and preview a report, the Data Reporter Developer toolbar appears. The Data Reporter Developer toolbar contains tools for editing the reporting application or the current report page.

Description of the illustration dp_toolbar.png

The Data Reporter Developer toolbar contains three controls:

• Home - Links to the home page. The home page that displays depends upon the user's Account Privileges.

• App XX (where XX is the app ID) - Links to the Data Reporter Application home page.

• Page XX (where XX is the page number) - Links to the Report Details page when previewing a report, or the Reporting Application Home page if you are previewing the Reporting Application home. Click the page ID.

5.4 Creating and Editing Reports

Administrators or editors can create and edit reports on the Data Reporter Application home page.

• About Creating and Editing Reports
  Learn about creating reports from datasets.
• Creating an Interactive Report
  Create an interactive report from the Data Reporter home page.
• Editing an Interactive Report
  Edit an interactive report from the Report Details page.
• Creating a Faceted Search with Table
  Create a faceted search with table from the Data Reporter home page.
• Editing a Faceted Search with Table
  Edit a faceted search with table from the Report Details page.
• Creating a Faceted Search with List
  Create a faceted search with list from the Data Reporter home page.
• Editing a Faceted Search with List
  Edit a faceted search with list from the Report Details page.
• Adding a Drilldown
  Add a drilldown by editing a report to link to another report.

5.4.1 About Creating and Editing Reports

Learn about creating reports from datasets.

You must be a Data Reporter administrator or editor to create reports. By default, reports are unpublished. You must publish a report so that it is visible to Data Reporter viewers.

When you create a report, you choose between different types of reports:

• Interactive Report
• Faceted Search with Table
• Faceted Search with List

For more information on report types, see Managing Faceted Search and Managing Interactive Reports in Oracle APEX App Builder User’s Guide.

Only a Data Reporter administrator or editor can edit reports. If the report is unpublished, you can edit the report directly. If the report is published, you create a draft and edit that draft without affecting users accessing the published version of the report.

When you publish the edited report, the changes overwrite the currently published report.

5.4.2 Creating an Interactive Report

Create an interactive report from the Data Reporter home page.

The data reporting application must have a dataset. For this example, the dataset used is based on the Projects Sample Dataset.

1. From the Data Reporter home page, select the reporting application.
2. Select Create Report.
3. Enter the Name of the report. For example, Projects - Interactive Report.
4. Select Interactive Report and select Next.
5. Define the Report Source:
   • Table or View - Select the table or view the report is based on.
   • SQL Query - Enter a custom SQL Query for the report.
   For this example, use the EBA_PROJECTS view.
6. Select Create Report.
   The Report Details screen opens, showing high-level details about the report.

5.4.3 Editing an Interactive Report

Edit an interactive report from the Report Details page.

1. From the Data Reporter home page, select the reporting application.
2. Select an interactive report.
3. To edit Report Details:
   1. From the Actions menu, select Edit Details:
   2. Description - A description of the application.

      Note:

      When AI is enabled, select Generate Description to add a description using the details associated with the objects and columns in the dataset.
   3. Tags - Enter custom tags to help identify the report. For more information, see item-level help.
   4. Generative AI, Natural Language Support - Displays if Generative AI is enabled for the reporting application.

      Specify whether users can interact with this report using natural language prompts (for example, Show me projects that cost of greater than $10,000.). When enabled, APEX uses AI to interpret user intent and apply relevant filters, sorting, or other report settings.

   5. Select Apply Changes.
4. Select Apply Changes.
5. To convert the report to a SQL Query, select Convert to SQL Query and then Convert.

   Tip:

   Once the report is converted to a SQL Query, it cannot be converted back.
6. Under Columns - Select Edit to edit specific columns in the report:
   • Label - Edit the label that displays in the report.
   • Display - Select whether to display the column as part of the report at runtime.
   • Enable Sorting - Select whether to allow the column to be sortable in the report at runtime.
   • Enable Filtering - Select whether to allow the column to be used for filtering the report at runtime.
   • Value Identifies Row - Define the column, or combination of columns used to identify the row of data. For example for person data. this could be the first and last name. For customer data, this could be the customer name, and so on.

     Defining this attribute is very important for the usability of the report for users of assistive technologies like screen readers. When a screen reader user navigates to different rows of the report, the column or columns defined as identifying the row will be announced as the row header, as soon as they move to the new row. If this is not defined, it is much harder for these users to orientate themselves when moving around the report.

     Note:

     This value will be automatically set according to how it's set in the underlying dataset, but can be overridden if required.
   • Enable Drill Down - Select whether to use the column values to drill down into another report. The drilldown report will be filtered by the selected column value.
7. Select Apply Changes.
8. Descriptors - Descriptors are typically one-line sentences that provide concise, meaningful metadata that enhances semantic search accuracy by supplying context, key terms, and relevant details. Well-crafted descriptors help the search engine understand user intent, disambiguate similar items, and match queries to the most relevant content, making it easier for users to discover and access the information they need. To add a descriptor:
   1. Select Add Descriptor.
   2. Report Descriptor - Enter a descriptor for this report.

      Good descriptors clearly state purpose, include relevant keywords that users might search for and highlight important features. Use natural language and keep the descriptor brief to maximize clarity and searchability.

   3. Select Create or Create and Create Another.
9. To view the report, select Run.

5.4.4 Creating a Faceted Search with Table

Create a faceted search with table from the Data Reporter home page.

The data reporting application must have a dataset. For this example, the dataset used is based on the Projects Sample Dataset.

1. From the Data Reporter Home page, select the reporting application.
2. Select Create Report.
3. Enter the Name of the report. For example, Tasks - Faceted Search with Table.
4. Select Faceted Search with Table and select Next..
5. Define the Report Source:
   • Table or View - Select the table or view the report is based on.
   • SQL Query - Enter a custom SQL Query for the report.
   For this example, use the EBA_PROJECTS_TASKS table.
6. Select Create Report.
   The Report Details screen opens, showing high-level details about the report.

5.4.5 Editing a Faceted Search with Table

Edit a faceted search with table from the Report Details page.

1. From the Data Reporter Home page, select the reporting application.
2. Select a Faceted Search with Table report.
3. To edit Report Details:
   1. From the Actions menu, select Edit Details:
   2. Description - A description of the application.

      Note:

      When AI is enabled, select Generate Description to add a description using the details associated with the objects and columns in the dataset.
   3. Tags - Enter custom tags to help identify the report. For more information, see item-level help.
   4. Select Apply Changes.
4. To convert the report to a SQL Query, select Convert to SQL Query, and then Convert.

   Tip:

   Once the report is converted to a SQL Query, it cannot be converted back.
5. Under Facets and Columns, select Edit to edit specific columns in the report:

   Attributes change based on the column type. Common attributes include:

   • Label - Edit the label that displays in the report.
   • Format Mask - Select a format mask from the list.
   • Display - Select whether to display the column as part of the report at runtime.
   • Enable Sorting - Select whether to allow the column to be sortable in the report at runtime.
   • Value Identifies Row - Define the column, or combination of columns used to identify the row of data. For example for person data. this could be the first and last name. For customer data, this could be the customer name, and so on.

     Defining this attribute is very important for the usability of the report for users of assistive technologies like screen readers. When a screen reader user navigates to different rows of the report, the column or columns defined as identifying the row will be announced as the row header, as soon as they move to the new row. If this is not defined, it is much harder for these users to orientate themselves when moving around the report.

     Note:

     This value will be automatically set according to how it's set in the underlying dataset, but can be overridden if required.
   • Facet Configuration:
     • Enable Facet - Enables users to sort the report based on this column.
     • Facet Label - The display label for the facet.
     • Facet Sequence - The sequence for the facet.
     • Facet Type - Select the facet type.
     • Facet Display - Select Inline or Add Filter Dialog. For more information, see item-level help.
   • Enable Drill Down - Select whether to use the column values to drill down into another report. The drilldown report will be filtered by the selected column value.
6. Select Apply Changes.
7. Descriptors - Descriptors are typically one-line sentences that provide concise, meaningful metadata that enhances semantic search accuracy by supplying context, key terms, and relevant details. Well-crafted descriptors help the search engine understand user intent, disambiguate similar items, and match queries to the most relevant content, making it easier for users to discover and access the information they need. To add a descriptor:
   1. Select Add Descriptor.
   2. Report Descriptor - Enter a descriptor for this report.

      Good descriptors clearly state purpose, include relevant keywords that users might search for and highlight important features. Use natural language and keep the descriptor brief to maximize clarity and searchability.

   3. Select Create or Create and Create Another.
8. To view the report, select Run.

5.4.6 Creating a Faceted Search with List

Create a faceted search with list from the Data Reporter home page.

The data reporting application must have a dataset. For this example, the dataset used is based on the Projects Sample Dataset.

1. From the Data Reporter Home page, select the reporting application.
2. Select Create Report.
3. Enter the Name of the report. For example, Milestones - Faceted Search with List.
4. Select Faceted Search with List.
5. Define the Report Source:
   • Table or View - Select the table or view the report is based on.
   • SQL Query - Enter a custom SQL Query for the report.
   For this example, use the EBA_PROJECT_MILESTONES table.
6. Select Next.
7. Configure Display Options and Facets:
   • Title - Select NAME.
   • Description - Select DESCRIPTION.
   • Overline - Select DUE_DATE.
   • Miscellaneous - Select UPDATED_BY.
   • Order By Column - Select PROJECT_ID.
8. Select Create Report.
   The Report Details screen opens, showing high-level details about the report.

5.4.7 Editing a Faceted Search with List

Edit a faceted search with list from the Report Details page.

1. From the Data Reporter Home page, select the reporting application.
2. Select a Faceted Search with List report.
3. To edit Report Details:
   1. From the Actions menu, select Edit Details:
   2. Description - A description of the application.

      Note:

      When AI is enabled, select Generate Description to add a description using the details associated with the objects and columns in the dataset.
   3. Tags - Enter custom tags to help identify the report. For more information, see item-level help.
   4. Select Apply Changes.
4. To convert the report to a SQL Query, select Convert to SQL Query, and then Convert.

   Tip:

   Once the report is converted to a SQL Query, it cannot be converted back.
5. Under Configuration, select Edit to edit the list report attributes:
   1. Overline Text
   2. Primary Text
   3. Secondary Text
   4. Meta Text
   5. Visual Type
   6. Badge Position
   7. Select Apply Changes.
6. Under Facets and Columns, select Edit to edit specific columns in the report.

   Attributes change based on the column type. Common attributes include:

   • Format Mask - Optionally select a format mask from the list. Format masks should only be applied to columns with NUMBER or DATE data types. Otherwise, a runtime error is raised when the component contains a value that can not be converted using the specified format mask.
   • Facet Configuration:
     • Enable Facet - Enables users to sort the report based on this column.
     • Facet Label - The display label for the facet.
     • Facet Sequence - The sequence for the facet.
     • Facet Type - Select the facet type.
     • Facet Display - Select Inline or Add Filter Dialog. For more information, see item-level help.
   • Sort Configuration:
     • Enable Sorting - Select whether to allow the column to be sortable in the report at runtime.
     • Sort Label - The display label for the sort.
     • Direction - The default direction for the Order By clause.
     • Null Sorting - The default position for NULL values.
     • Sort Sequence - The sequence for the sort.
7. Select Apply Changes.
8. Descriptors - Descriptors are typically one-line sentences that provide concise, meaningful metadata that enhances semantic search accuracy by supplying context, key terms, and relevant details. Well-crafted descriptors help the search engine understand user intent, disambiguate similar items, and match queries to the most relevant content, making it easier for users to discover and access the information they need. To add a descriptor:
   1. Select Add Descriptor.
   2. Report Descriptor - Enter a descriptor for this report.

      Good descriptors clearly state purpose, include relevant keywords that users might search for and highlight important features. Use natural language and keep the descriptor brief to maximize clarity and searchability.

   3. Select Create or Create and Create Another.
9. To view the report, select Run.

5.4.8 Adding a Drilldown

Add a drilldown by editing a report to link to another report.

1. From the Data Reporter Home page, select the reporting application.
2. Select a report to contain a drilldown.
3. Under Facets and Columns, select Edit:
   1. Enable Drill Down - Select to use the column values to drill down into another report. The drilldown report is filtered by the selected column value.
   2. Target Report - The target report the column navigates to.
   3. Target Column - The column from the target report to filter by.
   4. Source Column - The column in this report to pass as the filter value.
4. Select Apply Changes.
5. To view the report, select Run.

5.5 Understanding Report Publishing

Reports must be published to be visible to Data Reporter users.

• About Publishing
  Learn about report publishing.
• Publishing a Report
  Publish a report from the Report Details page.
• Unpublishing a Report
  Unpublish a report from the report details page.
• Creating and Publishing a Draft
  Create a draft by editing a published report.

5.5.1 About Publishing

Learn about report publishing.

In order to publish or unpublish specific reports, you must be a Data Reporter Editor or a Data Reporter Administrator. When reports are unpublished, they cannot be viewed by Data Reporter Viewers.

Only one version of a published report may be published at any given time. When you edit an existing report, the changes are not visible to viewers until you publish the changes, and the viewers continue to see the last published version of the report. When you unpublish a report, the report is no longer available to viewers at all.

You can see whether a report is published or unpublished by viewing the reporting application home page. The status of each report is listed under the status column as either Published or Unpublished.

5.5.2 Publishing a Report

Publish a report from the Report Details page.

To publish a report:

1. From the Data Reporter Home page, select the reporting application.
2. Select the desired report.
3. Confirm the details of the report are correct.

   Tip:

   Preview the report by selecting Run.
4. Select Publish.
5. Select Publish to confirm.

The report is now visible to all users with access to the reporting application.

Tip:

You can also publish reports from the reporting application home page by using the Actions menu.

5.5.3 Unpublishing a Report

Unpublish a report from the report details page.

To unpublish a report:

1. From the Data Reporter Home page, select the reporting application.
2. Select the desired report.
3. From the Actions menu, select Unpublish.

The report is unpublished, and no longer visible to viewers.

Tip:

You can also publish reports from the reporting application home page by using the Actions menu.

5.5.4 Creating and Publishing a Draft

Create a draft by editing a published report.

To create a report draft:

1. From the Data Reporter Home page, select the reporting application.
2. Select the desired report.

   Tip:

   In order to create a draft, the report you select must be Published.
3. Select Edit Report.
4. Select Create Draft.
   The report is now in Draft status, as indicated by the label beside the report title.
5. Make the desired edits to the report.

To discard the draft:

6. From the Actions menu, select Discard Draft.
7. Select Discard Draft to confirm.
   The current draft is deleted, and unpublished changes are lost. The report reverts to the last published version.

To publish the draft:

8. Confirm the details of the report draft are correct.

   Tip:

   Preview the report by selecting Run.
9. Select Publish Draft.
10. If you are deleting user's saved reports, toggle the Delete User's Saved Reports attribute.
11. Select Publish Draft to publish the draft and make it available to users.

The revised report is now visible to all users with access to the reporting application.

5.6 Copying a Report

Copy a report from the report detail page.

To copy a report:

1. From the Data Reporter home page, select the reporting application.
2. Select the desired report.
3. From the Actions menu, select Copy.
4. Specify the New Report Name.
5. Select Copy Report.

The report is copied, and the report details page is visible. From here, you can publish the copied report or make additional changes.

5.7 Deleting a Report

Delete a report from the report detail page.

To delete a report:

1. From the Data Reporter home page, select the reporting application.
2. Select the desired report.
3. From the Actions menu, select Delete.
4. Select Delete Report to confirm.

The report is deleted, and any associated users, drafts, or saved reports are lost.