10.4 Editing Interactive Reports in Page Designer

10.4.5.1 Interactive Report Search Bar

All interactive reports include search bar at the top of the page which includes the following controls: a Select columns to search icon, Text area, Go button, and Actions menu.

You can remove or customize the search bar by configuring report attributes in the Property Editor.

10.4.5.2 Customizing the Search Bar in Page Designer

To customize the search bar:

1. View the attributes for the report. See "Editing Interactive Report Attributes in Page Designer."

   The Attributes display in the Property Editor.

2. Locate and expand Search Bar.

   
   Description of the illustration ''pd_ir_search_att.png''
   
   

3. Configure the options under Search Bar. To learn more about an attribute, select the attribute and click the Help tab.

   Table 10-4 describes the Search Bar attributes.

   Table 10-4 Property Editor Search Bar Attributes

   Attribute	Description
   Include Search Bar	Select Yes or No. Selecting No removes the Search bar.
   Search Field	Displays a text field in the search bar in which to enter search criteria. Select Yes or No.
   Finder Drop Down	Enables users to search on a selected column or against all columns. Select Yes or No. Within the interactive report, this option is identified as Select columns to search.
   Reports Select List	Displays report select list if the report has alternative default, shared report or personal report. Select Yes or No. See Also: "Saving Interactive Reports".
   Rows Per Page Selector	Specify whether a separate drop down row selector is included within the search bar. Select Yes or No. See Also: "Saving Interactive Reports".
   Search Button Label	Specify the text to use as search button label.
   Maximum Rows Per Page	Enter the maximum number to display in the Rows Per Page Selector.

   
   

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

10.4.5.3 Removing the Search Bar in Page Designer

To remove the search bar from in interactive report:

1. View the attributes for the report. See "Editing Interactive Report Attributes in Page Designer."

   The Attributes page displays in the Property Editor.

2. Locate and expand Search Bar.

3. For Include Search Bar, select No.

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

10.4.6.1 Interactive Report Action Menu

The Actions menu appears to the right of the Go button on the Search bar. End users can use this menu to customize an interactive report.

You can remove or customize the Actions menu by configuring report attributes in the Property Editor.

10.4.6.2 Customizing the Action Menu in Page Designer

To customize the Action menu:

1. View the attributes for the report. See "Editing Interactive Report Attributes in Page Designer."

   The Attributes page displays in the Property Editor.

2. Locate and expand Actions Menu.

   
   Description of the illustration ''pd_ir_action_att.png''
   
   

3. Configure the options under Action Menu by selecting Yes or No.

   Tip:

   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.

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

10.4.6.3 Configuring Actions Menu Download Options in Page Designer

You can configure a Download option to the Actions menu to enable users to download an interactive report as a comma-delimited file (CSV) format, HTML, Microsoft Excel (XLS) format, Adobe Portable Document Format (PDF), Microsoft Word Rich Text Format (RTF), or as HTML attached to an email.

• Enabling Download Formats

• Enabling CSV Download

• Enabling Email Download

10.4.7.1 Linking to a Single Row View

To link to a single row view:

1. View the attributes for the report. See "Editing Interactive Report Attributes in Page Designer."

   The Attributes page displays in the Property Editor.

2. Configure Link attributes:

   1. Locate and expand Link.

   2. Link Column - Select Link to Single Row View.

   3. Uniquely Identify Rows by - Select ROWID or Unique Column.

      If you select, Unique Column, specify the column in the Unique Column field.

   4. Link Icon - Accept the default or specify the path to another icon.

   5. Link Attributes - Optionally specify additional column link attributes to be included in the <a href= > tag (for example, a link target, classes, or styles).

   6. Authorization Scheme - Select an authorization scheme to associate with the Link Column. This authorization scheme must evaluate to TRUE in order for the Link Column to be rendered in the report.

   7. Condition Type - Select a condition type from the list that must be met in order for this link to be rendered.

3. Configure Single Row View attributes:

   1. Locate and expand Single Row View.

   2. Exclude Null Values - Specify whether null columns are hidden on the Single Record View.

   3. Only Displayed Columns - Specify whether only those columns currently displayed are displayed in the Single Record View. If you specify No then hidden report columns may also be shown on the Single Record View.

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

10.4.7.2 Linking to a Specific Page

To link to a specific page:

1. View the attributes for the report. See "Editing Interactive Report Attributes in Page Designer."

   The Attributes page displays in the Property Editor.

2. Under Link:

   1. Link Column - Select Link to Custom Target.

   2. Target -

      • Click the Target field.

        The Link Builder - Target dialog appears.

      • Target Type - Select Page in this Application.

      • Page - Select the target page number.

      • Set Items - Select a Name and Value to specify session state for an item.

      • Clear Cache - Specify the page numbers on which to clear cache. To specify multiple page, enter a comma-delimited list of page numbers. See "Linking to Interactive Reports."

      • Request - Specify the request to be used.

      • To reset the pagination for this page, select Yes for Reset Pagination.

      • Click OK.

   3. Link Icon - Accept the default or specify another image.

   4. Link Attributes (Optional) - Specify additional column link attributes to be included in the <a href= > tag (for example, a link target, classes, or styles).

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

10.4.7.3 Linking to a URL

To link to a URL:

1. View the attributes for the report. See "Editing Interactive Report Attributes in Page Designer."

   The Attributes page displays in the Property Editor.

2. Configure the Link attributes:

   1. Locate and expand Link.

   2. Link Column - Select Link to Custom Target.

   3. Configure the Target:

      • Click the Target field.

        The Link Builder - Target dialog appears.

      • Target Type - Select URL.

      • URL - Enter the appropriate address.

      • Click OK.

   4. Link Icon - Accept the default or specify another image.

   5. Link Attributes (Optional) - Specify additional column link attributes to be included in the <a href= > tag (for example, a link target, classes, or styles).

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

10.4.7.4 Excluding a Link Column

To exclude a column link:

1. View the attributes for the report. See "Editing Interactive Report Attributes in Page Designer."

   The Attributes page displays in the Property Editor.

2. Locate and expand Link.

3. Configure the Link attributes:

   1. Locate and expand Link.

   2. For Link Column, select Exclude Link Column.

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

10.4.11.1 Adding a View Icon Button

To add Icon view to an interactive report:

1. View the attributes for the report. See "Editing Interactive Report Attributes in Page Designer."

   The Attributes page displays in the Property Editor.

2. Locate and expand Icon View.

3. Configure Icon View attributes:

   Tip:

   To view examples, see field-level Help.

   1. Enabled - Select Yes.

   2. Custom Icon View - Specify whether you wish to define a custom link for the Icon View. Select Yes or No. See "Adding a Custom Icon View Link."

   3. Columns Per Row - Select the number of icons to display per row in Icon View. A value of 5 displays 5 icons per row of the report.

   4. Link Column - Select the column that returns the link target of the icon.

   5. Image Source Column - Identify the column that returns the image source.

   6. Label Column - Select the column that returns the image label.

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

10.4.11.2 Adding a Custom Icon View Link

A custom Icon View link provides greater flexibility in defining the content of the Icon View, including the ability to utilize more than one column.

To add a custom Icon View link:

1. View the attributes for the report. See "Editing Interactive Report Attributes in Page Designer."

   The Attributes page displays in the Property Editor.

2. Locate and expand Icon View.

3. Configure Icon View attributes:

   1. Enabled - Select Yes.

   2. Custom Icon View - Select Yes.

   3. Columns Per Page - Select the number of icons to display per row in Icon View. A value of 5 displays 5 icons per row of the report.

   4. Custom Link - Enter the column link for the Icon view. Use substitution strings for column names, for example:

      <a href="#EMP_LINK#"><img src="#EMP_IMG#" title="#ENAME#" alt="#ENAME#"><br>#ENAME#</a>
      

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

10.4.14.1 Configuring Advanced Attributes in Page Designer

To configure Advanced Attributes:

1. View the attributes for the report. See "Editing Interactive Report Attributes in Page Designer."

   The Attributes page displays in the Property Editor.

2. Locate and expand Advanced.

   Table 10-5 describes the available Advanced Attributes.

   Table 10-5 Advanced Attributes

   Attribute	Description
   Region Alias	Enter an alphanumeric alias for this interactive report region. The alias must be unique within the application. Enter an alphanumeric alias for this interactive report region. The alias must be unique within the application. You can use an alias to reference an interactive report region in your custom API call. For example, you can write a function to return the INTERACTIVE_REPORT_ID by querying the ALIAS column in the APEX_APPLICATION_PAGE_IR view. Since the INTERACTIVE_REPORT_ID value can change when you export or import the application to different instance, referencing interactive report regions using an alias may be preferable.
   Maximum Row Count	Enter the maximum number of rows to query. The number of rows you query can impact performance. Querying fewer rows can improve performance and querying thousands of rows can degrade performance.
   Report ID Item	Select a page or application item to store the region ID for this report. This enables you to include the region ID, by referencing the value in this item, when defining a URL to navigate to a saved alternative or public report.
   Email From Address	Enter a valid email address to use as the From address when sending email from this report. Emails are sent from this report for Downloads of type Email and for Subscriptions. The value can be a literal string containing a valid email address or a static substitution reference defined in the application using substitution syntax. Oracle does not recommend using an item substitution at the application or page-level since it only works in an email download, but not for subscriptions. Examples: john.doe@abc.com &MY_APP_EMAIL_FROM. &APP_EMAIL.

   
   

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

10.4.14.2 About Emailing from an Interactive Report

You can define the from address for emails sent from an interactive report in two ways:

• At the application-level on the Edit Application Definition page in the Application Email from Address attribute. See "Edit Application Definition Page."

• At the interactive report-level on the Interactive Report Attributes page in the Email from Address attribute. See "Configuring Advanced Attributes for Interactive Reports."

In either case, the value can be a literal string containing a valid email or an application substitution defined at the application-level using substitution syntax or &APP_EMAIL. substitution which returns the Application Email From Address defined at the application-level. Examples:

john.doe@abc.com
&MY_APP_EMAIL_FROM.
&APP_EMAIL.

Oracle does not recommend using an item substitution at the application or page-level since it only works in email download, but not for subscriptions.

10.4.15.1 Request Syntax

To link to a specific saved report, use the following Request syntax:

IR[region static ID]_<report_alias>

Consider the following example:

IR[EMP]_dept20

10.4.15.2 Name and Value Syntax

To create a filter, use the following itemNames and itemValues syntax:

IR[region static ID]<operator>_<target column alias>

Consider the following example:

IR[EMP]C_ENAME:KING

To create a filter on an interactive report in a link, use the itemNames syntax described previously and add the filter value in the corresponding location in the item names section of the URL.

To create row text which contains a filter on an interactive report, use ROWFILTER as the target column alias in the item name syntax and add a filter value in the item itemValues of the URL. The link will add a Row Text Contains filter which searches all columns displayed in the report with type STRING or NUMBER.

Consider the following example:

IR[EMP]_ROWFILTER:SALES

Valid operators include:

• C = Contains

• EQ = Equals (this is the default)

• GTE = Greater than or equal to

• GT = Greater Than

• LIKE = SQL Like operator

• LT = Less than

• LTE = Less than or equal to

• N = Null

• NC = Not Contains

• NEQ = Not Equals

• NLIKE = Not Like

• NN = Not Null

• NIN = Not In (escape the comma separated values with backslash, \)

• IN = In (escape the comma separated values with backslash, \)

• ROWFILTER = Row Text Contains (this searches all columns displayed in the report with type STRING or NUMBER)

10.4.15.3 ClearCache Syntax

Use the following syntax in the ClearCache section of the URL to reset, clear, or reset pagination the interactive report:

• RIR - Resets an interactive report. This is equivalent to the end user choosing the Reset option from the interactive report Actions menu on the target page. The report is returned to the default report settings specified by the developer or saved by the user.

• CIR - Clears interactive report. This clears all of the report settings such as control break, aggregate, flashback, chart, number of rows to display, filter, highlight, computation, group by, and pivot.

• RP - Resets interactive report pagination.

10.4.15.4 Restrictions When Linking to Interactive Reports

When linking to interactive reports, remember the following restrictions:

1. If a Request value is not defined in the URL, all of the primary default report settings will change.

2. If a Request value is not defined and itemNames section does not include a fully qualified filter column name with region static ID, an error occurs if there are more than one interactive report region in the target page.

3. If a Request value is not defined and itemNames section do not include a fully qualified filter column name with region static ID, it will create a filter on the primary default report if there is only one interactive report region in the target page.

10.4.15.5 Valid Linking Examples

This section contains valid linking examples.

Valid Linking Example 1

This example includes a link with no Request value, but includes a qualified filter column with region static ID in the itemNames section of the URL. This example creates a filter on the primary default report in the referenced region item name.

f?p=&APP_ID.:2:&SESSION.::::IR[EMP]_ENAME:KING

Valid Linking Example 2

To support backwards compatibility with previous releases, this example uses older syntax and works on a page with one interactive report region.

?p=&APP_ID.:1:&SESSION.:IR_REPORT_12345::RIR,CIR::RIR,CIR:IR_ENAME:KING

Valid Linking Example 3

In this example the link has no Request value. The clear cache section has RIR or CIR or RP and will reset, clear, or reset the pagination of the primary default reports of all interactive report regions.

f?p=&APP_ID.:1:&SESSION.:::RIR:

10.4.15.6 Invalid Linking Examples

This section contains invalid linking examples.

Invalid Linking Example 1

This link has no Request value and does not include a fully qualified filter column with region static ID in the item name section of the URL. This example generates an error if there is more than one interactive report region in the target page.

f?p=&APP_ID.:2:&SESSION.::::ENAME:KING

Invalid Linking Example 2

This example has a link with two request values separated by commas and does not contain a fully qualified filter column with region static ID in the item name section of the URL. This example generates an error since it is not clear where the filter needs to be created.

f?p=&APP_ID.:2:&SESSION.:IR[test]_employee,IR[test2]_dept10:::ENAME:KING

Invalid Linking Example 3

This example uses old request value syntax used on a page with multiple interactive report regions. This example will generate an error. The old syntax only works if there is one interactive report region.

f?p=&APP_ID.:2:&SESSION.:IR_REPORT_myrpt:::ENAME:KING

10.4.15.7 Linking to Shared Interactive Reports

This section describes how to link to saved primary default, alternative default, and public reports using IR[region static ID]_<report_alias> in the Request value of the URL.

• Editing the Alias of Default Report in Page Designer

• Link Examples to a Primary Report

• Link Examples to Saved Reports

f?p=100:1:&APP_SESSION.:IR_PRIMARY

f?p=100:1:&APP_SESSION.:IR_PRIMARY::RIR,CIR:

f?p=100:1:&APP_SESSION.:IR_PRIMARY::RIR,CIR:IR_ENAME:KING

f?p=100:1:&SESSION.:IR_REPORT1

f?p=100:1:&SESSION.:IR_REPORT1::RIR,CIR:

f?p=100:1:&SESSION.:IR_REPORT1::RIR,CIR::RIR,CIR:IR_ENAME:KING