8.10.6 Managing Classic Report Attributes

Edit report Attributes control how a classic report works.

• Editing Classic Report Attributes
  Customize a classic report by editing report Attributes.
• Updating Classic Report Appearance Attributes
  Change the appearance of a classic report by editing Appearance attributes.
• Editing Classic Report Pagination
  Edit classic report pagination.
• Adding Support for XML File or a CSV File Export
  Add support for exporting a report as an XML or CSV by selecting a report template.
• Enabling Classic Report CSV Output Option
  Enable classic report CSV output option.
• Controlling Classic Report Column Breaks
  Control classic report column breaks.

See Also:

Editing Pages in Page Designer

8.10.6.1 Editing Classic Report Attributes

Customize a classic report by editing report Attributes.

To edit report Attributes:

1. View the page in Page Designer:
   1. On the Workspace home page, click the App Builder icon.
   2. Select an application.
   3. Select a page.
   Page Designer appears.
2. In the Rendering tab, select the region containing the report.
3. In the Property Editor, select the Attributes tab.
   
   Description of the illustration pd_cl_rpt_att.png

   The Property Editor displays the report Attributes. Attributes are organized in groups.

   To find a group or attribute, enter keywords in the Filter Properties field. The Property Editor displays the group or attributes. Or, you can click Go to Group and select the group.

4. Edit the appropriate attributes.
5. To view Help, select the attribute and click the Help tab. Once you activate the Help pane, the content that displays changes every time you select another attribute.
6. To save your changes click Save. To save and run the page, click Save and Run Page.

8.10.6.2 Updating Classic Report Appearance Attributes

Change the appearance of a classic report by editing Appearance attributes.

To change the appearance of a classic 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. Under Appearance, edit the following:
   1. Template Type - Select template type o this report.
   2. Template - Select a report template to define the appearance and layout of this classic report.

      Report templates are defined in the application theme. When a classic report is created, the template is automatically set to the default report template defined in the current theme. Many themes contain classic report templates for displaying data in a table, key value pairs, search results, cards, and so forth.

      Note that some report templates, such as cards and search results, are "row based" and expect your SQL query to return a particular set of column aliases that are substituted in the template. The Universal Theme provides the following report templates:

      • Alerts - Displays any number of horizontal alerts or notifications on your page.
      • Badge List - Displays key value pairs in a dashboard-like user interface.
      • Cards - Displays report data in cards, or small blocks and is useful for presenting a variety of information. Cards can be heavily customized with Template Options.
      • Comments - Displays comments and other messages.
      • Content Row - Displays report data in a set of rows, with support for a selection column, icons, and actions. Suitable for most types of content.
      • Contextual Info - Displays simple key-value pairs one after the next. It uses the column headers as the labels and displays the associated column value next to each label.
      • Media List - Displays report content in a media list, with an icon, heading, description, and badge.
      • Search Results - Displays search-engine style search results.
      • Standard - This is the default report template for displaying data in a table and can be heavily customized with Template Options.
      • Timeline - Displays a timeline of actions. It is well suited for home pages, change logs, and other areas where an activity feed of recent actions is needed.
      • Value Attribute Pairs - Column - Displays key-value pairs for column-based queries. It uses the column header as the label for each item.
      • Value Attribute Pairs - Row - Displays key-value pairs for row-based queries. It uses the first column for labels, and second column for values.
   3. Template Options - Select template options to customize the user interface of this component.

      You can also modify the template options when running the application using Live Template Options. Live Template Options enable you to customize your application in real time.

      To learn more see Page Designer Help and Managing Template Options.

   4. CSS Classes - Enter additional space delimited CSS classes you want to add to your report. Your report template must include the #COMPONENT_CSS_CLASSES# substitution string.
   5. Show Null Values as - Enter the text you want to display for null columns.
5. To save your changes click Save. To save and run the page, click Save and Run Page.

8.10.6.3 Editing Classic Report Pagination

Edit classic report pagination.

To control classic report pagination:

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. Under Pagination, edit the following:
   1. Type - Select the pagination type for this report. Generally only a subset of the results are currently displayed in the report. Pagination provides the user with information about the number of rows and the current position within the result set. Pagination also defines the style of links or buttons that are used to navigate to the next or previous page.
   2. Display Position - Select where the report pagination displays.
   3. Partial Page Refresh - Specify whether to use Partial Page Refresh (PPR) to update the report display.
      If the end user performs an action, such as a pagination request or selection of a new sort column, the current report rows must be refreshed. Setting this attribute to On refreshes just the report region. Setting this attribute to No refreshes the entire page.
5. To save your changes click Save. To save and run the page, click Save and Run Page.

8.10.6.4 Adding Support for XML File or a CSV File Export

Add support for exporting a report as an XML or CSV by selecting a report template.

To export a report as a file:

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. Under Appearance, edit the following:
   1. Template Type - Select Predefined.
   2. Template - Select XML or CSV.

      Selecting XML prevents the APEX engine from rendering the page and dumps the content to an XML file.

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

8.10.6.5 Enabling Classic Report CSV Output Option

Enable classic report CSV output option.

To use the enable the CSV output option:

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. Under Download, edit the following:

   1. CSV Export Enabled - Specify whether end users can download the report contents to a CSV file. To enable CSV Downloads, you must use a report template with a #CSV_LINK# substitution string and set this option to On.

   2. CSV Separator - Enter a column separator. If no value is entered, a comma or semicolon is used depending on your current NLS settings.

   3. 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.

   4. Link Text - Specify the text for the link to invoke the CSV download.

   5. Filename - Specify a name for the CSV download file. If no name is specified, the region name is used followed by the extension *.csv.

   6. Supplemental Text - Enter text that displays at the top of the download file. Use this attribute to for 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.

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

8.10.6.6 Controlling Classic Report Column Breaks

Control classic report column breaks.

You can control if a specific column repeats and how column breaks appear when printed using Break Formatting attributes. For example, suppose your report displays employee information by department number. If multiple employees are members of the same department, you can increase the readability by specifying that the department number only appears once.

To control column breaks:

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. Under Break Formattingedit the following:
   1. Report Sum Label - Enter the text that displays adjacent to report sum values.
   2. Break Columns - Select how many report columns are incorporated into the break formatting. The columns must be consecutive columns, starting from the first column displayed in the report.
5. To save your changes click Save. To save and run the page, click Save and Run Page.