8.9.9 Linking to Interactive Reports
Link to interactive reports using the syntax in the Request
value and ItemNames
section of the URL.
Data in an interactive report is driven by declarative filters. Developer can set report parameters by modifying interactive report settings for an end user. However, these settings only affect the end user's working report and do not affect any saved report settings. Developers can use the syntax described in this topic to link to interactive reports.
Note:
When you add additional interactive report regions, be sure to change the old single interactive report link syntax. Otherwise, the link generates an error. A link to a page with more than one interactive report regions, the request or name syntax needs to fully qualify with region static ID. To open a link to an interactive report from outside of an application (for example, from an email), you may need to enable the Session Management, Deep Linking attribute in your application. See Session Management.
- Interactive Report Request Syntax
Link to a specific saved report usingRequest
syntax. - Interactive Report Name and Value Syntax
Create a filter usingitemNames
anditemValues
syntax. - Interactive Report ClearCache Syntax
Use theClearCache
section of the URL to reset, clear, or reset pagination the interactive report. - Restrictions When Linking to Interactive Reports
Learn about restrictions when linking to interactive reports. - Valid Interactive Report Linking Examples
View valid interactive report linking examples using Friendly URL Syntax. - Invalid Interactive Report Linking Examples
View invalid interactive report linking examples. - Linking to Shared Interactive Reports
Learn about linking to shared interactive reports.
See Also:
Understanding URL SyntaxParent topic: Managing Interactive Reports
8.9.9.1 Interactive Report Request Syntax
Link to a specific saved report using 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
Note:
The use of Request
in the URL is optional. To link to multiple saved reports, separate each Request with comma.
Parent topic: Linking to Interactive Reports
8.9.9.2 Interactive Report Name and Value Syntax
Create a filter using itemNames
and
itemValues
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
Note:
If there is only one interactive report region on the page, the itemName
does not need to be fully qualified with the region static ID. If an operator is not defined, a filter with equal operator is added.
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 a leading and trailing backslash, \) -
IN
= In (escape the comma separated values with a leading and trailing backslash, \) -
ROWFILTER
= Row Text Contains (this searches all columns displayed in the report with type STRING or NUMBER)
Parent topic: Linking to Interactive Reports
8.9.9.3 Interactive Report ClearCache Syntax
Use the ClearCache
section of the
URL to reset, clear, or reset pagination the
interactive report.
Tip:
Using ClearCache
without specifying a saved report alias in the
Request
, clears the primary
default report. To clear a specific interactive
report region on a page with more than one
interactive reports, specify the region static ID
along with saved report alias in the
Request
.
Use the following syntax in the ClearCache
section of the URL to reset, clear, or reset pagination the interactive report:
-
RR
- Resets an interactive report and pagination. 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. -
CR
- Clears interactive report and resets pagination. This clears all of the session 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.
Parent topic: Linking to Interactive Reports
8.9.9.4 Restrictions When Linking to Interactive Reports
Learn about restrictions when linking to interactive reports.
When linking to interactive reports, remember the following restrictions:
-
If a
Request
value is not defined in the URL, all of the primary default report settings will change. -
If a
Request
value is not defined anditemNames
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. -
If a
Request
value is not defined anditemNames
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.
Parent topic: Linking to Interactive Reports
8.9.9.5 Valid Interactive Report Linking Examples
View valid interactive report linking examples using Friendly URL Syntax.
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 URL Syntax:
https://hostname:port/ords/f?p=&APP_ID.:2:&SESSION.::::IR[EMP]_ENAME:KING
-
Friendly URL Syntax:
https://hostname:port/ords/r/mycompany/hr-app/simple-ir?session=15332852263343&IR_JOB=CLERK
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.
-
f?p URL Syntax:
https://hostname:port/ords/f?p=&APP_ID.:1:&SESSION.:IR_REPORT_12345::RIR,CIR::RIR,CIR:IR_ENAME:KING
-
Friendly URL Syntax:
https://hostname:port/ords/r/mycompany/hr-app/simple-ir?IRC_JOB=ERK
Valid Linking Example 3
In this example the link has no REQUEST
value. The clear cache
section RR
resets the report for all interactive
report regions for page 1.
f?p URL Syntax:
https://hostname:port/ords/f?p=&APP_ID.:1:&SESSION.:::RR
See Also:
Understanding Friendly URL SyntaxParent topic: Linking to Interactive Reports
8.9.9.6 Invalid Interactive Report Linking Examples
View invalid interactive report 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 URL Syntax:
https://hostname:port/ords/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 URL Syntax:
https://hostname:port/ords/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 URL Syntax:
https://hostname:port/ords/f?p=&APP_ID.:2:&SESSION.:IR_REPORT_myrpt:::ENAME:KING
Parent topic: Linking to Interactive Reports
8.9.9.7 Linking to Shared Interactive Reports
Learn about linking to shared interactive reports.
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 Interactive Report Saved Report Alias
Edit the Alias for a saved reports to create a more meaningful URL link to the saved report. - Link Examples to a Primary Report
View examples that demonstrate how to link to a primary report (report_alias=PRIMARY
). - Link Examples to Saved Reports
View examples that demonstrate how to link to a saved report (report_alias=REPORT1
).
See Also:
- About Using f?p Syntax to Link Pages
- Saving a Default Interactive Report
- Deleting Saved Interactive Reports
- Managing Saved Interactive Reports in Oracle APEX Administration Guide
Parent topic: Linking to Interactive Reports
8.9.9.7.1 Editing the Interactive Report Saved Report Alias
Edit the Alias for a saved reports to create a more meaningful URL link to the saved report.
To edit the Alias for saved reports:
Parent topic: Linking to Shared Interactive Reports
8.9.9.7.2 Link Examples to a Primary Report
View examples that demonstrate how to link to a primary report
(report_alias=PRIMARY
).
This example links to a primary report:
f?p=100:1:&APP_SESSION.:IR_PRIMARY
This example links, resets, and clears primary report settings:
f?p=100:1:&APP_SESSION.:IR_PRIMARY::RR,CR:
This example links, resets, and clears primary report settings. It additionally creates a ENAME = 'KING'
filter on the primary report:
f?p=100:1:&APP_SESSION.:IR_PRIMARY::RR,CR:IR_ENAME:KING
Parent topic: Linking to Shared Interactive Reports
8.9.9.7.3 Link Examples to Saved Reports
View examples that demonstrate how to link to a saved
report (report_alias=REPORT1
).
This example links to a saved report:
f?p=100:1:&SESSION.:IR_REPORT1
This example links, resets, and clears settings for saved report
REPORT1
:
f?p=100:1:&APP_SESSION.:IR_REPORT1::RR,CR:
This example links, resets, and clears saved report REPORT1
settings. It additionally creates a ENAME = 'KING'
filter on saved
report REPORT1.
f?p=100:1:&APP_SESSION.:IR_REPORT1::RR,CR:IR_ENAME:KING
Parent topic: Linking to Shared Interactive Reports