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

Part Number E10148-16
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
View PDF

63 Consuming Portlets

This chapter describes how to add portlets to the pages of your WebCenter Portal application and the options that accompany this process.

This chapter includes the following sections:

This chapter does not cover Oracle JDeveloper or Oracle ADF page creation basics. It covers only those aspects of page creation that are specific to WebCenter Portal application pages. Therefore, you should familiarize yourself with the information covered in the Oracle Fusion Middleware Web User Interface Developer's Guide for Oracle Application Development Framework before reading this chapter.

For information about creating portlets, which can then be consumed by WebCenter Portal application pages, see the following chapters:

63.1 Introduction to Consuming Portlets

Oracle WebCenter Framework enables you to consume a portlet by registering its producer either with an application or with the Resource Palette from where you can add it to any application. After you register the producer, its portlets appear under the registered producer's name under the Connections node in the Application Resources panel or in the Resource Palette.

Your application can consume portlets that you build and portlets that you receive from a third party, such as a packaged-application vendor.

There are many options associated with portlet consumption. For example, you can choose to place portlets straight onto a page or nest them in an Oracle Composer component, you can adjust many attributes of the portlet tag, and you can wire portlets to each other.

63.2 Registering Portlet Producers with a WebCenter Portal Application

Before you can add a portlet to a WebCenter Portal application page, you must register the portlet's producer with the application. You can register portlet producers in two ways:

A portlet that is available in the Resource Palette can be added to any of your WebCenter Portal applications by dropping it on the page as you would any other component. When you add a portlet from the Resource Palette, its producer gets registered with the application if that producer is not already register with the application. You can drag and drop a whole producer connection from the Resource Palette into the Application Resources panel of the Application Navigator. This registers the producer with the application. Alternatively, you can right-click a producer in the Resource Palette and choose Add to Application from the context menu to register the producer with the currently open application.

JDeveloper provides wizards for registering both WSRP producers and Oracle PDK-Java producers.

Note:

If your application is source controlled, you must manually create elements in the source control system for any new files created during producer registration. Any files that are already source controlled are checked out automatically by the producer registration process.

This section includes the following subsections:

For more information about producers, see Section 57.2.3, "Deployment Type." For information about obtaining prebuilt portlets through Oracle, see Section 3.4, "Working with the Integrated WebLogic Server." For information about using JDeveloper's portlet creation wizards, see Chapter 59, "Creating Portlets with the Portlet Wizard." For more information about portlets, see Chapter 57, "Overview of Portlets."

63.2.1 How to Register a WSRP Portlet Producer

When you register a WSRP portlet producer, you provide basic information that describes the producer's operational parameters. This information is used by the portlet-consuming application to communicate with the producer and with the portlets through the producer.

Oracle WebCenter Framework supports both WSRP 1.0 and WSRP 2.0 producers. The WSRP 2.0 standard, among others, provides support for inter-portlet communication and export and import of portlet customizations. You can leverage the benefits of WSRP 2.0 while building standards-based JSR 286 portlets.

The Register WSRP Portlet Producer wizard is the entry point for registering both WSRP 1.0 and 2.0 producers. When registration is successful, the newly registered producer displays in JDeveloper either in the Application Resources panel of the Application Navigator, or in the Resource Palette, depending on where you created the connection. You can then select portlets from the producer for placement on your application (.jspx) pages.

Note:

If you are registering a producer provided by Oracle WebLogic Portal, and the portlet uses ADF Rich Components, you should register the WSRP 2.0 WSDL URL to ensure that the portlet functions correctly.

You also use the Register WSRP Portlet Producer wizard to register JSF portlets, which are portletized JSF applications or portletized ADF task flows. Once you create a portlet from a JSF application, you can deploy the portlet to a WLS instance and register the JSF portlet producer as you would register any WSRP portlet producer. The Oracle JSF Portlet Bridge exposes JSF applications and task flows as JSR 286 portlets. For more information, see Chapter 58, "Creating Portlets with the Oracle JSF Portlet Bridge."

To register a WSRP portlet producer:

Note:

In the Register WSRP Portlet Producer wizard, if you click Cancel after you have clicked Finish, the registration is not canceled.
  1. In the Application Resources panel of the Application Navigator, right-click Connections, choose New Connection and then choose WSRP Producer.

    For other methods of invoking the wizard, such as from the Resource Palette, see Section 1.6.2, "How Do I Access the Connection Wizards?"

  2. In the Specify Producer Name page (Figure 63-1) of the Register WSRP Portlet Producer wizard, the Create Connection in option is set depending on how you accessed the wizard. The default selection is Application Resources if you invoked the wizard from an application, and Resource Palette if you invoked the wizard from the Resource Palette. You can change this option at this point.

    Figure 63-1 The Specify Producer Name Page (WSRP Producer)

    Description of Figure 63-1 follows
    Description of "Figure 63-1 The Specify Producer Name Page (WSRP Producer)"

  3. From the Target Project dropdown list, select the project to be configured for the WSRP producer connection.

    This should be the same project as the one in which you intend to consume the portlets.

    You can change this option only if you invoked the wizard from the Application Navigator.

  4. In the Producer Registration Name field, enter a name for the producer registration that is unique among all connections and then click Next.

  5. In the Specify Connection Details page (Figure 63-2), in the WSDL URL field, enter the producer's URL.

    The syntax varies according to your WSRP implementation, for example, the sample WSRP producer uses the following syntax:

    • http://host:port/context-root/portlets/wsrp1?WSDL

    • http://host:port/context-root/portlets/wsrp2?WSDL

    • http://host:port/context-root/portlets?WSDL (WSRP 1.0 for backward compatibility)

    Where:

    • host is the server to which your producer has been deployed.

    • port is the port to which the server is listening for HTTP requests.

    • context-root is the Web application's context root.

    • portlets[/wsrp(1|2)]?WSDL is static text. The text entered here depends on how the producer is deployed.

    For example:

    http://myhost.example.com:7101/portletapp/portlets/wsrp2?WSDL
    

    You can access the producer test page through the URL:

    http://host:port/context-root/info
    

    Figure 63-2 The Specify Connection Details Page (WSRP Producer)

    Description of Figure 63-2 follows
    Description of "Figure 63-2 The Specify Connection Details Page (WSRP Producer)"

  6. If the application and the producer are separated by a firewall, an HTTP proxy is needed for communication between the application and the producer. If this is the case for your application, select Use Proxy for Contacting Producer and specify the URL and port number of the proxy.

    Note:

    The proxy fields in this step default to the proxy preferences set in JDeveloper Preferences (from the main menu, choose Tools > Preferences, and then select Web Browser and Proxy).
  7. Click Next.

    The connection to the producer is tested. If there are any problems, an error message displays. You must resolve any problems before you can continue.

  8. In the Specify Additional Registration Details page (Figure 63-3), in the Default Timeout Interval (Seconds) field, enter the number of seconds to wait for the producer to respond during design time operations.

    Some producers define additional registration properties. In such cases, the properties are displayed in a table on this page of the wizard. You can enter values for these additional properties in the table. These properties are producer-specific and are used only at registration time. That is, they collect information that consumer applications send to producers at registration time; the producers store this information against the consumers and use it subsequently.

    Figure 63-3 The Specify Additional Registration Details Page (WSRP Producer)

    Description of Figure 63-3 follows
    Description of "Figure 63-3 The Specify Additional Registration Details Page (WSRP Producer)"

  9. If you are registering the producer in the Resource Palette, click Finish to complete the registration.

    If you are registering the producer in the Application Resources panel, and plan to request authentication whenever the producer (and consequently, its portlet) is accessed, click Next and follow the remaining steps. If you do not want to configure security, click Finish.

    If the producer declares user categories, when you click Finish, the Register WSRP Portlet Producer dialog displays. Click Yes and see Section 63.2.2, "How to Map a Producer's Declared User Categories to an Application's Defined Java EE Security Roles." Click No to decline this opportunity and complete the registration process.

    Note:

    If you decline to map the user categories to security roles at this point, you can do so later by editing the producer registration.
  10. In the Configure Security Attributes page (Figure 63-4), from the Token Profile dropdown list, select the type of token profile to use for authentication with the WSRP producer:

    • None—No token; no WS-Security header is attached to the SOAP message.

      If you select this option, you do not want to complete the rest of the wizard. Click Finish.

    • WSS 1.0 SAML Token with Message Integrity—Provides message-level integrity protection and SAML-based authentication for outbound SOAP requests in accordance with the WS-Security 1.0 standard. A SAML token, included in the SOAP message, is used in SAML-based authentication with sender vouches confirmation. This policy uses WS-Security's Basic 128 suite of asymmetric key technologies and SHA-1 hashing algorithm for message integrity.

    • WSS 1.0 SAML Token with Message Protection—Provides message-level protection (integrity and confidentiality) and SAML-based authentication for outbound SOAP requests in accordance with the WS-Security 1.0 standard. The Web service consumer includes a SAML token in the SOAP header and the confirmation type is sender-vouches. This policy uses WS-Security's Basic 128 suite of asymmetric key technologies. Specifically, RSA key mechanisms for message confidentiality, SHA-1 hashing algorithm for message integrity, and AES-128 bit encryption.

      When you select this policy, you must also specify the Recipient Alias.

    • WSS 1.0 User Name Token without Password—Provides username (with password) token profile based identity propagation with certificate based message protection for outbound SOAP requests in accordance with the WS-Security v1.0 standard. Both plain text and digest mechanisms are supported. This policy uses WS-Security's Basic128 suite of asymmetric key technologies. Specifically, RSA key mechanism for message confidentiality, SHA-1 hashing algorithm for message integrity, and AES-128 bit encryption.

      Use this token profile if the WSRP producer has a different identity store. You must define an external application pertaining to the producer and associate the external application with this producer. The external application defined here is used to retrieve and propagate the user credentials to the producer. The producer verifies this against the identity store configured for the external application.

      When you select this policy, you must also specify the Recipient Alias.

    • WSS 1.0 User Name Token with Password—provides username (with password) token profile based identity propagation with certificate based message protection for outbound SOAP requests in accordance with the WS-Security 1.0 standard. Credentials (username only) are included in outbound SOAP request messages through a WS-Security UsernameToken header. No password is included. Message protection is provided using WS-Security 1.0's Basic128 suite of asymmetric key technologies. Specifically, RSA key mechanisms for message confidentiality, SHA-1 hashing algorithm for message integrity, and AES-128 bit encryption.

      When you select this policy, you must also specify the Recipient Alias.

    • WSS 1.0 SAML Token—Provides SAML-based authentication for outbound SOAP request messages in accordance with the WS-Security 1.0 standard. The policy propagates user identity and is typically used in intra departmental deployments where message protection and integrity checks are not required.

      This policy does not require any keystore configuration.

    • WSS 1.1 SAML Token with Message Protection—Provides message-level protection (integrity and confidentiality) and SAML token population for outbound SOAP requests in accordance with the WS-Security 1.1 standard. A SAML token, included in the SOAP message, is used in SAML-based authentication with sender vouches confirmation. This policy uses the symmetric key technology for signing and encryption, and WS-Security's Basic128 suite of asymmetric key technologies for endorsing signatures.

    Figure 63-4 The Configure Security Attributes Page (WSRP Producer)

    Description of Figure 63-4 follows
    Description of "Figure 63-4 The Configure Security Attributes Page (WSRP Producer)"

  11. Select the configuration type:

    • Default—If you choose default, then all the default keystore attributes, that is location, password, keystore type, signature key and alias, encryption key and alias are picked up from the JPS (Java Platform Security) configuration. The value for recipient alias is used from the policy being used. The WebLogic Server where the application is deployed must be configured for WS-Security. For more information, see "Securing a WSRP Producer with WS-Security" in Oracle Fusion Middleware Administrator's Guide for Oracle WebCenter.

    • Custom—If you select this option, then you must enter the appropriate keystore attributes in the next page of the wizard.

  12. In the Default User field, enter a user name to assert to the remote producer when the user has not authenticated to the WebCenter Portal application.

    When unauthenticated, the identity anonymous is associated with the application user. OWSM does not currently support the propagation of an anonymous identity, so you must specify an alternative identity here. Keep in mind though, that in this case, the WebCenter Portal application has not authenticated the user so the default user you specify should be a low privileged user in the remote producer that is an appropriate identity to use for showing public content. For example, you may want to create a guest account in the identity store for this purpose. If the user has authenticated to the application, then the user's identity is asserted rather than the default user.

    Note:

    If you specify a Default User, the remote producer must be set up to accept this information.

    The Default User field does not appear if you selected User Name Token with Password.

  13. In the Issuer Name field, enter the name of the issuer of the SAML Token, for example www.oracle.com.

    This field appears only if you selected an SAML Token option from the Token Profile dropdown list, and Custom from the Configuration options. The issuer name is the attesting entity that vouches for the verification of the subject.

  14. Select Associate Producer with External Application, then select the application, if this producer must provide authentication to an external application.

    For more information, see Section 67.13.3, "Managing External Applications."

    This option is available only if you selected User Name Token with Password.

  15. Click Next.

    If you selected Default as the configuration option, then the fields on the Specify Key Store page are disabled. Click Finish to complete the registration.

    If the producer declares user categories, when you click Finish, the Register WSRP Portlet Producer dialog displays. Click Yes and see Section 63.2.2, "How to Map a Producer's Declared User Categories to an Application's Defined Java EE Security Roles." Click No to decline this opportunity and complete the registration process.

  16. In the Specify Key Store page, in the Store Path field, provide the full path to the keystore that contains the certificate and the private key that is used for signing some parts (security token and SOAP message body) of the SOAP message.

    If you are not sure of the full path, click Browse to navigate to and select the file. The selected file should be a keystore created with the Java keytool.

    Figure 63-5 The Specify Key Store Page (WSRP Producer)

    Description of Figure 63-5 follows
    Description of "Figure 63-5 The Specify Key Store Page (WSRP Producer)"

  17. In the Store Password field, provide the password to the keystore that was set when the keystore was created.

    The keystore password must be correct for the Store Type field and the Signature Key Alias dropdown list to populate.

    If an incorrect keystore path or password is entered, then an error message appears stating that the password is invalid and must be corrected. All fields on this screen except for Store Path and Store Password are disabled until you specify the correct values.

  18. After you provide the correct keystore path and password, press the Tab key to move to another active field (for example, the Store Path field). This ensures that the Store Type field and the Signature Key Alias dropdown list are properly populated.

  19. The Store Type value is read from the keystore and is never editable. The store type is always JKS (Java Key Store).

  20. From the Signature Key Alias dropdown list, select the signature key alias.

    This list populates automatically when the correct password is entered in the Store Password field. The Signature Key Alias is the identifier for the certificate associated with the private key that is used for signing. The key aliases found in the specified keystore are available in the list. Select the one to be used for signing.

  21. In the Signature Key Password field, specify the password for accessing the key identified by the alias specified in Signature Key Alias.

  22. Optionally, from the Encryption Key Alias dropdown list, select the encryption key alias.

    This list populates automatically when the correct password is entered in the Store Password field. The key aliases found in the specified keystore are available in the list. Select the one to be used for encryption.

  23. Optionally, in the Encryption Key Password field, specify the password for accessing the key identified by the alias specified in Encryption Key Alias.

  24. From the Recipient Alias field, select the keystore alias that is associated with the producer's certificate and then click Finish.

    This certificate is used to encrypt the message to the producer.

    This field is not displayed if you selected SAML Token with Message Integrity as the Token Profile in the Configure Security Attributes page of the wizard.

    If the producer declares user categories, when you click Finish, a dialog displays asking whether you want to map the user categories to Java EE roles. Click Yes and see Section 63.2.2, "How to Map a Producer's Declared User Categories to an Application's Defined Java EE Security Roles." Click No to decline this opportunity and complete the registration process.

63.2.2 How to Map a Producer's Declared User Categories to an Application's Defined Java EE Security Roles

The user categories the producer declares come from the portlets it contains. For example, if the producer contains one or more JSR 286 portlets created with the Standards-based Java Portlet (JSR 286) Wizard, then any security roles added during portlet creation are included in the user categories the producer declares. Java EE Security Roles can be specified through the WebCenter Portal application's web.xml file properties.

For more information about security roles in JSR 286 portlets, see Section 67.17, "Securing Identity Propagation Through WSRP Producers with WS-Security."

This procedure continues forward from Section 63.2.1, "How to Register a WSRP Portlet Producer."

To map producer-declared user categories with application-defined Java EE security roles:

  1. After clicking Finish in the Register WSRP Portlet Producer wizard, click Yes in the resulting dialog.

  2. In the User Categories dialog (Figure 63-6), for each User Category, click the corresponding field in the J2EE Security Role column.

    The User Categories dialog is also accessible when you edit producer registration settings. For more information see Section 63.2.4, "How to Edit Portlet Producer Registration Settings."

    Figure 63-6 The User Categories Dialog

    Description of Figure 63-6 follows
    Description of "Figure 63-6 The User Categories Dialog"

  3. From the resulting list, select the security role to map to the producer user category.

  4. Click OK when all user categories are mapped.

63.2.3 How to Register an Oracle PDK-Java Portlet Producer

When you register a PDK-Java portlet producer, you provide basic information that describes the producer's operational parameters. This information is used by the portlet-consuming application to communicate with the producer and with the portlets through the producer.

When registration is successful, the newly registered producer is displayed in JDeveloper either in the Application Resources panel of the Application Navigator, or in the Resource Palette, depending on where you created the connection. You can then select portlets from the producer for placement on your application (.jspx) page.

Note:

In the Register Oracle PDK-Java Portlet Producer wizard, if you click Cancel after you have clicked Finish, the registration is not canceled.

To register a PDK-Java portlet producer:

  1. In the Application Resources panel of the Application Navigator, right-click Connections, choose New Connection and then choose Oracle PDK-Java Producer.

    For other methods of invoking the wizard, such as from the Resource Palette, see Section 1.6.2, "How Do I Access the Connection Wizards?."

  2. In the Specify Producer Name page (Figure 63-7) of the Register Oracle PDK-Java Portlet Producer wizard, the Create Connection in option is set depending on how you accessed the wizard. The default selection is Application Resources if you invoked the wizard from an application, and Resource Palette if you invoked the wizard from the Resource Palette. You can change this option at this point.

    Figure 63-7 The Specify Producer Name Page (PDK-Java Producer)

    Description of Figure 63-7 follows
    Description of "Figure 63-7 The Specify Producer Name Page (PDK-Java Producer)"

  3. From the Target Project dropdown list, select the project to be configured for the PDK-Java producer connection.

    This should be the same project as the one in which you intend to consume the portlets.

    You can change this option only if you invoked the wizard from the Application Navigator.

  4. In the Producer Registration Name field, enter a name for the producer registration that is unique among all connections and then click Next.

  5. In the Specify Connection Details page (Figure 63-8), in the URL Endpoint field, enter the producer's URL using the following syntax:

    http://host:port/context-root/providers
    

    Where:

    • host is the server to which your producer has been deployed.

    • port is the port to which the server is listening for HTTP requests.

    • context-root is the Web application's context root.

    • providers is static text. The text entered here depends on how the producer is deployed.

    For example:

    http://myhost.example.com:7101/myEnterprisePortlets/providers
    

    Figure 63-8 The Specify Connection Details Page (PDK-Java Producer)

    Description of Figure 63-8 follows
    Description of "Figure 63-8 The Specify Connection Details Page (PDK-Java Producer)"

  6. In the Service ID field, enter the unique identifier for this producer.

    PDK-Java enables you to deploy multiple producers under a single adapter servlet. The producers are identified by their unique service IDs. A service ID is required only when a service ID or producer name is not appended to the URL endpoint. For example the following URL endpoint requires the service ID, sample:

    http://myhost:7101/myEnterprisePortlets/providers
    

    However, the following URL endpoint, does not require a service ID:

    http://myhost:7101/myEnterprisePortlets/providers/sample
    
  7. If the application and the producer are separated by a firewall, an HTTP proxy is needed for communication between the application and the producer. If this is the case for your application, select Use Proxy for Contacting Producer and specify the URL and port number of the proxy.

    Note:

    The proxy fields in this step default to the proxy preferences set in JDeveloper Preferences (from the main menu, choose Tools > Preferences, and then select Web Browser and Proxy.)
  8. Select Associate Producer with External Application, then select the application, if this producer must provide authentication to an external application.

    For more information, see Section 67.13.3, "Managing External Applications."

    This option is available only if you invoked the wizard from the Application Navigator, as external applications are scoped to individual applications.

  9. Select Enable Producer Sessions to enable sessions between the producer and the consuming application.

    When sessions are enabled, the server maintains session-specific information, such as user name. Message authentication uses sessions, so if the shared key is set, then this option should also be selected.

    For sessionless communication between the producer and the server, deselect this option.

  10. At this point in the wizard, you can click Finish to complete the registration, using the default values for all remaining steps.

    To provide additional details, click Next and follow the remaining steps.

  11. In the Specify Additional Details page (Figure 63-9), in the Default Timeout Interval (Seconds) field, enter the number of seconds to wait for the producer to respond during design time operations.

    Figure 63-9 The Specify Additional Registration Details Page (PDK-Java Producer)

    Description of Figure 63-9 follows
    Description of "Figure 63-9 The Specify Additional Registration Details Page (PDK-Java Producer)"

  12. In the Subscriber ID field, enter a string to identify the consumer of the producer being registered.

    When a producer is registered, a call is made to the producer. During the call, the consumer passes the value for Subscriber ID to the producer. This value for Subscriber ID is also passed every time a portlet call is made. If the producer does not see the expected value for Subscriber ID, then it might reject the registration call.

    Note:

    Editing the producer registration to change the Subscriber ID after the initial registration has no effect. To specify a different Subscriber ID, you must reregister the producer.
  13. In the Shared Key field, enter a shared key to use for producers that are set up to handle encryption and then click Finish.

    The shared key is used by the encryption algorithm to generate a message signature for message authentication. Producer registration fails if the producer is set up with a shared key and you enter an incorrect shared key here. The shared key can contain between 10 and 20 alphanumeric characters.

63.2.4 How to Edit Portlet Producer Registration Settings

Both the WSRP and PDK-Java portlet producer registration wizards enable you to access and revise many of the values you entered when you registered the producer.

To edit portlet producer registration settings:

  1. Navigate to the producer in the Application Resources panel of the Application Navigator or in the Resource Palette.

  2. Right-click the producer to edit, and choose Properties.

  3. Edit the producer registration properties as required, clicking Next to step through the pages of the wizard.

    You can also go directly to a specific step by clicking the links in the navigation panel on the left side of the wizard.

    You cannot edit the Producer Registration Name.

  4. When you have changed all the necessary settings, click Finish.

  5. Editing some properties, such as the WSDL URL or URL Endpoint, requires a producer refresh. When you make such a change, a dialog displays allowing you to refresh the producer immediately, save the changes but do not refresh the producer, or return to the edit producer registration wizard. Click Yes, No, or Cancel as appropriate.

    Note:

    While you can edit the value of the WSDL URL field, you can point to a different producer only if the new producer has access to the preference store of the old producer, or if the preference store of the old producer has been migrated to that of the new producer.
  6. Click OK when the producer has been successfully refreshed, if necessary.

  7. Once you have completed your edits, consider testing the producer connection to be sure the connection information is valid. For more information, see Section 63.2.5, "How to Test a Portlet Producer Connection."

63.2.5 How to Test a Portlet Producer Connection

The connection testing feature provides a means of testing the validity of a portlet producer connection.

To test a portlet producer connection:

  1. Navigate to the producer in the Application Resources panel of the Application Navigator or in the Resource Palette.

  2. Right-click the producer to test, and choose Test Producer Connection.

  3. A progress bar appears while the test is underway. A success or failure dialog displays when the test is complete. Click OK to close this dialog.

    If the failure dialog displays, consider editing the producer registration details and retesting the producer connection. Additionally, especially if the failure dialog takes a long time to display, ensure that the producer is available. For example, if the producer is provided through the Integrated WLS, ensure that the Integrated WLS is running, and then retest the connection.

63.2.6 How to Refresh a Portlet Producer

When you refresh a portlet producer, the portlets from that producer are also refreshed. Newly added portlets and any updates to existing portlets become available to any applications that are consuming portlets from this producer.

Tip:

When a portlet is removed from a producer, be sure to manually delete the portlet from all application pages on which it has been placed. For more information, see Section 63.6, "Deleting Portlets from Application Pages."

To refresh a portlet producer:

  1. Navigate to the producer in the Application Resources panel of the Application Navigator or in the Resource Palette.

  2. Right-click the producer to refresh, and choose Refresh Producer Registration.

  3. In the Portlet Producer Refresh dialog, click Yes.

63.2.7 How to Delete a Portlet Producer

If you no longer want to use a particular producer with your application, you can delete the producer. For information about deleting portlets and relevant page variables, see Section 63.6, "Deleting Portlets from Application Pages."

Note:

if you delete a producer, any pages that consume portlets from that producer display an error message that the portlet is unavailable. The portlets continue to be unavailable even if you re-register the producer using the same name.

To delete a portlet producer:

  1. Navigate to the producer in the Application Resources panel of the Application Navigator or in the Resource Palette.

  2. Right-click the producer to delete, and choose Delete.

  3. In the Delete Confirmation dialog, click Yes.

63.3 Adding Portlets to a Page

Placing a portlet on a WebCenter Portal application page is a simple matter of dragging the portlet from the Application Resources panel or Resource Palette and dropping it on the page.

This section includes the following subsections:

Before You Begin

Before you can place a portlet on a page, there are a few preparatory steps you must perform before you can take this simple action. These include:

  1. Creating a WebCenter Portal application. For more information, see Section 5.2.1, "How to Create a WebCenter Portal Application."

  2. Creating an application page. For more information, see Section 5.2.2, "Adding Pages to the Portal."

  3. Registering the portlet's producer with the application. For more information, see Section 63.2, "Registering Portlet Producers with a WebCenter Portal Application."

  4. Some of the portlets you plan to consume may come from applications that handle their own authentication. In such cases, you must register the application as an external application and identify it to the portlet producer that provides it. For more information, see Chapter 67, "Securing Your WebCenter Portal Application."

  5. Some of the portlets you plan to consume may come from producers that are Secure Sockets Layer (SSL) enabled. When you try to access an SSL-enabled producer, you may be presented with a Security Alert dialog, prompting you to view the producer's certificate and add it to the list of trusted certificates. The Security Alert dialog displays only if the producer uses a security certificate issued by a certificate authority that is not widely accepted. To consume portlets from such a producer, you must first add the producer's security certificate to the keystore. For more information, see Section 67.14, "Registering Custom Certificates with the Keystore."

63.3.1 How to Add a Portlet to a Page

You can add a portlet to a page by dragging and dropping it from the Application Resources panel of the Application Navigator or from the Resource Palette.

To add a portlet to a page:

  1. In the Application Navigator, open the application that contains the page (.jspx file) to which you want to add the portlet.

  2. Expand the project that contains the page.

  3. Locate the page, right-click it, and then choose Open.

    Tip:

    You can also double-click the page to open it.
  4. Under the Connections node in the Application Resources panel of the Application Navigator, or in the Resource Palette:

    • If the producer is a WSRP producer, expand the WSRP Producer node.

    • If the producer is a PDK-Java producer, expand the Oracle PDK-Java Producer node.

  5. Expand the node for the portlet producer that contains the portlet to add to the page.

    Under the selected producer, all portlets contained by that producer are listed.

  6. Drag the portlet from the producer node directly onto the page.

    You should drag the portlet onto a form on the page. If you do not, a dialog displays prompting you to create a form to contain the portlet. Select:

    • ADF Faces - Form if the page contains rich client components. This adds an af:form component to the page.

    • JSF HTML - Form if the page contains HTML components (for example, if it is an upgraded 10.1.3.2 page). This adds an h:form or tr:form component to the page, depending on the surrounding document tag.

    Do not select HTML - Form as this is not valid for portlets.

    Note:

    You can include any Oracle ADF Faces component or task flow as a child component of a Show Detail Frame component. However, portlets contain headers similar to those provided by the Show Detail Frame component and can be added to a Panel Customizable component directly. There are no additional benefits to including portlets in Show Detail Frame components.

Note:

If you are adding a PeopleSoft portlet to a page in a WebCenter Portal application, you must set the renderPortletInIFrame portlet tag attribute to true.

For more information, see Section 63.4, "Setting Attribute Values for the Portlet Tag."

63.3.2 What Happens When You Add a Portlet to a Page

When you add a portlet to a page, a portlet tag (adfp:portlet or adfph:portlet) is added to the page source. This is the tag that represents the portlet component. This tag includes attributes that you can edit using the Property Inspector, or in the page source, to further control the behavior and appearance of the portlet. For information about these attributes, see Section 63.4, "Setting Attribute Values for the Portlet Tag."

The type of portlet tag used is determined by the following:

  • If the project is configured for rich client components alone, the adfp:portlet tag is used.

  • If the project is configured for Trinidad components alone, the adfph:portlet tag is used.

  • If the project is configured for both rich client and Trinidad components, a dialog displays where you can choose which portlet tag to use.

  • If the project is not configured for rich client or Trinidad components, the adfp:portlet tag is used and the project is automatically configured for rich client components.

This is so that the look and feel of the portlet matches that of other components on the page. For example, if you created your page as described in Section 5.2.2, "Adding Pages to the Portal," the page is a rich client page. In this case, the portlet is added using the adfp:portlet tag.

Example 63-1 A Rich Client Page Containing a Portlet

<?xml version='1.0' encoding='US-ASCII'?>
<jsp:root xmlns:jsp="http://java.sun.com/JSP/Page" version="2.0"
          xmlns:h="http://java.sun.com/jsf/html"
          xmlns:f="http://java.sun.com/jsf/core"
          xmlns:af="http://xmlns.oracle.com/adf/faces/rich"
          xmlns:adfp="http://xmlns.oracle.com/adf/faces/portlet">
  <jsp:directive.page contentType="text/html;charset=US-ASCII"/>
  <f:view>
    <af:document>
      <af:form>
        <adfp:portlet value="#{bindings.Portlet11_1}"
                      id="portlet1"
                      renderPortletInIFrame="true"/>
      </af:form>
    </af:document>
  </f:view>
</jsp:root>

If you are working with an upgraded 10.1.3.2 application or an application that contains Trinidad components, the application uses HTML components, rather than rich client components. In this case, when you drag a portlet onto a page, the adfph:portlet tag is used.

Example 63-2 A Trinidad Page Containing a Portlet

<?xml version='1.0' encoding='US-ASCII'?>
<jsp:root xmlns:jsp="http://java.sun.com/JSP/Page" version="2.0"
          xmlns:h="http://java.sun.com/jsf/html"
          xmlns:f="http://java.sun.com/jsf/core"
          xmlns:af="http://xmlns.oracle.com/adf/faces/rich"
          xmlns:tr="http://myfaces.apache.org/trinidad"
          xmlns:adfph="http://xmlns.oracle.com/adf/faces/portlet/html">
  <jsp:directive.page contentType="text/html;charset=US-ASCII"/>
  <f:view>
    <tr:document title="Title 1">
      <tr:form>
        <adfph:portlet value="#{bindings.Portlet12_1}"
                       id="portlet1"/>
      </tr:form>
    </tr:document>
  </f:view>
</jsp:root>

If the application page includes one or more Oracle Composer components, this may influence where the portlet is placed. For example, in the Structure panel, a portlet placed on a page with a cust:panelCustomizable tag, would be placed as illustrated in Example 63-3:

Example 63-3 Hierarchical Placement of the Portlet Tag

af:document
  af:form
   cust:panelCustomizable
     adfp:portlet

Note:

We recommend that you do not mix ADF Faces rich client components with HTML or Trinidad components on the same page. Doing so may produce unexpected results at runtime. Therefore, do not place a rich client portlet inside an Oracle Composer HTML component or an HTML portlet inside an Oracle Composer rich client component.

For information about Composer tags, see Chapter 19, "Enabling Runtime Editing of Pages Using Oracle Composer."

Note:

When you drop an instance of OmniPortlet onto your page, open the Property Inspector and ensure that the AllModesSharedScreen, under the Display Mode category, is set to false, the default value. Setting this property to true may prevent you from editing certain sections of your OmniPortlet in the OmniPortlet wizard.

When you add a portlet to a page, a portlet binding is added to the page definition file. This portlet binding includes attributes that specify whether the portlet should automatically listen for parameter changes and events (Example 63-4).

Example 63-4 Portlet Binding

<portlet id="LotteryPortlet2_1"
         portletInstance="oracle/adf/portlet/SamplePortlets/ap/Ei7default_03ba18be_012d_1000_8002_0ae8827e9493"
         class="oracle.adf.model.portlet.binding.PortletBinding"
         retainPortletHeaders="false"
         listenForAutoDeliveredPortletEvents="true"
         listenForAutoDeliveredParameterChanges="true"
         xmlns="http://xmlns.oracle.com/portlet/bindings"/>

Setting these attributes to true (the default) means that any parameters or events raised that match those supported by the portlet (or that match an alias for one of the supported parameters or events) automatically cause the portlet to be updated accordingly. You can set these attributes to false to disable this automatic parameter and event listening off. For example, your page might contain multiple instances of the same portlet that require values to come from different sources. If you disable automatic parameter and event listening, you must manually configure the portlet wiring.

63.3.3 What Happens at Runtime

Once you place a portlet on a page, right-click the page and choose Run. This displays the page and runs the portlet in your default browser using JDeveloper's Integrated WLS. Different portlets may require additional runtime configuration. Notably, the content of an OmniPortlet or Web Clipping portlet instance is defined at runtime. For more information about OmniPortlet, see Chapter 64, "Creating Portlets with OmniPortlet." For more information about the Web Clipping portlet, see Chapter 65, "Creating Content-Based Portlets with Web Clipping." For more information about portlets generally, see Chapter 57, "Overview of Portlets."

When running a portlet that has an Edit mode (in a WebCenter Portal application, this renders as a Personalize icon (pencil icon) in the portlet header), the Personalize icon displays only to authenticated users (that is, users who have logged in). Anonymous or public users do not see the option to personalize the portlet. Some form of security must be implemented for the portlet-consuming application before users can personalize their view of a portlet. If you are a developer creating portlets and pages, you may want to test your portlet's Edit mode without creating a complete security model for your application. For information about how to add security to enable testing of a portlet's Edit mode, see Section 67.12, "Configuring Basic Authentication for Testing Portlet Personalization."

Note:

To be able to add portlets to your page at runtime, you must add at least one portlet to that page at design time. Adding a portlet at design time ensures that the following is added to the <definitionFactories> element of the DataBindings.cpx file:
<factory nameSpace="http://xmlns.oracle.com/portlet/bindings"
className="oracle.adf.model.portlet.binding.PortletBindingDefFactoryImpl"/>
<dtfactory className="oracle.adfdtinternal.view.faces.portlet.PortletDefinitionDTFactory"/>

This entry is required to enable consumption of portlets at runtime.

If a portlet supports parameters or events and the automatic parameter and event listening is enabled, any changes to the supported parameters and events (or to parameters and events that are aliased) automatically update the portlet.

When running a portlet from a producer associated with an external application, a link to update login information is displayed. Clicking the link displays a credential provisioning page for entering external application credentials. After specifying valid credentials the portlet displays content appropriately. For more information about external applications, see Section 67.13, "Working with External Applications."

63.4 Setting Attribute Values for the Portlet Tag

In the source code view of a page, each portlet is represented by an adfp:portlet tag (or adfph:portlet tag), which includes a set of required and optional attributes. Required attributes, value and portletType, are provided automatically by the framework, and must not be altered. Optional attribute values are relevant when support for the attribute is built into the portlet. For example, you can set isAboutModeAvailable to true, but if no About mode has been defined for the portlet, then the attribute setting does not affect the portlet.

Portlets also support a set of style-related attributes, which are discussed more fully in Section 21.10, "Applying Styles to Components."

The portlet tag uses many attributes, which you can set at design time either through the JDeveloper Property Inspector or in the source code as attributes of the tag.

This section includes the following subsections:

63.4.1 How to Set Attribute Values for the Portlet Tag Using the Property Inspector

The Property Inspector provides a quick and easy way to set attribute values for the portlet tag without having to edit the source code yourself.

To set attribute values for the portlet tag using the Property Inspector:

  1. In the Application Navigator, open the application that contains the page on which the portlet appears.

  2. Expand the project that contains the page.

  3. Locate the page, right-click it, and then choose Open.

    Tip:

    You can also double-click the page to open it.
  4. In the design view, select the portlet whose attributes you want to set.

  5. In the Property Inspector, click the appropriate tab and set the desired attribute.

    Repeat this step as often as required.

  6. Save your changes.

  7. To test the changes you have made, right-click the page and choose Run.

63.4.2 How to Set Attribute Values for the Portlet Tag in Source Code

If you prefer working in source code, you can set attribute values for the portlet tag directly there.

To set attribute values for the portlet tag in source code:

  1. In the Application Navigator, open the application that contains the page on which the portlet appears.

  2. Expand the project that contains the page.

  3. Locate the page, right-click it, and then choose Open.

    Tip:

    You can also double-click the page to open it.
  4. In the design view, select the portlet whose attributes you want to set.

  5. Click the Source tab. The portlet that you selected is highlighted in the source code.

  6. Make your changes directly to the source code. Example 63-5 shows an edited portlet tag.

    Example 63-5 An Edited Portlet Tag

    <adfp:portlet value="#{bindings.portlet1}"
                  portletTypes="/oracle/adf/portlet/WsrpPortletProducer1/applicationPortlets/
                               E0default_b452f828_010a_1000_8002_82235f57eaa8"
                  allModesSharedScreen="true"
                  isMaximizable="true"
                  isMinimizable="true"/>
    
  7. Save your changes.

  8. To test the changes you have made, right-click the page and choose Run.

63.4.3 Common Attributes of the Portlet Tag

Table 63-1 describes the common attributes of the portlet tag.

Table 63-1 Common Attributes of the Portlet Tag

Attribute Value Description

id

Text string. For example:

id="newsBrief"

The value must follow a subset of the syntax allowed in HTML:

  • Must not be a zero-length String.

  • First character must be an ASCII letter (A-Z a-z) or an underscore (_).

  • Subsequent characters must be ASCII letter or digits (a-Z a-z 0-9), underscores (_), or dashes (-).

The unique identifier of the portlet. This attribute is populated with a unique value by default when you add the portlet to a page.

title

Text string. For example:

title="Announcements"

The portlet title, which is displayed in the portlet header.

The value specified here takes precedence over any title specified elsewhere (for example, in the portlet markup).

If no value is specified here, the portlet extracts its title from the portlet markup (response).

If no value is specified either here or in the portlet markup, the portlet extracts its title from the portlet definition.

Note: Supplying a value to the title attribute at design time means that any change made to the title at runtime in Edit or Edit Defaults mode is ignored.

width

Number expressed in pixels or as a percentage of available area:

  • For pixels, enter npx, for example:

    width = 300px
    
  • For percentage, enter n%, for example:

    width = 50%
    

The width of the area to allow for portlet display.

If the actual portlet width is larger than the width value entered here, a scrollbar appears, provided displayScrollBar is set to auto or true. If displayScrollBar is set to false, and the actual portlet width exceeds the value expressed for the width attribute, the width attribute value is considered and the portlet content is truncated.

height

Number expressed in pixels, for example:

height = 300px

The height of the area to allow for portlet display.

If the actual portlet height is larger than the height value entered here, a scrollbar appears, provided displayScrollBar is set to auto or true. If displayScrollBar is set to false, and the actual portlet height exceeds the value expressed for the height attribute, the height attribute value is considered and the portlet content is truncated.

icon

URI to an image. For example:

icon="coffee.png"

In the Property Inspector, click the Property Menu icon next to the field and then choose Edit to locate and select the required image.

The value must be an absolute URI or a URI that is resolvable relative to the current page or the application context root. The URI provided in the preceding example is stored at the application context root, therefore a full path is not required.

A URI specifying the location of an image to use as an icon, displayed to the left of the portlet title in the portlet header. You can use the icon to indicate the portlet's purpose, to reinforce branding, as a content indicator, or for some other reason.

partialTriggers

One or more component IDs. For example:

partialTriggers="_id1 _id2 componentID5"

Separate component IDs with spaces.

The IDs of the components that trigger a partial update. The portlet listens on the specified trigger components. If a trigger component receives a trigger event that causes it to update in some way, this portlet also requests to be updated.


63.4.4 Appearance Attributes of the Portlet Tag

Table 63-2 describes the appearance attributes of the portlet tag.

Table 63-2 Appearance Attributes of the Portlet Tag

Attribute Value Description

expansionMode

minimized
normal

Default: normal

The default state of the portlet:

  • minimized—The portlet's default display mode is collapsed (minimized).

  • normal—The portlet's default display made is neither collapsed nor expanded to the width of the page.

allModesSharedScreen

auto
false
true

Default: auto

Whether a change in portlet mode renders the new mode on a new page, rather than the page on which the portlet resides.

  • auto—All portlet modes are displayed inline if the remote portlet is configured, through the com.oracle.portlet.requireIFrame container runtime option in its portlet.xml file, to require an inline frame (IFRAME). This ensures that Oracle Bridge portlets are displayed inline.

  • false—All portlet modes, except View (JSR 286) or Show (PDK-Java), are rendered each on their own page. This is useful for portlets such as OmniPortlet and the Web Clipping portlet, which require that modes other than Show mode display on pages other than the page on which the portlet resides.

  • true—All portlet modes are displayed inline. One mode is swapped out for another on the same page. In other words, this attribute enables all portlet modes to display without leaving the context of a given page.

renderPortletInIFrame

auto
false
true

Default: auto

Whether the portlet is rendered in an IFRAME:

  • auto—The portlet is rendered in an IFRAME if:

    - parsing of the content fails

    - a form in the content contains an input of type file

    - the remote portlet is configured, through the com.oracle.portlet.requireIFrame container runtime option in its portlet.xml file, to require an IFRAME. This ensures that Oracle JSF Portlet Bridge portlets are displayed in an IFRAME.

    For more information, see Section 63.4.12, "What You May Need to Know About IFRAMEs."

  • false—The portlet is rendered inline. HTML markup from a portlet that is not rendered in an IFRAME may interfere with other components on the Oracle ADF page.

  • true—The portlet is rendered in an IFRAME.

displayScrollBar

auto
false
true

Default: auto

Whether a scroll bar is displayed:

  • auto—Render a scroll bar if the portlet content does not fit the width and height specified.

  • false—Never render a scroll bar. If the portlet content does not fit the height and width specified, the portlet renders in its actual size.

  • true—Always render a scroll bar.

displayHeader

false
true

Default: true

Whether the portlet header is displayed:

  • false—The portlet header is not displayed. Icons and links normally displayed in the header are hidden. If isSeededInteractionAvailable is set to true, users can access portlet menus and icons by rolling the mouse over the portlet. A fade-in/fade-out toolbar appears, from which users can select Actions menu options.

  • true—The portlet header is displayed. Consequently, header-based icons and links are displayed.

displayShadow

false
true

Default: true

Whether to display a shadow decoration around the portlet:

  • false—Do not display a shadow decoration.

  • true—Display a shadow decoration.

rendered

false
true

Default: true

Whether the portlet is rendered.

  • false—Do not render the portlet. No output is rendered.

  • true—Render the portlet. This is the recommended setting. Setting this attribute to false causes problems when you run the page.

background

dark
light
medium

Default: medium

The style selector to apply to the skin used by the portlet:

  • dark—Apply the dark style selector to the skin.

  • light—Apply the light style selector to the skin.

  • medium—Apply the medium style selector to the skin.

This provides a way for you to apply a different look and feel to each portlet on an page.

shortDesc

Text string. For example:

shortDesc="Portlet for entering display text in place."

A short description of the portlet.

displayActions

always
onHover

Default: always

Whether seeded interactions for the portlet are shown:

  • always—Always show seeded interactions.

  • onHover—Show seeded interactions when users move the mouse over the portlet.

showMoveAction

menu
none

Default: menu

Whether to display the Move command in the portlet's Action menu:

  • menu—Display the Move command on the portlet's Action menu.

  • none—Do not display the Move command.

There is a difference in the way that the Move command behaves at design time and at runtime. For more information, see Section 63.4.11, "What You May Need to Know About Maximize, Minimize, Restore, and Move."

showRemoveAction

menu
none

Default: menu

Whether to display the Remove icon on the portlet chrome:

  • menu—Display the Remove command on the portlet's Action menu.

  • none—Do not display the Remove icon.

There is a difference in the way that the Remove icon behaves at design time and at runtime. For more information, see Section 63.4.11, "What You May Need to Know About Maximize, Minimize, Restore, and Move."

Note: This attribute is available only for the adfp:portlet tag and not for the adfph:portlet tag.

showResizer

always
never

Default: always

Whether to display the resize handle at the bottom right corner of the portlet.

  • always—Always display the resize handle.

  • never—Never display the resize handle.

Note: This attribute is available only for the adfp:portlet tag and not for the adfph:portlet tag.

showMinimizeAction

chrome
none

Default: chrome

Whether to display the Minimize icon on the portlet chrome:

  • chrome—Display the Minimize icon on the portlet chrome.

  • none—Do not display the Minimize icon.

There is a difference in the way that the Minimize icon behaves at design time and at runtime. For more information, see Section 63.4.11, "What You May Need to Know About Maximize, Minimize, Restore, and Move."


63.4.5 Behavior Attributes of the Portlet Tag

Table 63-3 describes the behavior attributes of the portlet tag.

Table 63-3 Behavior Attributes of Portlet Tag

Attribute Value Description

partialTriggers

One or more component IDs. For example:

partialTriggers="_id1 _id2 componentID5"

Separate component IDs with spaces.

The IDs of the components that trigger a partial update. The portlet listens on the specified trigger components. If a trigger component receives a trigger event that causes it to update in some way, this portlet also requests to be updated.

submitUrlParamters

false
true

Default: false

Whether parameters in portlet links that point to the page on which the portlet is placed are made available to the page:

  • false—Parameters are not made available to the page. Rather, they are available only inside the portlet initiating the request.

  • true—Parameters available on the container page.


63.4.6 Portlet Modes Attributes of the Portlet Tag

Portlet Modes attributes control the rendering of mode-switching UI actions, such as entering edit mode. The ability to render a portlet in a particular mode depends on the modes supported by the portlet and the user authorization. For example, if the isCustomizeModeAvailable attribute is set to true, but the action is not supported in the portlet, then the attribute setting does not affect the portlet.

Portlet Modes attributes, described in Table 63-4, are value binding expressions that evaluate to true or false:

  • true means the portlet is allowed to render in the named mode.

  • false means the portlet is not allowed to render in the named mode.

Table 63-4 Portlet Modes Attributes of the Portlet Tag

Attribute Value Description

isAboutModeAvailable

false
true

Default: true

Whether to render an About command on the portlet's Actions menu.

Users choose About to invoke the portlet's About mode.

isConfigModeAvailable

false
true

Default: true

Whether to render a Configure command on a JSR 286 portlet's Actions menu.

Users choose Configure to open the portlet's Configuration settings.

isCustomizeModeAvailable

false
true

Default: true

Whether to render a Customize icon in the portlet header.

Site administrators choose Customize to edit a portlet's default personalization data.

isDetailModeAvailable

false
true

Default: true

Whether to render a Details command on a PDK-Java portlet's Actions menu.

Users choose Details to open the portlet in Full Screen mode.

isHelpModeAvailable

false
true

Default: true

Whether to render a Help command on the portlet's Actions menu.

Users choose Help to open the portlet's Help page.

isPrintModeAvailable

false
true

Default: true

Whether to render a Print command on a JSR 286 portlet's Actions menu.

Users choose Print to displays a printer-friendly version of the portlet.

isNormalModeAvailable

false
true

Default: true

Whether to render a Refresh command on the portlet's Actions menu.

Users choose Refresh to redraw the portlet independent of any other content on the page (also known as a partial-page refresh).

isPersonalizeModeAvailable

false
true

Default: true

Whether to render a Personalize icon in the portlet header.

Users choose Personalize to alter their personal view of the portlet. This mode is equivalent to the Edit mode selection in the Standards-based Java Portlet (JSR286) Wizard.

The Personalize icon displays only to authenticated users (that is, users who are logged in). It does not display to public or unauthenticated users. You must implement some form of application security for users to be able to personalize their portlet views.

If you are a developer creating portlets, and you want to test the Personalize mode without creating a complete security model for your application, then see Section 67.12, "Configuring Basic Authentication for Testing Portlet Personalization."

Note: A typical personalization setting is Portlet Title. You can set Portlet Title at design time, by providing a value for the title attribute. Consider however that supplying a value to the title attribute at design time prevents personalization and customization of the portlet title at runtime.

isPreviewModeAvailable

false
true

Default: false

Whether to enable previewing of portlet content.

This mode has no particular application in WebCenter Portal applications, but it is used in Oracle Portal's Portlet Repository, where it renders as a magnifying glass icon, which users click to preview a portlet.


63.4.7 Style Attributes of the Portlet Tag

Table 63-5 describes the style attributes of the portlet tag.

Table 63-5 Style Attributes of the Portlet Tag

Attribute Value Description

contentStyle

One or more CSS styles.

These should be in compliance with, at least, CSS 2.0 and take the following format:

contentStyle="color:rgb(255,0,255); font-family:Arial Helvetica Geneva sans-serif;font-size:large;"

The CSS style to apply to the portlet content.

Values entered here take precedence over styles specified in the inlineStyle attribute and those included in a CSS or skin on the specific portlet instance. For more information, see Understanding contentStyle and inlineStyle Properties.

inlineStyle

One or more CSS styles.

These should be in compliance with, at least, CSS 2.0 and take the following format:

inlineStyle="color:rgb(255,0,255); font-family:Arial Helvetica Geneva sans-serif;font-size:large;"

The CSS style to apply to the whole portlet.

Values entered here take precedence over styles included in a CSS or skin on the specific portlet instance. For more information, see Understanding contentStyle and inlineStyle Properties.


63.4.8 Binding Attributes of the Portlet Tag

Table 63-6 describes the binding attributes of the portlet tag.

Table 63-6 Binding Attributes of the Portlet Tag

Attribute Value Description

binding

Name of a managed bean. For example:

binding="#{frameActionsBean.Binding}"

In the Property Inspector, click the Property Menu icon next to the field and then choose Edit to select a managed bean and specify the relevant managed bean property.

A binding reference to store the component instance. The binding reference binds an instance of the portlet to a managed bean property. Managed beans are any JavaBeans used by the application that are registered in the JSF faces-config.xml file.


63.4.9 Customization Attributes of the Portlet Tag

Table 63-7 describes the customization attributes of the portlet tag.

Table 63-7 Customization Attributes of the Portlet Tag

Attribute Value Description

customizationAllowed

false
true

Default: true

Whether design time customizations of the portlet tag are allowed on this portlet.

customizationAllowedBy

Text string

The roles for which design time customizations are allowed. This attribute enables you to allow customizations, but restrict who can actually perform them.


63.4.10 Other Attributes of the Portlet Tag

Table 63-8 describes the other attributes of the portlet tag.

Table 63-8 Other Attributes of the Portlet Tag

Attribute Value Description

iframeDtd

loose
none
strict

Default: loose

Which DTD, if any, is specified in the doctype declaration that is created when portlet content is rendered inside a IFRAME:

  • none—No DTD is specified. This relaxes the restrictions on the HTML content being technically conformant HTML. Browsers usually handle such HTML acceptably, however, because some CSS style sheet from the ADF Faces page consuming the portlet is also imported into the IFRAME document, for that style sheet to work correctly, it may be necessary to declare the content conformant to the loose or strict DTDs.

  • loose—The DTD http://www.w3.org/TR/html/loose.dtd is used.

  • strict—The DTD http://www.w3.org/TR/html/strict.dtd is used


63.4.11 What You May Need to Know About Maximize, Minimize, Restore, and Move

To accommodate the needs of the development environment, the behavior of the actions Minimize, Maximize, Restore, and Move for Show Detail Frame and portlet components differs between design time and runtime. At design time, these actions persist in a given WLS session, but do not persist over sessions (session means the time between starting and stopping WLS). At runtime, these actions persist both during a given WLS session and across sessions.

This difference has been introduced to enable an automatic reset of an application page at design time.

If persisting across sessions is not required at runtime, then a simple modification to the application's web.xml file can turn it off. Go to the following parameter setting in the application's web.xml file (Example 63-6):

Example 63-6 Persistence Setting in the Application's web.xml File

<context-param>
  <param-name>oracle.adf.view.faces.CHANGE_PERSISTENCE</param-name>
  <param-value>oracle.adfinternal.view.faces.change.HybridChangeManager</param-value>
</context-param>

Replace it with the following (Example 63-7):

Example 63-7 Turning Runtime Persistence Off in the Application's web.xml File

<context-param>
  <param-name>oracle.adf.view.faces.CHANGE_PERSISTENCE</param-name>
  <param-value>oracle.adf.view.faces.change.SessionChangeManager</param-value>
</context-param>

If security has been implemented on the application, then the Minimize, Maximize, Restore, and Move actions display only to users with Customize privileges. They do not display to users with Personalize privileges. Customize users can test the effect of these actions by following these steps at design time:

  1. Run the application page using JDeveloper's Integrated WLS.

  2. Log in as the administrator.

  3. Maximize a portlet. Move portlets around. Make whatever changes you want using the relevant actions commands.

  4. Log out, then log in as a user and check the effects of your actions.

63.4.12 What You May Need to Know About IFRAMEs

Placing a portlet inline on a page provides a better user experience as compared to placing it in an inline frame, or IFRAME. However, at times, it may be required to include the portlet markup inside an IFRAME. Setting the renderPortletInIFrame attribute to auto causes Oracle WebCenter Framework to render the portlet in an IFRAME if:

  • The portlet is a JSF Portlet.

  • The portlet contains a file upload element.

  • The parser throws an exception as it is not able to parse the markup.

  • You have specified that the portlet must be rendered in an IFRAME.

    To ensure that the portlet is always included in an IFRAME, edit the portlet.xml file and set the com.oracle.portlet.requireIFrame container runtime option to true for the portlet.

Note:

If you render a portlet within an IFRAME, then manipulating window.location may give unexpected results. If your portlet uses window.location, then you should ensure that your JavaScript is robust enough to handle the case where the portlet renders itself inside of an IFRAME.

Using IFRAMEs also has accessibility implications. For more information, see Section 2.9, "Overview of WebCenter Accessibility Features."

63.5 Copying Portlets

When you copy portlets, the portlets and their copies must reside within the same application. For example, you can copy a portlet from one page in an application to another page in the same project in that application, or from one place on a page to another place on the same page. You can also copy a portlet from one project to another project in the same application, if the target project is configured for consuming portlets. The copies are references to the same portlet instance, so customizations or personalizations made to any instance of the portlet (original or copy) affect all the other instances.

Copying a portlet is more than a matter of copying and pasting the portlet view tag. It involves copying portlet-related entries from the application page's source. It may also involve copying portlet-related entries from the page definition file and removing duplicate portlet binding information or creating a new method in the copied portlet's binding bean.

When a portlet is copied, the target page must be an Oracle ADF Faces page. Any preexisting code on the target page must reflect that. This is quite easy to accomplish. When JDeveloper creates a new JSF page, it contains pure JSF tags. The first time you drop an Oracle ADF Faces component onto the page, tags are automatically updated to be Oracle ADF Faces tags. For example, an <html> tag becomes <afh:html>, <head> and <title="title"> tags become <afh:head title="title">, and so on. Therefore, a simple way to ensure the conversion of the target page to an Oracle ADF Faces page is to place any Oracle ADF Faces component on the target page. This performs any required code conversion for you automatically.

This section includes the following subsections:

63.5.1 How to Copy a Portlet and Place it on the Same Page

Because all of the page's resources are available to both portlet instances when you copy a portlet to the same page, there is no requirement to copy portlet-related information from the page's Page Definition file. It is just a matter of copying and pasting the portlet's view tag, and assigning a unique identifier to the copy.

To copy and place a portlet on the same page:

  1. In the Application Navigator, open the application that contains the page on which the portlet to copy appears.

  2. Expand the project that contains the page.

  3. Locate the page, right-click it, and then choose Open.

    Tip:

    You can also double-click the page to open it.
  4. In the design view, select the portlet to copy.

  5. Click the Source tab. The portlet that you selected is highlighted in the source code.

  6. Copy the portlet tag (Example 63-8).

    Example 63-8 Code Fragment to be Copied When Copying a Portlet

    <f:view>
      <afh:html binding="#{backing_portlet_page.html1}" id="html1">
        <afh:head title="portlet_page" binding="#{backing_portlet_page.head1}"
          id="head1">
          <meta http-equiv="Content-Type"
            content="text/html;charset=windows-1252"/>
        </afh:head>
        <afh:body binding="#{backing_portlet_page.body1}" id="body1">
          <h:form binding="#{backing_portlet_page.form1}" id="form1">
            <adfp:portlet value="#{bindings.portlet1}"
              portletType="/oracle/adf/portlet/
              pdksampleproducer_1153245807295/applicationPortlets/
              Portlet2_82d49b79_010c_1000_8006_82235ffc4e2b"
              binding="#{backing_portlet_page.portlet1}"
              id="portlet1"
              isCustomModesAvailable="true"/>
          </h:form>
        </afh:body>
      </afh:html>
    </f:view>
    
  7. Paste the copied code fragment into the desired location of the page source.

  8. Provide a unique value for the copy's id attribute (Example 63-9).

    Example 63-9 Changing the Portlet ID

    <adfp:portlet value="#{bindings.portlet1}"
      portletType="/oracle/adf/portlet/
      pdksampleproducer_1153245807295/applicationPortlets/
      Portlet2_82d49b79_010c_1000_8006_82235ffc4e2b"
      binding="#{backing_portlet_page.portlet1}"
      id="portlet2"
      isCustomModesAvailable="true"/>
    

    Note:

    On a given page, each portlet must have a unique ID.
  9. In the page source, if the copied portlet's adfp:portlet tag has a binding attribute, for example:

    binding="#{backing_untitled2.portlet1}"
    

    Then either remove this binding, or create a new method in the binding bean by opening the managed bean class for this managed bean and defining the new method.

    For example, if portlet1 is copied, the pasted copy becomes portet2 in the managed bean class, as shown in Example 63-10.

    Example 63-10 Creating a New Method for a Managed Bean in the Managed Bean Class

    .
    private PortletBase portlet2;
    public void setPortlet2(PortletBase portet2) {
       this.portlet2 = portlet2;
    }
    .
    public PortletBase getPortlet2() {
       return portlet2;
    }
    
  10. From the main menu, choose File > Save All.

63.5.2 How to Copy a Portlet from One Application Page to Another

When you copy a portlet from one page to another in an application, portlet-related code must also be copied from the source page's Page Definition file. This section describes the steps related to both copying from one application page to another and from one application project to another.

To copy a portlet from one page to another:

  1. In the Application Navigator, open the application that contains the page on which the portlet to copy appears.

  2. Expand the project that contains the page.

  3. Locate the page, right-click it, and then choose Open.

    Tip:

    You can also double-click the page to open it.
  4. In the design view, select the portlet to copy.

  5. Click the Source tab. The portlet that you selected is highlighted in the source code.

  6. Copy the portlet tag (Example 63-11).

    Example 63-11 Source Page Code Fragment to Be Copied When Copying a Portlet

    <f:view>
      <afh:html binding="#{backing_portlet_page.html1}" id="html1">
        <afh:head title="portlet_page" binding="#{backing_portlet_page.head1}"
          id="head1">
          <meta http-equiv="Content-Type"
            content="text/html;charset=windows-1252"/>
        </afh:head>
        <afh:body binding="#{backing_portlet_page.body1}" id="body1">
          <h:form binding="#{backing_portlet_page.form1}" id="form1">
            <adfp:portlet value="#{bindings.portlet1}"
              portletType="/oracle/adf/portlet/
              pdksampleproducer_1153245807295/applicationPortlets/
              Portlet2_82d49b79_010c_1000_8006_82235ffc4e2b"
              binding="#{backing_portlet_page.portlet1}"
              id="portlet1"
              isCustomModesAvailable="true"/>
          </h:form>
        </afh:body>
      </afh:html>
    </f:view>
    
  7. Go to the application page to which to copy the portlet (the target page).

    Portlets can reside only on Oracle ADF Faces pages. If the target page does not contain Oracle ADF Faces components, then ensure that the container objects—that is, any tags the portlet tag is nested in—use Oracle ADF tags.

    If you are copying the portlet to a page in a different project, the target project must be configured for consuming portlets. To configure the project, you must register a portlet producer with the project. For information, see Section 63.2, "Registering Portlet Producers with a WebCenter Portal Application."

  8. Click the Source tab and paste the copied code fragment into the desired location of the page source.

  9. In the Application Navigator, right-click the source page (the page from which the portlet was copied), and choose Go to Page Definition.

  10. Click the Source tab and copy the portlet binding from the source page's page definition file (Example 63-12).

    Example 63-12 Code Fragment to Be Copied From a Page Definition File

    <portlet id="portlet1"
      portletInstance="/oracle/adf/portlet/pdksampleproducer_1153245/applicationPortlets/Portlet2_82d49_010c_1000_8006_82235"
     class="oracle.adf.model.portlet.binding.PortletBinding"
     xmlns="http://xmlns.oracle.com/portlet/bindings"/>
    

    Note:

    When the portlet being copied includes parameters, be sure to include the copied portlet's portlet parameters and the page variables linked to the portlet parameters in the copy.
  11. In the Application Navigator, right-click the target page and choose Go to Page Definition.

    If a page definition does not exist for the page, you are asked if you want to create one. Click Yes.

  12. Click the Source tab and paste the portlet binding you copied from the source (along with relevant portlet parameters and the page variables associated with those parameters).

    Paste the code between the <executables> tags. You may need to add a closing </executables> tag and ensure that the opening tag does not contain a slash (/).

  13. From the main menu, choose File > Save All.

63.6 Deleting Portlets from Application Pages

When you delete a portlet from an application page, if the portlet had parameters, then you should also delete page variables associated with those parameters from the application page's Page Definition file.

To delete a portlet and its related page variables from a page:

  1. In the Application Navigator, open the application that contains the page on which the portlet to delete appears.

  2. Expand the project that contains the page.

  3. Locate the page, right-click it, and then choose Open.

    Tip:

    You can also double-click the page to open it.
  4. In the design view, right-click the portlet to delete and choose Delete.

    This deletes the portlet from the page and the portlet binding from the Page Definition file.

  5. If the portlet included variables, in the Application Navigator, right-click the page and choose Go to Page Definition.

  6. Click the Source tab and locate the page variables associated with the deleted portlet, and delete them from the page definition file.

    For example, if you deleted portlet1, you would also delete the highlighted variables in Example 63-13:

    Example 63-13 Deleting Portlet-Related Page Variables from a Page Definition File

    <?xml version="1.0" encoding="UTF-8" ?>
    <pageDefinition xmlns="http://xmlns.oracle.com/adfm/uimodel"
        version="10.1.3.38.97" id="untitled1PageDef"
        Package="project1.pageDefs">
      <parameters/>
      <executables>
        <variableIterator id="variables">
            <variable Name="portlet1_param1" Type="java.lang.Object"/>
            <variable Name="portlet1_param2" Type="java.lang.Object"/>
            <variable Name="portlet2_param1" Type="java.lang.Object"/>
            <variable Name="portlet2_param2" Type="java.lang.Object"/>
        </variableIterator>
        <portlet id="portlet2" portletInstance="/oracle/adf/portlet/
            PdkPortletProducer2_1154100666247/applicationPortlets/
            Portlet1_b5e49696_010c_1000_8008_8c5707ef9c4f"
            class="oracle.adf.model.portlet.binding.PortletBinding"
            xmlns="http://xmlns.oracle.com/portlet/bindings">
          <parameters>
             <parameter name="param1" pageVariable="portlet2_param1"/>
             <parameter name="param2" pageVariable="portlet2_param2"/>
          </parameters>
        </portlet>
      </executables>
      <bindings/>
    </pageDefinition>
    
  7. From the main menu, choose, select File > Save All.

63.7 Adding the Portlet Producer Task Flow

The portlet producer task flow (Producer) enables users to manage portlet producer connections at runtime.

For applications created using the WebCenter Portal Application template, the portlet producer task flow is available out of the box through the WebCenter Portal Application Administration pages (Services tab). For details, see the chapter "Managing Services, Portlet Producers, and External Applications" in the Oracle Fusion Middleware Administrator's Guide for Oracle WebCenter.

In addition, just like other task flows, you can add the portlet producer task flow to your application pages. This might be especially useful if you are not using the WebCenter Portal Application template and the Administration pages are therefore not part of your project. Special permissions are required to manage or view portlet producer connections through the Producer task flow:

By default, users with the Administrator role can manage portlet producers. If you want other users to manage connections through the portlet producer task flow, you must grant them the AppConnectionManager role.

To add the portlet producer task flow:

  1. Create or open a JSF page in your application where you want the task flow to be added (see Section 5.2.2, "Adding Pages to the Portal").

  2. In the Resource Palette, expand My Catalogs, WebCenter Services Catalog, and Task Flows.

  3. Drag Producer from the Resource Palette and drop it onto the page inside the af:form tag.

  4. Grant the AppConnectionManager role to one or more test users, if required:

    1. Add the test user TEST_PROD.

    2. Grant the AppConnectionManager role.

    For information about how to add a user and grant this role, see the section "Creating Test Users" in the Oracle Fusion Middleware Fusion Developer's Guide for Oracle Application Development Framework.

  5. Save and run your page. Login as an administrator or the TEST_PROD user defined in the previous step. The screen shown in Figure 63-10 appears.

    Figure 63-10 The Portlet Producer Task Flow

    Description of Figure 63-10 follows
    Description of "Figure 63-10 The Portlet Producer Task Flow"

    Note:

    At runtime, application administrators can grant users the AppConnectionManager and AppConnectionViewer roles through WebCenter Portal Administration (see the section "Adding Members to Application Roles" in the Oracle Fusion Middleware Administrator's Guide for Oracle WebCenter). Alternatively, system administrators can grant AppConnectionManager and AppConnectionViewer roles through Fusion Middleware Control (see "Granting Application Roles Using Fusion Middleware Control" in the Oracle Fusion Middleware Administrator's Guide for Oracle WebCenter).