1. Open Oracle JDeveloper.
2. In the Application Navigator, expand Application Resources node.
3. In the Application Resources, right-click Connections, and select New Connection, then select WSRP Producer from the context menu.

   The Specify Producer Name page of the Register WSRP Portlet Producer wizard opens.

   Figure 14-1 Specify Producer Name page of the Register WSRP Portlet Producer

   
   

   

   
   
4. On the Specify Producer Name page, enter the WSRP portlet producer details.

   Fields	Description
   Create Connection in	Select the create connection option depending on how you accessed the wizard. Application Resources—Choose this option if you invoked the wizard from an application. This is the default selection. Resource Palette—Choose this option if you invoked the wizard from the Resource Palette.
   Target Project	Select the project to be configured in which you intend to consume the portlets for the WSRP producer connection. Note: You can change this option only if you invoked the wizard from the Application Navigator.
   Producer Registration Name	Enter a name for the producer registration that is unique among all connections.

5. Click Next.

   The Specify Connection Details page of the Register WSRP Portlet Producer wizard opens.

   Figure 14-2 Specify Connection Details page of the Register WSRP Portlet Producer

   
   

   

   
   
6. On the Specify Connection Details page, enter the connection details for the WSRP portlet producer.

   Fields	Description
   WSDL URL	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
   Use Proxy for Contacting Producer	Select the option if your application and the producer are separated by a firewall. An HTTP proxy is needed for communication between the application and the producer, if it is separated by a firewall. 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 then 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.

   The Specify Additional Registration Details page of the Register WSRP Portlet Producer wizard opens.

   Figure 14-3 Specify Additional Registration Details page of the Register WSRP Portlet Producer wizard

   
   

   

   
   
8. On the Specify Additional Registration Details page, 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.

9. Choose one of the following options.

   • Click Finish, if you are registering the producer in the Resource Palette 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 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.

   • Click Next, 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.

     If you do not want to configure security, click Finish.

   If you click Next, the Configure Security Attributes page of the Register WSRP Portlet Producer wizard opens.

   Figure 14-4 Configure Security Attributes of the Register WSRP Portlet Producer wizard

   
   

   

   
   
10. In the Configure Security Attributes page, specify the type of security token used for authentication with the WSRP producer.

    Fields	Description
    Token Profile	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 WSS 1.0 SAML Token with Message Protection— When you select this policy, you must also specify the Recipient Alias in the Specify Key Store page. WSS 1.0 User Name Token without Password— 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. WSS 1.0 User Name Token with Password—When you select this policy, you must also specify the Recipient Alias in the Specify Key Store page. When you select this policy, you must also specify the Recipient Alias WSS 1.0 SAML Token —This policy does not require any keystore configuration. WSS 1.1 SAML Token with Message Protection For more information on the Token Profile, see WSRP Producer Security Connection Parametersin Administering Oracle WebCenter Portal
    Configuration	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 taken 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 Administering Oracle WebCenter Portal. Custom—If you select this option, then you must enter the appropriate keystore attributes in the next page of the wizard.
    Default User	Enter a user name to assert to the remote producer when the user has not authenticated to the 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 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.
    Issuer Name	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 drop-down list, and Custom from the Configuration options. The issuer name is the attesting entity that vouches for the verification of the subject.
    Associate Producer with External Application	Select the application, if this producer must provide authentication to an external application. This option is available only if you selected User Name Token with Password.

11. Choose one of the following options.

    • Click Finish, if you selected Default as the configuration option the fields on the Specify Key Store page are disabled.

      If the producer declares user categories, when you click Finish, the Register WSRP Portlet Producer dialog displays. Click Yes and see 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.

    • Click Next to continue.

    If you selected Next, the Specify Key Store page of the Register WSRP Portlet Producer wizard opens.

    Figure 14-5 Specify Key Store of the Register WSRP Portlet Producer wizard

    
    

    

    
    
12. On the Specify Key Store page, specify the keystore details.

    Fields	Description
    Store Path	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.
    Store Password	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 drop-down 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.
    Store Type	The store type is always JKS (Java Key Store). The Store Type value is read from the keystore and is never editable.
    Signature Key Alias	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.
    Signature Key Password	Specify the password for accessing the key identified by the alias specified in Signature Key Alias.
    Encryption Key Alias	(Optional) 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.
    Encryption Key Password	Specify the password for accessing the key identified by the alias specified in Encryption Key Alias.
    Recipient Alias	Select the keystore alias that is associated with the producer's certificate. 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.

13. Click Finish.

    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 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.

    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 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.

1. After you click Finish in the Register WSRP Portlet Producer wizard, click Yes in the resulting dialog.
2. In the User Categories dialog, 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.
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.

1. Open Oracle JDeveloper.
2. In the Application Navigator, expand Application Resources node.
3. Navigate to the producer and right-click to edit, then choose Properties.
4. Edit the producer registration properties as required, click Next to step through the pages of the wizard.

   Figure 14-9 Edit Portlet Producer

   
   

   

   
   

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

   • For information about WSRP Producer settings, see Registering a WSRP Portlet Producer with WebCenter Portal

   • For information about Oracle PDK-Java Producer settings, see Registering an Oracle PDK-Java Portlet Producer with WebCenter Portal

   You cannot edit the Producer Registration Name.

5. When you have changed all the necessary settings, click Finish.
6. 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.

7. Click OK when the producer has been successfully refreshed, if necessary.
8. Once you have completed your edits, consider testing the producer connection to be sure the connection information is valid. For more information, see Testing a Portlet Producer Connection.

1. Open Oracle JDeveloper.
2. In the Application Navigator, expand Application Resources node.
3. Navigate to the producer and right-click the producer to test, and choose Test Producer Connection.
4. 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.

1. Open Oracle JDeveloper.
2. In the Application Navigator, expand Application Resources node.
3. Navigate to the producer and right-click the producer you want to refresh, and choose Refresh Producer Registration.
4. In the Portlet Producer Refresh dialog, click Yes.

1. Open Oracle JDeveloper.
2. In the Application Navigator, expand Application Resources node.
3. Navigate to the producer and right-click the producer you want to delete, and choose Delete.
4. In the Delete Confirmation dialog, click Yes.

1. Open Oracle JDeveloper.
2. In the Application Navigator, open the application that contains the page (.jspx file) to which you want to add the portlet.
3. Expand the project that contains the page.
4. Locate the page, right-click it, and then choose Open.

   Tip:

   You can also double-click the page to open it.

5. Under the Connections node in the Application Resources panel, or in the Resource Palette,

   • Expand the WSRP Producer node, if the producer is a WSRP producer.

   • Expand the Oracle PDK-Java Producer node, if the producer is a PDK-Java producer.

6. 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.
7. 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.

   • Select 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 add a portlet as a Trinidad component, that is, inside a tr:form component, and the portlet implements modes other than View mode, you must include the following in the application's web.xml file:

   <context-param>
     <param-name>
       oracle.adf.view.rich.newWindowDetect.OPTIONS
     </param-name>
     <param-value>off</param-value>
   </context-param>

   Note:

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

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

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 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. In this case, the portlet is added using the adfp:portlet tag, as shown in the following example:.

<?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, as shown in the following example.

<?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 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 the following example:

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

One way to make your application more interactive is by linking related components such that their contents are synchronized based upon the context. For example, suppose you have two stock portlets on a page, one provides data about a stock's price while the other provides headline news items for a stock. Both portlets are based upon the stock ticker symbol, hence it would make sense that, when the ticker symbol is changed in the stock price portlet, the stock headlines portlet picks up that change and refreshes itself with headlines pertaining to the same ticker symbol.

The JSR 286 standard introduces public render parameters, which you can use to link portlets on a page. See How to Use Public Render Parameters in JSR 286 Portlets.

The JSR 286 standard also supports portlet events. You can use portlet events to drive the content of a portlet based on actions that occur elsewhere on the page. Portlet events can be cascaded so that a portlet may respond to an event by triggering an event of its own, which in turn affects other portlets on the page. Portlet events can also be consumed by ADF contextual events and contextual events can be consumed by portlets. You can use this to contextually link portlets and task flows. See How to Use Portlet Events in JSR 286 Portlets.

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.

<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 that are changed or events that are raised elsewhere on the page that match those supported by the portlet (that is, they have the same QName) automatically cause the portlet to be updated accordingly. In addition, the portlet can define aliases for its parameters and events to match parameters and events with different QNames.

You can set these attributes to false to disable this automatic parameter and event listening. 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, or if your portlet defines parameters or events with names that do not match those you want to use for linking, you must manually configure the portlet wiring. See Manually Wiring Parameters and Events in JSR 286 Portlets.

Rendering a portlet directly on a page provides a better user experience as compared to placing it in an inline frame (iframe). However, at times, it may be required to include the portlet markup inside an inline frame. You can use the renderPortletInIFrame attribute to determine whether or not a portlet should be rendered in an inline frame.

The default setting of the renderPortletInIFrame attribute is auto. This causes the portlet consumer to attempt to rewrite the portlet markup whenever possible, so that it renders correctly within the Oracle ADF page without the need for an inline frame.

However, in the following circumstances, the portlet is rendered within an inline frame:

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

• The portlet code contains a multi-part form post.

• The portlet code contains a file upload element.

• The portlet developer explicitly requested that the portlet be rendered in an inline frame by setting the com.oracle.portlet.requireIFrame container runtime option in the portlet.xml file to true.

In some circumstances, the portlet consumer may be unable to rewrite the portlet markup and JavaScript to accommodate the portlet in the Oracle ADF page. If this is the case, you may find that the portlet does not behave as expected, for example, buttons do nothing or you get JavaScript errors in the console. If this happens, you should set the renderPortletInIFrame attribute to true so that the portlet is always rendered in an inline frame.

Some examples of when you should set renderPortletInIFrame to true are when:

• The portlet code builds up element names dynamically in JavaScript.

• The portlet code uses multiple forms and references them in JavaScript by index.

• JavaScript library code references elements within the portlet.

If you render a portlet within an inline frame, 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 an inline frame.

If you want to ensure that a portlet is never rendered in an inline frame, for example for accessibility reasons, set the renderPortletInIFrame attribute to false. Note however, that HTML markup from a portlet that is not rendered in an inline frame may interfere with other components on the Oracle ADF page.

For more information about the accessibility implications of using inline frames, see WebCenter Portal Accessibility Features.

ADF Faces components can stretch their children, or not. It is usually a requirement that a parent only contains a single child for it to be able to stretch that child. Components also support being stretched or not. When a component that supports being stretched is placed inside a parent that is stretching its child, the dimension of the child is determined by those of the parent. The child is said to be stretched by the parent and it is sized to fill the parent.

When a component is not stretched by its parent, it is said to be in a flow layout. Here it is not taking its size from its parent. It must determine its own size, either from its children or from dimension style settings specified by the page designer.

The portlet Faces component supports being stretched by its parent. It does not explicitly stretch its children.

There are three ways the size of a portlet component is determined, depending on the portlet's parent component and attributes set on the portlet component itself.

• If the portlet is being stretched by its parent, the size is determined only by the parent. The portlet is in a stretch layout.

  • It does not matter how big the content is, this is irrelevant to the size of the portlet. If the content is bigger than the portlet, scrollbars are provided to enable users to display all the content.

  • If you specify a height for the portlet, it is ignored; stretching takes precedence.

  • This is the preferred layout method; it is always reliable.

  • The ADF Faces Tag documentation tells you whether each component stretches its children or not.

• If the portlet is not being stretched by its parent and explicit sizes are set, they are used.

  • This is also always reliable; you'll get the size you specified.

  • If the content is bigger than the specified size, scrollbars are provided to enable users to display all the content.

  • The size is fixed; the size of the content is not taken into account.

• If the portlet is not being stretched by its parent and no explicit sizes are set, the portlet attempts to auto-size to the content.

To accommodate the needs of the development environment, the behavior of the actions Minimize, 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.

<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.

<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, 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. Minimize 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.

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. For more information about portlets generally, see Introduction to Portlets.

When running a portlet that has an Edit mode (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.

<factory nameSpace="http://xmlns.oracle.com/portlet/bindings"
className="oracle.adf.model.portlet.binding.PortletBindingDefFactoryImpl"/>
<dtfactory className="oracle.adfdtinternal.view.faces.portlet.PortletDefinitionDTFactory"/>

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.

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.

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.

   The following example shows an edited portlet tag.

   <adfp:portlet value="#{bindings.portlet1}"
                 portletTypes="/oracle/adf/portlet/WsrpPortletProducer1/applicationPortlets/
                              E0default_b452f828_010a_1000_8002_82235f57eaa8"
                                  allModesSharedScreen="true"
                               />

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

The following describes the common attributes of the portlet tag.

The following table describes the appearance attributes of the portlet tag.

The following table describes the behavior attributes of the portlet tag.

partialTriggers="_id1 _id2 componentID5"

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 the following table, 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.

The following table describes the style attributes of the portlet tag.

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

The following table describes the binding attributes of the portlet tag.

binding="#{frameActionsBean.Binding}"

The following table describes the customization attributes of the portlet tag.

The following table describes the other attributes of the portlet tag.

When you place a portlet on a page, any public render parameters with the same QName are automatically linked. For example, if one portlet publishes a value to a parameter with the name myParam, then if a second portlet on the page accepts values from a parameter with the same name, the second portlet is automatically updated with the appropriate value.

Portlets can also link together using parameters with different QNames if the portlet developer has set up aliases for the parameter.

The following example shows how to use public render parameters to link the behavior of two portlets using parameters with different names and no defined aliases. In the example, we take a generic Parameter Form portlet that allows us to update public render parameters, and show how that can be linked to a Stock Price portlet that renders stock prices, taking the stock symbol from a public render parameter.

When these two portlets are dropped onto the same page, they are not automatically linked together. This is because none of the generic parameter names in the Parameter Form portlet match the stocksymbol parameter in the Stock Price portlet, and the Stock Price portlet does not define any aliases for the stocksymbol parameter that match the generic parameter names in the Parameter Form portlet.

There are two methods for manually linking parameters:

• Manually Linking Parameters Using Page Variables

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.
   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.
   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

   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 and select Save All.

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.
   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 Registering an Oracle PDK-Java Portlet Producer with WebCenter Portal.

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.
    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 then select Save All.

If the portlet displays a Remote Portlet Error, this indicates that the producer responded with an error message. The error message is returned in the form of a SOAP fault message inside the response document. There are a number of reasons the producer might return an error. The best strategy to diagnose these errors is to first find the corresponding exception stack trace in the consumer diagnostic logs. This stack trace shows what kind of fault was returned by the producer, plus any further information required in the response. Some faults you may encounter are listed in the following sections.

Problem 1

OperationFailedException. This is the most common type of Remote Portlet Error and it is a catch-all for most unhandled exceptions raised in the producer application.

Solution 1

To resolve an OperationFailedException, examine the exception in the consumer diagnostic logs. This generally shows any exception that was raised in the producer application to trigger the fault response as the final Caused by exception.

Problem 2

InvalidRegistrationException. This error indicates that the producer has not been properly registered with the consumer before the consumer attempted to communicate with it. This could also occur if the producer's preference store has been moved or deleted since the consumer registered it.

Solution 2

The most likely cause is a problem during provisioning. It is also worth checking the producer application's web.xml file setting to ensure that the entry shown in the example is present.

<env-entry>
  <env-entry-name>oracle/portal/wsrp/server/persistentStore</env-entry-name>
  <env-entry-type>java.lang.String</env-entry-type>
  <env-entry-value>Consumer</env-entry-value>
</env-entry>

Problem 3

InvalidHandleException. This indicates that the consumer has asked the producer to render, or otherwise interact with, a portlet instance that the producer does not know about. This could occur if the producer's preference store has been corrupted in some way since the portlet was added to the page.

Solution 3

This error is most likely caused by a problem during provisioning, or a missing persistentStore setting in the web.xml file, as described in Solution 2.

Problem 4

AccessDeniedException. This indicates that the producer application decided that the current user did not have access to the portlet or task flow in question.

Solution 4

This could either be a legitimate error message or an indication of a configuration problem. In most cases, WebCenter Portal should deal with authorization errors gracefully, without a Portlet Remote Error being displayed.