64 Create Customizable Applications

1. In the Application Navigator in JDeveloper, right-click your view project and choose Project Properties.
2. In the Project Properties dialog, select ADF View to display the ADF View settings.
3. Select Enable User Customizations and select Across Sessions Using MDS, as shown in Figure 64-1.
4. Select Enable Seeded Customizations.

   Figure 64-1 Project Properties — ADF View

   
5. Click OK.

1. In the Application Navigator in JDeveloper, right-click the application and select Application Properties.
2. In the Application Properties dialog, select Resource Bundles.
3. Click Add.
4. Type the following string in the File Name field in the Select Resource Bundle dialog.

   oracle.adf.view.page.editor.resource.ComposerOverrideBundle.xlf
   

5. Click Open.
6. Select the Overridden check box.
7. Click OK to save your changes.
8. Open the adf-config.xml file, which is located in the Application Resources > Descriptors > ADF META_INF folder.
9. Add the resource-string-editor element shown in Example 64-2 to the page-editor-config section to enable resource string editing.

<pe:page-editor-config>
  ...
  <resource-string-editor>
    <enabled>
      #{GlobalAreaBackingBean.tipLayerNonUser}
    </enabled>
  </resource-string-editor>
</pe:page-editor-config>

1. Right-click your view project and select Project Properties.
2. Select Technology Scope.
3. Add the Oracle WebCenter Portal — Composer technology scope to your project and click OK.

1. From JDeveloper, open the JSF page fragment (.jsff) from where the UI Shell can be edited.
2. In the Application Navigator, expand the Data Controls hierarchy to locate and expand the FndUIShellController.
3. Drag and drop the customizeUIShellTemplate operation onto the page, and choose Create > Method > ADF Button or choose Create > Method > ADF Link.
4. In the Edit Action Binding dialog, provide a comma delimited list of fully packaged qualified customization classes for the custClass parameter, as shown in Example 64-3.

   Each of the customization classes supplied in the list must be valid and configured in the adf-config.xml file, as shown in Figure 64-2.

   Figure 64-2 adf-config.xml — Customization Classes

   

   If any of the classes cannot be instantiated, or if they are not pre-configured in the adf-config.xml file, an exception is thrown at runtime.

   The last customization class specified is the tip customization layer and the modifications to the UI Shell is written to this layer. In Example 64-3, the customization of the UI Shell takes place in SiteCC. The purpose of the earlier customization in the list is to view the UI Shell with any other customizations applied.

   For information about customization layers, see the "Understanding Customization Layers" section in the Extensibility Guide for Developers.

5. Click OK.
6. Open the page definition file for the page fragment.
7. In the editor window, click the Source tab.
8. Add the <methodAction> element shown in Example 64-4 to the <bindings> element. The id attribute must be set to custNavigate, which is the key to the customizeUIShellTemplate operation that you dropped on the page in Step 3.
9. Add the view permission for oracle_apps_fnd_applcore_template_customization_TemplateCustomizationUIShellPageDef (the customization page) for each role for which you want to enable the view action as described in How to Authorize the Runtime Customization of Pages and Task Flows. To access oracle_apps_fnd_applcore_template_customization_TemplateCustomizationUIShellPageDef in the Resource Grants navigation tab, select Web Page from the Resource Type dropdown list and select Show web pages imported from ADF libraries.

oracle.apps.fnd.applcore.customization.GlobalCC,oracle.apps.fnd.applcore.customization.SiteCC

  <bindings>
    <methodAction id="custNavigate" RequiresUpdateModel="true"
                  Action="invokeMethod" MethodName="navigate"
                  IsViewObjectMethod="false" DataControl="FndUIShellController"
                  InstanceName="FndUIShellController.dataProvider"
                  ReturnName=
"FndUIShellController.methodResults.navigate_FndUIShellController_dataProvider_navigate_result">
      <NamedData NDName="viewId" NDValue="TemplateCustomizationUIShell"
                 NDType="java.lang.String"/>
      <NamedData NDName="webApp" NDType="java.lang.String"/>
      <NamedData NDName="pageParametersList" NDType="java.lang.String"/>
      <NamedData NDName="navTaskFlowId" NDType="java.lang.String"/>
      <NamedData NDName="navTaskKeyList" NDType="java.lang.String"/>
      <NamedData NDName="navTaskParametersList" NDType="java.lang.String"/>
      <NamedData NDName="navTaskLabel" NDType="java.lang.String"/>
      <NamedData NDName="methodParameters"
  NDType="oracle.apps.fnd.applcore.patterns.uishell.ui.bean.FndMethodParameters"/>
    </methodAction>
  </bindings>

1. From the Database Navigator, right-click the ApplicationDB node under your application's node and choose Properties.
2. Make a note of the settings and click Cancel.
3. Right-click IDE Connections and choose New Connection.
4. Enter the settings that you noted in Step 2.
5. Click Test Connection to ensure the settings are correct.
6. Click OK.

   The database connection appears under the IDE Connections node.

1. Ensure that the customizable pages have page definition files.
2. Make pages runtime editable by adding Page Composer components to the pages.
3. If you are enabling the runtime addition of content, set up a resource catalog.
4. (Optional) Set up a default catalog definition file to facilitate testing.

1. In the Application Navigator, select the .jspx page.
2. In the Structure window, select the af:pageTemplate component.
3. In the Property Inspector, select true from the isPersonalizableInComposer dropdown list.

1. In the Application Navigator, select the page or fragment for which you want to edit customization properties.
2. If you are restricting the customization of a component, select the component in the Structure window.
3. If the Property Inspector is not open, choose Property Inspector from the View menu.
4. In the Property Inspector, expand Customization.
5. Set the appropriate customization attribute.

   • To disable runtime customization, set Customization Allowed to false.

   • To restrict customization to specific sets of users and layers, set Customization Allowed By to a space-separated list of the security roles for which you wish to permit customization.

As described in How to Restrict Customization of a Page_ Page Fragment_ or Component , all end users who can personalize or customize a page can use Page Composer to change the layout on a page by default.

For some pages, Page Composer enables end users to configure a page in either Source view or Design view. For other pages, end users can only configure the page in Design view. By default, end users can add and edit components in Source view. In Design view the default is to allow end users to add components to a page but not edit existing components. You can configure the page to allow users to select components for editing in Design view, as shown in Figure 64-4, or you can configure the page to disallow both adding and editing components.

Figure 64-4 Page Configured to Allow Users to Add and Edit Components

If a page has properties with EL expressions that you do not want changed, you can set all existing property EL expressions to read-only. For example, the page in Figure 64-4 was configured to disallow the editing of existing EL expressions and, therefore, the user cannot edit the Action Listener property. In addition, you can configure a page to disallow entering new EL expressions. That is, you can prevent users from entering EL expressions in property fields that do not currently contain EL expressions.

Figure 64-5 Page Configured to Not Allow Editing of Existing EL Expressions

Table 64-1 lists the properties that you set at the af:pageTemplate level to control the editing of components in Page Composer.

Table 64-2 lists all possible combinations of allowELInComposer and protectELInComposer property values and describes how each combination affects the user's ability to add and edit EL expressions.

1. In the Application Resources panel, expand Descriptors, expand META-INF nodes, and then double-click jazn-data.xml.

   Tip:

   If the jazn-data.xml file does not exist, you can create it by right-clicking the META-INF node, selecting New Oracle Deployment Descriptor, selecting jazn-data.xml, and then clicking Finish.

2. In the overview editor, click the Resource Grants navigation tab, as shown in Figure 64-6.

   Figure 64-6 Resource Grants Tab in jazn-data.xml Overview

   
3. Select Web Page from the Resource Type dropdown list.

   You use the Web Page resource type for both web pages and page fragments.

4. Set the Source Project to ViewController.
5. For each Page Composer enabled web page, select the Customize action for each role for which you want to enable page customization.

   You must also authorize customization for the task flows, as described in the following two steps.

6. Select Task Flow from the Resource Type dropdown list.
7. For each task flow, select the Customize action for each role for which you want to enable customization of the components in the task flow.
8. If you want the task lists that are exposed in your pages to be customizable for your application, select the entry for TaskList in the Resources list, and, for each role for which you want to enable task list customization, select the customize and grant actions.

Certain ADF Faces components have attributes that can be saved during a user session. For example, if a user expands a panel box component, the box will be expanded when the user returns to the page. This type of change is referred to as implicit runtime customization. For information about which component properties can be persisted, see the Allowing User Customizations at Runtime chapter in the Developing Fusion Web Applications with Oracle Application Development Framework.

In How to Set Project Properties to Enable User and Seeded Customizations, you configured the application to persist implicit runtime customizations across sessions as well as within sessions.

The attributes that can be persisted are set in the tag library, but you can override these settings. For example, you might not want the end users to change column widths, but you want all other default attribute changes for columns to be persisted. You set and unset these values in the Overview Editor for the adf-config.xml file, as described in the Configuring User Customizations section in the Developing Fusion Web Applications with Oracle Application Development Framework. You can also override these settings for specific components, as described in the Controlling User Customizations in Individual JSF Pages section in the Developing Fusion Web Applications with Oracle Application Development Framework.