8.9.6.5 Configuring Interactive Report Download Options

Configure interactive report download options available on the Actions menu..

The Download option on the Actions menu enables users to download an interactive report as a comma-delimited file (CSV) format, HTML, Microsoft Excel (XLSX) format, Adobe Portable Document Format (PDF), or as one of the formats attached to an email.

WARNING:

Downloads may also take considerable time to complete for large data sets.

Note:

The Pivot view does not support the PDF download format even if it is enabled and report server is configured.

8.9.6.5.1 Configuring Interactive Report Download Formats

Configure interactive report download options.

Tip:

Email is only available to authenticated users, and requires the SMTP Server to be configured within Oracle APEX Administration Services application (Administration Services), by an Instance Administrator.

To configure download formats:

  1. View the page in Page Designer:
    Page Designer appears.
  2. In the Rendering tab, select the region containing the report.
  3. In the Property Editor, select the Attributes tab.
    The Property Editor displays the attributes. Attributes are organized in groups
  4. Search Bar, Include Search Bar - Select On.
  5. Actions Menu, Download - Select On.

    Tip:

    Setting Download to Off prevents the Download menu from displaying on the Actions menu. To fully prevent users from downloading data, deselect all Download Formats described in the next step.

  6. Under Download:
    1. Download, Authorization - Select an authorization scheme to restrict who can download. To enable an end user to download, this authorization scheme must evaluate to TRUE for that user.

      If no authorization scheme is provided then any user may download.

    2. Download, Download Formats - Select the download formats users can utilize to download the currently displayed columns. Options include:
      • CSV
      • HTML
      • Excel
      • PDF

      Tip:

      The Download attributes only appear on the Actions menu if you select a file format under Download Formats. If a report server has not been defined within Instance Administration then certain options do not display. To learn more, see Configuring Report Printing in a Full Development Environment in Oracle APEX Administration Guide.

    3. Send as Email - Specify whether end users can send an email, with the report download included as an attachment.

      Email is only available to authenticated users, and requires the SMTP to be configured within APEX Administration Services application by an Instance Administrator.

    4. CSV Separator - Enter a column separator. If no value is entered, a comma or semicolon is used depending on your current NLS settings.
    5. CSV Enclosed By - Enter a delimiter character to delineate the starting and ending boundary of a data value. The default delimiter is double quotation marks.
    6. Filename - Enter the filename for the document when downloaded. Do not specify a file extension. The extension is added automatically. If you leave this attribute blank, the region name is used as the file name.
    7. Supplemental Text - Enter text that appears at the top of the download files. You can enter data classification, legal or warning messages about the data in the file.

      WARNING:

      Do not use the Supplemental Text attribute with CSV download. If you enable CSV download, the defined text will invalidate the CSV file format.

  7. To save your changes click Save. To save and run the page, click Save and Run Page.

8.9.6.5.2 Enabling Interactive Report CSV Download

Enable the Enable CSV download in an interactive report.

To enable support for CSV download, you must first enable Automatic CSV Encoding on the Edit Globalization Attributes page. See Accessing the Globalization Page and Automatic CSV Encoding.

To enable the Enable CSV download in an interactive report:

  1. View the page in Page Designer:
    Page Designer appears.
  2. In the Rendering tab, select the region containing the report.
  3. In the Property Editor, select the Attributes tab.
    The Property Editor displays the attributes. Attributes are organized in groups
  4. Search Bar, Include Search Bar - Select On.
  5. Actions Menu, Download - Select On.

    Tip:

    Setting Download to Off prevents the Download menu from displaying on the Actions menu. To fully prevent users from downloading data, deselect all Download Formats described in the next step.

  6. Under Download:
    1. Download Formats - Select CSV.

      Tip:

      The Download option only appears on the Actions menu if a file format is selected.

    2. CSV Separator - (CSV only) Define the column separator. If no value is entered, a comma or semicolon is used depending on your current NLS settings.
    3. CSV Enclosed By - (CSV only) Enter a delimiter character. This character delineates the starting and ending boundary of a data value. Default delimiter is double quotation marks (" ").
    4. Filename - Enter a name for the downloaded document. Do not specify a file extension, the extension is added automatically. If you leave this blank, the region name is used as the file name.

      WARNING:

      Do not use the Supplemental Text attribute with CSV download. If you enable CSV download, the defined text will invalidate the CSV file format.

  7. To save your changes click Save. To save and run the page, click Save and Run Page.

8.9.6.5.3 Enabling Interactive Report Email Download

Enable interactive report email download.

Tip:

Email is only available to authenticated users, and requires the SMTP to be configured within APEX Administration Services application (Administration Services), by an Instance Administrator.

Interactive reports support email of all formats except Word (RTF). Note this only applies to Download dialog, not the Subscription dialog.

Tip:

Email download is only supported on authenticated pages. If you enable Email download on a public page, the Email download option does not display in Download dialog.

To enable support for email download, an APEX administrator must configure email at the Instance level. See Configuring Mail in Oracle APEX Administration Guide.

To enable email download:

  1. View the page in Page Designer:
    Page Designer appears.
  2. In the Rendering tab, select the region containing the report.
  3. In the Property Editor, select the Attributes tab.
    The Property Editor displays the attributes. Attributes are organized in groups.
  4. Search Bar, Include Search Bar - Select On.
  5. Actions Menu, Download - Select On.

    Tip:

    Setting Download to Off prevents the Download menu from displaying on the Actions menu. To fully prevent users from downloading data, deselect all Download Formats described in the next step.

  6. Under Download:
    1. Send as Email - Specifies whether end users can send an email, with the report download included as an attachment. Enable Send as Email.

      Tip:

      The Download attributes only appear on the Actions menu if you select a file format under Download Formats.

    2. Filename - Enter a name for the downloaded document. Do not specify a file extension, the extension is added automatically. If you leave this blank, the region name is used as the file name.
    3. Supplemental Text - Enter text that displays at the top of the download files. You can enter data classification, legal, or warning messages about the data in the file.

      WARNING:

      Do not use the Supplemental Text attribute with CSV download. If you enable CSV download, the defined text will invalidate the CSV file format.

  7. To save your changes click Save. To save and run the page, click Save and Run Page.

    Note:

    Email sent from an Email Download contains a system generated email signature identifying who sent the email. This signature cannot be removed.