| Oracle® Fusion Middleware Developer's Guide for Oracle WebCenter 11g Release 1 (11.1.1.5.0) Part Number E10148-15 |
|
|
View PDF |
| Oracle® Fusion Middleware Developer's Guide for Oracle WebCenter 11g Release 1 (11.1.1.5.0) Part Number E10148-15 |
|
|
View PDF |
You can extend or alter the look and feel and functionality of Oracle WebCenter task flows using the Oracle JDeveloper Customization Developer role. When you apply task flow customizations to a deployed WebCenter application, the customizations apply to all instances of that task flow in the application. You do not need to deploy customizations for individual task flow instances.
In WebCenter Spaces, task flow customizations are deployed at application-level, so any customizations that you make will apply to all Spaces. You cannot deploy them to a particular Space.
Note:
While you can perform view-level customizations to WebCenter applications, such as task flow customization, ADF model and Controller customizations are not supported in this release. To learn more about the different customization types, see the Oracle Fusion Middleware Java EE Developer's Guide for Oracle Application Development Framework.This chapter includes the following sections
Section 24.1, "Preparing for Task Flow Customization": Before you can customize task flows, you must enable your application to accept these customizations.
Section 24.2, "Configuring the JDeveloper Customization Developer Role": After you have enabled customization for your application, you must configure the customization layer values to use in the JDeveloper Customization Developer role.
Section 24.3, "Customizing Oracle WebCenter Task Flows": The instructions in this section describe how to customize task flows in WebCenter Spaces or a WebCenter Portal application. The examples in this section demonstrate WebCenter task flow customization using the JDeveloper Customization Developer role.
Section 24.4, "Applying Task Flow Customizations to Deployed WebCenter Applications": Once you complete a task flow customization, you must apply it to the deployed WebCenter application by following the steps in this section.
Section 24.5, "Removing Customizations from Deployed WebCenter Applications": To revert task flow behavior or look and feel to the original deployment, remove the task flow customizations using the steps in this section.
Section 24.6, "Catalog of WebCenter Task Flows": This section lists WebCenter task flows available for customization.
Follow the steps below to prepare WebCenter applications for customizing task flows.
In JDeveloper, install the WebCenter Customization JDeveloper Extension. To do so, choose Help > Check for Updates.
In the Check for Updates wizard, click Next.
On the Search for Updates page, select the Oracle Fusion Middleware Products update center, and click Next.
On the Updates page, in the Available Updates field, enter webcenter.
Select the Oracle WebCenter Customization Framework Design Time extension and click Finish. You may also want to install the new version of the Oracle WebCenter Framework and Services Design Time extension.
If you are customizing task flows in WebCenter Spaces, open JDeveloper and create a new WebCenter Spaces Task Flow Customization Application.
To enable task flow customization in your WebCenter Portal application, first ensure that you have created your application using the WebCenter Portal application template. Then follow the steps below to prepare your application.
In the Application Navigator, right-click the ViewController project, and choose Project Properties.
In the Project Properties dialog, select ADF View, then select the Enable Seeded Customizations checkbox. Click OK and save your files.
Figure 24-1 Enabling Seeded Customizations
After you have enabled customization for your application as described in Section 24.1, "Preparing for Task Flow Customization", you must configure the customization layer values to use in the JDeveloper Customization Developer role.
To enable customization of WebCenter task flows at design time, edit the CustomizationLayerValues.xml file for your application by selecting Configure Application Layer Values in the Customization Context panel.
When customizing WebCenter Spaces, use the fragment below.
<cust-layers xmlns="http://xmlns.oracle.com/mds/dt"> <cust-layer name="site" id-prefix="s"> <cust-layer-value value="webcenter" display-name="WebCenter"/> </cust-layer> </cust-layers>
For WebCenter Portal applications with a standard customization configuration using the ADFSiteCC customization class, use a cust-layer-value of site instead of webcenter for the JDeveloper Customization Developer role.
In JDeveloper, choose Tools > Preferences > Roles, select the Customization Developer role, then click OK.
Figure 24-2 Selecting the Customization Developer Role
JDeveloper prompts you to restart. Choose Yes to restart JDeveloper in the Customization Developer role.
Ensure that Show Libraries is enabled in the dropdown (on the far right) of the Projects bar in JDeveloper navigator.
Figure 24-3 Navigator Display Options - Show Libraries
In the Customization Developer role, JDeveloper will display a red man next to your application name in the Application Navigator. You will also see a Customization Context window with Edit with following Customization Context selected and the customization layer name selected as site, and the layer value set to the value defined in CustomizationLayerValues.xml. These values indicate that you have successfully configured your application to enable customization of WebCenter task flows.
JDeveloper's Customization Developer role is a powerful mechanism that allows you to customize the ADF Library without changing the code in base library JAR. Since both Oracle WebCenter and Oracle ADF leverage MDS, you can use the Customization Developer role to extend WebCenter Spaces and WebCenter Services task flows. All WebCenter task flows are packaged in the ADF Library so task flow customization is possible in JDeveloper design time. For instructions on configuring the Customization Developer role, see Section 24.2, "Configuring the JDeveloper Customization Developer Role"
The use cases that can be achieved by task flow customization include:
Change labels including column names for task flows.
Change icons used in task flows, for example replacing the Edit and Refresh icons with new icons on the Discussions - Space Forums task flow.
Change the order of table columns in a task flow.
Remove an entire region or component, such as the Search box from primary tab.
Show additional attributes available by using Expression Language, for example customizing the People Picker task flow to show an additional user Profile attribute.
After you have prepared your application for customization as described in the previous sections, open the application and make any necessary customizations.
For examples of task flow customization in WebCenter Spaces, see Section 24.3.1, "Examples: Customizing Task Flows for WebCenter Spaces."
For a list of customizable task flows, see Section 24.6, "Catalog of WebCenter Task Flows."
After you have completed your customizations, deploy them as explained in Section 24.4, "Applying Task Flow Customizations to Deployed WebCenter Applications."
To customize task flows in WebCenter Spaces, open the application you created in Section 24.1.1, "WebCenter Spaces: Create a New Task Flow Customization Application" and make any necessary customizations. The examples that follow show some common customizations:
Section 24.3.1.1, "Example 1: Remove Primary Tabs from the Local Toolbar Task Flow"
Section 24.3.1.2, "Example 2: Customize the Discussion Forums Task Flow"
In WebCenter Spaces, Space navigation is performed through displays in tabs and menus. You can modify the application to show Space navigation only through menu items by customizing the Local Toolbar task flow.
Figure 24-5 Local Toolbar Task Flow in WebCenter Spaces
To remove primary tabs from the WebCenter Spaces Local Toolbar task flow:
Ensure that the SpacesTaskflowCustomizationApplication application is open in JDeveloper and that you are using the Customization Developer role.
In the Application Navigator, expand the ViewController project, and navigate to the WebCenter Spaces View library, as shown in Figure 24-6.
Figure 24-6 Application Navigator - WebCenter Spaces View Library
Navigate to oracle.webcenter.webcenterapp.view.taskflows.localToolbar.
Figure 24-7 Local Toolbar Task Flow in the Application Navigator
Under localToolbar, select LocalBoilerPlate.jsff and open it.
In the Structure window, select the wcNavigationPane component with the id="primaryTabSet."
Delete this component by pressing the Delete key on your keyboard.
Performing these steps created the necessary customization for LocalBoilerPlate.jsff under Application_Directory/ViewController/libraryCustomizations/ oracle/WebCenter/WebCenterapp/view/task flows/localToolbar.
The resulting toolbar looks as follows:
This example shows how you can customize the WebCenter Spaces Discussion Forums task flow to display a profile image for the user who initiated the discussion. The following is a sample Discussion Forum without the profile image.
To customize the Discussion Forums task flow:
If you are not already using the Customization Developer role, switch to this role (choose Tools > Preferences, select Role, then select Customization Developer Role and restart JDeveloper).
In the Application Navigator, expand the ViewController project to view the WebCenter Discussion Services View library.
Figure 24-10 WebCenter Discussion Services View Library in the Application Navigator
In the WebCenter Discussion Services View library, open the ListTopics.jsff file.
In the Structure window, search for the <rtc:presence> tag on the page. This tag renders the user name.
Figure 24-11 rtc:presence Tag in the Structure Window
Right-click the rtc.:presence tag, then choose Insert After > ADF Faces > Panel Group Layout from the context menu.
In the Structure window, right-click the new Panel Group Layout and choose Insert > Image Component.
In the Property Inspector for the new Image component, set the Source property to #{webCenterProfile[row.createdBy].photoURI['SMALL']}. This generates a name for the image (that you added to your application project) based on the user who posted the discussion.
Save your files and rebuild the project.
The ListTopics.jsff.xml file that is generated will contain the following code:
Example 24-1 Updated ListTopics.jsff.xml File
<mds:customization version="11.1.1.54.01"
xmlns:mds="http://xmlns.oracle.com/mds">
<mds:insert parent="frmltpgl11" position="last"
xmlns:af="http://xmlns.oracle.com/adf/faces/rich">
<af:panelGroupLayout xmlns:af="http://xmlns.oracle.com/adf/faces/rich"
id="s1pgl1">
<af:image xmlns:af="http://xmlns.oracle.com/adf/faces/rich"
source="#{webCenterProfile[row.createdBy].photoURI['SMALL']}" id="s1i1"/>
</af:panelGroupLayout>
</mds:insert>
</mds:customization>
Figure 24-12 Discussions Forum Task Flow Rendering the User Profile Image in WebCenter Spaces
The previous sections explained how to customize WebCenter task flows for three different scenarios. The output of these exercises is the generated MDS customization. The customizations show up as .xml.xml or .jsff.xml files in the View project of the application under the libraryCustomization package. These customization documents are essentially instructions for MDS to apply changes on top of the base document that is shipped to show the customized behavior at runtime.
Once you complete a task flow customization, you must apply it to the deployed WebCenter application. To see customizations performed on WebCenter task flows in JDeveloper at runtime, you must import these customizations to the MDS repository of the deployed WebCenter application.
Note:
This process updates the runtime WebCenter application metadata repository; back up the MDS schema before performing these steps. Also, it is a best practice to test your customizations in a development or stage environment first.To import WebCenter task flow customizations to the MDS repository:
If you are using the WebCenter Spaces Task Flow Customization Application, skip to Step 5. Otherwise, in the Application Navigator, from the Application Menu, choose Application Properties.
Choose Deployment and create a deployment profile by using the MAR File archive type.
Figure 24-14 Creating a Deployment Profile
Click OK to close the Create Deployment Profile dialog.
Click OK, then OK again to finish creating the Deployment Profile.
In the Application Navigator, from the Application Menu, choose Deploy > metadata (metadata is the name of the Deployment Profile).
Figure 24-15 Deploying the "metadata" Deployment Profile
In the Deploy metadata dialog, choose Deploy to MAR file, then click Finish.
Tip:
Alternatively, you can export the metadata to a deployed application by selecting the Export to Deployed Application option, configuring the connection details of the server on which the application is deployed, and selecting the appropriate application.JDeveloper creates the MAR file in the application directory of your JDEV_USER home directory. Copy this MAR file, which contains the customizations, to the directory where the WebCenter application is deployed. Maintain a backup of this file so that you always have a version of the customizations for this application.
Extract the MAR to a temporary directory, for example /tmp/wc-cust.
Use the MDS WLST import command to import the task flow customizations to the application's MDS repository.
For more information on MDS WLST commands, refer to the Oracle Fusion Middleware WebLogic Scripting Tool Command Reference on the Oracle Technology Network.
You can revert task flow behavior or look and feel to the original deployment by removing task flow customizations.
Use the MDS WLST deleteMetadata command to remove the applied customizations. The deleteMetadata command needs to exercise with caution as incorrect use of this command may cause the loss of metadata documents. The sample command below removes the Local Toolbar customization created in Section 24.3.1.1, "Example 1: Remove Primary Tabs from the Local Toolbar Task Flow."
Example 24-3 Command to Delete the Customization Metadata from a Deployed WebCenter Application
deleteMetadata(application='webcenter',server='WC_Spaces', docs='/oracle/webcenter/webcenterapp/view/taskflows/globalToolbar/**', excludeBaseDocs='true')
For more details on MDS WLST commands, refer to the Oracle Fusion Middleware WebLogic Scripting Tool Command Reference on the Oracle Technology Network.
The following task flows have been validated for view-level customizations. You can find these task flows in the libraries or JAR files and definition paths specified in Table 24-1.
Note:
To customize analytics task flows, you must add the following JARs to the project:JDEV_HOME/webcenter/modules/oracle.webcenter.framework_11.1.1/analytics-reporting-service-view.jar
JDEV_HOME/webcenter/modules/oracle.webcenter.framework_11.1.1/analytics-reporting-service-model.jar
Table 24-1 WebCenter Task Flows
| Description | Library/JAR Files | Definition Path |
|---|---|---|
|
adfpage-renderer |
WebCenter Portal Framework |
|
|
Activity Stream - Mini View |
WebCenter Activity Streaming Service View |
|
|
Activity Stream - Main View |
WebCenter Activity Streaming Service View |
|
|
Analytics - Console |
Task flows included in |
|
|
Analytics - WebCenter Traffic |
Task flows included in |
|
|
Analytics - Page Traffic |
Task flows included in |
|
|
Analytics - Login Metrics |
Task flows included in |
|
|
Analytics - Portlet Traffic |
Task flows included in |
|
|
Analytics - Portlet Response Time |
Task flows included in |
|
|
Analytics - Portlet Instance Traffic |
Task flows included |
|
|
Analytics - Portlet Instance Response Time |
Task flows included in |
|
|
Analytics - Search Metrics |
Task flows included in |
|
|
Analytics - Document Metrics |
Task flows included in |
|
|
Analytics - Wiki Metrics |
Task flows included in |
|
|
Analytics - Blog Metrics |
Task flows included in |
|
|
Analytics - Discussion Metrics |
Task flows included in |
|
|
Announcements |
WebCenter Announcement Service View |
|
|
Announcements - Quick View |
WebCenter Announcement Service View |
|
|
Application Navigator |
WebCenter Spaces View |
|
|
Blogs |
|
|
|
Calendar Main View |
WebCenter Events Service View |
|
|
Calendar Mini View |
WebCenter Events Service View |
|
|
ChooseLanguageTaskflow |
WebCenter Spaces View |
|
|
CommunityBrowserRegion |
WebCenter Spaces View |
|
|
community-contacts-task-flow |
WebCenter Spaces View |
|
|
Connections - Card |
WebCenter PeopleConnections View |
|
|
Connections - Detailed View |
WebCenter PeopleConnections View |
|
|
Connections - Main View |
WebCenter PeopleConnections View |
|
|
Connections - Main View |
WebCenter PeopleConnections View |
|
|
Connections - Mini View |
WebCenter PeopleConnections View |
|
|
Connections - Network |
WebCenter PeopleConnections View |
|
|
content-renderer |
WebCenter Portal Framework |
|
|
customization-manager-taskflow |
Oracle Composer |
|
|
Discussions |
WebCenter Discussions Service View |
|
|
Discussions - Manager |
WebCenter Discussions Service View |
|
|
Discussions - Popular Topics |
WebCenter Discussions Service View |
|
|
Discussions - Recent Topics |
WebCenter Discussions Service View |
|
|
Discussions - Space Forums |
WebCenter Discussions Service View |
|
|
Discussions - Quick View |
WebCenter Discussions Service View |
|
|
Discussions - Watched Forums |
WebCenter Discussions Service View |
|
|
Discussions - Watched Topics |
WebCenter Discussions Service View |
|
|
Documents - AutoVue |
WebCenter Document Library Service View |
|
|
Documents - Content Presenter |
WebCenter Document Library Service View |
|
|
Documents - Document Manager |
WebCenter Document Library Service View |
|
|
Documents - Document Navigator |
WebCenter Document Library Service View |
|
|
Documents - Document Viewer |
WebCenter Document Library Service View |
|
|
Documents - Folder Viewer |
WebCenter Document Library Service View |
|
|
Documents - Document Explorer |
WebCenter Document Library Service View |
|
|
Documents - List Viewer |
WebCenter Document Library Service View |
|
|
Documents - Main View |
WebCenter Document Library Service View |
|
|
Documents - Mini Properties |
WebCenter Document Library Service View |
|
|
Documents - Properties |
WebCenter Document Library Service View |
|
|
Documents - Recent Documents |
WebCenter Document Library Service View |
|
|
Documents - Rich Text Editor |
WebCenter Document Library Service View |
|
|
Documents - Upload |
WebCenter Document Library Service View |
|
|
Documents - Version History |
WebCenter Document Library Service View |
|
|
Events |
WebCenter Events Service View |
|
|
Exportregion |
Internal - invoked by WebCenter Spaces administrator for export of Spaces or Spaces templates. |
|
|
Feedback |
WebCenter PeopleConnections View |
|
|
Feedback - Summary View |
WebCenter PeopleConnections View |
|
|
ImportRegion |
Internal - invoked by WebCenter Spaces administrator for import of Spaces or Spaces templates. |
|
|
LifecycleCartTaskflow |
Internal |
|
|
LifecycleSelectorTaskflow |
Internal |
|
|
lifecycle-siteresource-export-task-flow |
Internal - used in Resource Manager |
|
|
lifecycle-siteresource-import-task-flow |
Internal - used in Resource Manager |
|
|
Links |
WebCenter Links Service View |
|
|
Links Dialog |
WebCenter Links Service View |
|
|
List - Main View |
WebCenter List Service View |
|
|
list-instance-view-task-flow |
WebCenter Lists Service View |
|
|
list-of-resource-types-taskflow |
|
|
|
|
WebCenter Mail Service View |
|
|
Message Board - Mini View |
WebCenter PeopleConnections View |
|
|
Message Board - Main View |
WebCenter PeopleConnections View |
|
|
Navigation - Menu |
Navigation Task Flows |
|
|
Navigation - Breadcrumb |
Navigation Task Flows |
|
|
Navigation - Tree |
Navigation Task Flows |
|
|
navigation-renderer |
WebCenter Portal Framework |
|
|
Organization View |
WebCenter PeopleConnections View |
|
|
Page - Create New |
WebCenter Page Service View |
|
|
Polls - Polls Manager |
WebCenter Polls and Surveys Service View |
|
|
Polls - Quick View |
WebCenter Polls and Surveys Service View |
|
|
Polls - Take Poll |
WebCenter Polls and Surveys Service View |
|
|
Polls - View Poll Results |
WebCenter Polls and Surveys Service View |
|
|
portlet-renderer |
WebCenter Portal Framework |
|
|
Presence Controls |
WebCenter IM and Presence Service View |
|
|
Profile - Actions |
WebCenter PeopleConnections View |
|
|
Profile Gallery |
WebCenter PeopleConnections View |
|
|
Profile - Main View |
WebCenter PeopleConnections View |
|
|
Profile - Snapshot |
WebCenter PeopleConnections View |
|
|
Profile - Summary |
WebCenter PeopleConnections View |
|
|
Publisher |
WebCenter PeopleConnections View |
|
|
Recommended Connections |
WebCenter Activity Graph Service View |
|
|
Resource Action Handler - Resource Viewer |
WebCenter Common View |
|
|
Recent Activities |
WebCenter Recent Activity Service View |
|
|
RSS Viewer |
WebCenter RSS Service View |
|
|
Search |
WebCenter Search Services View |
|
|
Search Preferences |
WebCenter Search Services View |
|
|
Search - Saved Searches |
WebCenter Search Services View |
|
|
Search Toolbar |
WebCenter Search Services View |
|
|
Security - Self Registration |
Public user registration |
|
|
Security - Self Registration - Public Invitation |
Public user invitation to join spaces |
|
|
Security - Enterprise Role - Members |
Lists the members of an enterprise group |
|
|
Security - Enterprise Role - Members Search |
The members of an enterprise group of a particular pattern |
|
|
Security - Enterprise Role - Members Viewer |
A tabbed page which shows the members of a group in one and the other tab lets you search for a particular pattern |
|
|
Security - Role Manager |
Create, modify and delete application roles |
|
|
Security - External Application Credential Provisioning |
Credential provisioning for a particular external application |
|
|
Security - External Application Change Password |
Screen to change the password for all the external applications created |
|
|
Similar Items |
WebCenter Activity Graph Service View |
|
|
Similar Spaces |
WebCenter Activity Graph Service View |
|
|
Smart Tag Actions |
|
|
|
Smart Tag Actions Enabler |
|
|
|
Spaces |
WebCenter Spaces View |
|
|
Space Members |
WebCenter Spaces View |
|
|
Subscription Preferences |
WebCenter Notification Service View |
|
|
Subscription Viewer |
WebCenter Notification Service View |
|
|
Tag Cloud |
WebCenter Tagging Service View |
|
|
Tagging Dialog |
WebCenter Tagging Service View |
|
|
Tagged Items |
WebCenter Tagging Service View |
|
|
Tagging - Personal View |
WebCenter Tagging Service View |
|
|
Tagging - Related Links |
WebCenter Tagging Service View |
|
|
Tagging - Similar Items |
WebCenter Tagging Service View |
|
|
taskflow-renderer |
WebCenter Portal Framework |
|
|
Worklist |
WebCenter Worklist Service View |
|
|
 Copyright © 2007, 2011, Oracle and/or its affiliates. All rights reserved. Legal Notices |
|
