1/35
Contents
List of Examples
List of Figures
List of Tables
Title and Copyright Information
Preface
Intended Audience
Documentation Accessibility
Related Documents
Conventions
Part I Portlet Overview
1
Understanding Portlets
1.1
Introduction to Portal Development
1.2
Understanding Portlets
1.3
Portlet Anatomy
1.4
Portlet Resources
1.4.1
Out-of-the-Box Portlets
1.4.2
Other Sources of Prebuilt Portlets
1.4.3
Web Clipping
1.4.4
OmniPortlet
1.4.5
Portlet Builder
1.4.6
JSF Portlets
1.4.7
Programmatic Portlets
1.4.8
Deciding Which Tool to Use
2
Portlet Technologies Matrix
2.1
The Portlet Technologies Matrix
2.2
General Suitability
2.2.1
Web Clipping
2.2.2
OmniPortlet
2.2.3
Java Portlets
2.2.4
Portlet Builder
2.2.5
PL/SQL Portlets
2.3
Expertise Required
2.3.1
Web Clipping
2.3.2
OmniPortlet
2.3.3
Java Portlets
2.3.4
Portlet Builder
2.3.5
PL/SQL Portlets
2.4
Deployment Type
2.4.1
Web Providers
2.4.2
WSRP Producers
2.4.3
Database Providers
2.4.4
Provider Architecture
2.4.5
Provider Registration
2.5
Caching Style
2.5.1
Web Clipping, OmniPortlet, and Portlet Builder
2.5.2
Java Portlets
2.5.3
PL/SQL Portlets
2.6
Development Tool
2.6.1
Web Clipping, OmniPortlet, and Portlet Builder
2.6.2
Java Portlets
2.6.3
PL/SQL Portlets
2.7
Portlet Creation Style
2.7.1
OmniPortlet and Web Clipping
2.7.2
Java Portlets
2.7.3
Portlet Builder
2.7.4
PL/SQL Portlets
2.8
User Interface Flexibility
2.8.1
Web Clipping
2.8.2
OmniPortlet
2.8.3
Java Portlets and PL/SQL Portlets
2.8.4
Portlet Builder
2.9
Ability to Capture Content from Web Sites
2.9.1
Web Clipping
2.9.2
OmniPortlet
2.9.3
Java Portlets
2.9.4
PL/SQL Portlets
2.10
Ability to Render Content Inline
2.10.1
Web Clipping
2.10.2
OmniPortlet
2.10.3
Java Portlets
2.10.4
Portlet Builder
2.10.5
PL/SQL Portlets
2.11
Charting Capability
2.11.1
Web Clipping
2.11.2
OmniPortlet
2.11.3
Java Portlets
2.11.4
Portlet Builder
2.11.5
PL/SQL Portlets
2.12
Public Portlet Parameters Support
2.13
Private Portlet Parameter Support
2.13.1
OmniPortlet, Web Clipping, and Portlet Builder
2.13.2
Java Portlets and PL/SQL Portlets
2.14
Event Support
2.14.1
Web Clipping, OmniPortlet, and Java Portlets
2.14.2
Portlet Builder and PL/SQL Portlets
2.15
Ability to Hide and Show Portlets Based on User Privileges
2.15.1
Web Clipping and OmniPortlet
2.15.2
Java Portlets
2.15.3
Portlet Builder
2.15.4
PL/SQL Portlets
2.16
Multilingual Support
2.16.1
Web Clipping, OmniPortlet, Java Portlets, and PL/SQL Portlets
2.16.2
Portlet Builder
2.17
Pagination Support
2.17.1
Web Clipping
2.17.2
OmniPortlet
2.17.3
Java Portlets and PL/SQL Portlets
2.17.4
Portlet Builder
2.18
Single Sign-On and External Application Integration
2.18.1
Web Clipping
2.18.2
OmniPortlet
2.18.3
Java Portlets
2.18.4
PL/SQL Portlets
Part II Creating Portlets
3
Creating Portlets with OmniPortlet
3.1
Introduction to OmniPortlet
3.2
The OmniPortlet Wizard
3.2.1
Type
3.2.2
Source
3.2.2.1
Proxy Authentication
3.2.2.2
Connection Information
3.2.2.3
Spreadsheet
3.2.2.4
SQL
3.2.2.5
XML
3.2.2.6
Web Service
3.2.2.7
Web Page
3.2.3
Filter
3.2.4
View
3.2.5
Layout
3.2.5.1
Tabular Layout
3.2.5.2
Chart Layout
3.2.5.3
News Layout
3.2.5.4
Bullet Layout
3.2.5.5
Form Layout
3.2.5.6
HTML Layout
3.2.6
Edit Defaults mode
3.2.7
Events
3.3
Parameters and Events
3.3.1
Portlet Parameters and Events
3.3.2
Page Parameters and Events
4
Building Example Portlets with OmniPortlet
4.1
Adding an OmniPortlet Instance to a Portal Page
4.2
Building an OmniPortlet Based on a Web Service
4.3
Building an OmniPortlet Based on a Spreadsheet (CSV)
4.4
Building an OmniPortlet Based on an XML Data Source
4.5
Building an OmniPortlet Based on a Web Page Data Source
4.6
Setting Up Portlet Parameters and Events
4.6.1
Configure Portlets to Accept Parameters
4.6.2
Map the Page Parameter to the Portlet Parameters
4.6.3
Configure the Chart Portlet to Use Events
4.6.4
Map the Chart Event to the Page
4.7
Building an OmniPortlet Using the HTML Layout
5
Creating Content-Based Portlets with Web Clipping
5.1
What Is Web Clipping?
5.2
Adding Web Page Content to a Portal Page
5.2.1
Adding a Web Clipping Portlet to a Page
5.2.2
Selecting a Section of a Web Page to Display in the Web Clipping Portlet
5.2.3
Setting Web Clipping Portlet Properties
5.3
Integrating Authenticated Web Content Using Single Sign-On
5.4
Adding a Web Clipping That Users Can Personalize
5.4.1
Adding a Web Clipping Portlet to a Personal Page
5.4.2
Selecting a Clipping in OTN
5.4.3
Personalizing a Web Clipping Portlet
5.5
Using Web Clipping Open Transport API
5.6
Migrating from URL-Based Portlets
5.6.1
Preparing for Migration
5.6.2
Performing the Migration
5.6.3
Post-Migration Configuration
5.6.4
Maintaining Migrated Portlets
5.6.5
Limitations in Migrating URL-Based Portlets
5.7
Current Limitations for Web Clipping
6
Creating Java Portlets
6.1
Guidelines for Writing Java Portlets
6.1.1
Guidelines for Show Modes
6.1.1.1
Shared Screen Mode (View Mode for JPS)
6.1.1.2
Edit Mode (JPS and Pdk-Java)
6.1.1.3
Edit Defaults Mode (JPS and PDK-Java)
6.1.1.4
Preview Mode (JPS and PDK-Java)
6.1.1.5
Full Screen Mode (PDK-Java)
6.1.1.6
Help Mode (JPS and Oracle Portal)
6.1.1.7
About Mode (JPS and PDK-Java)
6.1.1.8
Link Mode (PDK-Java)
6.1.2
Guidelines for Navigation within a Portlet
6.1.2.1
Types of Links for Portlets
6.1.3
Guidelines for JavaScript
6.1.4
Guidelines for Mobile Portlets
6.1.4.1
Declare Capabilities
6.1.4.2
Declare a Short Title
6.1.4.3
Implement Personalization of the Short Title
6.1.4.4
Implement Link Mode
6.1.4.5
Heed Device Information
6.1.4.6
Tailor Personalization Pages
6.2
Introduction to Java Portlet Specification (JPS) and WSRP
6.3
Building JPS-Compliant Portlets with Oracle JDeveloper
6.3.1
Creating a JSR 168 Portlet
6.3.2
Adding Portlet Logic to Your JSR 168 Portlet
6.3.3
Deploying Your JSR 168 Portlet to the Oracle WebLogic Server
6.3.4
Registering and Viewing Your JSR 168 Portlet
6.3.5
Registering WSRP Producers in Enterprise Configurations
6.4
Introduction to Oracle PDK-Java
6.5
Building Oracle PDK-Java Portlets with Oracle JDeveloper
6.5.1
Creating an Oracle PDK-Java Portlet and Provider
6.5.2
Adding Portlet Logic to Your Oracle PDK-Java Portlet
6.5.3
Validating Your Oracle PDK-Java Portlet and Provider
6.5.4
Deploying Your Oracle PDK-Java Portlet to an Application Server
6.5.5
Registering and Viewing Your Oracle PDK-Java Portlet
6.6
Setting up the WSRP and JPDK Applications in Oracle Portal
6.6.1
Configuring and Deploying the WSRP
6.6.2
Configuring and Deploying the JPDK
7
Enhancing Java Portlets
7.1
Enhancing JPS Portlets
7.1.1
Adding Personalization
7.1.1.1
Assumptions
7.1.1.2
Implementing Personalization
7.2
Enhancing PDK-Java Portlets
7.2.1
Adding Show Modes
7.2.1.1
Assumptions
7.2.1.2
Implementing Extra Show Modes
7.2.1.3
Updating the XML Provider Definition
7.2.1.4
Viewing the Portlet
7.2.2
Adding Personalization
7.2.2.1
Assumptions
7.2.2.2
Implementing Personalization for Edit and Edit Defaults Pages
7.2.2.3
Implementing Personalization for Show Pages
7.2.2.4
Preference Information Within the XML Provider Definition
7.2.2.5
Viewing the Portlet
7.2.3
Passing Parameters and Submitting Events
7.2.3.1
Assumptions
7.2.3.2
Adding Public Parameters
7.2.3.3
Passing Private Portlet Parameters
7.2.3.4
Submitting Events
7.2.4
Using JNDI Variables
7.2.4.1
Declaring JNDI Variables
7.2.4.2
Setting JNDI Variable Values
7.2.4.3
Retrieving JNDI Variables
7.2.5
Creating Private Events
7.2.6
Accessing Session Information
7.2.6.1
Assumptions
7.2.6.2
Implementing Session Storage
7.2.6.3
Viewing the Portlet
7.2.7
Implementing Portlet Security
7.2.7.1
Assumptions
7.2.7.2
Introduction to Portlet Security Features
7.2.7.3
Single Sign-On
7.2.7.4
Oracle Portal Access Control Lists (ACLs)
7.2.7.5
Portlet Security Managers
7.2.7.6
Oracle Portal Server Security
7.2.7.7
Message Authentication
7.2.7.8
HTTPS Communication
7.2.7.9
LDAP (Oracle Internet Directory) Security
7.2.7.10
User Input Escape
7.2.8
Controlling the Export/Import of Portlet Personalizations
7.2.8.1
Import/Export Programming Interface
7.2.8.2
Exporting Personalizations Example
7.2.8.3
Implementing Security for Export/Import
7.2.9
Enhancing Portlet Performance with Caching
7.2.9.1
Assumptions
7.2.9.2
Activating Caching
7.2.9.3
Adding Expiry-Based Caching
7.2.9.4
Adding Invalidation Based Caching
7.2.9.5
Adding Validation-Based Caching
7.2.10
Enhancing Portlets for Mobile Devices
7.2.10.1
Accessing Configuration, User, and Device Information
7.2.10.2
Modifying Navigation for Mobile Portlets
7.2.11
Writing Multilingual Portlets
7.2.11.1
Assumptions
7.2.11.2
Internationalizing Your Portlet
7.2.11.3
Viewing the Portlet
7.3
Building Struts Portlets with Oracle JDeveloper
7.3.1
Oracle Portal and the Apache Struts Framework
7.3.1.1
Model View Controller Overview
7.3.1.2
Apache Struts Overview
7.3.1.3
Oracle Portal Integration with Struts
7.3.1.4
Summary
7.3.2
Creating a Struts Portlet
7.3.2.1
Creating a Struts Portlet
7.3.2.2
Registering the Provider
7.3.2.3
Summary
7.3.3
Creating an Oracle Application Development Framework (ADF) Portlet
8
Creating PL/SQL Portlets
8.1
Guidelines for Creating PL/SQL Portlets
8.1.1
Portlet Show Modes
8.1.2
Recommended Portlet Procedures and Functions
8.1.3
Guidelines for Mobile Portlets
8.2
Building PL/SQL Portlets with the PL/SQL Generator
8.2.1
Creating the Input XML File
8.2.2
Running the PL/SQL Generator
8.2.3
Publishing the Generated PL/SQL Portlet
8.2.3.1
Installing the Packages in the Database
8.2.3.2
Registering the Database Provider
8.2.3.3
Adding Your Portlet to a Page
8.3
Building PL/SQL Portlets Manually
8.3.1
Implementing the Portlet Package
8.3.2
Implementing the Provider Package
8.3.3
Adding Your Portlet to a Page
8.4
Implementing Information Storage
8.4.1
Implementing a Preference Store
8.4.1.1
Using a Preference Store
8.4.1.2
Creating and Accessing a Preference Store
8.4.2
Implementing a Session Store
8.5
Using Parameters
8.5.1
Passing Private Parameters
8.5.2
Passing Page Parameters and Mapping Public Portlet Parameters
8.5.3
Retrieving Parameter Values
8.6
Accessing Context Information
8.6.1
Using Context Information
8.6.2
Using wwctx_api to Obtain Context Information
8.7
Implementing Portlet Security
8.7.1
Using Security
8.7.2
Coding Security
8.8
Improving Portlet Performance with Caching
8.8.1
Using Caching
8.8.1.1
Validation-Based Caching
8.8.1.2
Expiry-Based Caching
8.8.1.3
Invalidation-Based Caching
8.8.2
Configuring and Monitoring the Cache
8.8.3
Implementing Validation-Based Caching
8.8.4
Implementing Expiry-Based Caching
8.8.5
Implementing Invalidation-Based Caching
8.9
Implementing Error Handling
8.9.1
Using Error Handling
8.9.2
Adding Error Handling
8.10
Implementing Event Logging
8.10.1
Using Event Logging
8.10.2
Adding Event Logging
8.11
Writing Multilingual Portlets
8.11.1
Using Multilingual Support
8.11.2
Adding Multilingual Support
8.11.2.1
Loading Language Strings
8.11.2.2
Retrieving Language Strings
8.12
Enhancing Portlets for Mobile Devices
8.13
Registering Providers Programmatically
8.13.1
Registration Prerequisites
8.13.2
Provider Record Input
8.13.3
Registration Example
Part III Content Management APIs
9
Content Management API Introduction
9.1
Overview
9.2
Content Management APIs
9.2.1
Secure Content Repository Views
9.2.2
Terminology
9.3
Providing Access to the APIs and Secure Views
9.4
Guidelines for Using the APIs
9.4.1
Using a Separate Schema
9.4.2
Using Constants
9.4.3
Invalidating the Cache
9.4.4
Issuing Commits
9.4.5
Resetting CMEF Global Variables
9.4.6
Using Predefined Exceptions
9.4.7
Naming Objects
9.5
Guidelines for Using the Secure Views
9.5.1
Identifying Primary Keys
9.5.2
Querying Translatable Objects
9.5.3
Selecting Data for the Current User
9.6
Code Samples
10
Getting Started with Content Management APIs
10.1
Setting the Session Context
10.2
API Parameters
10.3
Finding an Object ID
10.3.1
Finding a Page Group ID
10.3.2
Finding a Page ID
10.3.3
Finding Region IDs
10.3.4
Finding an Item ID
11
Performing Simple Content Management Tasks
11.1
Editing Page Properties
11.2
Editing Content
11.2.1
Setting Item Attributes
11.2.2
Editing an Item
11.2.3
Checking Items Out and In
11.2.4
Using Version Control
11.3
Reorganizing Content
11.3.1
Moving an Item to a Different Page
11.3.2
Moving Pages
11.3.3
Moving Categories and Perspectives
11.4
Copying Content
11.4.1
Copying Items
11.4.2
Copying Pages
11.5
Deleting Content
11.5.1
Deleting Items
11.5.2
Deleting Pages
12
Extending Your Portal
12.1
Creating a Page Group
12.2
Creating Pages
12.3
Creating Categories and Perspectives
12.4
Creating Items
12.5
Setting Perspectives Attributes of Pages and Items
12.6
Approving and Rejecting Items
13
Searching Portal Content
13.1
Searching For Items Across All Page Groups
13.2
Searching For Pages in Specific Page Groups
13.3
Searching For Items By Attribute
13.4
Transforming Search Results into XML
13.4.1
Creating a Directory for the XML File
13.4.2
Creating an XML File from a CLOB
13.4.3
Generating Search Results in XML
13.4.4
Workaround for get_item_xml
13.5
Displaying Search Results
13.5.1
Displaying XML Search Results in OmniPortlet
13.5.2
Displaying Search Results in a Dynamic Page
14
Creating Multi-Lingual Content
14.1
Introduction to Multi-Lingual Support
14.2
Querying the Default Language
14.3
Setting the Session Language
14.4
Modifying an Existing Translation
14.5
Creating a Translation for an Item
14.6
Translations and Item Versioning
15
Implementing Content Security
15.1
Retrieving Object Privileges
15.2
Setting Page Level Privileges
15.2.1
Granting Page Level Privileges
15.2.2
Removing Page Level Privileges
15.3
Setting Item Level Privileges
15.3.1
Granting Item Level Privileges
15.3.2
Removing Item Level Privileges
15.3.3
Inheriting Item Level Privileges from the Page
16
Using the Content Management Event Framework
16.1
What Is the Content Management Event Framework?
16.2
How Does the Content Management Event Framework Work?
16.2.1
Enqueuing Messages
16.2.2
Subscribers and Dequeuing Messages
16.2.2.1
Adding a Subscriber to the WWSBR_EVENT_Q Queue
16.2.2.2
Subscriber Queue Management
16.2.2.3
Dequeuing Messages
16.2.3
Exception Handling
16.2.4
Listening for Messages
16.3
Using the Content Management Event Framework
16.3.1
Creating Subscriber Code
16.3.2
Adding a Subscriber to WWSBR_EVENT_Q
16.3.3
Enabling CMEF Events at the Page Group Level
16.3.4
Examining CMEF Events
16.3.5
Running a CMEF Subscriber
16.3.6
CMEF Message Payload
16.3.7
Oracle Portal Actions and CMEF Events
16.3.7.1
Page and Page Group Actions
16.3.7.2
Item Actions
16.4
Installing the Examples
16.5
Example: Portal Object Event Logging
16.6
Example: Item Notification
16.7
Example: Item Validation
16.8
Example: Integrating External Workflow
16.8.1
Integrating Workflow with Oracle Portal
16.8.2
Example Overview
16.8.3
Detailed Example Description
16.8.3.1
Enable Approvals and Notifications in Oracle Portal
16.8.3.2
Grant Users the Manage Items With Approval Privileges
16.8.3.3
Run Scripts Required for the CMEF Workflow Integration Example
16.8.3.4
Create Subscriber and Check Procedures
16.8.3.5
Register the WF_CHECKURL Process with Oracle Workflow
16.8.3.6
Add the CMEF_WORKFLOW Subscriber to the WWSBR_EVENT_Q Queue
Part IV Appendixes
A
Creating Portlets with the Portlet Builder
B
Troubleshooting Portlets and Providers
B.1
Diagnosing General Portlet Problems
B.1.1
Portlet Refresh Failure
B.1.2
HTML Tags Appearing in Portlet
B.2
Diagnosing Java Portlet Problems
B.2.1
Portlet Logging
B.2.2
Installation and Deployment Problems
B.2.2.1
Cannot Find a Java Class Object
B.2.2.2
Cannot Deploy the template.ear File
B.2.2.3
Error When Attempting to Register Provider
B.2.2.4
Error Adding a Portlet to a Provider
B.2.2.5
Portlet Does Not Exist
B.2.2.6
File Not Found
B.2.2.7
XML Parser Error
B.2.2.8
Error Adding Portlets
B.2.2.9
Content Request Timed Out
B.2.2.10
Message 500 Returned
B.2.2.11
JPS Portlets with the get Method not Working
B.2.2.12
Portlet Displays Session Expired Message After Redeployment
B.2.3
Portlet Code Does Not Compile
B.2.4
Application Server Connection Test Fails
B.2.5
Provider Test Page Shows Error
B.2.6
Web Provider Not Appearing in Portlet Repository
B.2.7
Portlet Does Not Display on Page
B.2.8
After Initial Successful Display, Portlet Does Not Display on Page
B.3
Diagnosing OmniPortlet Problems
B.3.1
OmniPortlet Cannot Access the Specified URL
B.3.2
Portlet Content Is Not Refreshed
B.3.3
Edit Defaults Changes are Not Reflected in the Personalized Portlet
B.4
Diagnosing Web Clipping Problems
B.4.1
Setting Logging Levels
B.4.2
Reviewing Error Messages
B.4.3
Checking the Status of the Provider with the Test Page
B.4.4
Problem Connecting to the Web Site for Clipping
B.4.5
HTTP Error Code 407 When Clipping Outside Firewall
B.4.6
Cannot Clip a Page
B.4.7
Images Not Retrieved with Clipping
B.4.8
Resolving Problems with Migration of URL-based Portlets
B.4.8.1
File Not Found Exception When Running Migration Tool
B.4.8.2
Null Pointer Exception When Running Migration Tool
B.4.8.3
Target provider.xml is Already Migrated Error
B.4.8.4
Cannot Migrate provider.xml with Class Error
B.5
Need More Help?
C
Mapping Profile Items to Attributes
C.1
Mapping userProfileItems to Attributes
D
Manually Packaging and Deploying PDK-Java Providers
D.1
Introduction
D.1.1
WAR and EAR files
D.1.2
Service Identifiers
D.2
Packaging and Deploying Your Providers
D.2.1
Packaging Your Provider
D.2.1.1
Preparing Your Directories
D.2.1.2
Specifying Your Default Service
D.2.1.3
Creating Your WAR File
D.2.1.4
Creating Your EAR File
D.2.2
Deploying Your EAR File Using Fusion Middleware Control
D.2.3
Testing Deployment
D.2.4
Setting Deployment Properties
D.2.5
Securing Your Provider
D.2.6
Registering Your Provider
E
Oracle Portal Provider Test Suite
E.1
Provider Test Page
E.2
Test Harness
E.2.1
Test Definition File
E.2.2
runTest Command
E.2.3
Running a Test with Test Harness
F
Content Management APIs and Views
F.1
Supported APIs
F.1.1
The WWSBR_API Package
F.1.2
The WWSRC_API Package
F.1.3
The WWSEC_API Package
F.1.4
The WWCTX_API Package
F.1.5
The WWPRO_API_INVALIDATION Package
F.2
Secure Views
F.2.1
WWSBR_ALL_CATEGORIES
F.2.2
WWSBR_ALL_CONTENT_AREAS
F.2.3
WWSBR_ALL_FOLDER_REGIONS
F.2.4
WWSBR_ALL_FOLDERS
F.2.5
WWSBR_ALL_ITEMS
F.2.6
WWSBR_ALL_NAVIGATION_BARS
F.2.7
WWSBR_ALL_PERSPECTIVES
F.2.8
WWSBR_ALL_STYLES
F.2.9
WWSBR_APPROVER
F.2.10
WWSBR_ATTRIBUTES
F.2.11
WWSBR_CONTENT_AREA_APPROVAL
F.2.12
WWSBR_CONTENT_AREA_ITEM_TYPES
F.2.13
WWSBR_FOLDER_ATTRIBUTES
F.2.14
WWSBR_FOLDER_PERSPECTIVES
F.2.15
WWSBR_FOLDER_TYPE_ATTRIBUTES
F.2.16
WWSBR_FOLDER_TYPES
F.2.17
WWSBR_ITEM_APPROVAL
F.2.18
WWSBR_ITEM_ATTRIBUTES
F.2.19
WWSBR_ITEM_PERSPECTIVES
F.2.20
WWSBR_ITEM_TYPE_ATTRIBUTES
F.2.21
WWSBR_ITEM_TYPES
F.2.22
WWSBR_SUBSCRIPTION
F.2.23
WWSBR_USER_FOLDERS
F.2.24
WWSBR_USER_PAGES
G
Content Management Event Framework Events
G.1
Actions and Events for Items
G.2
Actions and Events for Pages
G.3
Actions and Events for Tabs
G.4
Actions and Events for Page Groups
G.5
Actions and Events for Attributes
G.6
Actions and Events for Item Types
G.7
Actions and Events for Page Types
G.8
Actions and Events for Categories
G.9
Actions and Events for Perspectives
G.10
Actions and Events for Templates
Glossary
Index
Scripting on this page enhances content navigation, but does not change the content in any way.