|Oracle® Fusion Middleware Developer's Guide for Oracle WebCenter
11g Release 1 (188.8.131.52.0)
Part Number E10148-12
Web Clipping is a publishing portlet that enables you to integrate any web application with your WebCenter Portal application. Web Clipping is designed to give you quick integration by leveraging the existing user interface of a web application. 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 includes the information you are required to know to use Web Clipping in your Oracle JDeveloper environment. For information about how to use Web Clipping at runtime, refer to the "Working with the Web Clipping Portlet" chapter in the Oracle Fusion Middleware User's Guide for Oracle WebCenter Spaces.
This chapter includes the following sections:
For information about additional Web Clipping portlet producer configuration such as repository and proxy settings and producer security, see Appendix E, "Additional Portlet Configuration."
You can find information about developing different types of portlets and information about producers and other portlet technologies in Chapter 53, "Overview of Portlets."
With Web Clipping you can clip an entire web page or a portion of it and reuse it as a portlet. You can clip basic and HTML-form-based sites. Use Web Clipping when you want to copy content from an existing web page and expose it in your WebCenter Portal application as a portlet.
Navigation through various styles of login mechanisms
Fuzzy matching of clippings
Fuzzy matching enables the Web Clipping engine to correctly identify a web clipping and deliver it as portlet content even if the web clipping is reordered within the source page or if its character font, size, or style changes.
Personalization enables you to expose input parameters that end users can modify when they personalize the portlet. Parameters can be exposed as public parameters that you can map as page parameters. This feature enables end users to obtain personalized clippings.
Integrated authenticated web content through single sign-on
You can use external applications and leverage Oracle Single Sign-On to clip content from authenticated external web sites.
Inline rendering enables you to set up Web Clipping portlets to display links within the context of the portlet. When a user clicks a link in the Web Clipping portlet, the results display within the same portlet. You can use this feature with internal and external web sites.
Web Clipping supports proxy authentication, including global proxy authentication and authentication for each user. You can use this feature if proxy servers require authentication. You can specify proxy server authentication details, including type (Basic or Digest) and realm in the
provider.xml file. In addition, you can specify a scheme for entering user credentials:
All users automatically log in using a user name and password that you provide.
All users are required to log in using a user name and password that they provide.
All public users (not authenticated into the WebCenter Portal application) automatically log in using a user name and password that you provide, while valid users (authenticated into the WebCenter Portal application) log in using a user name and password that they provide.
For more information, see Section E.2.2, "HTTP or HTTPS Proxy Configuration."
Support for HTTPS
Web Clipping enables you to clip content from HTTPS-based external web sites if appropriate server certificates are acquired. For information about server certificates, see Section E.2.3.1, "Adding Certificates for Trusted Sites."
Open Transport API
By default, the Web Clipping provider supports only HTTP challenge-based authentication methods, such as Basic and Digest and form submission logins. To support custom authentication methods, such as Kerberos proxy authentication, you can use the Web Clipping Transport API. For more information, see Section 61.4.1, "Using the Web Clipping Transport API."
Reuse of a wide range of web content
Web Clipping also supports clipping of content from pages written with HTML 4.01, including:
<applet>, <body>, <div>, <embed>, <img>, <object>, <ol>, <span>, <table>, and
<ul> tagged content
<head> styles and fonts, and CSS
Support for UTF-8 compliant character sets
Navigation through hyperlinks (HTTP GET), form submissions (HTTP POST), frames, and URL redirection
Web Clipping provides globalization support in URLs and URL parameters. For information about how Web Clipping determines the character set of clipped content, see Section 61.5, "Current Limitations of Web Clipping."
Persistent storage of Web Clipping definitions
Web Clipping definitions are stored persistently in a repository. By default, in JDeveloper, the Web Clipping producer is configured to use the file-based Oracle Metadata Service (MDS) as a repository. If you prefer, you can use a database schema for your Web Clipping repository. For information about configuring a Web Clipping repository, see Section E.2.1, "Web Clipping Repository Configuration."
Encryption of secure information
Any secure information, such as passwords, is stored in an encrypted form, according to the Data Encryption Standard (DES), using Oracle encryption technology.
You can add a Web Clipping portlet to a JSP document created through JDeveloper. For more information, see Chapter 59, "Consuming Portlets." The Web Clipping portlet producer is included in:
Integrated WebLogic Server (WLS), the default server installed with JDeveloper
WLS_Portlets managed server in the default domain in a full Oracle Fusion Middleware installation
To add a Web Clipping portlet to your application:
In JDeveloper, start Integrated WLS. For information, see Section 3.4, "Working with the Integrated WebLogic Server."
In JDeveloper, register the Web Clipping producer. For more information, see Section 59.2.3, "How to Register an Oracle PDK-Java Portlet Producer."
During this step, you must provide the endpoint URL, for example:
You can choose to register the Web Clipping portlet producer from the
WLS_Portlets managed server or Integrated WLS.
When the producer is registered, portlets become available either in the Application Resources panel or the Resource Palette.
From the Application Resources panel or the Resource Palette, drag the Web Clipping portlet onto your
.jspx page. For more information, see Section 59.3, "Adding Portlets to a Page."
If you are using a
ShowDetailFrame component, then drag the portlet on top of that component instead of
af:form. In the Structure pane, the Web Clipping portlet must display under the
ShowDetailFrame component. In the Page Editor, the portlet must display inside the
Note:When you add an instance of Web Clipping to your page in JDeveloper, open the Property Inspector for the portlet and ensure that the
RenderPortletInIFrameproperties are set as follows:
AllModesSharedScreen is set to
false to display the Customize and Personalize in full page size. If you do not set this property to
false, then when you edit the Web Clipping portlet at runtime, the text displayed on the page may be distorted.
RenderPortletInIFrame is set to
true to display the Web Clipping in its own inline frame (IFRAME) in the View mode.
.jspx page and choose Run.
The Web Clipping portlet displays in your default browser.
Customize the Web Clipping portlet to define its contents. For information, see the "Working with the Web Clipping Portlet" chapter in the Oracle Fusion Middleware User's Guide for Oracle WebCenter Spaces.
Note:To clip SSL-enabled web sites, you must add certificates of those sites to the certificate store. You are not required to add certificates of SSL-enabled web sites that use Equifax, VeriSign, or Cybertrust certificates because these certificates are included in the default certificate store.
For information about adding certificates, see Section E.2.3.1, "Adding Certificates for Trusted Sites."
You can leverage Oracle Single Sign-On to integrate content from external web sites that require authentication, into a Web Clipping portlet.
To integrate an external application that requires authentication:
Open your WebCenter Portal application in JDeveloper.
Register the external application, specifying the authentication information. For more information, see Section 184.108.40.206.1, "Registering an External Application in Oracle JDeveloper."
Register the Web Clipping producer. For information, see Section 59.2.3, "How to Register an Oracle PDK-Java Portlet Producer."
While registering the producer by using the Register Oracle PDK-Java Portlet Producer wizard, on the Specify Connection Details page, select the Associate Producer with External Application checkbox, and from the list of values, select the external application that you just registered. The Enable Producer Sessions checkbox gets selected automatically.
Figure 61-1 shows the external application named MyOracleSupport associated with a Web Clipping producer.
Figure 61-1 Associating a Web Clipping Producer with an External Application
Add the Web Clipping portlet from the producer that you just registered to a
.jspx page and choose Run.
If you did not specify shared or public credentials for the external application, then the portlet contains an Update login information link. Click this link.
Enter your credentials, and then click OK to log in to the external web site.
Figure 61-2 shows the login screen of an external application named MyOracleSupport.
Figure 61-2 Logging into the Integrated External Application
Click the Actions icon on the header of the Web Clipping portlet, and select Customize.
The Find a Web Clipping page displays, with the default URL for the external application displayed in the URL Location field (Figure 61-3).
Figure 61-3 Finding a Web Clipping
You can now select any section of a web page that you intend to display in your Web Clipping portlet. For information about how to customize a Web Clipping portlet, see the "Working with the Web Clipping Portlet" chapter in the Oracle Fusion Middleware User's Guide for Oracle WebCenter Spaces.
After you clip the required page of the external application, the web clipping, even though it is from a page requiring authentication, is available in your portlet.
This section includes the following subsections:
To support custom authentication methods, you can use the Web Clipping Transport API. To extend the Web Clipping transport layer to support custom authentication methods, you must perform several implementation and deployment procedures.
This section includes the following subsections:
If you want to support a custom authentication method, such as Kerberos, you must first implement your own transport classes.
To implement custom transport classes:
Override two use cases of the
In Web Clipping, this interface is used to abstract the HTTP transport layer. By default, the two use cases of this interface are manifested by the following implementations:
HttpClientStudioTransportLiaison, which handles HTTP transport in Web Clipping Studio mode
HttpClientProviderTransportLiaison, which handles HTTP transport in Web Clipping Producer show mode
To support more authentication methods, you must override the
addRequestHeaders methods for both the Studio and Provider
HttpClientTransportLiaison implementations to add your own authentication-specific headers. For information, see Oracle WebLogic Server Web Clipping Transport API Reference.
Compile the new subclasses and package them into a JAR file.
For example, to compile the new subclasses, use the following command:
path_to_wcejar refers to the path to the
To create the JAR file, for example, run the following command from the
jar cvf ../
mytransport.jar refers to the JAR file users want to create.
After implementing the new transport classes, you must deploy the JAR file to support the custom authentication method.
To deploy the JAR file:
Place the JAR file into the class path or shared library that is used by the Web Clipping producer at runtime.
Register the transport class in the
web.xml file for the Web Clipping producer by making the following modifications to the context parameters defined for
Change the parameter value for
oracle.webclipping.provider.TransportLiaisonClass to the name of the new class extended from the
Change the parameter value for
oracle.webclipping.studio.TransportLiaisonClass to the name of the new class extended from the
Restart the producer server for the changes to take effect.
<env-entry> <env-entry-name>oracle/webclipping/rewriteImageLink</env-entry-name> <env-entry-type>java.lang.Boolean</env-entry-type> <env-entry-value>false</env-entry-value> </env-entry>
When you integrate with partner applications (by using
mod_osso), you cannot clip directly through those partner applications in an authenticated manner. However, you can use partner applications through the external application framework.
If a web page contains multiple portlets that use a CSS, then they should not conflict if the CSS uses distinct style names, such as
OraRef, to specify a style within an HTML tag, rather than using an HTML tag name, such as
<A>, as the name of the style.
If one portlet uses a CSS, and that CSS overwrites the behavior of HTML tags by using the name of the tag, such as
<A>, as the name of the style, and a second portlet on the same page does not use a CSS, the second portlet is affected by the style instructions of the CSS of the first portlet.
If two portlets on the same page use a different CSS and each CSS overwrites the behavior of HTML tags by using the name of an HTML tag, such as
<A>, as the name of the style, then the style that is displayed depends on the browser.
Web Clipping checks the
Content-Type in the HTTP header for the
charset attribute. If this is present, then it assumes that this is the character encoding of the HTML page.
charset attribute is not present, then Web Clipping checks the HTML
META tag on the page to determine the character encoding.
If the value of the
META tag is not supported (for example, if the
charset was specified as
NONE), then Web Clipping uses the default character set, ISO-8859-1, not the
charset in the previously browsed page.
This section provides information to help you troubleshoot problems you may encounter while using Web Clipping.
Encountered "x" at line n, column n. Was expecting one of : "x", "y" ...
Parser error message written to the log file.
This is a site-specific issue, not a Web Clipping error. Contact the site's administrator for assistance.