Personalization programming reference

IBM® WebSphere® Portal provides the programming model, processes, and APIs for the Personalization rules and resource engines.

Preparing your personalized application
Before deploying applications that take advantage of the features of Portal Personalization, certain features must be configured in order to work properly. The Feedback and LikeMinds components of Personalization both communicate with their databases using Java™ data sources. Before using either of these components, you must create resource references to the data sources in your project.
Programming model
Personalization builds on the same programming model used by WebSphere Application Server. Two components of that model are Java Server Pages (JSP) and business logic (JavaBeans™ and enterprise beans). JSP files enable you to effectively separate HTML coding (presentation) from business logic. You isolate your business logic in beans that the Web page author embeds in the JSP.
User and content models
The first step in developing a Personalization solution is to analyze your business conditions and events to determine the users and content to be targeted. The business users and administrators are primarily responsible for this task.
How the rules engine works
The rules engine processes and delivers the results of a rule execution to a content spot contained in a Web page. The content spot is marked by a content spot bean which is placed in either a JSP file or a servlet. The JSP file or servlet is then linked to the Web page.
Workload management
Only one Portal Personalization engine can be installed on an application server. Consequently, there is one Personalization engine for each servlet engine. Personalization supports application server clustering, because each Personalization instance in the cluster shares the same IBM Java Content Repository. Therefore, each Personalization instance accesses the same customer data stores.
Using the Personalization APIs
Personalization provides open APIs that enable the Personalization run-time environment and Rational Application Developer to access user and content data in customer data stores.
Generic query framework
The generic query framework enables resource collection developers to convert a property-based query object into a language specific executable query string. It contains query component classes, and builder and callback interfaces.
Request context interface
This is the interface used to access various attributes for rules. For HTTP contexts, it provides access to the HttpRequest and HttpSession attributes. For non-HTTP contexts, it provides the same interface to a surrogate for the request and session.
Sample Personalization resources XML file
Use the sample file ExportFromServlet.xml as a reference for coding other Personalization actions.
Content spot exits
Content spot exits provide the ability to alter the default flow of processing of content spots, making it possible in the runtime environment to override the rule to process, the current user, and the results of rule processing. Instances of the same exit class are instantiated for all content spots. The exit class interface name is public interface RuleExit.
Resource cache
Personalization uses the WebSphere Application Server Dynamic Cache service to cache the results of select rules and to cache the rules themselves in a DistributedMap. When publishing, importing or saving rules, the cache is flushed automatically to ensure that the site is current.
Programmatically invoking rules
All types of rules can be accessed programmatically within a Java application. For example, a profiler can be used to determine the behavior an application should exhibit depending on the current user, or an action can return content to your application for further processing before the content is displayed. Rules are mapped to content spots, and because a content spot is an implementation of a JavaBean, it can be programmatically declared and implemented.
Rule Exception Handling in the run-time environment
The default method of error or exception handling within the Personalization run-time environment is for the engine to print out a trace error to the application server's stdout log. Using an exception handling utility, it is possible to specify the type of output (error message or stacktrace), the output log file to use (stdout or stderr), and whether the exception should be rethrown to the JSP. The additional exception handling capabilities can be set on a per-request basis or globally.

Parent topic: Personalization

Previous topic: Developing a personalized portlet