The invention relates generally to portals, and particularly to a system and a method for providing application flow integration in a portal framework.
In the world of e-commerce, portal systems and applications (more commonly referred to as “portals”) are being increasingly used to provide software applications and services to end-users and third-parties. This is particularly important in the business enterprise environment, or on the Internet (where portals are often referred to as “Web portals”), since the portal can be used to group together and manage a large number and a wide variety of applications in a manner that allows those applications to be effectively delivered to a large number of users, each of which may have very different needs and access rights. The portal provides a central access point and a common look-and-feel to the end user. Portals can also be used to support collaboration between different parties, so that for example, a third-party vendor application can be integrated seamlessly within the enterprise platform.
Typically, the portal resides atop an application server, such as the WebLogic server product from BEA Systems, Inc. A product such as BEA WebLogic Portal, for example, delivers a single, unified portal framework for all enterprise requirements by providing foundation services that allow for sophisticated portal development; personalization and interaction management, intelligent portal administration to simplify and speed portal deployment; and portal integration services that allow application integration within and beyond the enterprise. Portlets, smaller pre-built modular applications that are primarily based upon Java Server Page (JSP) technology, execute within the portal, and can be provided either as part of the portal or can be created by third-parties. Portlets enable fast, out-of-the-box assembly and deployment of an enterprise portal solution by providing common application capabilities.
One of the problems with current portal offerings is they lack a convenient mechanism to integrate the flow of a complex software application (“application”) within the framework of the portal, so that the portal developer can easily include logic for portal-related events. What is needed is a mechanism for allowing the portal and the portlets, and other components therein, to communicate with each other in a manner that supports application flow within the portal as a whole.
The invention relates generally to portals, and particularly to a system and a method for providing application flow integration in a portal framework. In accordance with one embodiment, the invention comprises a portal servlet, which handles all incoming servlet requests and determines whether the incoming request represents a request either for a portal page or for a non-portal page; and, a portal processor which handles all portal page requests passed by the portal servlet, and executes an appropriate webflow to update the current state of the portal page, depending on a current set of events.
Disclosed herein is a system and a method for providing software application flow integration within a portal framework. In particular, the disclosed invention allows a portal framework to be supplemented with logical flow features such as webflow and pipeline functionality. As used herein a “webflow” is a state-machine-like mechanism that can be used to describe the flow of application logic throughout the Web site or portal, including the execution of business logic, error handling and dispatching. The flow is based on both user events and programming events. This state machine is then used as input to a webflow processor that guides the system, and that combines Web links, form submissions, form processing, business logic execution, and business logic exceptions, into an easily managed schema. Any required change to the logic flow of the system can be made by modifying just the webflow itself.
Typically, the webflow guides the progress of the interaction of the user with the actual e-commerce application. In many cases, the e-commerce system or application may be a Web site hosted on a Web server. Different types of application code can be used to track and to modify the user interface. These may include Java Servlet Pages (JSPs); input processing code which is used to modify the user input; and pipeline processing code. When properly configured, the webflow represents a tree structure along which the user is guided. The tree structure includes presentation nodes and actions nodes. Presentation nodes are what the customer actually sees in their browser, for example, these may include HTML and JSP files. While viewing the output from a presentation node, the customer's data is stored in a pipeline session. A pipeline session is a set of attributes which may in one embodiment be name value pairs which hold pertinent data on a given customer during a given session. Since the webflow acts like a state like machine, the pipeline session defines a current state for a given customer. The data stored in the pipeline session are used throughout the webflow to provide information to other features and services.
Action nodes perform the actual work for the e-business site, and include such features as input processors and pipelines. Input processors handle the attributes of the pipeline session. Typically the input processor may either: (a) put the attribute in the pipeline session; (b) modify the value of existing attributes within that pipeline session; or (c) validate values of particular attributes within the pipeline session. A pipeline controls the flow of the business logic within the e-commerce site. Typically the pipeline comprises many pipeline components. A pipeline component is an object responsible for doing a particular portion of the business logic. Each pipeline component is thus a unit of business functionality. The developer may combine the use of a webflow together with input processors and pipeline to modify their business functionality with ease of use and in real time. Further details about the use of webflow and pipelines in an e-commerce environment is presented in co-pending application “SYSTEM FOR MANAGING LOGICAL PROCESS FLOW IN AN ONLINE ENVIRONMENT; Inventors: Neil Smithline, and Sathyanarayana Giridhar, incorporated herein by reference.
The present invention provides a mechanism for providing software application flow integration, including such features as the webflow and pipelines described above, within a portal framework. In particular, the disclosed invention provides patterns for using webflow and pipeline technologies within a portal or with portlets. This allows the invention to provide a declarative means for developing portals and portlets. In addition a framework is provided for handling portal page events and portlet window events. A declarative means is provided for portal developers to add additional logic for framework supported events. A declarative means is also provided for handling any portal or portlet events. Lastly, a means is provided for communicating between the portlets and/or the portal and portlets.
The use of Webflow is not mandatory in developing the portal—instead it may be considered an advanced feature of the Portal development platform. Whether webflow is used in a particular portal depends on the particular needs and design of the application. Some reasons to use Webflow in individual portlets include:
Throughout the following description of a particular embodiment, it is assumed that only one portal may be deployed per web application; and that a portal web application may include conventional web pages (non-portal pages), along with the portal (portal page, maximized portlet page). However, it will be evident to one of skill in the art that in alternate embodiments of the invention different assumptions may be made.
Portal Web Application
A portal web application is usually comprised of a portal jsp page and, optionally, one or more conventional web pages. The invention assists in declaring access to, and transition between, the portal jsp page and conventional web pages, including for example in the following cases:
Functionally, five primary components make up the design: Portal Servlet, Portal Processor, PortalState object, PortalSession object and the Portal Manager.
The Portal Servlet handles all incoming servlet requests and determines whether they represent a request for either a portal page or a non-portal page. Non-portal page requests utilize the standard webflow (as described in further detail in copending application “SYSTEM FOR MANAGING LOGICAL PROCESS FLOW IN AN ONLINE ENVIRONMENT”; Inventors: Neil Smithline, and Sathyanarayana Giridhar), and are routed to the standard webflow executor unmodified. Portal page requests are however directed through the webflow executor to the Portal Processor for subsequent handling.
The Portal Processor handles all portal page requests. For each request, the Portal Processor obtains the current PortalState object for the request, and then executes appropriate framework logic to adjust the current state depending on the current appflow event. The Portal Processor then invokes webflow namespaces for the portal and all portlets to be rendered for the request. The webflow namespaces should declaratively cause execution of appropriate business logic for the given request. When the Portal Processor returns, it provides a URL to the Portal Servlet which is used to forward the request to the appropriate servlet (or jsp).
The PortalState object represents the current state of the Portal for the current user. The object returned by the Portal Manager contains only the persistent state for the current user. The Portal Processor augments this persistent state with the state of the current session (PortalSession). From the view of the rendering engine, realized in portal.jsp, the PortalState object contains all state for the current user, i.e. both the persistent and the session-based state. PortalState objects are intended to be used only for a single request.
The PortalSession is used to maintain the current portal page (tab) for the user and the content jsp page for each portlet.
The Portal Manager provides an interface between persisted portal data (XML and database data) and the clients of that data. The Portal Manager, with the aid of the entitlement engine, assembles a PortalState object for the current user and returns it to the client.
Webflow and the Portal Platform
To customize the behavior of the portal Web application, whether this means creating special navigation logic for a simple portlet, or developing complex business and presentation framework customizations that change the portal platform, to suit a particular business case, a basic understanding of Webflow is required.
Webflow and Portal can be thought of as two complementary navigation mechanisms. The portal platform provides an array of content placeholders, each able to function as a virtual browser that controls its own state without influencing the state of its neighbor portlets. The Webflow mechanism is designed to enable the navigation logic of a web application to be controlled by a multitude of factors, so that Personalization, etc., can all be coordinated to influence what is presented to the Web site visitor at runtime. Each individual portlet can be assigned its own particular Webflow. The following section explains the basic requirements in using Webflows with portlets.
Portlets and Webflow
The Webflow associated with portals are generally not edited by the application developer because it is fundamental to the application logic that makes up the portal platform. Individual portlets, however, can have individual webflows (in the form of Webflow files) assigned to them, allowing Webflow functionality to be applied to each portlet.
Portlet Webflow Parameters
Portal Webflow is invoked with the following three parameters:
In one embodiment, the portal framework uses the following portlet events, all of which must be handled when Webflow is invoked:
These events are called when the corresponding actions are performed, and are handled by the portal framework. These events can be used within custom portlets, and a developer can also define their own events. Custom events can be added if desired, and can be triggered from within custom portlets, or alternatively they can be triggered by portlet framework events.
The Refresh Event
Understanding Webflow in portals requires a grasp of the Refresh event. To illustrate the way this event is used, consider the page view 130 of the sample portal screenshot shown in
The Origin Parameter
Portlet Webflows do not use Origin differently than other web applications. Consider what happens when a user clicks on the “Next Page” link 136 in Portlet2 as shown in
Clicking on the “Next Page” link in page 1 of Portlet2 takes the visitor to Page 2 (138), as shown in
Considering this simple example illustrating the Origin parameter and the way Refresh events are handled in the portal framework, it is apparent that much customization can be accomplished without writing any Java code.
A few general reminders should be followed when using webflows within portlets:
In the general case, access should be through a generic url, such as: http://www.company.com/myPortal (with no additional query string or extra path information), and the portal for an anonymous visitor at the default portal page (tab) should be displayed.
Variations on the above include the ability to authenticate the visitor via a cookie, or by some other means, and render the default portal page (tab) for this visitor.
Changing the Portal Page
The application flow use cases described in further detail below illustrate several types of links that may be made available to a portal developer for use within portal areas of the portal page. These include “self”; “sibling’; “in”; and “out”. The following are example urls that correspond to these link types:
Generic Portlet Links
The application flow use cases described in further detail below illustrate several types of links that may be made available to a portal developer for use within portlet areas of the portal page. These also include “self”; “sibling’; “in”; and “out”. The following are example urls that correspond to these link types:
Object Implementations
The following section describes some object implementations in accordance with a particular embodiment of the invention as it may be used with a product such as WebLogic Server from BEA systems, Inc. to provide application flow in a portal framework. The following object descriptions are not intended to be exhaustive but merely to illustrate a particular embodiment. It is intended that alternate implementations may be developed by those skilled in the art, within the spirit and scope of the invention.
Com.bea.portal.appflow.common Package
Com.bea.portal.appflow.servlet Package
Com.bea.portal.appflow.internal Package
The foregoing description of the present invention has been provided for the purposes of illustration and description. It is not intended to be exhaustive or to limit the invention to the precise forms disclosed. Many modifications and variations will be apparent to the practitioner skilled in the art. The embodiments were chosen and described in order to best explain the principles of the invention and its practical application, thereby enabling others skilled in the art to understand the invention for various embodiments and with various modifications that are suited to the particular use contemplated. It is intended that the scope of the invention be defined by the following claims and their equivalence.
This application claims priority from provisional application “ENHANCED PORTALS [FLAGSTAFF RELEASE]” Application No. 60/386,487, filed Oct. 24, 2001, and incorporated herein by reference. This application is related to application “SYSTEM FOR MANAGING LOGICAL PROCESS FLOW IN AN ONLINE ENVIRONMENT; Inventors: Neil Smithline, and Sathyanarayana Giridhar, application Ser. No. 09/908,023, filed Jul. 18, 2001, and subsequently issued as U.S. Pat. No. 7,051,069, which is incorporated herein by reference.
Number | Name | Date | Kind |
---|---|---|---|
5173939 | Abadi et al. | Dec 1992 | A |
5237614 | Weiss | Aug 1993 | A |
5347653 | Flynn et al. | Sep 1994 | A |
5355474 | Thuraisngham et al. | Oct 1994 | A |
5369702 | Shanton | Nov 1994 | A |
5426747 | Weinreb et al. | Jun 1995 | A |
5481700 | Thuraisingham | Jan 1996 | A |
5544322 | Cheng et al. | Aug 1996 | A |
5627886 | Bowman | May 1997 | A |
5649195 | Scott et al. | Jul 1997 | A |
5758355 | Buchanan | May 1998 | A |
5797128 | Birnbaum | Aug 1998 | A |
5826000 | Hamilton | Oct 1998 | A |
5826268 | Schaefer et al. | Oct 1998 | A |
5838909 | Roy et al. | Nov 1998 | A |
5848396 | Gerace | Dec 1998 | A |
5867667 | Butman et al. | Feb 1999 | A |
5918210 | Rosenthal et al. | Jun 1999 | A |
5950195 | Stockwell et al. | Sep 1999 | A |
5956400 | Chaum et al. | Sep 1999 | A |
5956719 | Kudo et al. | Sep 1999 | A |
5966707 | Van Huben et al. | Oct 1999 | A |
5987611 | Freund | Nov 1999 | A |
5991735 | Gerace | Nov 1999 | A |
5991877 | Luckenbaugh | Nov 1999 | A |
6005571 | Pachauri | Dec 1999 | A |
6006194 | Merel | Dec 1999 | A |
6006285 | Jacobs et al. | Dec 1999 | A |
6009410 | LeMole et al. | Dec 1999 | A |
6026433 | D'Arlach et al. | Feb 2000 | A |
6029144 | Barrett et al. | Feb 2000 | A |
6029182 | Nehab et al. | Feb 2000 | A |
6055637 | Hudson et al. | Apr 2000 | A |
6058392 | Sampson et al. | May 2000 | A |
6081829 | Sidana | Jun 2000 | A |
6083276 | Davidson et al. | Jul 2000 | A |
6092083 | Brodersen et al. | Jul 2000 | A |
6098173 | Elgressy et al. | Aug 2000 | A |
6105027 | Schneider et al. | Aug 2000 | A |
6112192 | Capek | Aug 2000 | A |
6128663 | Thomas | Oct 2000 | A |
6133915 | Arcuri et al. | Oct 2000 | A |
6141010 | Hoyle | Oct 2000 | A |
6141686 | Jackowski et al. | Oct 2000 | A |
6144988 | Kappel | Nov 2000 | A |
6148333 | Guedalia et al. | Nov 2000 | A |
6154844 | Touboul et al. | Nov 2000 | A |
6157924 | Austin | Dec 2000 | A |
6161139 | Win et al. | Dec 2000 | A |
6167448 | Hemphill et al. | Dec 2000 | A |
6169794 | Oshimi et al. | Jan 2001 | B1 |
6170009 | Mandal et al. | Jan 2001 | B1 |
6178172 | Rochberger | Jan 2001 | B1 |
6182142 | Win et al. | Jan 2001 | B1 |
6182226 | Reid et al. | Jan 2001 | B1 |
6182277 | DeGroot et al. | Jan 2001 | B1 |
6188399 | Voas et al. | Feb 2001 | B1 |
6195696 | Baber et al. | Feb 2001 | B1 |
6202066 | Barkley et al. | Mar 2001 | B1 |
6202157 | Brownlie et al. | Mar 2001 | B1 |
6205466 | Karp et al. | Mar 2001 | B1 |
6209101 | Mitchem et al. | Mar 2001 | B1 |
6216231 | Stubblebine | Apr 2001 | B1 |
6226745 | Wiederhold | May 2001 | B1 |
6233576 | Lewis | May 2001 | B1 |
6236991 | Frauenhofer et al. | May 2001 | B1 |
6241608 | Torango | Jun 2001 | B1 |
6253321 | Nikander et al. | Jun 2001 | B1 |
6260050 | Yost et al. | Jul 2001 | B1 |
6269393 | Yost et al. | Jul 2001 | B1 |
6275941 | Saito et al. | Aug 2001 | B1 |
6285983 | Jenkins | Sep 2001 | B1 |
6285985 | Horstmann | Sep 2001 | B1 |
6295607 | Johnson | Sep 2001 | B1 |
6308163 | Du et al. | Oct 2001 | B1 |
6317868 | Grimm et al. | Nov 2001 | B1 |
6327628 | Anuff et al. | Dec 2001 | B1 |
6336073 | Ihara et al. | Jan 2002 | B1 |
6341352 | Child et al. | Jan 2002 | B1 |
6353886 | Howard et al. | Mar 2002 | B1 |
6393474 | Eichert et al. | May 2002 | B1 |
6412077 | Roden et al. | Jun 2002 | B1 |
6418448 | Sarkar | Jul 2002 | B1 |
6438563 | Kawagoe | Aug 2002 | B1 |
6449638 | Wecker et al. | Sep 2002 | B1 |
6457007 | Kikuchi et al. | Sep 2002 | B1 |
6460084 | Van Horne et al. | Oct 2002 | B1 |
6460141 | Olden | Oct 2002 | B1 |
6463440 | Hind et al. | Oct 2002 | B1 |
6473791 | Al-Ghosein et al. | Oct 2002 | B1 |
6477575 | Koeppel et al. | Nov 2002 | B1 |
6484177 | Van Huben et al. | Nov 2002 | B1 |
6484261 | Wiegel | Nov 2002 | B1 |
6519647 | Howard et al. | Feb 2003 | B1 |
6530024 | Proctor | Mar 2003 | B1 |
6539375 | Kawasaki | Mar 2003 | B2 |
6571247 | Danno et al. | May 2003 | B1 |
6584454 | Hummel et al. | Jun 2003 | B1 |
6587849 | Mason et al. | Jul 2003 | B1 |
6615218 | Mandal et al. | Sep 2003 | B2 |
6618806 | Brown et al. | Sep 2003 | B1 |
6654747 | Van Huben et al. | Nov 2003 | B1 |
6665677 | Wotring et al. | Dec 2003 | B1 |
6668354 | Chen et al. | Dec 2003 | B1 |
6721888 | Liu et al. | Apr 2004 | B1 |
6735586 | Timmons | May 2004 | B2 |
6735701 | Jacobson | May 2004 | B1 |
6751659 | Fenger et al. | Jun 2004 | B1 |
6754672 | McLauchlin | Jun 2004 | B1 |
6769118 | Garrison et al. | Jul 2004 | B2 |
6789202 | Ko et al. | Sep 2004 | B1 |
6880005 | Bell et al. | Apr 2005 | B1 |
6904454 | Stickler | Jun 2005 | B2 |
6920457 | Pressmar | Jul 2005 | B2 |
6957261 | Lortz | Oct 2005 | B2 |
6965999 | Fox et al. | Nov 2005 | B2 |
6970876 | Hotti et al. | Nov 2005 | B2 |
6985939 | Fletcher et al. | Jan 2006 | B2 |
7051084 | Hayton et al. | May 2006 | B1 |
7062490 | Adya et al. | Jun 2006 | B2 |
20010009016 | Hofmann et al. | Jul 2001 | A1 |
20020059394 | Sanders | May 2002 | A1 |
20020062451 | Scheidt et al. | May 2002 | A1 |
20020069261 | Bellare et al. | Jun 2002 | A1 |
20020107913 | Rivera et al. | Aug 2002 | A1 |
20020111998 | Kim | Aug 2002 | A1 |
20020124053 | Adams et al. | Sep 2002 | A1 |
20020173971 | Stirpe et al. | Nov 2002 | A1 |
20020178119 | Griffin et al. | Nov 2002 | A1 |
20030065721 | Roskind | Apr 2003 | A1 |
20030078972 | Tapissier et al. | Apr 2003 | A1 |
20030131113 | Reeves et al. | Jul 2003 | A1 |
20030140308 | Murthy et al. | Jul 2003 | A1 |
20030187956 | Belt et al. | Oct 2003 | A1 |
20030229623 | Chang et al. | Dec 2003 | A1 |
20040003071 | Mathew et al. | Jan 2004 | A1 |
20040019650 | Auvenshine | Jan 2004 | A1 |
20040024812 | Park et al. | Feb 2004 | A1 |
20040205473 | Fisher et al. | Oct 2004 | A1 |
20040205557 | Bahrs et al. | Oct 2004 | A1 |
20040230546 | Rogers | Nov 2004 | A1 |
20050050184 | Boden et al. | Mar 2005 | A1 |
20050060324 | Johnson et al. | Mar 2005 | A1 |
20060085412 | Johnson et al. | Apr 2006 | A1 |
Number | Date | Country |
---|---|---|
1 256 889 | Nov 2002 | EP |
WO0038078 | Jun 2000 | WO |
WO0114962 | Mar 2001 | WO |
WO 0167285 | Sep 2001 | WO |
WO 0177823 | Oct 2001 | WO |
WO 02063496 | Aug 2002 | WO |
Number | Date | Country | |
---|---|---|---|
20030149722 A1 | Aug 2003 | US |
Number | Date | Country | |
---|---|---|---|
60386487 | Oct 2001 | US |