Skip Headers
Oracle® Fusion Middleware Developer's Guide for Oracle Portal
11g Release 1 (11.1.1)

Part Number E10238-05
Go to Documentation Home
Home
Go to Book List
Book List
Go to Table of Contents
Contents
Go to Index
Index
Go to Master Index
Master Index
Go to Feedback page
Contact Us

Go to previous page
Previous
Go to next page
Next
PDF · Mobi · ePub

5 Creating Content-Based Portlets with Web Clipping

Web Clipping is a browser-based declarative tool that enables you to integrate any Web application with Oracle Portal. It is designed to give you quick integration by leveraging the Web application's existing user interface. Web Clipping has been implemented as a Web provider using the Oracle Portal Developer Kit, which is a component of Oracle Portal.

With Web Clipping, you can collect Web content into portlets in a single centralized Web page. You can use Web Clipping to consolidate content from Web sites scattered throughout a large organization.

This chapter contains the following sections:

Note:

Web Clipping is provided with Oracle Portal 11g Release 1 (11.1.1) and is also available as a download with the Oracle Portal Developer Kit. In Oracle Portal, you can add a Web Clipping portlet from the Oracle Portal Repository in the Portlet Builders folder. If you've downloaded Web Clipping as part of the Oracle Portal Developer Kit, you must register it before you can use it. To learn more about registering a Web provider, see Oracle Fusion Middleware Administrator's Guide for Oracle Portal. You can then add an Web Clipping portlet to any portal page.

5.1 What Is Web Clipping?

Web Clipping allows clipping of an entire Web page or a portion of it and reusing it as a portlet. Basic and HTML-form-based sites may be clipped. Use Web Clipping when you want to copy content from an existing Web page and expose it in your portal as a portlet. The Web Clipping portlet supports the following:

By default, all Web clipping definitions are stored persistently in the Oracle Fusion Middleware infrastructure database. Any secure information, such as passwords, are stored in encrypted form, according to the Data Encryption Standard (DES), using Oracle encryption technology.

5.2 Adding Web Page Content to a Portal Page

To add Web page content to a portal page, follow the steps described in the following sections:

5.2.1 Adding a Web Clipping Portlet to a Page

To add a Web Clipping portlet to an Oracle Portal page, perform the following steps:

  1. Navigate to the Page Groups portlet. By default, the Page Groups portlet is located on the Build tab of the Portal Builder page.

  2. In the Layout & Appearance section, for Pages, click Browse.

  3. Figure 5-1 shows the Page Groups tab with the list of pages. For the page to which you want to add the Web Clipping portlet, click Edit in the Actions column.

    Figure 5-1 Selecting a Page

    Description of Figure 5-1 follows
    Description of "Figure 5-1 Selecting a Page"

    The page you want to edit is displayed.

  4. In the region in which you want to add the Web Clipping portlet, click the Add Portlet icon.

    Figure 5-2 shows a portion of the page.

    Figure 5-2 Adding a Portlet to a Page

    Description of Figure 5-2 follows
    Description of "Figure 5-2 Adding a Portlet to a Page"

  5. On the Add Portlets page, in the Available Portlets list, click the Portlet Builders link.

  6. Click the Web Clipping Portlet link.

  7. Click OK. The new instance of the Web Clipping portlet now displays on your portal page, as shown in Figure 5-3.

    Figure 5-3 Web Clipping Portlet Added to a Page

    Description of Figure 5-3 follows
    Description of "Figure 5-3 Web Clipping Portlet Added to a Page"

5.2.2 Selecting a Section of a Web Page to Display in the Web Clipping Portlet

To select a section of a Web page to display in the Web Clipping portlet, you use the Web Clipping Studio. Using the Web Clipping Studio, you can do the following:

  • Browse for Web content

  • Section the chosen target page

  • Choose the exact portion of the Web content to clip

  • Preview the clipped content as a portlet

  • Save the clipped content as a portlet

  • Set portlet properties and save the updated portlet information

To select a section of a Web page to display in the Web Clipping portlet, perform the following steps:

  1. Above the Web Clipping portlet, click the Edit Defaults icon, as shown in Figure 5-4.

    Figure 5-4 Editing Default Settings

    Description of Figure 5-4 follows
    Description of "Figure 5-4 Editing Default Settings"

    The Find a Web Clipping page is displayed.

  2. In the URL Location field, enter the location of the starting Web page that links to the content you want to clip, as shown in Figure 5-5.

    Figure 5-5 Specifying a URL

    Description of Figure 5-5 follows
    Description of "Figure 5-5 Specifying a URL"

  3. Click Start.

    The Web Clipping Studio displays the page you specified, as shown in Figure 5-6.

    Figure 5-6 Browsing to a Page Containing Content for a Web Clipping

    Description of Figure 5-6 follows
    Description of "Figure 5-6 Browsing to a Page Containing Content for a Web Clipping"

    Note that the URL in the browser bar changes from:

    http://host:port/portal/page?_dad=portal&_schema=PORTAL...
    

    To:

    http://host:port/portalTools/webClipping...
    
  4. Browse to the page that contains the content you want to clip.

    As you click hyperlinks in the Web page, your navigation links are recorded.

    Note:

    Any browsing operations that do not contribute to the eventual Web clipping will be discarded. Only the significant browsing operations are recorded for later playback during the show mode; any discarded links are not visited.

    For any Web sites that require HTTP Basic or Digest Authentication, a form is displayed that requests user name and password information. This encoded authentication information is recorded as part of the browsing information.

  5. Once you display the page that contains the content you want to clip, in the Web Clipping Studio banner, click Section, as shown in Figure 5-7.

    Figure 5-7 Sectioning the Target Web Page

    Description of Figure 5-7 follows
    Description of "Figure 5-7 Sectioning the Target Web Page"

    Sectioning divides the target Web page into its clippable sections, as shown in Figure 5-8. After you click Section, you are no longer able to browse links in the displayed page. If you want to continue navigation, click Unsection in the Web Clipping Studio banner.

    Figure 5-8 Sectioned Target Web Page

    Description of Figure 5-8 follows
    Description of "Figure 5-8 Sectioned Target Web Page"

  6. At the top left of the section of the Web content you want to clip, click Choose.

    You can choose only one section as a clipping at a time.

    Note:

    To increase the number of sections available from which to choose, click Section Smaller in the Web Clipping Studio banner. For example, you would click Section Smaller to drill down one level of nested tables. To decrease the number of sections available from which to choose, click Section Larger.

  7. Web Clipping Studio displays a preview of your chosen section. If it is the section you want, click Select in the Web Clipping Studio banner. The Web Clipping Studio displays the Find a Web Clipping page, with the properties of the clipping.

    If you do not want to use the section you clipped in your portlet, click Unselect to return to the page containing the section. You can choose another section on the page, or click Unsection to navigate to another page.

    Some sections may contain no data, only whitespace. For example, a Web page may contain an HTML <DIV> tag that contains no text or images. If you click Choose on a section that contains no data, Web Clipping displays a preview, but the preview correctly shows only whitespace. In this case, click Unselect in the preview page to return to the sectioned page. Then, select a section containing data.

  8. In the Find a Web Clipping page, click OK to display the selected Web clipping in the Web Clipping portlet on your page. (You can edit default properties in the page. See Section 5.2.3, "Setting Web Clipping Portlet Properties" for more information.)

    Figure 5-9 shows the content added to the Web Clipping portlet.

    Figure 5-9 Clipped Content Added to the Web Clipping Portlet on a Portal Page

    Description of Figure 5-9 follows
    Description of "Figure 5-9 Clipped Content Added to the Web Clipping Portlet on a Portal Page"

Note that the Refresh link in the Web Clipping Portlet retrieves fresh data from the originating Web site. The Portlet Refresh link reloads the portlet, but it may retrieve the data from the cache, depending upon the settings for expiration.

5.2.3 Setting Web Clipping Portlet Properties

You can edit various portlet settings to change the appearance of the Web Clipping portlet and to specify how end users can interact with the portlet.

To set Web Clipping portlet properties, perform the following steps:

  1. Choose the section you want, click Select in the Web Clipping Studio banner. Web Clipping Studio displays the Find a Web Clipping page with a Properties section, as shown in Figure 5-10.

    Figure 5-10 Properties Section of Find a Web Clipping Page

    Description of Figure 5-10 follows
    Description of "Figure 5-10 Properties Section of Find a Web Clipping Page "

  2. From the URL Rewriting list in the Properties section, choose Inline if you want link targets to be displayed inside the portlet, or choose None if you want link targets to replace the current Portal page in the browser.

  3. In the Title field, enter a title to display in the portlet banner.

  4. In the Description field, enter a description of the portlet.

  5. In the Time Out (seconds) field, enter the amount of time (in seconds) for the Web Clipping provider to attempt to contact the Web page from which the content was clipped.

  6. In the Expires (minutes) field, enter the amount of time (in minutes) that cached content is valid. Any requests for portlet content that occur within the time period you specify will be satisfied from the cache.

    Once the cache period is exceeded, requests for portlet content will be satisfied by retrieving content from the portlet's Web Clipping data source. The cache will also be refreshed with this content.

  7. If you entered any information in a form while clipping content for the Web Clipping portlet, the Parameterize Inputs section is available. Select the Click to start parameterizing check box to customize parameters associated with the Web Clipping portlet content. Then perform the following steps:

    1. From the Parameters list, choose the parameters that you want to customize.

    2. From the Personalizable list, select a parameter if you want to allow end users to provide their own values for the parameters when they personalize the portlet. Select None if you do not want to allow this.

    3. In the Display Name field, enter a name to be displayed for the parameter.

    4. In the Default Value field, enter a value to use by default for the parameter.

    Section 5.4.3, "Personalizing a Web Clipping Portlet" provides an example of personalizing parameters.

  8. Click OK.

5.3 Integrating Authenticated Web Content Using Single Sign-On

This section walks you through an example that demonstrates how you can leverage OracleAS Single Sign-On to integrate content from external Web sites that require authentication into a Web Clipping portlet.

The example incorporates a secured page from Oracle Metalink (an external application) into a Web Clipping portlet.

To integrate an external application, perform the following steps:

  1. Set up the external application in Oracle Portal, specifying the authentication information by performing the following steps. Refer to Oracle Fusion Middleware Administrator's Guide for Oracle Portal for more details.

    1. Log in to Oracle Portal as a user who has SSO Administration privileges, for example, the orcladmin user.

    2. Navigate to the Administer External Applications portlet. (Click the Administer tab, then click the Portal subtab. In the SSO Server Administration section, which is in the right column, select Administer External Applications.)

    3. Click Add External Application.

    4. In the Create External Application page, in the Application Name field, enter a name for the application, for example, Metalink.

    5. For Login URL, enter the URL to log in to the application, for example, http://metalink.oracle.com/metalink/plsql/sit_main.showSitemap?p_showTitle=0. To determine the URL, navigate to the desired application in a browser and note the URL.

      For Form-based Authorization, view the source of the login page for the external application and note the URL to be accessed during the login action.

    6. For User Name/ID Field Name, enter the field name that the external application uses for the user name. Determine the field name by viewing the source for the desired page. If the Authentication method uses Basic Authentication, you do not need to enter a field name. For Metalink, you do not need to enter anything in this field.

    7. For Password Field Name, enter the field name that the external application uses for the password. Determine the field name by viewing the source for the desired page. If the Authentication method uses Basic Authentication, you do not need to enter a field name. For Metalink, you do not need to enter anything in this field.

    8. Select Basic Authentication as the authentication method.

      Figure 5-11 shows a portion of the Create External Application page:

      Figure 5-11 Creating an External Application

      Description of Figure 5-11 follows
      Description of "Figure 5-11 Creating an External Application"

    9. In the Additional Fields section, you can enter names and values of any additional fields that are submitted with the login form of the external application. To specify a field name that is used to indicate a redirection URL, enter redirectFieldName for Field Name. For this example, you do not need to enter additional fields. Figure 5-12 shows the Additional Fields section.

      Figure 5-12 Specifying Redirection

      Description of Figure 5-12 follows
      Description of "Figure 5-12 Specifying Redirection"

    10. Click OK.

    11. To test your credentials with Oracle Metalink, in the Administer External Applications page, click the name of the application you just created. Then, in the External Application Login page, log in to the application Oracle Metalink using your Oracle Metalink user name and password.

      In the Administer External Applications page, click Close.

    For more information about OracleAS Single Sign-On Server and external applications, see the Oracle Application Server Single Sign-On Administrator's Guide.

  2. For the Web Clipping portlet, create a new Web Clipping provider by performing the following steps:

    1. Click the Administer tab, then click the Portlets tab.

    2. Select Register a Provider.

    3. In the Register a Provider page, enter webClippingMetalink for the Name and webClipping Metalink for the Display Name. Enter values for Timeout and Timeout Message. Choose Web for the Implementation Style.

    4. Click Next.

    5. In the General Properties section of the Define Connection page, for the URL, enter:

      http://host:port/portalTools/webClipping/providers/webClipping
      

      Note that host:port refers to the host and port where the providers are located. This corresponds to the URL for Oracle Portal.

    6. For the user's identity, select The user's identity needs to be mapped to a different name in the Web provider's application, and/or the Web provider requires an external application login for establishment of a browser session. If selecting this option, specify the external application ID below.

    7. For External Application ID, click the List of Values icon and select the external application you added.

      Figure 5-13 shows the top part of the Define Connections page.

      Figure 5-13 Specifying an External Application for a Web Clipping Provider

      Description of Figure 5-13 follows
      Description of "Figure 5-13 Specifying an External Application for a Web Clipping Provider"

    8. In the User/Session Information section, select User to send user specific information to the provider. For Login Frequency, select Once Per User Session.

    9. Check that the proxy settings are correct. If you use a proxy server to contact the Web providers from the middle tier, enter the proxy server for Middle Tier.

      If you use a proxy server to contact the Web providers from the portal repository, enter the proxy server for Portal Repository.

      Usually, because the Oracle Portal and Web Clipping URLs point to the same middle tier, this step is not necessary.

    10. Click Finish.

    11. In the Registration Confirmation page, if the registration was successful, click OK.

  3. Add a portlet to a page, using the Web Clipping Metalink provider that you just created, by performing the following steps:

    1. In Oracle Portal, navigate to the page in which you want to add the portlet.

    2. In the region in which you want to add the Web Clipping portlet, click the Add Portlet icon.

    3. In the Add Portlets to Region page, search for Web Clipping Metalink. It is located in the Portlet Staging Area. Click it to move it to the Selected Portlets box.

    4. Click OK.

    Section 5.2.1, "Adding a Web Clipping Portlet to a Page" describes in detail how to add a portlet.

  4. If you have not entered your credentials for the External Application representing Metalink, the portlet will contain an Update login information link. Click the link and enter your credentials. Then, click OK.

  5. Select a section of a page to display in the Web Clipping portlet, by performing the following steps:

    1. In the Web Clipping portlet, click the Edit Defaults icon.

      The Find a Web Clipping page is displayed.

    2. In the URL Location field, the default URL for the External Application is displayed. Change it to the location of the starting Web page that links to the content you want to clip. In this case, enter http://www.metalink.oracle.com.

    3. Click Start. The Web Clipping Studio displays the page you specified. Log in to Oracle Metalink.

    4. Browse to the page that contains the content you want to clip. After you display the page that contains the content you want to clip, click Section in the Web Clipping Studio banner. Figure 5-14 shows the external application displayed in Web Clipping Studio.

      Figure 5-14 External Application in Web Clipping Studio

      Description of Figure 5-14 follows
      Description of "Figure 5-14 External Application in Web Clipping Studio"

    5. At the top left of the section of the Web content you want to clip, click Choose.

    6. Web Clipping Studio displays a preview of your chosen section. If it is the section you want, click Select in the Web Clipping Studio banner.

      The Web Clipping Studio displays the Find a Web Clipping page, with the properties of the clipping, as shown in Figure 5-15.

      Figure 5-15 Properties of the External Application

      Description of Figure 5-15 follows
      Description of "Figure 5-15 Properties of the External Application"

    7. In the Find a Web Clipping page, from the URL Rewriting list, choose Inline to specify that you want link targets displayed inside the portlet, rather than in a new browser window. OK to display the selected Web clipping in the Web Clipping portlet on your page, as shown in Figure 5-16.

      Figure 5-16 External Application Displayed in Portlet

      Description of Figure 5-16 follows
      Description of "Figure 5-16 External Application Displayed in Portlet"

Now, the Web clipping, even though it is from a page requiring authentication, is available in your portlet.

Note that you can associate only one external application with a provider. For each external application, you must register a new provider. Each portal user accesses the authenticated content using their user name and password for that system, not the page designer's credentials.

5.4 Adding a Web Clipping That Users Can Personalize

This section walks you through an example that demonstrates how you can enable end users to personalize their own view of the content in a Web Clipping portlet.

In the example, you perform the following tasks:

5.4.1 Adding a Web Clipping Portlet to a Personal Page

Administrators can set up personal pages for all users. This task assumes that the administrator has enabled this functionality. This task explains how to add the Web Clipping portlet to your personal page. To do this, perform the following steps:

  1. In the Work In field of the Page Groups portlet, select the page group that contains personal pages.

    By default the Page Groups portlet is located on the Build tab of the Portal Builder page and the Personal Pages are located in Shared Objects page group.

  2. In the Pages section, select Personal Pages. Expand the node for the first letter of your user name. To View the Personal pages page (Figure 5-17), click on View link in Page Group portlet.

    Figure 5-17 Expanding Page Group Map Nodes

    Description of Figure 5-17 follows
    Description of "Figure 5-17 Expanding Page Group Map Nodes"

  3. Click your Page Name. Your personal page is displayed.

  4. In any portlet region, click the Add Portlets icon.

  5. In the Add Portlets page, click the Web Clipping Portlet link.

    By default, the Web Clipping portlet is located in the Portal Builder page of the Portlet Repository. If you cannot find this page, use the Search field to find the portlet.

  6. The Web Clipping portlet is added to the Selected Portlets list. Click OK.

5.4.2 Selecting a Clipping in OTN

In this task, you navigate to the Oracle Technology Network (OTN) and search for specific information, then select the results as the clipping for your portlet. To do this, perform the following steps:

  1. In the Web Clipping portlet, click the Edit Defaults icon.

  2. In the Web Clipping Studio's Find a Web Clipping page, in the URL Location field, enter:

    http://www.oracle.com/technology/products/ias/portal/index.html
    

    Click Start. OTN displays the Portal Center page.

  3. Enter a search string in the Search field at the top of the page. For this example, enter "web clipping portlet" (including the quotation marks), then click Search.

    The Search result is displayed in the Web Clipping Studio, as shown in Figure 5-18.

    Figure 5-18 Searching for Information on OTN

    Description of Figure 5-18 follows
    Description of "Figure 5-18 Searching for Information on OTN"

  4. Click Section. Web Clipping Studio divides the target Web page into its clippable sections, as shown in Figure 5-19.

    Figure 5-19 Sectioning the Target Web Page

    Description of Figure 5-19 follows
    Description of "Figure 5-19 Sectioning the Target Web Page"

  5. At the top left corner of the search result, click Choose.

    A preview of the search result section displays.

    Some sections may contain no data, only whitespace. For example, a Web page may contain an HTML <DIV> tag that contains no text or images. If you click Choose on a section that contains no data, Web Clipping displays a preview, but the preview correctly shows only whitespace. In this case, click Unselect in the preview page to return to the sectioned page. Then, select a section containing data.

  6. Click Select to confirm that the search result section is the one you want to clip.

  7. In the Find a Web Clipping page, click OK to display the selected Web Clipping in the Web Clipping portlet on your page. Figure 5-20 shows the Web Clipping displayed in the page.

Figure 5-20 Selected Web Clipping Displayed in Web Clipping Portlet

Description of Figure 5-20 follows
Description of "Figure 5-20 Selected Web Clipping Displayed in Web Clipping Portlet"

5.4.3 Personalizing a Web Clipping Portlet

In this task, you edit the properties of the Web Clipping portlet to allow end users to display different search results in the portlet. To do this, perform the following tasks:

  1. Above the Web Clipping portlet you just added, click the Edit Defaults icon, as shown in Figure 5-21.

    Figure 5-21 Clicking Edit Defaults for the Web Clipping Portlet

    Description of Figure 5-21 follows
    Description of "Figure 5-21 Clicking Edit Defaults for the Web Clipping Portlet"

  2. In the Find a Web Clipping page, modify the following items in the Properties section:

    • From the URL Rewriting list, choose Inline to specify that you want link targets displayed inside the portlet, rather than in a new browser window.

    • In the Title field, enter OTN Search. This title displays in the header of your Web Clipping portlet, as well as the pages where users can personalize parameters for the Web clipping.

    Figure 5-22 shows the Properties and Parameterize Inputs sections of the Find a Web Clipping page.

    Figure 5-22 Setting Properties for a Web Clipping

    Description of Figure 5-22 follows
    Description of "Figure 5-22 Setting Properties for a Web Clipping"

  3. Because the content displayed in the portlet was reached by entering information in the Search field on OTN, you can customize the parameters used by the search to allow end users to specify their own search string.

    In the Parameterize Inputs section, select the Click to start parameterizing check box.

  4. In the parameters table, make the following changes:

    • In the Parameters column, choose p_Query from the list.

    • In the Personalizable column, choose Param1 from the list. You can manually add more parameters in the provider.xml file if you need to.

    • In the Display Name column, enter OTN Search.

    • Make sure that Default Value displays "web clipping portlet" to be sure you have selected the right parameter.

    Figure 5-23 shows the parameters table.

    Figure 5-23 Specifying Parameters for User Input

    Description of Figure 5-23 follows
    Description of "Figure 5-23 Specifying Parameters for User Input"

  5. Click OK to display the default search results in the Web Clipping portlet on your page.

  6. In the Editing Views section, click View Page.

  7. In the Web Clipping portlet header, click Personalize, as shown in Figure 5-24.

    Figure 5-24 Clicking Personalize in the Web Clipping Portlet Header

    Description of Figure 5-24 follows
    Description of "Figure 5-24 Clicking Personalize in the Web Clipping Portlet Header"

  8. In the page that displays, scroll down to the Inputs section. Notice that the parameter field for the search string is labeled OTN Search, as you specified for the Display Name for this parameter. In the OTN Search field, enter a different search string. For example, enter OmniPortlet 2004, as shown in Figure 5-25.

    Figure 5-25 Specifying Input for Parameters

    Description of Figure 5-25 follows
    Description of "Figure 5-25 Specifying Input for Parameters"

  9. Click OK.

    The Web Clipping portlet now displays the results of performing a search on OTN for OmniPortlet 2004 information, as shown in Figure 5-26.

    Figure 5-26 New Web Clipping Result Based on Customer Input Parameter

    Description of Figure 5-26 follows
    Description of "Figure 5-26 New Web Clipping Result Based on Customer Input Parameter"

5.5 Using Web Clipping Open Transport API

To support custom authentication methods, users can use the Web Clipping Transport API. To extend the Web Clipping transport layer to support custom authentication methods, users must perform the following implementation and deployment procedures:

Implementation

Users can implement their own transport classes.

Deployment

Users must deploy the jar file to support the custom authentication method.

5.6 Migrating from URL-Based Portlets

You can migrate URL-based portlets that are stored in a provider.xml file to Web Clipping portlets. These Web Clipping portlets will exist in the Web Clipping Repository, but you can access the portlets through pointers defined in the provider.xml file.

Note that, during the migration process, no modifications will be done on the original files used by these URL-based portlets.

This section describes the following tasks:

5.6.1 Preparing for Migration

Before you begin the migration, take the following steps:

  1. Verify that the Web provider that contains the URL-based portlets you want to migrate is functional. The migration process will not succeed with non-functional URL-based portlets. To verify, make sure that the URL-based portlets are used by your Portal pages and that they appear correctly.

  2. Find existing URL-based portlets.

    Before you run the migration tool, make sure that you know the file path to the service deployment properties file, which holds pointers to everything about the service, including the path to the provider.xml file that holds the URL services definitions.

    You must run the migration tool once for each service. If you have multiple services, find the entire list of service deployment properties files that will be used during migration.

    The location of these service deployment properties files may vary depending on individual deployment scenarios. Typically, with JPDK samples, they are located in:

    <Domain_home>/servers/WLS_PORTAL/tmp/_WL_user/jpdk
    

    JPDK samples that are shipped with the Oracle Portal are located in the same directory path.

    The list of sample service deployment properties files include the following:

    • urlbasicauth.properties

    • urlexternalauth.properties

    • urlnls.properties

    • urlparams.properties

    • urlsample.properties

    • urlssl.properties

    In the migration process, the service deployment properties file as well as the provider.xml file used to contain old URL-based portlets will be copied and imported into the Web Clipping application, together with all the previous customizations based on the File Preference store. Because no modifications will be done on the original files used by these URL-based portlets, you do not need to back up any of these files. They can continue to be used as URL-based portlets.

  3. Depending on the types of URL-based portlets you have, you may need to rearrange them as follows:

    • Because Web Clipping does not offer parallel functionality for the XML Filter capability that URL-based portlets offer, isolate all of the URL-based portlets that use the XML Filter into a separate service deployment (and provider.xml file) that will not be migrated.

    • Because you may face limitations when migrating URL-based portlets that use external applications, you may decide that the migration is too costly for that subset of your URL-based portlets. In this case, you can isolate them into a separate service deployment (and provider.xml file) that will not be migrated.

  4. Make sure that the machine where you are planning to run the migration tool has local access to the service deployment files and files that the deployment files point to, for both the URL-based portlets provider and the Web Clipping provider.

  5. Make sure that both the Web Clipping Repository and the HTTP Proxy are configured, and that the proxy settings concur with those used by your deployment of URL-based portlets. If you have a proxy server that requires authentication, the Web Clipping provider must be configured with Requires Authentication enabled. Set the Login scheme to use a global log in (Use Login below for all users).

    Check the Web Clipping Provider Test page at:

    http://host:port/portalTools/webClipping/providers/webClipping
    

    See the Oracle Fusion Middleware Administrator's Guide for Oracle Portal for more information about setting proxy authentication.

  6. Shut down the WLS instance where your Portal Tools application is running. This step ensures that no modifications are made to the files that will be migrated. Do not restart the WLS instance until after the migration is completed.

    To shut down the WLS instance in a Portal instance, use the following command (from the Oracle\Middleware\user_projects\domains\<Domain Name>\bin directory):

    stopWebLogic.cmd
    

    Domain Name refers to the domain you have configured for your Portal.

5.6.2 Performing the Migration

The migration tool parses the service deployment properties file to find the provider.xml file that contains the XML definition of the URL-based portlets to be migrated.

The tool changes the Provider Definition class from URLProviderDefinition to WcProviderDefinition. For each of the URL-based portlets defined in the provider.xml file, an equivalent clipping definition is created and inserted into the Web Clipping Repository. Then, the PortletDefinition XML snippet corresponding to the portlet being migrated is replaced with a new one that uses WcPortletDefinition as its class. The replacement XML snippet contains a Clip Id that is a pointer to the newly inserted clipping definition.

The new PortletDefinition XML snippet will no longer contain the same information as it did when it was a URLPortletDefinition. Namely, the migration tool uses the URL to visit as well as the headerTrimTag and footerTrimTag to generate an equivalent Web Clipping definition that will be stored within the Web Clipping Repository and only accessible from the provider.xml file through the Clip Id. The only information remaining will be the title and description. See Section 5.2.3, "Setting Web Clipping Portlet Properties" for instructions on modifying your clipping.

To migrate portlets, take the following steps:

  1. Set environment variables as follows:

    • On UNIX, set LD_LIBRARY_PATH to either the Install_home/lib or Install_home/lib32, depending on whether the operating system is 32-bit or 64-bit.

    • On Windows, set PATH to Install_home\bin.

  2. Change to the ORACLE_HOME/portal/jlib directory.

  3. Use the following command to import the portlet to Web Clipping:

    java -Doracle.ons.oraclehome=ORACLE_HOME -jar wcwebdb.jar -import -from urlservices webclip_depprop urlsvc_depprop
    

    In the example, the parameters have the following meanings:

    • ORACLE_HOME refers to the directory where Oracle application is installed.

    • webclip_depprop refers to the path to your webClipping service deployment properties file. The path is typically:

      MW_HOME\user_projects\domains\<DomainName>\servers\WLS_PORTAL\tmp\_WL_user\portalTools_11.1.1.1.0\kjdcke\war\WEB-INF\deployment
      

      Inst_Home refers to the location where Portal is installed. WLS_PORTAL refers to the WLS instance where your PortalTools application is deployed.

    • urlsvc_depprop refers to the path for the URL-based portlets service deployment properties file that points to URL-based portlets that you wish to migrate.

    For example, assume your URL-based portlets are deployed in the following directory on Windows:

    MW_HOME\user_projects\domains\<DomainName>\servers\WLS_PORTAL\tmp\_WL_user\\portalTools_11.1.1.1.0\kjdcke\war\WEB-INF\deployment\providers
    

5.6.3 Post-Migration Configuration

After you migrate all of the URL-based portlets, take the following steps:

  1. Start the WLS instance that hosts your provider.

    To start the WLS instance, use the following command:

    startWeblogic.cmd
    
  2. Update all Portal instances where URL-Based portlets were previously registered. Go to Portal Navigator to find your previously registered URL-based Portlet provider. Click Edit Registration and then click the Connection tab to edit the connection information to the newly migrated provider. Depending on how you registered the portlet, perform either of the following steps:

    • If you previously registered your URL-based Portlet provider using the Service Id mechanism, your provider URL looked similar to the following:

      http://host:port/jpdk/jpdk/providers
      

      In this case, because the Service Id field already contains urn:someservice, you now need only to update the provider URL value to the following:

      http://host:port/portalTools/webClipping/providers
      
    • If you registered your URL-based Portlet provider using a provider URL that contained the Service Id, your provider URL looked similar to the following:

      http://host:port/jpdk/jpdk/providers/service_id
      

      In this case, you need to update the provider to the following:

      http://host:port/portalTools/webClipping/providers/service_id
      

    For the most part, the rest of the registration details can remain as they are. However, if you plan on using the in-line rendering functionality of the migrated portlets, you must select Once Per User Session for Login Frequency.

  3. Restore HTTP proxy authentication setting that you altered in preparation for the migration. During the migration process, URL-based portlets are converted to Web Clipping portlets. If the Web Clipping provider has originally been configured with Requires Authentication enabled, your migrated URL-based portlets may not function properly.

    Check the test page at:

    http://host:port/portalTools/webClipping/providers/webClipping
    

    If the Login Scheme is not set to Use login below for all users, then authentication is accomplished by mapping the current portal user to a proxy server username and password. A portal user's proxy server credentials can only be entered through the Personalize link of the Web Clipping portlet. However this cannot be accomplished through the Personalize link of the migrated URL-based portlets. The workaround is to temporarily add a Web Clipping portlet to the page and personalize it to provide the security credentials. After this is complete, you can remove the temporary portlet.

  4. Review each Portal page where you had used URL-based portlets and verify that the page still contains the content. Occasionally, you may find that, after migration, what used to be a "trimmed" Web page is now the entire Web page. This may be due to some of the limitations of the migration tool, which are discussed in Section 5.6.5, "Limitations in Migrating URL-Based Portlets." If this happens, edit the portlet by altering the Web Clipping associated with it.

5.6.4 Maintaining Migrated Portlets

After you have migrated the portlets, you no longer use the provider.xml file to edit the portlets. Instead, you use Web Clipping to edit the portlets, as described in Section 5.2.3, "Setting Web Clipping Portlet Properties."

Note the following:

  • Whatever modifications you make to the clipping will affect it at the portlet definition level and therefore will affect all the instances of that portlet which may exist across Portal pages.

  • When you modify the clipping and you have made the portlet rendering to be Inline, and have registered the provider with a Login Frequency of Once per User Session, then page viewers who have an instance of the particular portlet on their page, will need to log out of Oracle Portal and log in again to see the changes implemented. This feature avoids disruption of the page viewer's usage of a particular portlet when it is being modified.

  • For portlets with Web Clippings that require authentication to an external application prior to accessing the page containing the clip, the "off-line" editing mechanism detailed in the previous item does not provide such authentication information. Consequently, there is no way to modify the migrated clipping if the original URL-based portlet uses external applications. There is currently no workaround for this limitation.

5.6.5 Limitations in Migrating URL-Based Portlets

This sections describes limitations in migrating URL-based portlets to Web Clipping and describes some differences between the two methods. Following are the differences:

  • There is a fundamental difference between URL-based portlets and Web Clipping in the way that clippings are defined.

    URL-based portlets use the headerTrimTags and footerTrimTags tags to define the begin and end of a particular section in an HTML page. On the other hand, Web Clippings use the HTML tag path (for example, html/body/table[2]/tr[2]/td[1]) to denote the path to use when looking for an HTML tag that would contain the clipping within the page.

    While the header and footer trim tags for URL-based portlets offer greater flexibility (that is, the clipping does not need to reside within one single HTML tag), it is not as robust. When a clipping can no longer be found in the same location within a page, there is no way to apply fuzzy matching logic to find the clipping again. On the other hand, Web Clipping stores key pieces of information to locate the clipping within the page. If the clipping is not in the same location, the fuzzy match feature looks for other candidates on the same HTML page to account for the possibility that the clip may have moved.

  • The migration tool tries to find the clipping (HTML Tag) that encapsulates the headerTrimTags and footerTrimTags. Often, this will not be the exact HTML that was extracted by the URL-based portlet. In these cases, the entire Web page will be returned as the content of the migrated Web Clipping Portlet. To amend this, simply edit the portlet.

  • URL-based portlets that have been migrated to Web Clipping do not support proxy authentication by default. This is because URL-based portlets inherently do not support proxy authentication and Web Clipping preserves the edit mode of the portlets. Their edit mode does not provide an opportunity to enter authentication information. To work around this restriction, add an empty Web Clipping portlet to the same portal and use the Web Clipping portlet Personalize link to enter the user name and password for proxy authentication.

  • URL-based portlets that used external applications are migrated as full-page Web Clipping portlets. This means that the URL previously specified by the URL-based portlet definition will be the one used to display the full page after the log in process. Whatever headerTrimTags and footerTrimTags you have previously specified will be lost, because external application integration occurs at the Portal side while the migration tool only handles the provider side. Because you are not connected to any Portal instances at the time of the migration, and the external applications framework resides only on the Portal side, the migration tool cannot fetch the authentication information necessary to log in to parse the HTML and use the headerTrimTags and footerTrimTags that you have previously specified to compute an HTML Tag Path to store in the Web Clipping Definition.

    In maintaining migrated portlets, you can edit the clipping through links in the test page. However, this does not include URL-based portlets that used external applications to authenticate themselves to the external sites. There is currently no workaround for this issue.

  • URL-based portlets that use the XML Filter cannot be migrated to Web Clipping portlets because there is a lack of such a functionality in the Web Clipping Portlet. Before proceeding with migration, make sure that you have backed up the URL-based portlets that use the XML Filter into a separate URL-based portlet provider. You must do this because the migration occurs at the provider level. That is, upon interpreting that a particular provider.xml file has URLProviderDefinition for its provider definition class, all the portlet definitions contained within that provider definition are migrated.

5.7 Current Limitations for Web Clipping

This section describes current limitations for Web Clipping. For information about the latest limitations in a release, be sure to read the Oracle Portal Release Notes. Following are the limitations:

For troubleshooting information, see Appendix B, "Troubleshooting Portlets and Providers."