15.3 Publishing Your Report as a Portlet

After you have registered your Oracle Reports, you can expose your report in a portal by performing the following steps:

  1. Create a provider for your reports. This step defines a provider to contain the reports you wish to make available to users in the portal. Alternatively, you can use the existing providers included, by default, with Oracle Portal.

    Refer to Section 15.3.1, "Creating a Provider for Your Reports".

  2. Add the report as an item linkFoot 1  or as a portletFoot 2  to a page and optionally customize it. This makes the report available to users on a page and enables the page designer to set the report parameters and schedule it to run automatically. You can also distribute report output to Oracle Portal.

    Refer to:

15.3.1 Creating a Provider for Your Reports

If you do not already have a provider defined to contain your reports, you must create one. For more information on creating a provider, see the Oracle Portal online Help.

Note:

The provider that contains your reports must be a database provider and must have the Expose as Provider setting selected on its Access page.

15.3.2 Adding the Report Portlet to a Page

After you have registered your report with Oracle Portal, you can publish it as a portlet on your portal page.

Note:

You must have enabled the Publish as Portlet box to ensure that you can publish your report as a portlet.

To publish a report as a portlet:

  1. If you are not already on the Builder page, click Builder at the top of the page.

  2. Click the Build tab.

  3. In the Page Groups portlet, choose the name of the page group in which you want to place your report portlet.

  4. Create a new page by clicking Create a Page or edit an existing page by entering the name of an existing page and clicking Edit.

  5. If you are creating a new page, follow the steps in the wizard and click the question mark in the upper right corner for additional information about the available settings. Click Finish when you are done.

    See Also:

    Section 15.3.3, "Adding the Report as an Item Link to a Page" for information on how to add the Oracle Reports item to a page.

    If you are editing an existing page, skip to the next step.

  6. In the page region where you wish to add your report portlet, click the Add Portlet tool.

    Tip:

    Hints for each tool will display when you roll your mouse over them.
  7. Drill down through the Portlet Repository to the provider that contains the report portlet. The report portlet is listed in the Portlet Repository under the Portal DB Provider to which it belongs. The location of the provider depends on how the Portlet Repository has been organized. If the Portal DB Provider is a fairly new provider, it may be under the New page of the Portlet Repository.

  8. Click the name of your report portlet to add it to the Selected Portlets list.

  9. Click OK.

  10. Click Customize in the upper right corner of your report portlet.

  11. Enter parameter values in the Parameter tab and, if desired, schedule the job to run automatically in the Schedule tab.

  12. You can control the size of the portlet by specifying the Portlet Width and Portlet Height parameters on the Customize page for the Reports Definition File object. The value of these parameters may be a percentage (%) or a number of pixels.

    For example, you can enter:

    Portlet Width: 90%

    Portlet Height: 480

    If no value is specified, Oracle Reports Services uses its default value (640 pixels wide and 320 pixels high).

    If the Portlet Width and Portlet Height fields are visible to users, then they can also adjust each portlet's width and height through Customize. The user's value will override the value set in the Customize page of the Reports Definition File Object component.

  13. You can choose whether to make a report's parameters visible to users on the Customization page of a Reports Definition File Access component.

    To make a report's parameters visible to users:

    1. Click Customize at the bottom of the Develop tab for the report.

    2. Select Visible to user for each parameter you want to expose.

      Note:

      You can also set the default value of the parameter from this page.

      If the parameter you are exposing has a corresponding Oracle Portal page parameter, and you leave the parameter value empty in the Customize page, the portlet inherits the page parameter's value. If the user enters a value for the report portlet's parameter, that value will override the page parameter value.

15.3.3 Adding the Report as an Item Link to a Page

You can add an Oracle Reports component to a page as an item link using the Oracle Reports item type. If you have installed Oracle Portal with the nondefault language setting, refer to Section 15.3.4, "Running Reports on Oracle Portal as an Item Link on a Nondefault Installation".

Note:

This item type must be included from the hidden list of item types and can be configured only if you are the page group administrator.
  1. If you are not already on the Builder page, click Builder at the top of the page.

  2. Click the Build tab.

  3. In the Page Groups portlet, choose the name of the page group in which you want to place your report item link.

  4. Create a new page by clicking Create a Page or edit an existing page by entering the name of an existing page and clicking Edit.

  5. If you are creating a new page, follow the steps in the wizard and click the question mark in the upper right corner for additional information about the available settings. Click Finish when you are done.

    If you are editing an existing page, skip to the next step.

  6. Click the Add Item link. The Oracle Reports item type is available as a hidden item type. To include it as an available item type, click the configure the list of available item types link.

  7. Select Oracle Reports in the Hidden Item Types list and click the right arrow (>) to move it to the Visible Item Types list. Alternatively, you can click >> to move all items in the Hidden Item Types list to the Visible Item Types list.

  8. Click OK.

  9. Select the Oracle Reports item type in the Content Item Types menu and click Next to display the Add Oracle Reports page.

  10. Enter a Display Name that users of your portal will view when clicking your report.

  11. Select from the list of available default Oracle Reports components.

  12. Select Display Parameter Form if your report requires any user inputs before your report is displayed.

  13. Select Link That Displays Item In New Browser Window to ensure that the report is viewed in a separate page.

  14. Click Finish. The Oracle Reports item now displays as a link in your page.

  15. Click the link to run the report and provide any parameters required, if Display Parameter Form is selected.

15.3.4 Running Reports on Oracle Portal as an Item Link on a Nondefault Installation

When you install Oracle Portal with a nondefault language setting, some entries required to publish a report as an item link on a portal page are not installed automatically. You must install the language of your choice by using the rwlang.sql script.

Thus, you must run the script rwlang.sql (ORACLE_HOME/portal/admin/plsql/wwd/) if both of the following are true:

  • You have selected at least one language in addition to the default ("US") at the time of installing Oracle Portal.

  • You want to publish a report as an item link in Oracle Portal.

Note:

This is a one time post-installation task and will ensure that you can publish a report as an item link on Oracle Portal.

To run the script:

  1. Change the directory to ORACLE_HOME/portal/admin/plsql/wwd/.

  2. Run sqlplus.

  3. Log on to Oracle Portal using the portal schema.

  4. This is the portal schema used to install Oracle Portal PL/SQL packages.

  5. Run the rwlang.sql script with the following parameters:

    @rwlang.sql language_list
    

    where

    language_list is the list of languages separated by commas.

    For example, to install French and Japanese:

    @rwlang.sql f,ja
    

Usage Note

  • There should be no space before or after the comma (,) because sqlplus treats the language list as two parameters, instead of one parameter separated by a comma (,).

  • The header of the rwlang.sql script contains the complete list of all language abbreviations. Edit the script file using any text editor to find out the various abbreviations.

15.3.5 Distributing Report Output to Oracle Portal

To distribute to the ORACLEPORTAL destination from Reports Server:

  1. Create a distribution file (for example, distribution.xml) to distribute report output to Oracle Portal. For example:

    <destinations>
      <destype id="customforPortal" name="oraclePortal">
        <property name="outputpage" value="Test_Reports"/>
        <property name="statuspage" value="result"/>
        <property name="pagegroup" value="test_reports"/>
        <property name="itemtitle" value="TestReport"/>
        <include src="report"/>
      </destype>
    </destinations>
    

    Note:

    In this example, you must ensure that pagegroup test_reports exists in Oracle Portal or specify an existing pagegroup name.
  2. Run a report with the following URL:

    http://host:port/reports/rwservlet?server=reports_server
    &report=report_name&destination=distribution_file
    &distribute=yes&userid=user/password@db
    
  3. In Oracle Portal, go to the page specified in the URL and make sure the report is visible.



Footnote Legend

Footnote 1: An individual piece of content (text, hyperlink, image, and so on) that resides on a page in an item region.
Footnote 2: A reusable, pluggable Web component that typically displays portions of Web content.