Business components framework

[0002] The present invention relates to software framework designs and more particularly to generating software frameworks based on components of business aspects.

[0003] An important use of computers is the transfer of information over a network. Currently, the largest computer network in existence is the Internet. The Internet is a worldwide interconnection of computer networks that communicate using a common protocol. Millions of computers, from low end personal computers to high-end super computers are coupled to the Internet.

[0004] The Internet grew out of work funded in the 1960s by the U.S. Defense Department's Advanced Research Projects Agency. For a long time, Internet was used by researchers in universities and national laboratories to share information. As the existence of the Internet became more widely known, many users outside of the academic/research community (e.g., employees of large corporations) started to use Internet to carry electronic mail.

[0005] In 1989, a new type of information system known as the World-Wide-Web (“the Web”) was introduced to the Internet. Early development of the Web took place at CERN, the European Particle Physics Laboratory. The Web is a wide-area hypermedia information retrieval system aimed to give wide access to a large universe of documents. At that time, the Web was known to and used by the academic/research community only. There was no easily available tool which allows a technically untrained person to access the Web.

[0006] In 1993, researchers at the National Center for Supercomputing Applications (NCSA) released a Web browser called “Mosaic” that implemented a graphical user interface (GUI). Mosaic's graphical user interface was simple to learn yet powerful. The Mosaic browser allows a user to retrieve documents from the World-Wide-Web using simple point-and-click commands. Because the user does not have to be technically trained and the browser is pleasant to use, it has the potential of opening up the Internet to the masses.

[0007] The architecture of the Web follows a conventional client-server model. The terms “client” and “server” are used to refer to a computer's general role as a requester of data (the client) or provider of data (the server). Under the Web environment, Web browsers reside in clients and Web documents reside in servers. Web clients and Web servers communicate using a protocol called “HyperText Transfer Protocol” (HTTP). A browser opens a connection to a server and initiates a request for a document. The server delivers the requested document, typically in the form of a text document coded in a standard Hypertext Markup Language (HTML) format, and when the connection is closed in the above interaction, the server serves a passive role, i.e., it accepts commands from the client and cannot request the client to perform any action.

[0008] The communication model under the conventional Web environment provides a very limited level of interaction between clients and servers. In many systems, increasing the level of interaction between components in the systems often makes the systems more robust, but increasing the interaction increases the complexity of the interaction and typically slows the rate of the interaction. Thus, the conventional Web environment provides less complex, faster interactions because of the Web's level of interaction between clients and servers.

[0009] A method of generating software based on business components. A plurality of business components in a business are first defined with each logical business component having a plurality of capabilities. Next, functional interrelationships are identified between the logical business components. Code modules are then generated to carry out the capabilities of the logical business components and the functional interrelationships between the logical business components, wherein the code modules represent a transformation of the logical business components to their physical implementation, while ensuring the capabilities that are carried out by each code module are essentially unique to the logical business component associated with the code module. Next, the functional aspects of the code modules and the functional relationships of the code modules are tested. The code modules are then subsequently deployed in an e-commerce environment.

[0010] In one embodiment of the present invention, the business components may include customers, products, orders, inventory, pricing, credit check, billing, and fraud analysis. Further, a portion of the business components may be entity-centric.

[0011] In another embodiment of the present invention, a portion of the business components may be process-centric. In such an embodiment, a portion of the business components that are entity-centric may be governed by the business components that are process-centric. As an option in this embodiment, the business components that are process-centric may also be user-controlled.

[0012] The invention will be better understood when consideration is given to the following detailed description thereof. Such description makes reference to the annexed drawings wherein:

[0013] FIG. 1A illustrates an exemplary hardware implementation of one embodiment of the present invention;

[0014] FIG. 1B illustrates a flowchart for a codes table framework that maintains application consistency by referencing text phrases through a short codes framework according to an embodiment of the present invention;

[0015] FIG. 1C is a flowchart depicting a method for providing an interface between a first server and a second server with a proxy component situated therebetween;

[0016] FIG. 1D shows the execution architecture for components that make up the SAP Framework Execution Architecture according to an embodiment of the present invention;

[0017] FIG. 1E is a flowchart illustrating a method for sharing context objects among a plurality of components executed on a transaction server;

[0018] FIG. 2 illustrates the create component instances method according to an embodiment of the present invention;

[0019] FIG. 3 illustrates multiple components in the same transaction context according to an embodiment of the present invention;

[0020] FIG. 4 illustrates the forcing of a component's database operations to use a separate transaction according to an embodiment of the present invention;

[0021] FIG. 5 illustrates the compose work form multiple activities in the same transaction according to an embodiment of the present invention;

[0022] FIG. 6 illustrates JIT activation where MTS intercepts the Customer creation request, starts a process for the Customer package containing Customer component, creates the ContextObject and returns a reference to the client according to an embodiment of the present invention;

[0023] FIG. 7 illustrates JIT activation when the customer object has been deactivated (the customer object is grayed out) according to an embodiment of the present invention;

[0024] FIG. 8A is a flowchart depicting a method for providing an activity framework;

[0025] FIG. 8B is an illustration of the MTS runtime environment according to an embodiment of the present invention;

[0026] FIG. 9A is a flowchart illustrating a method for accessing services within a server without a need for knowledge of an application program interface of the server;

[0027] FIG. 9B illustrates the different layers in a Site Server framework architecture according to an embodiment of the present invention;

[0028] FIG. 10 illustrates schema attributes and classes, with class “Role” and attribute “RoleName” shown;

[0029] FIG. 11 illustrates the creating of Container “Roles” according to an embodiment of the present invention;

[0030] FIG. 12 is an illustration of a graphic display at a point where a user has right-clicked on the Schema folder and selected New—Attribute according to an embodiment of the present invention;

[0031] FIG. 13 illustrates the adding of different Roles according to an embodiment of the present invention;

[0032] FIG. 14 illustrates an example of the graphic display showing the attributes of member “Joe Bloggs” according to an embodiment of the present invention;

[0033] FIG. 15A is a flowchart that illustrates a method for handling events in a system;

[0034] FIG. 15B illustrates a ReTA Event Handier framework that manages the informational, warning and error events that an application raises according to an embodiment of the present invention;

[0035] FIG. 16A is a flowchart depicting a method for managing user information;

[0036] FIG. 16B illustrates a User framework which enables two approaches to maintaining user information according to an embodiment of the present invention;

[0037] FIG. 17A is a flowchart that illustrates a method for managing business objects in a system that includes a plurality of sub-activities which each include sub-activity logic adapted to generate an output based on an input received from a user upon execution, and a plurality of activities which each execute the sub-activities in a unique manner upon being selected for accomplishing a goal associated with the activity;

[0038] FIG. 17B shows a SubActivity component using the Persistence framework to retrieve a Customer Object from the Database according to an embodiment of the present invention;

[0039] FIG. 18A is a flow chart depicting a method for persisting information during a user session;

[0040] FIG. 18B illustrates a Session Flow Diagram—On Session Start according to an embodiment of the present invention;

[0041] FIG. 19 illustrates a Session Flow Diagram—On Start ASP Page according to an embodiment of the present invention;

[0042] FIG. 20A is a flow chart illustrating a method for generating a graphical user interface;

[0043] FIG. 20B is an illustration showing the steps for generating a HTML page consisting of a form with a TextBox, a DropDown list and a PushButton according to an embodiment of the present invention;

[0044] FIG. 21A is a flow chart depicting a method for software configuration management

[0045] FIG. 21B is an illustration of an IDEA framework on which the ReTA Development Architecture Design is based according to an embodiment of the present invention;

[0046] FIG. 22 illustrates the Configuration Management Life Cycle according to an embodiment of the present invention;

[0047] FIG. 23 illustrates the change control ‘pipeline’ and each phase within the pipeline according to an embodiment of the present invention;

[0048] FIG. 24 depicts the application of Roles within the Microsoft Transaction Server (MTS) management console according to an embodiment of the present invention;

[0049] FIG. 25 illustrates an environment migration process that guides development within ReTA engagement environments according to an embodiment of the present invention;

[0050] FIG. 26 is an illustration of a Development/Unit test for existing applications according to an embodiment of the present invention;

[0051] FIG. 27 illustrates an assembly test for existing applications according to an embodiment of the present invention;

[0052] FIG. 28 illustrates a system test for existing applications according to an embodiment of the present invention;

[0053] FIG. 29 is a flowchart for production of existing applications according to an embodiment of the present invention;

[0054] FIG. 30 illustrates a graphic display of Visual Source Safe according to an embodiment of the present invention;

[0055] FIG. 31 illustrates a frame of PVCS Version Manager I-Net Client according to an embodiment of the present invention;

[0056] FIG. 32 is an illustration of a Build Source Control Model according to an embodiment of the present invention;

[0057] FIG. 33 illustrates an Assembly Test phase control mode according to an embodiment of the present invention;

[0058] FIG. 34 illustrates a Microsoft Visual SourceSafe ‘Labels’ dialog box according to an embodiment of the present invention;

[0059] FIG. 35 illustrates a Database Diagram within Visual Studio according to an embodiment of the present invention;

[0060] FIG. 36 illustrates Object Modeling within Rational Rose according to an embodiment of the present invention;

[0061] FIG. 37 illustrates directly calling a wrapped CICS component according to an embodiment of the present invention;

[0062] FIG. 38 illustrates indirectly calling a wrapped CICS component according to an embodiment of the present invention;

[0063] FIG. 39 illustrates RSW eTest Automated Testing Tool according to an embodiment of the present invention;

[0064] FIG. 40 is an illustration which describes the physical configuration necessary for ReTA development according to an embodiment of the present invention;

[0065] FIG. 41 illustrates the application & architecture configuration for a typical ReTA Build environment according to an embodiment of the present invention;

[0066] FIG. 42 illustrates the application & architecture configuration for a typical ReTA Build environment according to an embodiment of the present invention;

[0067] FIG. 43 illustrates an IDEA Framework with components in scope ReTA Phase 1 according to an embodiment of the present invention;

[0068] FIG. 44 illustrates a NCAF Framework with the shaded components in scope for Phase 1 according to an embodiment of the present invention;

[0069] FIG. 45 illustrates a MODEnc Framework according to an embodiment of the present invention;

[0070] FIG. 46 illustrates a NCAF Framework according to an embodiment of the present invention;

[0071] FIG. 47 illustrates the components that comprise the ReTA execution architecture and their physical location according to an embodiment of the present invention;

[0072] FIG. 48 illustrates a MODEnc Framework for Operations Architecture according to an embodiment of the present invention;

[0073] FIG. 49 is an illustrative representation of a solicited event resulting from the direct (synchronous) polling of a network component by a network management station according to an embodiment of the present invention;

[0074] FIG. 50 is an illustrative representation of when an unsolicited event occurs when a network component sends (asynchronously) data to the network management station according to an embodiment of the present invention;

[0075] FIG. 51 illustrates event management in a net-centric environment according to an embodiment of the present invention;

[0076] FIG. 52 illustrates event management in an Intranet-based net-centric model according to an embodiment of the present invention;

[0077] FIG. 53 illustrates event management when using an Extranet-based net-centric model according to an embodiment of the present invention;

[0078] FIG. 54 illustrates the tables and relationships required for the ReTA Phase 1 Architecture Frameworks according to an embodiment of the present invention;

[0079] FIG. 55 illustrates tables and relationships required for the ReTA Phase 1 validation application according to an embodiment of the present invention;

[0080] FIG. 56 illustrates the physical configuration of a possible ReTA-engagement development environment according to an embodiment of the present invention;

[0081] FIG. 57 illustrates the physical configuration of possible ReTA-based Assembly, Product and Performance testing environments according to an embodiment of the present invention;

[0082] FIG. 58 illustrates Separate Web and Application Servers according to an embodiment of the present invention;

[0083] FIG. 59 illustrates a Single Web and Application Server according to an embodiment of the present invention;

[0084] FIG. 60 illustrates a Commerce Membership Server [Membership Authentication] properties view according to an embodiment of the present invention;

[0085] FIG. 61 illustrates a Membership Directory Manager Properties Dialog according to an embodiment of the present invention;

[0086] FIG. 62 is an illustration of a Membership Server Mapping Property according to an embodiment of the present invention;

[0087] FIG. 63 is an illustration of a Create New Site Foundation Wizard according to an embodiment of the present invention;

[0088] FIG. 64 illustrates the web application being placed under the “Member” directory of “cm” in Windows Explorer according to an embodiment of the present invention;

[0089] FIG. 65 depicts a typical ReTA engagement development environment according to an embodiment of the present invention;

[0090] FIG. 66 illustrates the development environment configuration for a ReTA Phase 1 engagement according to an embodiment of the present invention;

[0091] FIG. 67 illustrates an interface associated with the ability of inserting or removing statements within a block without worrying about adding or removing braces according to an embodiment of the present invention;

[0092] FIG. 68 shows a Visual J++ Build Environment according to an embodiment of the present invention;

[0093] FIG. 69 shows an interface for attaching to the MTS Process for debugging according to an embodiment of the present invention;

[0094] FIG. 70 shows an interface for debugging an Active Server Page (example global.asa file) according to an embodiment of the present invention;

[0095] FIG. 71 illustrates an example of Rose generated java file and javadoc comments according to an embodiment of the present invention;

[0096] FIG. 72A is a flowchart illustrating a method for testing a technical architecture;

[0097] FIG. 72B illustrates the application & architecture configuration for a typical ReTA Build environment according to an embodiment of the present invention;

[0098] FIG. 73 illustrates that the code for technology architecture assembly test may be migrated from the technology architecture component test environment as defined in the migration procedures according to an embodiment of the present invention;

[0099] FIG. 74 illustrates the application & architecture configuration for a typical ReTA Build environment according to an embodiment of the present invention;

[0100] FIG. 75 illustrates the physical characteristics of the testing environment to be utilized during the Performance Testing Phases according to an embodiment of the present invention;

[0101] FIG. 76A is a flow chart depicting a method for managing change requests in an e-commerce environment;

[0102] FIG. 76B illustrates a framework associated with the change tracker according to an embodiment of the present invention;

[0103] FIG. 77 illustrates the Change Tracker Main Window according to an embodiment of the present invention;

[0104] FIG. 78 illustrates the Change Request Detail Screen according to an embodiment of the present invention;

[0105] FIG. 79 illustrates a History of Changes Window according to an embodiment of the present invention;

[0106] FIG. 80 illustrates the Ad-Hoc Reporting Window according to an embodiment of the present invention;

[0107] FIG. 81 illustrates the Manager Reporting Window according to an embodiment of the present invention;

[0108] FIG. 82 illustrates the Migration Checklist Window according to an embodiment of the present invention;

[0109] FIG. 83A is a flow chart illustrating a method for managing issues in an e-commerce environment;

[0110] FIG. 83B illustrates the Issue Tracker Main Screen according to an embodiment of the present invention;

[0111] FIG. 84 illustrates the New Issue Screen according to an embodiment of the present invention;

[0112] FIG. 85 illustrates the Modify Issue Screen according to an embodiment of the present invention;

[0113] FIG. 86 illustrates the Report Selection Screen according to an embodiment of the present invention;

[0114] FIG. 87A is a flow chart depicting a method for network performance modeling;

[0115] FIG. 87B illustrates the end to end process associated with Performance Modeling according to an embodiment of the present invention;

[0116] FIG. 88 illustrates the Effective Network Performance Management according to an embodiment of the present invention;

[0117] FIG. 89 illustrates an example of overhead introduced at lower layers according to an embodiment of the present invention;

[0118] FIG. 90 illustrates a graph depicting a Network Usage Profile according to an embodiment of the present invention;

[0119] FIG. 91 illustrates a Network Layout according to an embodiment of the present invention;

[0120] FIG. 92 illustrates how the four tool categories relate to each other according to an embodiment of the present invention;

[0121] FIG. 93A is a flow chart depicting a method for managing software modules during development;

[0122] FIG. 93B illustrates the PVCS Migration Flow according to an embodiment of the present invention;

[0123] FIG. 94 illustrates SCM Planning according to an embodiment of the present invention;

[0124] FIG. 95 illustrates an Identify CM Units & Baselines Process Flow according to an embodiment of the present invention;

[0125] FIG. 96 illustrates a manner in which CM Repositories and Practices Process Flow are established according to an embodiment of the present invention;

[0126] FIG. 97 illustrates the Establish Change Control Process according to an embodiment of the present invention;

[0127] FIG. 98 illustrates Collect Metrics and Identify CI Activities according to an embodiment of the present invention;

[0128] FIG. 99 illustrates the Review/Establish Project Security according to an embodiment of the present invention;

[0129] FIG. 100 illustrates the Determine Training Requirements according to an embodiment of the present invention;

[0130] FIG. 101 illustrates the Create Project CM Plan according to an embodiment of the present invention;

[0131] FIG. 102 shows the Manage CM Repository Process Flow according to an embodiment of the present invention;

[0132] FIG. 103A is a flow chart illustrating a method for providing a system investigation report workbench;

[0133] FIG. 103B illustrates a SIR Workbench Main Window screen which provides navigation buttons for adding new SIRs, viewing existing SIRs, viewing/printing existing reports and help according to an embodiment of the present invention;

[0134] FIG. 104 illustrates New SIR window displayed upon select the New button on the Main Window according to an embodiment of the present invention;

[0135] FIG. 105 illustrates a window for reviewing and modifying existing SIRs according to an embodiment of the present invention;

[0136] FIG. 106 illustrates the Change Control Details Window according to an embodiment of the present invention;

[0137] FIG. 107 illustrates a Report Selection Screen upon selection the Report button from the main menu according to an embodiment of the present invention;

[0138] FIG. 108 illustrates a graphic display of SourceSafe Administrator according to an embodiment of the present invention;

[0139] FIG. 109A illustrates a configuration of a project tree within Visual SourceSafe Explorer according to an embodiment of the present invention;

[0140] FIG. 109B illustrates a dialog box of the projection tree in FIG. 109 designed to allow developers to quickly located and retrieve desired projects and/or files according to an embodiment of the present invention;

[0141] FIG. 110 illustrates a graphic display when the user gets the latest of the server-side application code from VSS according to an embodiment of the present invention;

[0142] FIG. 111 illustrates a window that appears where selection the Recursive checkbox permits copying of any sub-projects according to an embodiment of the present invention;

[0143] FIG. 112 illustrates a History window displayed upon selection of View History menu item according to an embodiment of the present invention;

[0144] FIG. 113 illustrates the VSS Explorer reflecting the status of the checked out files for other developers to see at a point where one can open the local project or files and make any desired changes according to an embodiment of the present invention;

[0145] FIG. 114 illustrates Check In from within the VSS Explorer according to an embodiment of the present invention;

[0146] FIG. 115 illustrates the prompting for Check In details according to an embodiment of the present invention;

[0147] FIG. 116 illustrates a label creation dialog box according to an embodiment of the present invention;

[0148] FIG. 117 illustrates a History of Project dialog box according to an embodiment of the present invention;

[0149] FIG. 118 illustrates a History Details dialog according to an embodiment of the present invention;

[0150] FIG. 119 illustrates the end to end evaluation process of an Internet firewall for ReTA according to an embodiment of the present invention;

[0151] FIG. 120 is a chart of Firewall Products according to an embodiment of the present invention;

[0152] FIG. 121 depicts the two firewall vendors selected for the product evaluation stage according to an embodiment of the present invention;

[0153] FIG. 122 is a diagram of the Activity Framework classes with the VBActivityWrapper according to an embodiment of the present invention;

[0154] FIG. 123 illustrates the relationships IVB Activity interface according to an embodiment of the present invention;

[0155] FIG. 124A is a flow chart depicting a method for providing a global internetworking gateway architecture in an e-commerce environment;

[0156] FIG. 124B illustrates a simple high level internetworking gateway architecture according to an embodiment of the present invention;

[0157] FIG. 125 illustrates an Internetworking Gateway with a Specialized Proxy/Cache Server according to an embodiment of the present invention;

[0158] FIG. 126 illustrates a high level global internetworking gateway architecture according to an embodiment of the present invention;

[0159] FIG. 127 shows an illustrative West Coast internetworking gateway architecture according to an embodiment of the present invention;

[0160] FIG. 128 shows a Remote Access Internetworking Gateway architecture according to an embodiment of the present invention;

[0161] FIG. 129 illustrates an Internetworking Gateway with Partner collaboration on internet Development according to an embodiment of the present invention;

[0162] FIG. 130 illustrates a persistable business object extending Persistence. RetaPersistableObj. According to an embodiment of the present invention;

[0163] FIG. 131 illustrates layers of a shared property group manager according to an embodiment of the present invention;

[0164] FIG. 132A is a flow chart depicting a method for initializing a database used with an issue tracker;

[0165] FIG. 132B illustrates configuring of an issue tracker tool for normal operation according to an embodiment of the present invention;

[0166] FIG. 133 illustrates a dialog box prompting to confirm the removal of linked tables within a database;

[0167] FIG. 134 illustrates a New Table' dialog window being displayed upon selection of a ‘New’ button in order to insert a new table according to an embodiment of the present invention;

[0168] FIG. 135 illustrates a prompting by Access for selecting tables to link according to an embodiment of the present invention;

[0169] FIG. 136 illustrates a dialog box indicating linked tables according to an embodiment of the present invention;

[0170] FIG. 137 illustrates a ‘Welcome Form’ window according to an embodiment of the present invention;

[0171] FIG. 138 illustrates a ‘Issue Form’ window according to an embodiment of the present invention;

[0172] FIG. 139 illustrates a window which permits modification of the available reports within the Issue tool according to an embodiment of the present invention;

[0173] FIG. 140 illustrates a window displayed permitting modification of desired report elements to the new project name according to an embodiment of the present invention;

[0174] FIG. 141 illustrates a Team Code Table window which allows adding and deleting of project locations according to an embodiment of the present invention;

[0175] FIG. 142 illustrates a Team Membership Table window which allows adding and deleting of team members according to an embodiment of the present invention;

[0176] FIG. 143 illustrates a Project Phases Table window which allows changing of project phases according to an embodiment of the present invention;

[0177] FIG. 144 illustrates a Startup window which allows changing of the title of a database according to an embodiment of the present invention;

[0178] FIG. 145A is a flowchart depicting a method for generating software based on business components;

[0179] FIG. 145B illustrates a relationship between business components and partitioned business components according to an embodiment of the present invention;

[0180] FIG. 146 illustrates how a Billing Business Component may create an invoice according to an embodiment of the present invention;

[0181] FIG. 147 illustrates the relationship between the spectrum of Business Components and the types of Partitioned Business Components according to an embodiment of the present invention;

[0182] FIG. 148 illustrates the flow of workflow, dialog flow, and/or user interface designs to a User Interface Component according to an embodiment of the present invention;

[0183] FIG. 149 is a diagram of the Eagle Application Model which illustrates how the different types of Partitioned Business Components may interact with each other according to an embodiment of the present invention;

[0184] FIG. 150 illustrates what makes up a Partitioned Business Component according to an embodiment of the present invention;

[0185] FIG. 151 illustrates the role of patterns and frameworks according to an embodiment of the present invention;

[0186] FIG. 152 illustrates a Business Component Identifying Methodology according to an embodiment of the present invention;

[0187] FIG. 153 is a flow chart depicting an exemplary embodiment of a resources e-commerce technical architecture;

[0188] FIG. 154 is a flow chart illustrating a second exemplary embodiment of a method for maintaining data in an e-commerce based technical architecture;

[0189] FIG. 155 is a flow chart illustraing an exemplary embodiment of a method for providing a resources e-commerce technical architecture;

[0190] FIG. 156 illustrates another exemplary embodiment of a method for providing a resources e-commerce technical architecture; and

[0191] FIG. 157 illustrates an additional exemplary embodiment of a method for providing a resources e-commerce technical architecture.

[0192] The Resources eCommerce Technology Architecture (ReTA) is a solution that allows the use of packaged components to be integrated into a client based eCommerce solution. Before the present invention, the Resources architecture offerings provided services that supported the construction, execution and operation of very large custom built solutions. In the last few years, client needs have shifted towards requirements for solutions that continually integrate well with third party applications (i.e., data warehouse and portion of the present description management systems). Previous engagements have proven that it is difficult to integrate these applications into a new solution. As application vendors continue to produce new releases that incorporate technical advancements, it is even more difficult to ensure that these integrated applications continue to work with a given solution.

[0193] The ReTA approach to constructing, executing and operating a solution emphasizes the ability to change solution components with minimal impact on the solution as a whole. From this approach, ReTA views third party applications as another component in the overall solution. ReTA is component based, which means the engagement can choose to take only the pieces it needs to meet its specific business requirements. ReTA is especially suited to building small applications, implementing tools and packages, integrating applications and web enabling applications.

[0194] ReTA leverages the best capabilities from established market leaders such as Microsoft, SAP and Oracle. In addition, ReTA leverages some of the Resources prior efforts to integrate solutions. The present invention is an assembly of these best capabilities that helps to ensure a holistic delivered solution.

[0195] In short, the benefits ReTA provides to the Resources practice and clients are:

[0196] Save engagement teams the redundant effort of repeatedly evaluating the same technology.

[0197] Help engagement teams avoid the risk of combining solution components that may be difficult to get to work together.

[0198] Make it cost effective and low risk to apply upgrades to each of the solution products without negatively affecting the other solution components.

[0199] Show the clients a solution to a real challenge that cannot be offered by SAP, Microsoft, IBM, Oracle or many technology startups involved in eCommerce work.

[0200] Focus the Resources architecture offering on common technology choices that coexist nicely.

[0201] In accordance with at least one embodiment of the present invention, a system is provided for affording various features which support a resources eCommerce Technical Architecture. The present invention may be enabled using a hardware implementation such as that illustrated in FIG. 1A. Further, various functional and user interface features of one embodiment of the present invention may be enabled using software programming, i.e. object oriented programming (OOP).

[0202] Hardware Overview

[0203] A representative hardware environment of a preferred embodiment of the present invention is depicted in FIG. 1A, which illustrates a typical hardware configuration of a workstation having a central processing unit 110, such as a microprocessor, and a number of other units interconnected via a system bus 112. The workstation shown in FIG. 1A includes Random Access Memory (RAM) 114, Read Only

[0204] Memory (ROM) 116, an I/O adapter 118 for connecting peripheral devices such as disk storage units 120 to the bus 112, a user interface adapter 122 for connecting a keyboard 124, a mouse 126, a speaker 128, a microphone 132, and/or other user interface devices such as a touch screen (not shown) to the bus 112, communication adapter 134 for connecting the workstation to a communication network (e.g., a data processing network) and a display adapter 136 for connecting the bus 112 to a display device 138. The workstation typically has resident thereon an operating system such as the Microsoft Windows NT or Windows/95 Operating System (OS), the IBM OS/2 operating system, the MAC OS, or UNIX operating system.

[0205] Software Overview

[0206] Object oriented programming (OOP) has become increasingly used to develop complex applications. As OOP moves toward the mainstream of software design and development, various software solutions require adaptation to make use of the benefits of OOP. A need exists for the principles of OOP to be applied to a messaging interface of an electronic messaging system such that a set of OOP classes and objects for the messaging interface can be provided.

[0207] OOP is a process of developing computer software using objects, including the steps of analyzing the problem, designing the system, and constructing the program. An object is a software package that contains both data and a collection of related structures and procedures. Since it contains both data and a collection of structures and procedures, it can be visualized as a self-sufficient component that does not require other additional structures, procedures or data to perform its specific task. OOP, therefore, views a computer program as a collection of largely autonomous components, called objects, each of which is responsible for a specific task. This concept of packaging data, structures, and procedures together in one component or module is called encapsulation.

[0208] In general, OOP components are reusable software modules which present an interface that conforms to an object model and which are accessed at run-time through a component integration architecture. A component integration architecture is a set of architecture mechanisms which allow software modules in different process spaces to utilize each other's capabilities or functions. This is generally done by assuming a common component object model on which to build the architecture. It is worthwhile to differentiate between an object and a class of objects at this point. An object is a single instance of the class of objects, which is often just called a class. A class of objects can be viewed as a blueprint, from which many objects can be formed.

[0209] OOP allows the programmer to create an object that is a part of another object. For example, the object representing a piston engine is said to have a composition-relationship with the object representing a piston. In reality, a piston engine comprises a piston, valves and many other components; the fact that a piston is an element of a piston engine can be logically and semantically represented in OOP by two objects.

[0210] OOP also allows creation of an object that “depends from” another object. If there are two objects, one representing a piston engine and the other representing a piston engine wherein the piston is made of ceramic, then the relationship between the two objects is not that of composition. A ceramic piston engine does not make up a piston engine. Rather it is merely one kind of piston engine that has one more limitation than the piston engine; its piston is made of ceramic. In this case, the object representing the ceramic piston engine is called a derived object, and it inherits all of the aspects of the object representing the piston engine and adds further limitation or detail to it. The object representing the ceramic piston engine “depends from” the object representing the piston engine. The relationship between these objects is called inheritance.

[0211] When the object or class representing the ceramic piston engine inherits all of the aspects of the objects representing the piston engine, it inherits the thermal characteristics of a standard piston defined in the piston engine class. However, the ceramic piston engine object overrides these ceramic specific thermal characteristics, which are typically different from those associated with a metal piston. It skips over the original and uses new functions related to ceramic pistons. Different kinds of piston engines have different characteristics, but may have the same underlying functions associated with them (e.g., how many pistons in the engine, ignition sequences, lubrication, etc.). To access each of these functions in any piston engine object, a programmer would call the same functions with the same names, but each type of piston engine may have different/overriding implementations of functions behind the same name. This ability to hide different implementations of a function behind the same name is called polymorphism and it greatly simplifies communication among objects.

[0212] With the concepts of composition-relationship, encapsulation, inheritance and polymorphism, an object can represent just about anything in the real world. In fact, the logical perception of the reality is the only limit on determining the kinds of things that can become objects in object-oriented software. Some typical categories are as follows:

[0213] Objects can represent physical objects, such as automobiles in a traffic-flow simulation, electrical components in a circuit-design program, countries in an economics model, or aircraft in an air-traffic-control system.

[0214] Objects can represent elements of the computer-user environment such as windows, menus or graphics objects.

[0215] An object can represent an inventory, such as a personnel file or a table of the latitudes and longitudes of cities.

[0216] An object can represent user-defined data types such as time, angles, and complex numbers, or points on the plane.

[0217] With this enormous capability of an object to represent just about any logically separable matters, OOP allows the software developer to design and implement a computer program that is a model of some aspects of reality, whether that reality is a physical entity, a process, a system, or a composition of matter. Since the object can represent anything, the software developer can create an object which can be used as a component in a larger software project in the future.

[0218] If 90% of a new OOP software program consists of proven, existing components made from preexisting reusable objects, then only the remaining 10% of the new software project has to be written and tested from scratch. Since 90% already came from an inventory of extensively tested reusable objects, the potential domain from which an error could originate is 10% of the program. As a result, OOP enables software developers to build objects out of other, previously built objects.

[0219] This process closely resembles complex machinery being built out of assemblies and sub-assemblies. OOP technology, therefore, makes software engineering more like hardware engineering in that software is built from existing components, which are available to the developer as objects. All this adds up to an improved quality of the software as well as an increase in the speed of its development.

[0220] Programming languages are beginning to fully support the OOP principles, such as encapsulation, inheritance, polymorphism, and composition-relationship. With the advent of the C++ language, many commercial software developers have embraced OOP. C++ is an OOP language that offers a fast, machine-executable code. Furthermore, C++ is suitable for both commercial-application and systems-programming projects. For now, C++ appears to be the most popular choice among many OOP programmers, but there is a host of other OOP languages, such as Smalltalk, Common Lisp Object System (CLOS), and Eiffel. Additionally, OOP capabilities are being added to more traditional popular computer programming languages such as Pascal.

[0221] The benefits of object classes can be summarized, as follows:

[0222] Objects and their corresponding classes break down complex programming problems into many smaller, simpler problems.

[0223] Encapsulation enforces data abstraction through the organization of data into small, independent objects that can communicate with each other. Encapsulation protects the data in an object from accidental damage, but allows other objects to interact with that data by calling the object's member functions and structures.

[0224] Subclassing and inheritance make it possible to extend and modify objects through deriving new kinds of objects from the standard classes available in the system. Thus, new capabilities are created without having to start from scratch.

[0225] Polymorphism and multiple inheritance make it possible for different programmers to mix and match characteristics of many different classes and create specialized objects that can still work with related objects in predictable ways.

[0226] Class hierarchies and containment hierarchies provide a flexible mechanism for modeling real-world objects and the relationships among them.

[0227] Libraries of reusable classes are useful in many situations, but they also have some limitations. For example: Complexity. In a complex system, the class hierarchies for related classes can become extremely confusing, with many dozens or even hundreds of classes.

[0228] Flow of control. A program written with the aid of class libraries is still responsible for the flow of control (i.e., it must control the interactions among all the objects created from a particular library). The programmer has to decide which functions to call at what times for which kinds of objects.

[0229] Duplication of effort. Although class libraries allow programmers to use and reuse many small pieces of code, each programmer puts those pieces together in a different way. Two different programmers can use the same set of class libraries to write two programs that do exactly the same thing but whose internal structure (i.e., design) may be quite different, depending on hundreds of small decisions each programmer makes along the way. Inevitably, similar pieces of code end up doing similar things in slightly different ways and do not work as well together as they should.

[0230] Class libraries are very flexible. As programs grow more complex, more programmers are forced to reinvent basic solutions to basic problems over and over again. A relatively new extension of the class library concept is to have a framework of class libraries. This framework is more complex and consists of significant collections of collaborating classes that capture both the small scale patterns and major mechanisms that implement the common requirements and design in a specific application domain. They were first developed to free application programmers from the chores involved in displaying menus, windows, dialog boxes, and other standard user interface elements for personal computers.

[0231] Frameworks also represent a change in the way programmers think about the interaction between the code they write and code written by others. In the early days of procedural programming, the programmer called libraries provided by the operating system to perform certain tasks, but basically the program executed down the page from start to finish, and the programmer was solely responsible for the flow of control. This was appropriate for printing out paychecks, calculating a mathematical table, or solving other problems with a program that executed in just one way.

[0232] The development of graphical user interfaces began to turn this procedural programming arrangement inside out. These interfaces allow the user, rather than program logic, to drive the program and decide when certain actions should be performed. Today, most personal computer software accomplishes this by means of an event loop which monitors the mouse, keyboard, and other sources of external events and calls the appropriate parts of the programmer's code according to actions that the user performs. The programmer no longer determines the order in which events occur. Instead, a program is divided into separate pieces that are called at unpredictable times and in an unpredictable order. By relinquishing control in this way to users, the developer creates a program that is much easier to use. Nevertheless, individual pieces of the program written by the developer still call libraries provided by the operating system to accomplish certain tasks, and the programmer must still determine the flow of control within each piece after it's called by the event loop. Application code still “sits on top of” the system.

[0233] Even event loop programs require programmers to write a lot of code that should not need to be written separately for every application. The concept of an application framework carries the event loop concept further. Instead of dealing with all the nuts and bolts of constructing basic menus, windows, and dialog boxes and then making all these things work together, programmers using application frameworks start with working application code and basic user interface elements in place. Subsequently, they build from there by replacing some of the generic capabilities of the framework with the specific capabilities of the intended application.

[0234] Application frameworks reduce the total amount of code that a programmer has to write from scratch. However, because the framework is really a generic application that displays windows, supports copy and paste, and so on, the programmer can also relinquish control to a greater degree than event loop programs permit. The framework code takes care of almost all event handling and flow of control, and the programmer's code is called only when the framework needs it (e.g., to create or manipulate a proprietary data structure).

[0235] A programmer writing a framework program not only relinquishes control to the user (as is also true for event loop programs), but also relinquishes the detailed flow of control within the program to the framework. This approach allows the creation of more complex systems that work together in interesting ways, as opposed to isolated programs, having custom code, being created over and over again for similar problems.

[0236] Thus, as is explained above, a framework basically is a collection of cooperating classes that make up a reusable design solution for a given problem domain. It typically includes objects that provide default behavior (e.g., for menus and windows), and programmers use it by inheriting some of that default behavior and overriding other behavior so that the framework calls application code at the appropriate times.

[0237] There are three main differences between frameworks and class libraries:

[0238] Behavior versus protocol. Class libraries are essentially collections of behaviors that you can call when you want those individual behaviors in your program. A framework, on the other hand, provides not only behavior but also the protocol or set of rules that govern the ways in which behaviors can be combined, including rules for what a programmer is supposed to provide versus what the framework provides.

[0239] Call versus override. With a class library, the code the programmer instantiates objects and calls their member functions. It's possible to instantiate and call objects in the same way with a framework (i.e., to treat the framework as a class library), but to take full advantage of a framework's reusable design, a programmer typically writes code that overrides and is called by the framework. The framework manages the flow of control among its objects. Writing a program involves dividing responsibilities among the various pieces of software that are called by the framework rather than specifying how the different pieces should work together.

[0240] Implementation versus design. With class libraries, programmers reuse only implementations, whereas with frameworks, they reuse design. A framework embodies the way a family of related programs or pieces of software work. It represents a generic design solution that can be adapted to a variety of specific problems in a given domain. For example, a single framework can embody the way a user interface works, even though two different user interfaces created with the same framework might solve quite different interface problems.

[0241] Thus, through the development of frameworks for solutions to various problems and programming tasks, significant reductions in the design and development effort for software can be achieved. A preferred embodiment of the invention utilizes HyperText Markup Language (HTML) to implement documents on the Internet together with a general-purpose secure communication protocol for a transport medium between the client and a company. HTTP or other protocols could be readily substituted for HTML without undue experimentation. Information on these products is available in T. Bemers-Lee, D. Connoly, “RFC 1866: Hypertext Markup Language—2.0” (November 1995); and R. Fielding, H, Frystyk, T. Bemers-Lee, J. Gettys and J. C. Mogul, “Hypertext Transfer Protocol—HTTP/1.1: HTTP Working Group Internet Draft” (May 2, 1996). HTML is a simple data format used to create hypertext documents that are portable from one platform to another. HTML documents are SGML documents with generic semantics that are appropriate for representing information from a wide range of domains. HTML has been in use by the World-Wide Web global information initiative since 1990. HTML is an application of ISO Standard 8879; 1986 Information Processing Text and Office Systems; Standard Generalized Markup Language (SGML).

[0242] To date, Web development tools have been limited in their ability to create dynamic Web applications which span from client to server and interoperate with existing computing resources. Until recently, HTML has been the dominant technology used in development of Web-based solutions. However, HTML has proven to be inadequate in the following areas:

[0243] Poor performance;

[0244] Restricted user interface capabilities;

[0245] Can only produce static Web pages;

[0246] Lack of interoperability with existing applications and data; and

[0247] Inability to scale.

[0248] Sun Microsystem's Java language solves many of the client-side problems by:

[0249] Improving performance on the client side;

[0250] Enabling the creation of dynamic, real-time Web applications; and

[0251] Providing the ability to create a wide variety of user interface components.

[0252] With Java, developers can create robust User Interface (UI) components. Custom “widgets” (e.g., real-time stock tickers, animated icons, etc.) can be created, and client-side performance is improved. Unlike HTML, Java supports the notion of client-side validation, offloading appropriate processing onto the client for improved performance. Dynamic, real-time Web pages can be created. Using the above-mentioned custom UI components, dynamic Web pages can also be created.

[0253] Sun's Java language has emerged as an industry-recognized language for “programming the Internet.” Sun defines Java as “a simple, object-oriented, distributed, interpreted, robust, secure, architecture-neutral, portable, high-performance, multithreaded, dynamic, buzzword-compliant, general-purpose programming language. Java supports programming for the Internet in the form of platform-independent Java applets.” Java applets are small, specialized applications that comply with Sun's Java Application Programming Interface (API) allowing developers to add “interactive content” to Web documents (e.g., simple animations, page adornments, basic games, etc.). Applets execute within a Java-compatible browser (e.g., Netscape Navigator) by copying code from the server to client. From a language standpoint, Java's core feature set is based on C++. Sun's Java literature states that Java is basically, “C++ with extensions from Objective C for more dynamic method resolution.”

[0254] Another technology that provides similar function to JAVA is provided by Microsoft and ActiveX Technologies, to give developers and Web designers wherewithal to build dynamic content for the Internet and personal computers. ActiveX includes tools for developing animation, 3-D virtual reality, video and other multimedia content. The tools use Internet standards, work on multiple platforms, and are being supported by over 100 companies. The group's building blocks are called ActiveX Controls, which are fast components that enable developers to embed parts of software in hypertext markup language (HTML) pages. ActiveX Controls work with a variety of programming languages including Microsoft Visual C++, Borland Delphi, Microsoft Visual Basic programming system and, in the future, Microsoft's development tool for Java, code named “Jakarta.” ActiveX Technologies also includes ActiveX Server Framework, allowing developers to create server applications. One of ordinary skill in the art readily recognizes that ActiveX could be substituted for JAVA without undue experimentation to practice the invention.

[0255] Various aspects of ReTA will now be set forth under separate headings:

[0256] With reference to FIG. 1B, a codes table framework 140 is provided for maintaining application consistency by referencing text phrases through a short codes framework. First, in operation 142, a table of codes each having a text phrase associated therewith is provided. Such table of codes is stored on a local storage medium. Next, in operation 144, the table of codes is accessed on the local storage medium. One of the text phrases is subsequently retrieved by selecting a corresponding one of the codes of the table, as indicated in operation 146. During operation, modification of the text phrases associated with each of the codes of the table is permitted. See operation 148.

[0257] The modification may be carried out during a business logic execution. Further, various services may be provided such as retrieving a single one of the text phrases, retrieving all of the text phrases in response to a single command, updating a single code and text phrase combination, updating all of the code and text phrase combinations, naming the table, adding a new code and text phrase combination, removing one of the code and text phrase combinations, and/or adding another table.

[0258] Further, a name of the table may be stored upon retrieval of the text phrase. Further, a total number of code and text phrase combinations in the table may be determined and stored. In the case where a plurality of tables are provided, any number of the tables may be removed during operation. Additional information will be now be discussed relative to the various foregoing operations.

[0259] This portion of the present description details the ReTA Codes Table framework design from the perspective of the application developer. The purpose of a codes table is to maintain application consistency by referencing text phrases (to be displayed to the end user) through short codes. The code and text phrase (decode) are stored in a standard table format. The codes table component stores this table locally on the web server, thus reducing the overhead of accessing the database each time the application needs to translate a code.

[0260] Description

[0261] The role of this framework is to store frequently used code/decode sets on the web server and provide services that enable the application developer to retrieve the decode(s) associated with code(s). In addition, the framework provides services to enable the developer to modify the contents of the locally stored codes table during business logic execution.

[0262] Services

[0263] The Codes Table Framework provides the following services:

[0264] Components

[0265] The Codes Table Framework consist of the following COM objects:

[0266] These components are described in detailed in the following sub-sections.

[0267] AFRetrieval

[0268] The AFRetrieval component enables the application developer to load the specified codes table into local memory (for faster access) and retrieve the requested decode(s).

[0269] Methods

[0270] The IAFRetrieval interface defines the access to the AFRetrieval component. This interface supports the following methods:

[0271] AFMaintenance

[0272] The AFMaintenance component maintains the specified local codes table.

[0273] Methods

[0274] The IAFMaintenance interface defines the access to the AFMaintenance component. This interface supports the following methods:

[0275] FIG. 1C illustrates a method 150 for providing an interface between a first server and a second server with a proxy component situated therebetween. Initially, in operation 152, a request for a business object is identified by an application on the first server. The first server is connected to the second server in operation 153. In operation 154, selection criteria from the first server is transmitted to the second server. In response to the selection criteria, the first server receives a first recordset and a second recordset from the second server in operation 155. Business data is included in the first recordset and result codes are included in the second recordset. The first and second recordsets are mapped to the business object in operation 156 and, in operation 157, the business object is sent to the application on the first server.

[0276] The first and second recordsets may also be mapped to the business object using a utility conversion function. Additionally, the first and second recordsets may also be mapped to the business object using a utility conversion function. Optionally, the recordsets may be ActiveX data objects (ADO) recordsets.

[0277] The first server may also receive a third recordset from the second server in response to the selection criteria. This third recordset may include errors and references to an error table on the first server for allowing processing of the errors.

[0278] In a further embodiment of the present invention, changes to the proxy component may be prevented from affecting the application on the first server. Additionally, generation of a plurality of the proxy components by a user may be allowed. The following material provides a more detailed description of the above-described method.

[0279] This portion of the present description details the ReTA SAP framework design from the perspective of the application developer. The role of this framework is to provide designs and templates that describe how to integrate an Internet application with a SAP server. Unlike the other ReTA frameworks, this does not provide any code components for connecting to SAP, but uses the SAP/DCOM component connector created jointly by Microsoft and SAP. This portion of the present description provides a framework for the design of the architecture using the SAP DCOM connector components to integrate with SAP.

[0280] The DCOM Component Connector provides interoperability between R/3 objects and COM objects across a heterogeneous network through well-defined business interfaces. It provides the development tools for connecting with SAP to standard SAP BAPI's (Business Application Programmer Interface) as well as custom developed or modified BAPI's. The DCOM component connector can connect to SAP on Windows NT or UNIX. The Application server needs to be R/3 Version 2.1 or higher or R/2 with 50D.

[0281] The ReTA SAP framework uses an adapter layer design that places a wrapper around the DCOM component connector. The adapter layer improves developer productivity by managing some of the lower level tasks, and improves the flexibility of the final solution.

[0282] The remainder of this portion of the present description describes the Execution and Development Architectures for the SAP framework.

[0283] SAP Framework Execution Architecture

[0284] The DCOM Component connector uses COM proxy components that map to SAP Business Objects. There is one proxy component for each SAP business object. The SAP business objects can contain both the standard BAPI's (Business Application Programmer Interface) as well as custom developed or modified BAPI's. The SAP/DCOM component generation wizard connects to SAP, examines the SAP business object, and generates a proxy component with the same interface. The SAP/DCOM connector component can connect to SAP on Windows NT or UNIX. FIG. 1D shows the execution architecture for components that make up the SAP Framework Execution Architecture 160.

[0285] Referring again to FIG. 1D, the different layers in the SAP framework architecture are shown. The SAP/DCOM connector generated components 162 provide the actual connection to SAP 164. These components are generated from the SAP Business Application Programmer Interface (BAPI) 166,168. The BAPI's are either the standard SAP BAPI's, custom created BAPI's or Remote Function Calls.

[0286] The ReTA framework uses an Adapter layer to provide a thin wrapper on the SAP/DCOM connector components. The adapter layer provides the following benefits:

[0287] It insulates the application from changes in the SAP/DCOM connector components.

[0288] It provides utility functions for mapping the SAP/DCOM connector data types to the types required by the application.

[0289] It maps the SAP return error codes to the format required by the application.

[0290] The SAP/DCOM connector generated components use ADO (ActiveX Data Objects) recordsets to pass data to SAP. The adapter layer components map from these recordsets to the Business Objects or Business Data format used by the application. If a given method returns business data from SAP then this is in the form of an ADO recordset. If a method updates information in SAP then one must pass in an ADO recordset with all the data. To initialize this ADO recordset one calls a separate standard interface method of the proxy component. SAP returns business errors by returning a separate ADO recordset that references an error table.

[0291] The ReTA framework's adapter layer maps the ADO recordsets that the DCOM connector uses to the business objects or data objects used by the application. The adapter layer also maps the error table recordset returned by SAP to the error handling mechanism used by the application.

[0292] SAP Framework Development Architecture

[0293] SAP/DCOM Component Connector Generation

[0294] The SAP/DCOM connector portion of the present description gives a detailed description of how to generate a COM proxy component for a given SAP BAPI. The steps for creating a proxy component are:

[0295] Using the DCOM Component Connector browser based tool, create a destination entry for the SAP Application server.

[0296] Use the DCOM Connector wizard to connect to this destination.

[0297] Browse through the available SAP Business Objects on the remote SAP system.

[0298] Select a business object and click Generate Component DLL.

[0299] The DCOM Component connector may then generate C++ and IDL files, compile these files to create the proxy component and install this component in MTS.

[0300] SAP Adapter Component Design

[0301] This portion of the description describes the responsibility of the SAP adapter components and gives a template for a component.

[0302] The SAP Adapter components are responsible for:

[0303] Insulating the application from changes in the SAP BAPI.

[0304] Receiving business data from SAP

[0305] Updating business data in SAP

[0306] Mapping to/from the SAP returned data types

[0307] Mapping the SAP error return codes to the error handling mechanism used by the application.

[0308] There is a one to one mapping between the SAP Adapter components and the generated SAP/DCOM connector components.

[0309] SAP Adapter Component Template

[0310] This template gives an example of an SAP connector component with one method to receive business data and one method to send business data. It describes how to convert to/from the data types required by the SAP Connector component and how to manage the SAP return error codes.

[0311] Function GetSAPData(<in>selectionCriteria, <out> businessObject):integer

[0312] Create instance of the corresponding SAP connector component

[0313] Call corresponding SAP method passing in selectionCriteria.SAP may return an ADO Recordset with the business data and a second ADO Recordset with the Result codes.

[0314] Call an error utility function that maps the error return codes onto the applications error handling system.

[0315] Map the return recordset onto the businessObject (possibly using utility conversion function). Return the business object to the caller of the function.

[0316] Function SetSAPData(<in>businessObject):integer

[0317] Create instance of the corresponding SAP connector component

[0318] Call the SAP connector standard method DimAS to retrieve the recordset that may be populated from the businessObject.

[0319] Populate the recordset from the businessObject (possibly using utility conversion function).

[0320] Cal the corresponding SAP method passing in the recordset.

[0321] Call the error utility function that maps the error return codes onto the applications error handling system.

[0322] Gives an example of an adapter component that demonstrates retrieving and updating SAP data and handling the SAP error codes.

[0323] FIG. 1E illustrates a method for sharing context objects among a plurality of components executed on a transaction server. In operation 170, a first component is executed on a transaction server. A context object is then generated for the first component in operation 172 to control a scope of the execution of the first component. In operation 174, a call made by the first component is identified to execute a second component. The context object of the first component is utilized for controlling the scope of the execution of the second component in operation 176. Optionally, the first and second components may be service order item components.

[0324] The first component may be an activity component and the second component may be a business component. As an option, a plurality of activity components may be provided. As another option, a call made by the activity component may also be identified to execute a second business component with the context object of the activity component utilized for controlling the scope of the execution of the second business component. As a further option, a call made by the activity component may be identified to execute an error logging component with an additional context object separate from the context object of the activity component being utilized for controlling the scope of the execution of the error logging component. The following material provides a more detailed description of the above-described method.

[0325] This portion of the present description details the ReTA approach to performing “logical unit of work” database operations in the context of transactions. Applications developed with ReTA implement transactions through Microsoft Transaction Server (MTS). Within the MTS transaction context, ReTA applications group business components into transactions. The application developer designs each business component to define whether its actions should be performed within a transaction.

[0326] In addition, this portion of the present description details the MTS framework features and their implications on ReTA application design.

[0327] MTS Transactions: Application Design Implementation

[0328] Description

[0329] There are two main tasks the developer performs to design applications that use MTS to support transactions:

[0330] Code the application component to be MTS aware.

[0331] Use MTS services to group database operations into transactions.

[0332] Design MTS Aware Components

[0333] FIG. 2 illustrates a create component instances method 200. MTS controls the scope of transactions by using transaction context objects. Each transaction server component has an associated MTS context object 202, which controls the transaction context. If a component 204 needs to create instances of other components 206 during its processing, it uses the CreateInstance method of the MTS context object to create the new object. Calling this method ensures that the new component has an associated MTS context object 202 with the correct transaction scope.

[0334] Group Database Operations into MTS Transactions

[0335] The following portions of the present description include three database operations grouping scenarios that a ReTA application developer can implement through MTS.

[0336] Compose Work from Multiple Components in the Same Transaction

[0337] As illustrated in FIG. 3, in this scenario, the developer composes the work of a business activity 300 into a single transaction. Activity 300 uses business objects in components 302 and 304 to compete its work. Any database operations generated by either of these business components are completed in the context of a single transaction. To achieve this functionality, the developer uses the default transaction context scope that MTS provides. The developer sets the transaction attribute of the Activity component to Requires a transaction and the attribute of the business components to either Requires a transaction or Supports transactions. When the activity component initializes, MTS creates a corresponding context object 306. Subsequently, when the activity component initializes the business components, these business components share the same context object and are therefore committed in the same transaction.

[0338] When the Activity completes and the reference to the activity component is removed, the transaction is committed. If any of the database calls, fails or any of the components decides to abort the transaction, the transaction is aborted and all the database actions performed are rolled back.

[0339] Force a Component's Database Operations to Use a Separate Transaction

[0340] In this scenario, as illustrated in FIG. 4, the developer creates a component whose database operations are always carried out in a separate transaction. For example, an error logging component 402 should not use the transaction context of the component generating the error. This could cause the error logged to the database to be rolled back if an error occurs in a separate database operation. This scenario has an activity component 400, two business components 404,406 and an error logging component 402. If an error occurs in the activity, then an error message is sent to the error logging component (which logs the error in a database). The transaction of the activity is rolled back, however, the transaction of the error logging component is committed to the database.

[0341] In this scenario, the developer uses the default behavior of MTS. The error logging component is registered as Requires a new transaction. When the activity component initializes the error logging component, MTS creates a new transaction context for the component. If an error occurs in the activity, the database operations for the activity is rolled back, but any database operations that the error component generates is committed.

[0342] Compose Work from Multiple Activities in the Same Transaction

[0343] With reference to FIG. 5 (which illustrates the compose work form multiple activities in the same transaction); in this scenario, the developer creates two separate activities 500,502 whose work sometimes need to be composed into a single transaction. To achieve this functionality using MTS, the developer creates a third activity component 504 that calls the other two activities. The third activity component is registered as Requires a transaction. When this component initializes, MTS creates a new transaction context. When the activity 504 initializes the other two activities 500,502, they share the same transaction context 506 (and any objects they create also have the ability to share the transaction context).

[0344] MTS Features: Application Design Implications

[0345] Description

[0346] Note: A FinancialWorks Knowledge Exchange (kX) posting (Optimizing Performance) provided most of the content for this portion of the description.

[0347] This portion of the description provides insight on the following MTS features:

[0348] Connection Pooling

[0349] Stateless/Stateful objects

[0350] Package threading

[0351] Transactions

[0352] Just in Time activation

[0353] Object creation

[0354] Parameter Passing.

[0355] Connection Pooling

[0356] MTS and ODBC provide connection pooling. MTS/ODBC associates a connection pool with a specific user account. Therefore, it is important that all data access components have a pre-defined account to use when requesting database connections. In addition, connections are pooled only within the same process. This implies that every MTS package may have a pool of connections, as each MTS package runs in its own process.

[0357] Note that the ODBC connections are pooled, not the ADO connections. When the application code closes the ADO connection, the corresponding ODBC connection stays in the pool until a configurable timeout expires (cptimeout). The configurable timeout key is in the registry under “Hkey_Local_Machine\Software\ODBC\ODBCINST.INI\<driver name>\cptimeout” (with a default value of 60 seconds). Connection pooling can be turned off by setting this value to 0. In effect, connection pooling keeps more connections open with the database but saves the (expensive) overhead of re-creating the connection every time.

[0358] Note: Connection pooling is a feature of the ODBC resource manager. MTS automates the configuration of the ODBC resource to enable connection pooling.

[0359] Implications on Application Design

[0360] Create accounts for account packages. Group components under the appropriate credentials and packages. The Database server is a resource bottleneck. To improve performance, ensure high bandwidth connections exist between application and database servers.

[0361] Connection pooling provides performance improvement especially in the case where connections are used and released frequently such as Internet application.

[0362] Stateful and Stateless Objects

[0363] MTS supports the concept of a stateful object. However, the object must satisfy the following conditions:

[0364] 1) The object can not be transactional.

[0365] 2) Even if it is marked as non-transactional, it cannot participate in a transaction (i.e. cannot be called from a transactional object or call a transactional object). The reason is that MTS implements an activity concept. In the activity concept, all objects participating in a transaction (or LUW) are logically “grouped” together. Upon the completion of that transaction, SetComplete is called and all objects in that activity are freed. Thus, no object in the transaction holds context (state) on transaction completion.

[0366] 3) To enable a stateful object to participate in a transaction, partition the object into two parts: Stateful and Transactional. The Stateful part lives outside MTS and uses the TransactionContext object to manage manually (making explicit calls to start, commit and/or abort) the transaction inside MTS. To maintain transactional integrity, use the TransactionContext (as opposed to the ObjectContext) to create MTS objects. Therefore, the TransactionContext is passed inside MTS for later use of any MTS object instantiation. On the server, the code looks like the following: Set MtsObject=MtxTransactionContext.CreateInstance(“progid”)

[0367] Implication on Application Design

[0368] In general, be deliberate with MTS and state. When working with MTS components, it is recommended to keep the context(state) on the client and have the server components be service driven. These components are instantiated to provide a service and then are freed.

[0369] Package Threading

[0370] Every time a package receives a method call, MTS creates a new thread to service the request. At the time of writing this portion of the present description, MTS packages have a maximum limit of 100 threads per package. If the number of the incoming concurrent calls exceeds 100, MTS serializes all excess calls. Project testing (a FinacialWorks project) proved that performance degraded significantly after reaching the 100 concurrent threads mark.

[0371] Implication on Application Design

[0372] Due to this limitation, package the application DLLs in a way to minimize thread contention. For future releases of MTS, Microsoft claims the limit for concurrent calls may increase to 1000.

[0373] Activities

[0374] MTS defines an activity as set of objects acting on behalf of a client's request. Every MTS object belongs to one activity. The activity ID is recorded in the context of the object. The objects in an activity consist of the object created by a base client and any subsequent object created by it and all of its descendants. Objects in an activity can be distributed across several processes (and machines).

[0375] Whenever a base client creates an MTS object, a new activity is created. When a MTS object is created from an existing context, the new object becomes part of the same activity. The object's context inherits the activity identifier of the creating context.

[0376] Implication on Application Design

[0377] Activities define a single logical thread of execution. When a base client calls into an activity, all subsequent requests from other clients are blocked until control is returned to the original caller.

[0378] Automatic Transaction Control

[0379] MTS initiates a transaction when a method on a transactional component is called. MTS records the transaction ID in the component's object context. This transaction ID is passed to other MTS components' context objects requiring participation in the same transaction.

[0380] MTS operates with an optimistic assumption that the transaction is going to succeed. If the component never calls SetAbort, SetComplete, DisableCommit, or EnableCommit, the transaction commits when the client releases its last reference to the MTS component.

[0381] If the component calls SetComplete, the transaction commits as soon as the method call returns to the client. When the component calls SetAbort the transaction aborts as soon as the method call returns to the client.

[0382] If the component calls DisableCommit, the transaction aborts when the client releases its last reference to the component. If the component calls EnableCommit, the transaction commits when the client releases its last reference to the component.

[0383] Implications on Application Design

[0384] When designing the transaction timeout, consider the potential for slow system and network response times. The application design should avoid long running transactions and attempt to break them into smaller ones.

[0385] Note

[0386] There is no explicit Commit method. If no objects have aborted the transaction by calling SetAbort or disabled commitment by calling DisableCommit, MTS may automatically commit the transaction when the client releases its object references.

[0387] Manual Transaction Control

[0388] Transactions can also be manually controlled from a base client by using the transaction context to start and commit/abort a transaction. This is particularly useful in the case where a stateful base client activates an MTS-managed transactional object to carry out a distributed transaction. In order to achieve that, MTS uses the Transaction Context created by the base client.

[0389] Just-In-Time Activation

[0390] For every business object created, MTS intercepts the call and creates a sibling object called the Object Context. It is the object context that may manage the transaction and the business object activation/deactivation.

[0391] One of the interface methods on the context object is SetComplete. When SetComplete is called, the transaction (if any) is signaled as ready to be committed and the instance of the business object is destroyed releasing all resources used by it. The next time the client issues a method call, MTS creates a new instance of the business object and delegates the call to it (this is assuming that the client did not release its original reference to the MTS-supplied context wrapper). In the MTS world, this is known as JIT activation.

[0392] The following method call trace illustrates JIT activation:

[0393] The client application starts, and the client requests an instance of the CustomerInterface of the Customer component.

[0394] Set objICustomer=CreateObject(“CustomerComponent.CustomerInterface”).

[0395] COM searches the Running Object Table to determine whether an instance of the component is active on the client.

[0396] If not, COM searches the Registry for the information describing CustomerInterface and invokes the creation of the interface.

[0397] MTS 600 intercepts the Customer creation request 602, starts a process for the Customer package containing Customer component 604, creates the ContextObject 606 and returns a reference to the client. See FIG. 6.

[0398] The client application requests an operation on the CustomerInterface.

[0399] MTS invokes the operation and commits the transaction (if any) by calling Setcomplete.

[0400] MTS 700 deactivates the component, freeing the thread, the memory and returns the result to the client. FIG. 7 shows that the customer object 702 has been deactivated (the customer object is grayed out).

[0401] To take advantage of JIT activation, the clients do not release the reference to the MTS-supplied context wrapper (the client code does not set objICustomer=null). When the client requests a new operation, the Context wrapper creates a new instance of the Customer component and delegates the incoming call to it. By keeping the reference to the context wrapper, MTS does not need to recreate the object.

[0402] Implications on Application Design

[0403] To take advantage of JIT activation, client applications acquire references to the server components as early as possible and uses them as needed. It would be ideal to obtain references at application startup, but this has the drawback of not being reliable. If for some reason the references were lost, this may result in run time errors.

[0404] Object Creation: New vs. CreateObject vs. CreateInstance

[0405] This portion of the description describes the appropriate usage of the different types of object creation methods.

[0406] New

[0407] The keyword “New” creates an object with private instantiation property. It is used with early binding.

[0408] CreateObject

[0409] Normally used with late binding and used to create objects with public instantiation property. If other MTS object are instantiated using CreateObject (on the server), they run the risk of running in the wrong context. CreateObject can be used from the client to instantiate any MTS object.

[0410] CreateInstance

[0411] It is the interface method of the context object used to instantiate other MTS objects. This is the only way to guarantee the newly created object participates in the same current transaction. When MTS instantiates a transaction, it records the transaction ID in the component's object context. This transaction ID is passed to other MTS components only when CreateInstance is used to create these objects.

[0412] Implication on Application Design

[0413] When CreateObject is used, Java/VB uses COM to create an instance of the object. If the Object is registered in MTS, MTS loads the DLL and creates a new instance passing back a MTS-managed handle to the object. The object gets a new MTS context.

[0414] When New is used in Java/VB, the action depends on where the object being created lives. If it is in a different DLL, COM is used and the mechanism is the same as CreateObject. If it is in the same DLL Java/VB creates the instance internally and may not create a new MTS-managed object, whereas CreateObject may. Private classes can only be created using New since they are not exposed to COM.

[0415] When one MTS object creates another MTS object, the new object gets a new context. If CreateObject (or New for an object in a different DLL) is used, the contexts are independent of each other. If a transaction is involved, the new context manages a completely different transaction from the original. If CreateInstance is used, the new object's context shares the same transaction as the invoking one.

[0416] Using New is only a problem in the following scenario. The application contains one DLL that contains more than one MTS-managed class. The application wants an instance of one of these classes to create an instance of the other (in separate contexts). New may not do this, whereas CreateObject and CreateInstance may. However, CreateInstance is required if they are to run under the same transaction.

[0417] Parameter Passing

[0418] If Visual Basic is the language of choice, make sure to pass parameters by value (as the default in VB is by reference). This may help reduce network trips and hence improves performance.

[0419] If one is passing the collection object in MTS, make sure to use the Microsoft provided wrapper collection object. The standard VB collection object is known to cause errors when running under MTS. It is better to use a variant array instead of collection to pass information around. It is more robust and performs better.

[0420] As parameters, MTS registered business objects are passed by reference as they use standard marshalling

[0421] When working with MTS objects, ensure that object references are exchanged through the return from an object creation interface such ITransactionContext.CreateInstance or IObjectContext.CreateInstance. This allows MTS to manage context switches and Object lifetime.

[0422] Data Access and Locking Policy

[0423] Database Locking should be in place to ensure the integrity of the database in a multi-user environment. Locking prevents the common problem of lost updates from multiple users updating the same record. The optimistic approach of record locking is based on the assumption that it is rarely the case for multiple users to read and update the same records concurrently. Such a situation is treated as exceptional processing rather than normal. Optimistic locking does not place any locks at read time; locks are actually placed at update time. A time stamp mechanism should be provided to ensure that at update or delete times the record has not changed since the last time it is read. It is recommended to use optimistic locking with ADO and MTS to improve performance. If the data access mechanism uses ADO disconnected RecordSets, then the only possible locking policy is optimistic.

[0424] Implication on Application Design

[0425] If one is using optimistic locking and ADO, it is recommended that one uses disconnected recordsets to marshal data. Project experience (FinancialWorks project) shows that the application should avoid using the ADO RecordSet.GetRows method, as it significantly slows performance.

[0426] Data Marshaling

[0427] Use disconnected Recordsets. This may ensure high performance result when marshaling data across a network. Client applications have to reference an ADOR.Recrodset, which is a lighter version of the ADODB.Recordset designed specifically for client's use. With disconnected Recordsets only optimistic locking can be employed.

[0428] If the marshalling of data from client to server is done by collection, beware to use the wrapper collection provided on the MTS site. MTS may not work correctly when passing the VB standard collection object. It is known to cause runtime errors.

[0429] FIG. 8A illustrates a method for providing an activity framework. First, in operation 800 a plurality of sub-activities are created which each include sub-activity logic adapted to generate an output based on an input received from a user upon execution. In operation 802, a plurality of activities are defined, each of which execute the sub-activities in a unique manner upon being selected for accomplishing a goal associated with the activity. Selection of one of the activities is allowed in operation 804 by receiving user indicia. In operation 806, an interface is depicted for allowing receipt of the input and display of the output during execution of the sub-activities associated with the selected activity.

[0430] The sub-activity logic may be adapted for verifying that all required input has been received prior to generating the output. Access to the input received from the user by each of the sub-activities of the activities may also be allowed.

[0431] Optionally, the activity may include creating a service order. Further, the sub-activities each may additionally include at least one business component.

[0432] The interface may include a plurality of displays that are each displayed during the execution of a corresponding one of the sub-activities. The following material provides a more detailed description of the above-described method.

[0433] This portion of the present description details the ReTA Activity framework design from the perspective of the application developer. The primary role of this framework is to provide services that support the “model view controller” (MVC) design pattern. In this pattern, the application implements a “separation of concern” among the user interface (view), logical unit of work (controller) and business components (model). Separating the user interface from the business logic increases reuse of the interface and the business component. In this design pattern, different types of interfaces can reuse the same model and the same interface can view different models. Another goal of separating presentation and storage responsibilities is to reduce the impact of change. For example, changing the user interface design should only impact the user interface components and not the business logic. Through modeling the “separation of concern” pattern, the ReTA Activity framework increases application maintainability and flexibility. It also encourages “best practice” coding standards.

[0434] Activity Framework

[0435] Description

[0436] See FIG. 8B, which illustrates the MTS runtime environment 830. The ReTA Activity framework distributes the application development responsibilities as follows:

[0437] Web page (Active Server Page) (View/Controller) The application's web page logic 832 starts the activity 834, executes the sub-activity and creates the user interfaces. No business logic is contained directly in the web page code. The application developer leverages the ReTA Session, ReTA Activity and the ReTA UI frameworks from the web page code.

[0438] Activity Components (Controller) The application's activity logic implements the business process logic (functional control logic) 836. Activities support high-level processes that are not the responsibility of any individual business components. This includes high-level steps related to a user's “logical unit of work” or business function. Thus, activities enable multiple web pages to implement a “logical unit of work”. An example of an activity implementing a “logical unit of work” with multiple web pages is “Create Service Order”. In this example activity, the user selects a service to order on the first page, enters the customer information on the second page, reviews and submits the order on the third page and receives an order confirmation on the fourth page.

[0439] Business Components: (Model) Business components 837 implement the application's business entity logic. These components represent individual business entities (such as customer or account). Each entity encapsulates its own data and behavior acting on that data. Note: The Activity implements business logic that spans multiple business components.

[0440] The ReTA Activity framework consists of the following three main components:

[0441] Activity

[0442] An activity 834 encompasses a combination of web pages, which fulfill a business function. The activity has the following responsibilities:

[0443] Provide a “logical unit of work” context to all sub-activities within the activity. The Activity framework uses Microsoft Transaction Server (MTS) transactions to implement the “logical unit of work” concept. On the completion of a transaction (whether successful or abort), MTS ensures that each sub-activity may be in a consistent state (either completed or rolled back).

[0444] Check that requested information and conditions are fulfilled before executing logic.

[0445] Maintain information shared between the pages of the activity.

[0446] Create, trigger and manage sub-activities.

[0447] Check page access authorization, when browsing through activity pages.

[0448] Release all maintained information when closed.

[0449] Execute post-conditions when closed. Examples of post conditions are releasing resources tied up for the activity or removing pessimistic locks on tables.

[0450] Commit or abort all opened sub-activities.

[0451] The activity (by itself) does not contain any business logic. Sub-activities (and their associated business components) provide the business logic. Thus, the activity maintains a context and provides a “logical unit of work” for a specific business functionality.

[0452] Sub-activity

[0453] A sub-activity 838 executes a sub-part of the overall activity business logic. The sub-activity represents the smallest grained business logic. For example in a “Create Service Order” activity, one sub-activity retrieves all the service types information to display on the first web page. A sub-activity has the following responsibilities:

[0454] Check pre-conditions. Ensure requested information and conditions are fulfilled before executing business logic.

[0455] Execute business logic

[0456] Execute post-conditions.

[0457] View

[0458] A view 840 defines the mapping between a user interface and business components containing the values to display. The view has the following responsibilities:

[0459] Unplugging the user interface from the business component values.

[0460] Automatically and transparent to the developer, capture all the values entered by the user and update the related business components.

[0461] Display the business component values attached to the user interface.

[0462] Trigger a sub-activity when capturing values.

[0463] Note: The Activity component maintains a separate view for each web page defined to be part of the activity.

[0464] Note

[0465] The ReTA Activity framework fully supports business activity components written in Java or Visual Basic. In addition, the Activity framework provides partial support for business activity components written C++. For C++ components, the application developer must implement the services provided by the Activity utility classes AFView and AFViewBOMapping.

[0466] Services

[0467] The Activity Framework provides the following services:

[0468] Components and Classes

[0469] The Activity Framework implements these services through the following COM and Class objects:

[0470] These components and classes are described in detailed in the following sub-portions of the description.

[0471] AFActivity

[0472] The AFActivity component provides the structure for implementing business logic, state management among web pages, management of views and sub-activities, and transactional support for carrying out a “logical unit of work”. The application developer creates an activity component for each specific business activity by extending the AFActivity component.

[0473] The activity component shares the services provided within the Activity framework allowing the application developer to concentrate on the business logic. Application business logic is organized into three separate areas within an activity: pre-conditions, execution, and post conditions.

[0474] Methods

[0475] The IAFActivity, IAFContext and IAFEventListener interfaces define the access to the AFActivity component. These interfaces support the following methods:

[0476] Abstract Methods

[0477] The application developer implements the following abstract methods in the business activity component:

[0478] AFSubActivity

[0479] The AFSubActivity component implements a sub-part of the overall activity business logic. The application developer creates a sub-activity component for each sub-part of a specific business activity by extended the AFSubActivity component.

[0480] As with activities, the sub-activity workflow sequence is pre-condition, execution and post-condition.

[0481] Note

[0482] There may be zero or more sub-activities on an ASP Page.

[0483] Methods

[0484] The IAFSubActivity interface defines the access to the AFSubActivity component. This interface supports the following methods:

[0485] Abstract Methods

[0486] The application developer implements the following abstract methods in the business sub-activity component:

[0487] AFCollection

[0488] The AFCollection component is a general purpose collection component. The collection component can be used to store and retrieve a collection of COM components, integers or strings.

[0489] Methods

[0490] The IAFCollection interface defines the access to the AFCollection component. This interface supports the following methods:

[0491] AFVBActivityWrapper

[0492] The AFVBActivityWrapper component enables the application developer to add Activities that are written in Visual Basic.

[0493] Methods

[0494] The IAFActivity, IAFContext, IAFEventListener and IAFVBActivityWrapper interfaces define the access to the AFVBActivityWrapper component. These interfaces support the following methods:

[0495] IAFVBActivity Interface Methods

[0496] The application developer implements the following interface methods in the VB business activity component:

[0497] AFView (AFVBView)

[0498] The AFView class provides a mapping between a User Interface and a set of Business Components (the view maps one web page form to one or more business components). When the user requests the next web page, the previous web page values are passed along with the URL request. Upon starting the next web page, the Session framework invokes the receiveEvent method on the appropriate Activity component. The Activity component uses the View class to record, into the appropriate business component, the data entered by the user at the previous web page. Also, the View class obtains the current user interface field values for the next web page as requested by the application developer through ASP scripting logic.

[0499] Note

[0500] Multiple views can exist for a single ASP. Since a view contains a collection of mapped field, one view can be defined for each form of an ASP.

[0501] Methods

[0502] The following AFView class methods are important for the application developer to understand:

[0503] AFViewBOMapping (AFVBViewBOMapping)

[0504] The AFViewBOMapping component defines the mapping between a user interface entry field and the business component instances containing the value to display.

[0505] This class gets/sets an U field value by getting/setting the business component instance contained in the activity context. Each mapped business component instance should implement the IAFEditable interface. This interface provides the setValue and getValue methods used to set and get values of the business component instance.

[0506] Methods

[0507] The following AFViewBOMapping class methods are important for the application developer to understand:

[0508] AFViewRadioButtonBOMapping (AFVBViewRadioButtonBOMapping)

[0509] The AFViewRadioButtonBOMapping component defines the mapping between a user interface radio button field and the business component instances containing the value to display. This class gets/sets an UI field value by getting/setting the business component instance contained in the activity context. Each mapped business component instance should implement the IAFEditable interface. This interface provides the setValue and getValue methods used to set and get values of the business component instance.

[0510] Methods

[0511] The following AFViewRadioButtonBOMapping class methods are important for the application developer to understand:

[0512] AFViewDynamicBOMapping (AFVBViewDynamicBOMapping)

[0513] The AFViewDynamicBOMapping component defines the mapping between a dynamically created user interface field and the business component instances containing the value to display. This class gets/sets an UI field value by getting/setting the business component instance contained in the activity context. Each mapped business component instance should implement the IAFEditable interface. This interface provides the setValue and getValue methods used to set and get values of the business component instance.

[0514] Methods

[0515] The following AFViewDynamicBOMapping class methods are important for the application developer to understand:

[0516] AFViewTextAreaBOMapping (AFVBViewTextAreaBOMapping)

[0517] The AFViewTextAreaBOMapping component defines the mapping between a user interface multi-line entry field and the business component instances containing the value to display. This class gets/sets an UI field value by getting/setting the business component instance contained in the activity context. Each mapped business component instance should implement the IAFEditable interface. This interface provides the setValue and getValue methods used to set and get values of the business component instance.

[0518] Methods

[0519] The following AFViewTextAreaBOMapping class methods are important for the application developer to understand:

[0520] AFViewDropDownBOMapping (AFVBViewDropDownBOMapping)

[0521] The AFViewDropDownBOMapping component defines the mapping between a user interface drop down field and the business component instances containing the value to display. This class gets/sets an UI field value by getting/setting the business component instance contained in the activity context. Each mapped business component instance should implement the IAFEditable interface. This interface provides the setValue and getValue methods used to set and get values of the business component instance.

[0522] Methods

[0523] The following AFViewDropDownBOMapping class methods are important for the application developer to understand:

[0524] AFViewUIListBOMapping (AFVBViewUIListBOMapping)

[0525] The AFViewUIListBOMapping component defines the mapping between a user interface Selected List field and the AFCollection component instance containing the values to display. This class gets/sets an UI field value by getting/setting the AFCollection component instance contained in the activity context.

[0526] Methods

[0527] The following AFViewSelectedListBOMapping class methods are important for the application developer to understand:

[0528] AFViewThumbNailBOMapping (AFVBViewThumbNailBOMapping)

[0529] The AFViewThumbNailBOMapping component defines the mapping between a user interface ThumbNail (iconic pushbutton) field and the business component instances containing the value to display. This class gets/sets an UI field value by getting/setting the business component instance contained in the activity context. Each mapped business component instance should implement the IAFEditable interface. This interface provides the setValue and getValue methods used to set and get values of the business component instance.

[0530] Methods

[0531] The following AFViewThumbNailBOMapping class methods are important for the application developer to understand:

[0532] FIG. 9A illustrates a method 900 for accessing services within a server without a need for knowledge of an application program interface of the server. A role container is first created in operation 902. In operation 904, a role class is defined and in operation 906 an attribute for the role class is generated which includes a default start page attribute. In the role container, a role object is made in the role class with the default start page attribute associated therewith in operation 908. A uniform resource locator is selected in operation 910 for the default start page attribute.

[0533] A plurality of attributes may be generated for the role container. Further, these attributes may include a default start page attribute, a user name attribute, a user identifier attribute, and/or a role name attribute.

[0534] A user may be assigned to the role object. Optionally, a plurality of role objects may be made in the role class with each role object having a unique default start page associated therewith. As another option, an operator role object and a customer role object may be made as well. The following material provides a more detailed description of the above-described method.

[0535] This portion of the present description details the ReTA Site Server framework design from the perspective of the application developer. The role of this framework is to provide components that allow one to integrate the ReTA custom frameworks with Site Server. This provides a user component connecting to Site Server, but does not require knowledge of the Site Server API itself to integrate with Site Server.

[0536] Site Server Framework Execution Architecture

[0537] To connect to Site Server a COM component (UserSS) is used to make calls to Site Server's API. The ReTA UserSS component allows the developer to access Site Server's Personalization and Membership Services without any knowledge of Site Server's API.

[0538] FIG. 9B illustrates Site Server Framework Architecture. This figure shows the different layers in the Site Server framework architecture. The UserSS COM component 930 connects to Site Server 932. The UserSS component uses Site Server's Personalization and Membership; UserSS also performs security as well on a Commerce Site. The ReTA framework 934 the UserSS layer to provide access to Site Server. The UserSS layer provides the following benefits:

[0539] It insulates the application developer from Site Server's API.

[0540] It provides functionality for using Site Server's Personalization and Membership Services.

[0541] Site Server Framework Development Architecture

[0542] UserSS Interface Methods

[0543] The UserSS component interfaces with the SiteServer personalization and membership services. This component uses SiteServer to handle the user security, role and preferences.

[0544] Methods

[0545] The IAFUser, IAFUserPreferences, and IAFUserRole interfaces define the access to the AFUserSS component. These interfaces support the following methods:

[0546] Site Server Personalization and Membership/Directory Membership Manager

[0547] This portion of the description describes the required settings in Site Server Commerce Edition used by the ReTA frameworks. This portion of the description also describes the steps involved in creating the required settings.

[0548] ReTA Required Settings

[0549] The Membership Directory Manager is used to manage administration and access control for Membership Directory objects, including users and groups, and schema objects. The Membership Directory stores objects used by all Site Server features.

[0550] The ReTA UserSS framework requires schema objects to be created. The schema objects required by the ReTA Frameworks are: Roles container 1000, RoleName attribute 1002, username attribute 1004, webUserId attribute, and a Role class. FIG. 10 illustrates schema attributes and classes, with class “Role” and attribute “RoleName” shown.

[0551] Required Container, Class, and Attribute Setup Instructions

[0552] Users may have different roles within the system. In Site Server ReTA takes advantage of this by creating a Container “Roles” that contains different “Roles” or different objects of the class “Role”. These “Roles” have attributes such as a default start page. Therefore different “Roles” (different objects of the class “Role”) such as “Operator” or “Customer” may both have a default start page attribute that may point to different URL's.

[0553] The Site Server portion of the present description details how to setup a Container, Class, and Attributes. The following lists the steps involved to setup the required attributes for the ReTA Frameworks to integrate with Site Server.

[0554] Using the Site Server Console, Right Click on the Membership Directory Manager Folder.

[0555] Select New—Container, then type in Roles for the Container name.

[0556] FIG. 11 illustrates the creating of Container “Roles”. Right click on Membership Directory Manager 1100 and select New 1102—Container 1104. After creating the Container “Roles”, create the attribute “DefaultStartPage”, “username”, webUserId”, and “RoleName” in the Schema. To create these attributes expand the Admin Container under the Membership Directory Manager.

[0557] Right click on the Schema folder 1200 and select New 1202—Attribute 1204 (See FIG. 12)

[0558] Define the class “Role” the same way by right clicking on Schema and selecting New—Class.

[0559] Select the “common-name” as a required attribute, also select the “DefaultStartPage” as an attribute but do not make it required.

[0560] Create the Roles for our Application, “Operator” and “Customer”.

[0561] See FIG. 13, which illustrates the adding of different Roles. Right click the Roles Container 1300 under the Membership Directory Manager folder 1302. Select New 1304—Object 1306, select “Role” for the class of object to create, type the name of the object i.e. “Operator”, add the attribute “DefaultStartPage” by clicking Add Attribute button and enter the URL.

[0562] Once these have been created, a member of the system can be assigned to a “Role” and the ReTA Framework required attributes can be added to the user. FIG. 14 illustrates an example showing the attributes 1400 of member “Joe Bloggs” (Note RoleName).

[0563] FIG. 15A illustrates a method 1500 for handling events in a system. In operation 1502, an event which includes metadata is recognized. Next, in operation 1504, the metadata of the event is read and, in operation 1506 a table look-up is performed for information relating to the event based on the metadata. The information includes a severity of the event and further information such as a type of the event, and a location where the event occurred. In operation 1508, a message is displayed either in-line in a currently depicted display or in a separate display based on the severity of the event.

[0564] Optionally, the event may additionally be indicated to components of the system other than the component in which the event occurred. The type of the event may be a database error, an architecture error, a security error, and/or an application error. Further the location of the event may be at least one of a method and an object where the event occurred. Also, the information may further relate to a code associated with the event.

[0565] The message may include the information relating to the event. In additionally, the message may also include a time during which the event occurred. Further, the message may include a string altered based on a user profile. The following material provides a more detailed description of the above-described method.

[0566] This portion of the present description details the ReTA Event Handler framework design from the perspective of the application developer. The role of this framework is to provide services to manage the informational, warning and error events that an application may raise. These services include:

[0567] Presenting the user with an understandable event explanation.

[0568] Informing other Components when errors happen (for example to restore transactional data to a consistent state) using a Publish/Subscribe mechanism.

[0569] Logging informational, warning and error event messages.

[0570] The Event Handler uses an Event Reference meta-data database table to maintain information about the types of events in an application and the policy for dealing with them. This gives a flexible approach and the event messages, the severity and other policies for the events can be changed during operations.

[0571] Phase 2—Event Handler Enhancements

[0572] For phase 2, Event Handler consists of the following enhancements:

[0573] The Event Handler framework is componentized. It no longer maintains references to any of the other framework components. Internally, the Event Handler continues to use the persistence light framework to log events to the database.

[0574] As in phase 1, it can be used as a Session level component. As an enhancement for phase 2, the Event Handler framework can be used as a stateless page level component. This means that a new instance of the component is created at the beginning of each ASP page and is released at the end of each page.

[0575] The Event Handler framework no longer requires Event Collection components as parameters to implement event handling, which only allowed handling events at the page level. In phase 2, the new method “processSingleEvent” takes the parameters of a single event as its input, which enables handling events at the occurrence of the event.

[0576] As in phase 1, The Event Handler can format error descriptions in HTML. As an enhancement for phase 2, the Event Handler can return the error message as a string and enables the application to implement client specific formatting (HTML or other).

[0577] The process event method no longer calls the ASP redirect method. Instead, it returns the severity level code. On return, the application logic determines whether to redirect to the error page or display the error in-line in the current page.

[0578] The Translator is no longer a separate component. Instead, it is a Java class inside the Event Handler component.

[0579] Event Handler Framework

[0580] Description

[0581] With reference to FIG. 15B, the ReTA Event Handler Framework 1530 manages the informational, warning and error events that an application raises. The following describes the ReTA event handling sequence:

[0582] 1) The event(s) occurs

[0583] When an event occurs the following event information is recorded:

[0584] event type (defined in database Event Reference table), for example:

[0585] database error

[0586] security error

[0587] architecture error

[0588] application error

[0589] event location:

[0590] method and object name where the event occurred

[0591] event code (sub-type).

[0592] SQL error code,

[0593] application error code—mapped to a unique description in the database

[0594] architecture error code—mapped to a unique description in the database

[0595] event context:

[0596] Any relevant information about when the event occurred stored in a tagged

[0597] name value pair format. Eg. [OrderNumber=1][Description=“Repeat Order”]

[0598] If the event occurs within a Java class inside a COM object, use the Java exception mechanism by throwing an AFEventException. If the exception occurs elsewhere, call the add method on the Event Collection passing the event information.

[0599] Each method defining a COM component interface captures these event exceptions and either adds them to an Event Collection component or directly calls a method on the Event Handler component.

[0600] Events are processed from the ASP page by calling the process method of the Event Handler. Events can also processed from the point where the event occurred by calling the “processSingleEvent” method of the Event Handler.

[0601] 2) The Event Handler processes the event(s):

[0602] For each event, set the user id and current page

[0603] For each event, retrieve the event severity from the event handler's “translator” class. This class caches in memory all event descriptions and severity levels retrieved from the event reference database table.

[0604] Add the events to the Event Handler context.

[0605] Implement the persistence policy on the events—events are logged in a batch.

[0606] Return the severity of the most severe event to the caller. The caller is responsible for either redirecting to the error page or displaying the event in-line in the Current Page.

[0607] 3) Display the event:

[0608] Use the Event Handler component to generate the error message. This message can contain context information describing when the event was created.

[0609] Create the HTML formatting and display the event message.

[0610] The Error Message is either displayed in-line in the current page or in a separate error page.

[0611] 4) The Event Handler generates error display message:

[0612] Get the event with the highest severity level from its event context.

[0613] If the most severe event is “fatal”, display the user description associated with the event. Broadcast a SESSION_ABORT message using the Publish/Subscribe mechanism. Any component that is interested in these events must implement the IAFEventListener interface and register with the Event Broadcaster component as interested. To do this they call the addListener method of the Event Handler component.

[0614] If the most severe event is “logical unit of work”, display the user description associated with the event. Broadcast an ACTIVITY_ABORT message using the Publish/Subscribe mechanism.

[0615] If the most severe event is “warning”, display the user description associated with the event.

[0616] Note: The user event descriptions are retrieved from the database either on session start or on demand and are cached by the Translator class. When generating the event description page, this description is requested from the Translator. Event descriptions can have embedded context parameters. When generating the event description page, the event handler replaces these parameters with their values specified when creating the event.

[0617] Database Tables

[0618] The Event Handler uses two database tables: The T_AF_EventReference 1534 is a static table that describes the Event meta-data, giving the policies for each event type. The policies include:

[0619] The message that is displayed to the user. These messages can contain data from the Context that is included when the event is generated.

[0620] The severity of the event. The severity can be Information, Warning, Error and Fatal.

[0621] Whether to persist the event in the database event log.

[0622] The T_AF_EventLog 1536 contains the log of the events that occurred. The following information is logged:

[0623] Event type and Code

[0624] The location where the event occurred. I.e. ASP, Object name and Method Name.

[0625] The user that raised the event.

[0626] The datestamp.

[0627] The context information giving other information about what caused the event.

[0628] Services

[0629] The Event Handler Framework provides the following services:

[0630] Components and Classes

[0631] The Event Handler Framework implements these services through the following COM and Class objects:

[0632] These components and classes are described in detailed in the following sub-portions of the description.

[0633] AFEventHandler

[0634] The AFEventHandler component 1538 handles the events generated by the system. Depending on the severity level, the event handler may redirect the user to another ASP page and may abort the activity or session. The event handler also determines whether and when to log an event.

[0635] Methods

[0636] The IAFEventHandler interface defines the access to the AFEventHandler component. This interface supports the following methods:

[0637] AFEventCollection

[0638] The AFEventCollection component contains a collection of events.

[0639] Methods

[0640] The IAFEventCollection interface defines the access to the AFEventCollection component. This interface supports the following methods:

[0641] AFResult

[0642] The AFResult component defines the result return by a method execution.

[0643] Methods

[0644] The IAFResult interface defines the access to the AFResult component. This interface supports the following methods:

[0645] AFTranslator

[0646] The AFTranslator class returns event reference information (based on the event type and event code.

[0647] Methods

[0648] The AFTranslator class has the following methods:

[0649] AFEventException

[0650] The AFEventException class contains the event exception information and is added to the AFEventCollection component for processing by the AFEventHandler component.

[0651] Methods

[0652] The following AFEventException class methods are important for the application developer to understand:

[0653] AFEventReference

[0654] The AFEventReference component 1540 contains the event reference information that is defined by the application through database table T_AF_EventReference. The architecture reads the event reference data into memory on session start.

[0655] T_AF_EventReference:

[0656] AFPersistableEvent

[0657] The AFPersistableEvent 1542 contains the event information captured during the application execution that is persisted to the database table T_AF_EVENTLOG.

[0658] T_AF_EVENTLOG:

[0659] FIG. 16A depicts a method 1600 for managing user information. A site server is provided in operation 1602. The side server has information stored on it including preferences, roles, and details relating to users. A database separate from the site server is provided in operation 1604. The database has information stored thereon including preferences, roles, and details relating to the users. In operation 1606, an identity of one of the users is authenticated. A single interface is displayed in operation 1608, which provides the user access to both the site server and the database upon authentication of the identity of the user. In operation 1610, the user is allowed to view and change the information that is stored on the site server and the database and that is associated with the user. The single interface is tailored in operation 1612 based on the information associated with the user.

[0660] The identity of the user may be authenticated by verifying a user name and a password, a secure sockets layer (SSL) certificate, and/or a log-in form. Further, the preferences relating to the users may include a currency in which monetary values are displayed and a language in which text is displayed. Also, the roles relating to the users may include a customer, a manager, and an employee. Additionally, the details of the users may include a user name and a legal name. The following material provides a more detailed description of the above-described method.

[0661] This portion of the present description details the ReTA User framework design from the perspective of the application developer. The primary role of this framework is to provide services that allow the application developer to maintain user preferences, roles and security.

[0662] In regards to security, the User framework provides User Authentication services through any of the standard Internet Information Server security methods:

[0663] Username/Password sent in clear text.

[0664] SSL Certificates

[0665] Windows NT Challenge/Response (Intranet only)

[0666] HTML Forms login (Site Server version only)

[0667] Once the user has been authenticated, the User framework provides services for accessing:

[0668] User information—NT username, Real Name.

[0669] User Preference information—For example Language, Currency (These are configurable)

[0670] User Role information (e.g. Customer, Manager, Employee)

[0671] User Role Preference information

[0672] There are two implementations of the User Component: One is database driven and the other interfaces with Site Server Personalization and Membership directory.

[0673] User Framework

[0674] Description

[0675] With reference to FIG. 16B, the User framework 1630 enables two approaches to maintaining user information. The framework supports two approaches by exposing a single set of interfaces that can be used by either of the two user framework components. With the AFUserSS component 1632, the framework interfaces with the Microsoft Site Server products Personalization and Membership Directory. For this user component, SiteServer holds and manages user information. With the AFUserDB component 1634, the framework interfaces with database tables. For this user component, database tables define the user information.

[0676] Services

[0677] The User Framework provides the following services:

[0678] Components

[0679] The User Framework implements these services through the following COM objects:

[0680] These components are described in detailed in the following sub-portions of the description.

[0681] AFUserDB

[0682] The AFUserDB component holds the user role, preferences and details retrieved from the database. When created the user component retrieves the user NT login name, user details and constructs the user preference and user role objects.

[0683] Methods

[0684] The IAFUser, IAFUserPreferences and IAFUserRole interfaces define the access to the AFUserDB component. These interfaces support the following methods:

[0685] AFUserSS

[0686] The UserSS component interfaces with the SiteServer personalization and membership services. This component uses SiteServer to handle the user security, role and preferences.

[0687] Methods

[0688] The IAFUser, IAFUserPreferences, and IAFUserRole interfaces define the access to the AFUserSS component. These interfaces support the following methods:

[0689] FIG. 17A illustrates a method 1700 for managing business objects in a system that includes a plurality of sub-activities which each include sub-activity logic adapted to generate an output based on an input received from a user upon execution, and a plurality of activities which each execute the sub-activities in a unique manner upon being selected for accomplishing a goal associated with the activity. First, in operation 1702, an identifier and a reference to a business object are received from one of the sub-activities upon the execution thereof. In operation 1704, a database is accessed and data from the database is retrieved based on the identifier. The business object is created and populated with the data retrieved from the database in operation 1706.

[0690] The data may be stored on the database in tables. Further, the created business object may replace an existing business object. Additionally, the identifier may identify a customer and the business object may be a customer object. Also, a business object referenced by one of the sub-activities may be removed upon the execution thereof.

[0691] The business object may be a Visual Basic business object. In another aspect of the present invention, the business object may be a Java business object. The following material provides a more detailed description of the above-described method.

[0692] This portion of the present description details the ReTA Persistence framework design from the perspective of the application developer. The role of this framework is to provide services that interact with application database(s) to create, retrieve, update and delete business objects.

[0693] Persistence Framework

[0694] Description

[0695] The ReTA Persistence framework provides a transparent and flexible mapping of the business object attributes to relational database tables. To implement this “business object to database table” mapping, the framework is tightly integrated with all business objects. The framework exposes abstract methods that the application developer implements in the business objects. In contrast with the other ReTA frameworks, the Persistence framework is not implemented as a separate component. The Persistence framework is a set of local language classes available in Java or Visual Basic. FIG. 17B shows a SubActivity component 1730 using the Persistence framework 1732 to retrieve a Customer Object 1734 from the Database.

[0696] Services

[0697] The Persistence Framework provides the following services:

[0698] Classes

[0699] The Persistence Framework implements these services through the following Java or Visual Basic Classes:

[0700] These classes are described in detailed in the following sub-portions of the description.

[0701] AFPLPersistableObj

[0702] The AFPLPersistableObj abstract class contains methods called by the application developer objects to manage attribute values common to all persistable business objects (user id and last update timestamp). In addition, the AFPLPersistableObj class represents the superclass of a persisted object. In order to persist a business class; the application developer extends AFPLPersistableObj and implements the AFPLPersistableObj abstract methods.

[0703] The AFPLPersistableObj defines the following methods:

[0704] AFPLExtent

[0705] The AFPLExtent class provides the mapping between the business object and its associated database table. In addition, the AFPLExtent class represents the domain defined by the visible part of the database table for the specified user. This class holds the passed in database URL, username and password used during the access to the database. Lastly, the AFPLExtent class manages the database connection.

[0706] Methods

[0707] The AFPLExtent class implements the following methods used by the application developer from business factory objects:

[0708] VBPersistObj

[0709] The VBPersistObj interface class contains methods that need to be implemented on every VB Business Object.

[0710] The application developer implements the following methods from their business object:

[0711] VBExtent

[0712] The VBExtent class provides the mapping between the business object and its associated database table. In addition, the VBExtent class represents the domain defined by the visible part of the database table for the specified user. This class holds the passed in database URL, username and password used during the access to the database. Lastly, the VBExtent class manages the database connection.

[0713] Methods

[0714] The VBExtent class implements the following methods used by the application developer from business factory objects:

[0715] FIG. 18A illustrates a method 1800 for persisting information during a user session. First, in operation 1802, a session is initiated upon a user accessing a predetermined starting page. A current page accessed by the user is then tracked in operation 1804 while browsing a plurality of pages during the session. In operation 1806, a record is maintained of a page previously accessed by the user during the session. Information is persisted in operation 1808. This information is selected from a group of items such as user identifier, a time of a most recent user action during the session, activity components accessed during the session, and business components accessed during the session. During the session, the current page, previous page record, and information are provided to at least one activity component in operation 1810. Also in operation 1810, the activity component generates output based on input provided by the user via the plurality of pages.

[0716] In one embodiment of the present invention, the activity components to which the current page, previous page record, and information are provided may be selectively determined. In addition, the activity component may be provided an indication as to whether the user is permitted to access each of the pages. In such a case, the activity component may also be provided the indication as to whether the user is permitted to access each of the pages based on the previous page record.

[0717] In another embodiment of the present invention, the information may also include the user identifier. In such an embodiment, user preferences may be looked up based on the user identifier with the information including the user preferences. Also, in order to identify the persisted information, references to activity components, business components, a user component, a tracking manager component, a system preference component, and an event handler component may be employed. The following material provides a more detailed description of the above-described method.

[0718] This portion of the present description details the ReTA Session framework design from the perspective of the application developer. The primary role of this framework is to provide services to handle the stateless nature of Internet. By default, the Internet does not provide services for maintaining information between pages. Without these services, it would not be possible to implement most eCommerce functionality. For example, session level state is necessary to implement eCommerce functionality where a customer can select products on multiple product description pages and then submit a complete product order request from a confirm order page. The ReTA Session framework leverages the Internet Information Server/Active Server Page (IIS/ASP) session object, which is automatically created when a user who has no open IIS sessions requests a Web page.

[0719] Session Framework

[0720] Description

[0721] FIG. 18B illustrates a Session Flow Diagram—On Session Start. As shown, a Session framework 1830 operates in the MTS Runtime Environment 1832. FIG. 19 illustrates a Session Flow Diagram—On Start ASP Page. Again, the Session framework 1900 operates in the MTS Runtime Environment 1902. The ReTA Session framework provides services required throughout a user session. The user creates the Session framework at log on and removes the Session framework at log off. During the lifetime of the user session, application and architecture components require certain data to persist. This framework provides services to store and retrieve all information needed for a particular user session. This information may persist throughout the user session. The Session framework also provides services to uniquely identify the user and enforce access rights.

[0722] The user information that the Session framework persists, in memory, between Active Server Page requests includes:

[0723] User id

[0724] Identifies session user

[0725] Last page

[0726] Last page accessed by the session user.

[0727] Current page

[0728] Current page accessed by the session user.

[0729] Last connection time:

[0730] Session user's last connection time.

[0731] Current activity.

[0732] Activity currently being executed by the session user (refer to activity framework design)

[0733] Activity Components

[0734] All activity components accessed during user session

[0735] Business Components

[0736] All business components accessed during user session required by multiple activity components.

[0737] Note

[0738] This framework uses the Active Server Page's Session Object. Thus, the framework only works with browsers that accept cookies. For other browsers (or if cookies are disabled), a new ASP Session Object may start for each web page.

[0739] Services

[0740] The Session Framework provides the following services:

[0741] Components

[0742] The Session Framework implements these services through the following COM objects:

[0743] These components are described in detailed in the following sub-portions of the description.

[0744] AFSession

[0745] The AFSession component maintains the user's session state information. To maintain the state information, this component holds references to activity components (logical units of work—application flow logic), business components (business logic required across activity components), user component (user information), tracking manager component (web page access security and web page flow control information), system preference component (system preference information) and event handier component (event handler) created during the user's session.

[0746] From the application developer's perspective, the state maintenance work performed by the AFSession component is transparent. The application developer leverages the session services through populating the database tables with the client specific information.

[0747] Methods

[0748] The IAFSession, IAFEventBroadcaster and IAFContext interfaces define the access to the AFSession component. These interfaces support the following methods:

[0749] AFSystemPreferences

[0750] The AFSysteniPreferences component contains system preferences (held during the session). This component uses the ReTA persistence framework to read the system preferences from the database (“system preferences” table).

[0751] Methods

[0752] The IAFSystemPreferences interface defines the access to the AFSystemPreferences component. This interface supports the following methods:

[0753] AFTrackingManager

[0754] The AFTrackingManager component provides page sequence security, dialogue flow and activity flow functionality for the session framework.

[0755] Page Sequence Security

[0756] The page sequence security is defined in the following tables:

[0757] Table “Authorized Destination Page” 1834:

[0758] Define for each page, the pages that are allowed to be accessed. If no authorized destination pages are defined, the page is authorized to access any page.

[0759] Table “Authorized Source Page” 1836.

[0760] Define for each page, the pages that are allowed to access it. If no authorized source pages are defined, the page is authorized to be accessed by any page.

[0761] Dialogue flow

[0762] The dialogue flow is defined in the following table:

[0763] Table “Destination For Action” 1838.

[0764] Define the action flow between the web pages (i.e., which ASP is open when a specified push button is clicked during a specified activity).

[0765] Activity flow

[0766] The activity flow is defined in the following table:

[0767] Table “Page Of Activity” 1840.

[0768] Define the automated activity switching when the user jumps from one web page to another.

[0769] Methods

[0770] The IAFTrackingManager interface 1904 defines the access to the AFTrackingManager component. This interface supports the following methods:

[0771] AFBrowserInfo

[0772] The AFBrowserInfo component contains the user's browser information.

[0773] Methods

[0774] The IAFBrowserInfo and IAFEditable interfaces define the access to the AFBrowserInfo component. These interfaces support the following methods:

[0775] FIG. 20A illustrates a method 2000 for generating a graphical user interface. A form is initially created in operation 2002. The form includes a plurality of attribute rules dictating a manner in which user interface objects are situated thereon. In operation 2004, a plurality of user interface objects are selected. A page is generated in operation 2006 with the selected user interface objects situated on the page in accordance with the attribute rules of the form. JavaScript actions are attached to the selected user interface objects in operation 2008. The JavaScript actions are capable of being executed upon detection of a user action involving one of the user interface objects.

[0776] The user interface objects may include one or more of the following: a push button, a text box, a text area, a radio button, a check box, a drop down, a blank item, a user interface list, and a static table. The user action may include at least one of clicking on one of the user interface objects, changing text in one of the interface objects, exiting a text box of one of the interface objects. Further, the user action involving one of the user interface objects may cause a predetermined event. Optionally, the page may be an HTML page. The following material provides a more detailed description of the above-described method.

[0777] This portion of the present description details the ReTA User Interface (UI) framework design from the perspective of the application developer. The role of this framework is to provide services that generate the HTML code for UI widgets and attach Javascript actions to UI widgets. The UI framework exposes these services through a set of Component Object Model (COM) objects. The application developer uses these UI COM objects and their services through scripting logic added to the application's Active Server Pages (ASP).

[0778] User Interface Framework

[0779] The User Interface framework provides components for generating HTML. An HTML page is generated from a combination of the various UI Components. FIG. 20B shows the steps for generating a HTML page consisting of a form 2030 with a TextBox 2032, a DropDown list 2034 and a PushButton 2036.

[0780] The User Interface Framework provides the following services:

[0781] The User Interface Framework implements these services through the following COM objects:

[0782] These components are described in detail in the following sub-portions of the description.

[0783] AFForm

[0784] The AFForm component is used in conjunction with form element widgets to build complex user interfaces. Initially, the application creates an instance of the form component and sets its attributes. Following this activity, the application creates instances of the associated form element widgets and adds them to the form using the form's add method. As another service, the form component provides methods to help align all associated form element widgets properly on the page.

[0785] Methods

[0786] The IAFForm interface defines the access to the AFForm component. This interface supports the following methods, which the developer uses to create a form.

[0787] AFPushButton

[0788] The AFPushbutton component can only be used in conjunction with a AFForm component (the form's generate method iterates through the generate method for all form element widgets to build the necessary HTML code). An action object can be attached to a AFPushButton component. (Refer to AFHardCodedASPAction and AFJScriptAction for details).

[0789] Methods

[0790] The IAFPushbutton and IAFUIActionItem interfaces define the access to the AFPushbutton component. These interfaces support the following methods, which the developer uses to create a push button form element.

[0791] AFTextBox

[0792] The AFTextBox component can only be used in conjunction with a AFForm component (the form's generate method iterates through the generate method for all form element widgets to build the necessary HTML code). An action object can be attached to a AFTextBox component. (Refer to AFHardCodedASPAction and AFJScriptAction for details).

[0793] Methods

[0794] The IAFTextBox and IAFUIActionItem interfaces define the access to the AFTextBox component. These interfaces support the following methods, which the developer uses to create a Text Box form element.

[0795] AFTextArea

[0796] The AFTextArea component can only be used in conjunction with a AFForm component (the form's generate method iterates through the generate method for all form element widgets to build the necessary HTML code). An action object can be attached to a AFTextArea component. (Refer to AFHardCodedASPAction and AFJScriptAction for details).

[0797] Methods

[0798] The IAFTextArea and IAFUIActionItem interfaces define the access to the AFTextArea component. These interfaces support the following methods, which the developer uses to create a Text Area form element.

[0799] AFRadioButton

[0800] The AFRadioButton component can only be used in conjunction with a AFForm component (the form's generate method iterates through the generate method for all form element widgets to build the necessary HTML code). An action object can be attached to a AFRadioButton component. (Refer to AFHardCodedASPAction and AFJScriptAction for details).

[0801] Radio buttons are used in groups. Because of the complexity of the client side script required in conjunction with the radio button component, the application developer must call the generateRadioButtonScript ( ) method on the AFScriptgenerator object on the page wherever radio buttons are used. This method takes as inputs:

[0802] The name of the form object to which the radio button has been added.

[0803] The name of the radio button group within the form

[0804] The default value the radio button group may pass to the page view if nothing is selected by the user.

[0805] The return value from this method is the generated HTML and Javascript which is written to the client browser within the <HEAD></HEAD> tag of the page.

[0806] Methods

[0807] The IAFRadioButton and IAFUIActionItem interfaces define the access to the AFRadioButton component. These interfaces support the following methods, which the developer uses to create a Radio Button form element.

[0808] AFCheckBox

[0809] The AFCheckBox component can only be used in conjunction with a AFForm component (the form's generate method iterates through the generate method for all form element widgets to build the necessary HTML code). An action object can be attached to a AFCheckBox component. (Refer to AFHardCodedASPAction and AFJScriptAction for details).

[0810] Methods

[0811] The IAFCheckBox and IAFUIActionItem interfaces define the access to the AFCheckBox component. These interfaces support the following methods, which the developer uses to create a Check Box form element.

[0812] AFDropDown

[0813] The AFDropDown component can only be used in conjunction with a AFForm component (the form's generate method iterates through the generate method for all form element widgets to build the necessary HTML code). An action object can be attached to a AFDropDown component. (Refer to AFHardCodedASPAction and AFJScriptAction for details).

[0814] Methods

[0815] The IAFDropDown and IAFUIActionItem interfaces define the access to the AFDropDown component. These interfaces support the following methods, which the developer uses to create a Combo Box form element.

[0816] AFBlankItem

[0817] The AFBlankItem component can only be used in conjunction with a AFForm component (the form's generate method iterates through the generate method for all form element widgets to build the necessary HTML code).

[0818] Methods

[0819] The IAFBlankItem interface defines the access to the AFBlankItem component. This interface supports the following methods, which the developer uses to create a blank item form element.

[0820] AFUIList

[0821] The AFUIList component creates a sophisticated DHTML based single-select list box form widget. The list box widget consists of a fixed headings row and a scrollable set of data rows. The list box widget supports data entry through data row level associated check boxes and text boxes. In addition, action objects can be attached to the list box and are generated in the same way as described for other form components. (Refer to AFHardCodedASPAction and AFJScriptAction for details).

[0822] The list box widget refreshes itself by passing (as parameters) the selected item and the state of all check boxes and all text boxes. The AFUIList view captures the values and updates the state of the list box to reflect the user choice.

[0823] Note

[0824] The sophisticated functionality provided by this widget requires DHTML support. As of this portion of the present descriptions release date (Phase 2), only Internet Explorer 4.0 provides the necessary DHTML services. Therefore, this component is not cross-browser compatible.

[0825] Methods

[0826] The IAFUIList interface defines the access to the AFUIList component. This interface supports the following methods, which the developer uses to create a single select list box.

[0827] AFThumbNailContainer

[0828] The AFThumbNailContainer component generates a set of thumbnail images. The thumbnails are used as iconic pushbuttons. The application developer defines the single click and double click action destinations in the ASP page by coding the JavaScript functions referenced by the AFThumbNailContainer “generate” method.

[0829] Methods

[0830] The IAFThumbNailContainer interface defines the access to the AFThumbNailContainer component. This interface supports the following methods, which the developer uses to create a Thumbnail container.

[0831] AFStaticTable

[0832] The static table component creates a standard HTML table with the parameters set by the developer through scripting logic added to application's ASP.

[0833] Methods

[0834] The IAFStaticTable interface defines the access to the AFStaticTable component. This interface supports the following methods, which the developer uses to create a static HTML table.

[0835] AFHardCodedASPAction

[0836] The AFHardCodedASPAction component adds a user defined automatic navigation action to a UI component. The UI components that support this service include AFPushButton, AFTextBox, AFTextArea, AFRadioButton, AFCheckBox, AFDropDown and AFSelectedList. Attaching the navigation action to a UI item may automatically direct the user to the next page. The next page is identified by the flow control service of the session framework. This means that the developer does not have to specify the page to open. This service also ensures that all changes made to the open pages are capture before opening a new one. The navigation action is triggered when the user causes a defined event on the object. Defined events include clicking on a link or button and changing the text or exiting a text box. The Javascript events are onClick and OnChange.

[0837] The page that represents the target of the action must be entered into the database. The action logic may look to see which activity it belongs to and then look in the database to determine what page to show to the user. An example database entry in the T_AF_FWDestinationforaction table is:

[0838] T_AF_FWDestinationforaction

[0839] The id field must be a unique number,

[0840] The current page is the page on which the action is being triggered.

[0841] The Action is the name of the UI item which is triggering the action,

[0842] The Activity is the activity in which the action is taking place.

[0843] The Destination Page is the page to which the user should be redirected as the outcome of the action.

[0844] Methods

[0845] The IAFAction and IAFHardCodedASPAction interface defines the access to the AFHardCodedASPAction component. These interfaces support the following methods, which the developer uses to create a navigational action.

[0846] AFJScriptAction

[0847] The AFJscriptAction component adds a user defined action to a UI Component. The UI components that support this service include AFPushButton, AFTextBox, AFTextArea, AFRadioButton, AFCheckBox, AFDropDown and AFSelectedList. Attaching a Javascript action to a UI item may call a Javascript function when the action is triggered. Note: The application developer creates the called Javascript function on the correct application's ASP. The Javascript action is triggered when the user causes a defined event on the object. Defined events include clicking on a link or button and changing the text or exiting a text box. The Javascript events are onClick and onChange.