WO2001052502A2 - Procede et appareil de gestion de l'echange de donnees entre systemes dans un reseau - Google Patents

Procede et appareil de gestion de l'echange de donnees entre systemes dans un reseau Download PDF

Info

Publication number
WO2001052502A2
WO2001052502A2 PCT/US2001/001095 US0101095W WO0152502A2 WO 2001052502 A2 WO2001052502 A2 WO 2001052502A2 US 0101095 W US0101095 W US 0101095W WO 0152502 A2 WO0152502 A2 WO 0152502A2
Authority
WO
WIPO (PCT)
Prior art keywords
xsl
format
wdk
data object
data
Prior art date
Application number
PCT/US2001/001095
Other languages
English (en)
Other versions
WO2001052502A3 (fr
Inventor
Christopher S. Helgeson
Daniel S. Lipkin
Robert S. Larson
Srinivas Panuganti
Original Assignee
Saba Software, Inc.
Priority date (The priority date is an assumption and is not a legal conclusion. Google has not performed a legal analysis and makes no representation as to the accuracy of the date listed.)
Filing date
Publication date
Application filed by Saba Software, Inc. filed Critical Saba Software, Inc.
Priority to AU2001229423A priority Critical patent/AU2001229423A1/en
Publication of WO2001052502A2 publication Critical patent/WO2001052502A2/fr
Publication of WO2001052502A3 publication Critical patent/WO2001052502A3/fr

Links

Classifications

    • H—ELECTRICITY
    • H04—ELECTRIC COMMUNICATION TECHNIQUE
    • H04L—TRANSMISSION OF DIGITAL INFORMATION, e.g. TELEGRAPHIC COMMUNICATION
    • H04L67/00—Network arrangements or protocols for supporting network services or applications
    • H04L67/50—Network services
    • H04L67/56—Provisioning of proxy services
    • H04L67/564—Enhancement of application control based on intercepted application data
    • H—ELECTRICITY
    • H04—ELECTRIC COMMUNICATION TECHNIQUE
    • H04L—TRANSMISSION OF DIGITAL INFORMATION, e.g. TELEGRAPHIC COMMUNICATION
    • H04L67/00—Network arrangements or protocols for supporting network services or applications
    • H04L67/50—Network services
    • H04L67/56—Provisioning of proxy services
    • H—ELECTRICITY
    • H04—ELECTRIC COMMUNICATION TECHNIQUE
    • H04L—TRANSMISSION OF DIGITAL INFORMATION, e.g. TELEGRAPHIC COMMUNICATION
    • H04L67/00—Network arrangements or protocols for supporting network services or applications
    • H04L67/50—Network services
    • H04L67/56—Provisioning of proxy services
    • H04L67/565—Conversion or adaptation of application format or content
    • H—ELECTRICITY
    • H04—ELECTRIC COMMUNICATION TECHNIQUE
    • H04L—TRANSMISSION OF DIGITAL INFORMATION, e.g. TELEGRAPHIC COMMUNICATION
    • H04L67/00—Network arrangements or protocols for supporting network services or applications
    • H04L67/50—Network services
    • H04L67/56—Provisioning of proxy services
    • H04L67/568—Storing data temporarily at an intermediate stage, e.g. caching
    • H—ELECTRICITY
    • H04—ELECTRIC COMMUNICATION TECHNIQUE
    • H04L—TRANSMISSION OF DIGITAL INFORMATION, e.g. TELEGRAPHIC COMMUNICATION
    • H04L69/00—Network arrangements, protocols or services independent of the application payload and not provided for in the other groups of this subclass
    • H04L69/30—Definitions, standards or architectural aspects of layered protocol stacks
    • H04L69/32—Architecture of open systems interconnection [OSI] 7-layer type protocol stacks, e.g. the interfaces between the data link level and the physical level
    • H04L69/322—Intralayer communication protocols among peer entities or protocol data unit [PDU] definitions
    • H04L69/329—Intralayer communication protocols among peer entities or protocol data unit [PDU] definitions in the application layer [OSI layer 7]

Definitions

  • the present invention relates to the general field of computers, telecommunications, and computer and Internet related systems. More specifically the invention relates to systems and processes to be used in a business systems platform generally used to integrate disparate business applications systems in an efficient manner, across multiple hardware platforms.
  • the Internet and other communications networks provide a mechanism for communication and transfer of data between a wide variety of systems and platforms.
  • a system for managing the exchange of data and information among applications which may be housed on disparate hardware platforms and in diverse locations.
  • a system that provides standardized access to connectivity with other systems and platforms in a users network there is a need for a system that provides standardized access to connectivity with other systems and platforms in a users network.
  • EJB EnterpriseJavaBeans
  • This new architectural system and related tools and systems are well documented and well known to those skilled in these arts.
  • U.S. Patent No. 6,125,363 issued on September 26, 2000 to
  • a system using one framework is unable to transfer data to a different framework, as systems implementing one framework will have a different application programming interface API than the application programming interface API of another system. Accordingly, there is a need in the art for a modular interconnect system containing data import, export and event monitoring and reporting facilities which are protocol independent of related applications.
  • an interconnect system which implements a generic connector framework with pluggable system specific components utilizing native application programming interfaces of systems to manage export and import of data from external systems.
  • There is also a need for such an interconnect system utilizing XML and there is a need for reliable monitoring mechanisms for changes to data in external systems.
  • the current invention provides these facilities and others in various new and novel ways as more fully described below.
  • the present invention presents a method for managing data exchange among systems connected via a network.
  • a plurality of predefined stylesheets are generated, with each stylesheet describing a mapping between a system specific local format and a generic interchange format.
  • a data object is received from a first system in a first system specific local format.
  • This data object is translated from the first system specific local format to a generic interchange format object with the predefined stylesheets using a system specific service component which utilizes a native application programming interface of said first system.
  • the data object is then translated from the generic interchange format to a second system specific local format object with the predefined stylesheets using a system specific service component which utilizes a native application programming interface of said second system.
  • the translated data object is then transferred to the second system.
  • the step of receiving a data object from a first system in a first system specific local format includes receiving a request to export a data object from a first system, identifying a local data object identifier utilizing a mapper component, identifying a document type utilizing a mapper component, identifying a stylesheet and transformer using said document type, and extracting the data object from the first system.
  • the present invention presents a system for managing data exchange among a plurality of systems connected via a network.
  • the system comprises a network interface, memory storing data and programs of instructions, and a processor coupled to the memory which executes the programs of instrucitons and accesses the stored data.
  • the programs of instructions comprise a first component for translating a data object from a first system specific local format to a generic interchange format object, a second component for translating the data object from the generic interchange format to a second system specific local format object, and a third component for transferring the data object between the first and second system.
  • the first component further comprises a system independent service subcomponent and a system specific service subcomponent utilizing a native API of said first system to translate said data object to a generic interchange format object using a predefined stylesheet.
  • the second component further comprises a system independent service subcomponent and a system specific service subcomponent utilizing a native API of said first system to translate said data object from a generic interchange format object to a second system specific local format object using a predefined stylesheet.
  • the system may also include a monitor component for monitoring changes of a data object at a system, with the monitoring component having both a system independent service subcomponent and a system specific service component utilizing a native API of the monitored system to monitor changes of the data object.
  • the system may also include a mapper component for identifying a local object identifier and a document type.
  • Figure 1 illustrates a typical configuration of Internet connected systems representative of the preferred embodiment of the present invention.
  • Figure 2 illustrates a typical general purpose computer system of the type representative of the preferred embodiment.
  • Figure 3 illustrates the general three tier relationship between user, webservers and their related applications-server, and the database management system.
  • Figure 4 illustrates a more detailed depiction of the applications-server portion of such a system as shown in FIG. 3 illustrating the business applications platform system of the present invention.
  • FIG. 5 illustrates an alternative configuration of the system which contains the invention.
  • Figure 6 is an alternative depiction of the platform of the present invention.
  • Figure 7 illustrates a more detailed configuration of an exemplary business server portion of the current invention.
  • Figure 8 A illustrates a more detailed configuration of an exemplary Web Content Server portion of the current invention.
  • Figure 8B shows a process flow diagram illustrating how to produce dynamic web content.
  • Figure 8C shows a process flow diagram illustrating the page development process.
  • Figure 9 illustrates a preferred embodiment of the Interconnect Backbone.
  • Figure 10 shows a process flow diagram illustrating a purchase order delivered from a Source site to a target system through Interconnect.
  • Figure 11 illustrates one embodiment of the structural overview of an DDK.
  • Figure 12 illustrates one embodiment of a functional overview of an
  • Figure 13 illustrates an exemplary view of APIs associated with the Information Distributor.
  • Figure 14 illustrates an exemplary view of using Information Distributor or lDK.
  • Figure 15 illustrates an exemplary overview of Query Objects.
  • Figure 16 illustrates an exemplary overview of the Implement Custom Delivery Service.
  • Figure 17 illustrates a preferred embodiment of the Business Applications Management System Platfo ⁇ n.
  • the present invention provides a solution to the needs described above through a system and method for integrating the disparate applications, and managing the applications processes in a hardware resource and user effort efficient manner.
  • the automated system of the present invention uses a business systems platform architecture comprised of several unique servers in a base platform (the "Platform") to efficiently manage multiple applications which may themselves generally be distributed across a network.
  • the platform makes use of a collection of Core Services which provide additional security, internationalization services, and reporting services which are applicable to all applications.
  • the Core Services are made available to a multitude of common business objects, which themselves are made available to various applications.
  • the present invention is a Business Applications Management System Platform Architecture (the "Platform” or alternatively the “SABA architecture”) which is designed to maintain and use a set of unique servers and common objects to generate the set of tasks required to be performed to complete a designated business transaction in a concrete, and useful way.
  • the platform permits application developers to work on the business aspects of the application without having to focus on transaction management, security, persistence of data or life cycle management of the object itself.
  • the servers and other aspects of the Platform are described in more detail below. However, a general overview of a preferred embodiment of the invention is first described.
  • the system is predominantly based on object-oriented programming principles as described in "Object-Oriented Software Construction” by Bertrand
  • Saba's architecture consists of four layers of APIs:
  • the Platform layer 501 provides underlying infrastructure for enterprise applications, including standards-based functionality for persistence and distributed logic, application integration, content generation, and metadata queries.
  • the Core Services layer 503 is a module that provides a set of common functionality for enterprise application. It includes services such as security, internationalization, and reporting.
  • the Common Business Objects layer 505 is a module that defines a set of business objects shared across all SABA applications. It includes objects such as Party and Plan. Vertical applications may each also contribute a set of common business objects.
  • the Applications layer 507 provides objects and services particular to a given application. There are multiple modules contained within the Applications layer, including modules for Learning 525, Content 527, Performance 529, and Sales & Marketing 531. The specific applications modules indicated are shown by way of example.
  • This architecture also helps avoid circular dependencies by requiring that all dependencies be directed downwards. That is, a vertical application 507 may have dependencies on one or more sets of common business objects 505, but not on other applications. Similarly, common business objects 505 may depend on core services 503, and on other common business objects 505, but not on applications 507.
  • Platform The Platform model 501 defines applicants' application platform, on top of which all additional business logic and functionality are implemented. Platform 501 provides the full set of standards-based services required for building modern enterprise applications.
  • Platform 501 consists of the following services: • BDK (Business Development Kit) Business applications server 519 is
  • the BDK 519 defines the following base interfaces: o ISabaEntityBean - The abstraction of a persistent object o ISabaSessionBean - The abstraction of a transactional service • WDK (Web Development Kit) server 523 is Saba's web content generation engine. Using web standards for XML and XSL, it provides a customizable framework for decoupling data from presentation, and generating web content in a variety of formats, from standard HTML to WML.
  • the WDK 523 provides the following base interfaces: o IWDKObj ect - An object capable of serializing itself as XML • Interconnect is Saba's application integration platform. Using XML and open standards for ERP integration, it provides a scalable and reliable solution for batch and period import, export, and monitoring. Interconnect defines the following base interfaces: o IAccessor - Service for exporting objects from SABA o Ilmporter - Service for importing objects into SABA o IMonitor - Service for monitoring object changes
  • Information Distributor Server 521 is applicants' query and delivery mechanism. Based on XML and RDF metadata standards, it defines a high-level query language and a set of agents for implementing information services. Interconnect provides the following services: o MetadataRepository - A datastore for querying metadata o ImportAgent - An agent for generating metadata o MatchAgent - An agent for locating metadata-based matches o Delivery Agent - An agent for delivering match results
  • the Core Services module 503 provides the common business services needed by applicants' system. These services are not specific to any industry, such as learning; instead, they provide the support and functionality required by applicants to meet generic enterprise requirements.
  • AuditManager Tracks changes to objects in the system. Can return a complete history of changes, including date, username, and reason.
  • BusinessRuleManager Manage system business rules, that is, company policies defining the system's behavior in given situations.
  • Domains are hierarchical groupings of business objects that can be used for a variety of purposes.
  • Finders provide a flexible mechanism for defining and executing database queries.
  • HandleManager Centralize access to managers available to all business objects.
  • • il ⁇ nManager Manage internationalization. Track information about locales, languages, timezones, and display formats associated with business objects.
  • LicenseManager Manage software licensing. Track installed modules, license keys, and version numbers. • LOVManager - Define lists of values.
  • SecurityManager Manage user privileges. Assign permitted operations on objects to users and groups.
  • TaxManager Calculate sales taxes.
  • NotificationManager Manage notifications. Associate actions, such as sending an email or executing a Java method, with predefined system and periodic events.
  • the Common Business Objects module 505 defines the set of business abstractions that are shared across more than one vertical application. These objects may be either generic business concepts, such as a Party, or shared concepts specific to Saba's application domain, such as Calendar.
  • Common Business Objects 505 comprise the following Session Managers:
  • AccountabilityManager Used to manage a variety of relationships, such as reporting and organization membership, between entities in the system
  • CalendarManager Manage calendars and schedules. o CorporateCalendarManager o PersonalCalendarManager o SfaCalendarManager o SfaCalendarOwnerManager o CheckListltemManager
  • PartyManager Manage entities within a business. Includes employees, clients, companies, departments, and business units.
  • LocationManager Manage locations, including addresses and contact information.
  • PlanManager - Manage plans that is, proposed course of actions.
  • ProfileManager - Manage profiles that is, comprehensive histories, goals, and plans for entities within a business.
  • the exemplary Learning module 525 within the Applications layer 507 defines the services used to build learning management systems. It provides APIs for defining learning offerings, which include classes, courses, on-line learning, and physical inventory, registering for and consuming learning, and tracking transcripts, certifications, and other results of learning.
  • Learning Session Managers are delivered as part of
  • LearningManager Manage learning offerings. Extends the concept of offering templates to include managing delivery types and delivery modes, offering instances, audience types, and offering modes.
  • AudienceTypeManager o DeliveryManager o DeliveryModeManager o EquivalentManager — Defines equivalent offering templates, o OfferingActionManager o OfferingManager o OfferingPolicyManager o OfferingTemplateDeliveryManager o ProductGroupManager o RosterManager o PrerequisiteManager
  • LearningResourceManager Manage resources used by classes, such as classrooms, faculty, and equipment. o InventoryManager / o QualifiedlnstructorManager • RegistrarManager - Request and order a learning resource.
  • the Content module 527 within the Applications layer 507 defines the services used for all forms on on-line learning. It includes creating and launching WBT and VOD courseware, virtual classrooms, testing and assessment, community services, and analysis and tracking.
  • ContentHolderManager Allows any business object to be a content holder
  • CourseContentManager Associate content such as attachments and exams with learning offerings.
  • Performance The Performance module 529 within the Applications layer 507 defines the services available for managing human performance. It includes competencies and goals.
  • CompetencyManager Assign competencies to roles, entities, and learning resources. Includes o CompetencyHolderManager o CompetencyProviderManager
  • OfferingCompetencyManager Associate competencies with offering templates and find learning interventions that provide competencies.
  • CompetencyAnalysisManager o CompetencyGroupManager o CompetencyMethodManager o CompetencyModelManager
  • GoalManager Manage and track goals. Includes assigning goals and observations on goals. o GoalLibraryManager o GoalObservationManager o GoalStateManager
  • Sales and Marketing The Sales and Marketing module 531 within the Applications layer 507 defines the services available for the running the finances and logistics of a learning content provider. It includes the purchase of learning resources and tools for managing sales and marketing campaigns.
  • OrderManager Generate orders. Includes invoicing and shipping options.
  • SalesMktManager Order a learning resource. Similar functionality to RegistrarManager, but designed for use in a call center to fulfill external orders.
  • TargetMarketManager Manage target markets and associate them with offering templates.
  • An exemplary version of an application architecture which can make use of applicants' invention could consist of four distinct applications that interoperate to provide a complete Human Capital Development and Management solution.
  • Each of these applications is based around a core set of metadata; the applicants' architecture's value lies in the effective management of this metadata.
  • the diagram in Figure 6 describes this core metadata and how it is employed by different types of users in this exemplary implementation of this architecture.
  • this architecture can be used with various other kinds of applications systems, such as: financial product sales & marketing systems; retail store management systems; various kinds of maintenance & repair management & dispatch systems; etc.
  • SABA Learning manages Catalog Metadata 609 that describes a set of available learning interventions and Profile Metadata
  • SABA Performance manages Profile Metadata 611 that describes individual and group goals, competencies, and development plans. Together, the Profile Metadata 611 in Learning 607 and Performance 605 provide a complete description of the human capital in an extended organization.
  • SABA Information 603 and SABA Content 601 manage metadata about a variety of on-line resources.
  • SABA Information 603 uses this metadata to construct information services targeted to individual's information needs, whereas SABA Content 601 uses this metadata to manage learning content throughout its lifecycle and construct intelligent, reusable Learning Objects.
  • Individual learners 619 query Learning Metadata (that is, the learning catalog) 609 to locate appropriate learning interventions.
  • the system uses Learning Object Metadata 613 to deliver and track learning interventions and updates the Profile Metadata 611 as appropriate.
  • Team managers 621 work with Profile Metadata 611 to define, update, and track progress towards goals. They can analyze the metadata to identify problem areas and generate plans for meeting their goals.
  • Learning providers 617 use import and administration tools to create and update Catalog 609 and Learning Object Metadata 613.
  • Competency gap analysis can be applied to either an individual's goals 713 or roles 715.
  • the analysis compares the required competencies for reaching a goal 713 or filling a role 715 (either held or targeted) to actual held competencies and generates a competency gap 721.
  • Learning interventions (offerings 723) that fill the competency gap 721 are the identified.
  • a variety of other intervention types are planned, including information 733 and community services 735.
  • Certification gap 719 analysis compares a role's certification requirements associated to the actual learning profile of the individual in the role. It then identifies the quickest certification track to completion and recommends appropriate learning offerings 723 from the catalog. Having described an exemplary application we now describe the invention in additional context.
  • the Platform can support both Application and Business component development, as well as integration with development tools, connectivity to external systems (import/export/ exchange), and information delivery.
  • the architecture of the present invention adopts a three-tier model and is shown in the diagram in Fig. 3.
  • a tier 1 web user 301 is connected electronically to a tier 2 web server 305 which is connected to a tier 3 applications server 307.
  • a dedicated user 311 may be directly connected to a tier 3 applications server 307.
  • the tier 3 applications server 307 may be cormected to a database management system 309.
  • the tier 3 applications server 307 is expanded in Fig. 4 to illustrate the Business Applications Platform 415 of the present invention.
  • Fig. 4 the tier 3 applications server 307 is expanded in Fig. 4 to illustrate the Business Applications Platform 415 of the present invention.
  • the Platform contains an Interface Server 417, an Information Server 419, an Interconnect Server 423 and a Business Server 421. All of these Servers 417, 419, 421 and 423 may physically reside on the same hardware platform (such as a UNIX box or a MicrosoftTM NTTM platform), or each server may reside on a separate hardware box, or any combination of servers and hardware boxes. Each of the servers may have included a JAVA Virtual MachineTM and the related runtime support. The electronic communications between these servers may use the XML protocol (409, 425, 427) with each server having services for translating XML into the particular Applications Programming Interface (API) language required by the server and for translating its internal language into XML prior to transmission to another server.
  • API Application Programming Interface
  • the Interface Server 417 (also alternatively designated herein as the WDK) , communicates through a web server 405 via the internet 403 to web clients 401 via the HTML protocol.
  • the Interface Server 417 also may communicate to a directly connected client 407 via other protocols such as XSL/XSLT etc., and may communicate to Personal Data Assistants 411 such as cell phones or Palm PilotsTM or other such wireless devices using wireless protocols such as WAP/WML, etc.
  • the Interface Server 417 contains mechanisms to manipulate various kinds of display style sheets, to generate and execute web links, to manage dynamic content generation and dynamic generation of Javascript, all of which is described in more detail below in the section on the interface Server/WDK 417.
  • the environment in which the present invention is used encompasses the use of general purpose computers as client or input machines for use by business users of various kinds, including clerks, managers, teachers, and/or systems administrators. Such client or input machines may be coupled to the Internet
  • FIG. 1 Some of the elements of a typical Internet network configuration are shown in Figure 1, wherein a number of client machines 105 possibly in a branch office of a large enterprise, a manufacturer, a financial enterprise, etc., are shown connected to a Gateway/hub/tunnel-server/etc. 106 which is itself connected to the internet 107 via some internet service provider (ISP) connection 108. Also shown are other possible clients 101, 103 possibly used by other application systems users, or interested parties, similarly connected to the internet 107 via an ISP connection 104, with these units communicating to possibly a home office via an ISP connection 104, with these units communicating to possibly a home office via an ISP connection 104.
  • ISP internet service provider
  • ISP connection 109 to a gateway/tunnel-server 110 which is connected 111 to various enterprise application servers 112, 113, 114 which could be connected through another hub/router 115 to various local clients 116, 117, 118.
  • Any of these servers 112, 113, 114 could function as a server of the present invention, as more fully described below. Any user situated at any of these client machines would normally have to be an authorized user of the system as described more fully below.
  • An embodiment of the Business Applications Platform System of the present invention can operate on a general purpose computer unit which typically includes generally the elements shown in Figure 2.
  • the general purpose system 201 includes a motherboard 203 having thereon an input/output ("I/O") section 205, one or more central processing units (“CPU”) 207, and a memory section 209 which may or may not have a flash memory card 211 related to it.
  • the I/O section 205 is connected to a keyboard
  • the CD-ROM drive unit 217 can read a
  • CD-ROM medium 219 which typically contains programs 221 and other data.
  • Such programmed computers may also be connected electronically to database systems such as those available from OracleTM, SybaseTM, InformixTM 5 SQLServer from MicrosoftTM and the like. Logic circuits or other components of these programmed computers will perform series of specifically identified operations dictated by computer programs as described more fully below.
  • BDK Business application server covers the presently preferred embodiment and the presently known best mode for making and using it. This section is followed by a further description of an alternative embodiment which may include features in addition to or in place of those in the preferred embodiment.
  • the Business Development Kit applications server (BDK) component of the Platform provides a supporting framework for business objects.
  • a business object is a Java object with persistent state that represents some entity in a business application, such as an employee or company.
  • the BDK provides a persistence framework for saving and restoring object state and a set of core services for performing a variety of useful operations on business objects.
  • Persistence Framework defines a common code path used to create new objects, restore and update existing objects, delete objects, and find objects.
  • the code path consists of a set of Java code and database stored procedures to construct and verify object data and SQL commands to save and restore information using a relational database.
  • the persistence framework is highly flexible because it is metadata-driven. For each class of object, the system provides a set of metadata - data about data - that defines the class' properties and behavior. This means that the data used to determine the behavior and characteristics of specific classes and instances of business objects is stored as distinct, editable information, rather than being hard- coded into the logic of the system.
  • the persistence code itself is part of the metadata, that is, the SQL commands for save, restore, etc. are stored as metadata, not in source code. As an example benefit, it makes applications much easier to port between databases because only the metadata for the SQL needs to be changed; no source code needs to be changed and recompiled.
  • Object properties that can be customized range from the labels used to display object information, to the type of data validation performed, to the amount of custom information associated with each object.
  • Custom fields provide a way for different customers to uniquely extend the data stored with a class of business objects.
  • customers are provided with a set of five "custom fields” that can be searched, and an unlimited number of "extended custom fields” that cannot be searched, but provide additional data validation for date and numeric values.
  • the code to save and restore custom fields is all driven off metadata.
  • a user of the system may attempt to create a new employee by specifying the employee's first and last name, social security number, starting salary, and date of birth.
  • the persistence framework performs the following operations to save this data as a new "SabaPerson" business object:
  • Metadata settings about the "first name”, “last name”, “ssn”, and “birth date” properties of a "SabaPerson” may instruct the framework to verify that values are provided for first name, last name, and ssn, that starting salary is greater than a fixed numeric minimum wage value, and that birth date is a valid date.
  • the meta-data store contains the definition of each type of object in the system, its attributes, and some basic properties of those attributes. Further, for each type of object, it contains a reference to the methods to invoke, to insert, update, delete or fetch a given instance of that object from the persistent store.
  • the Metadata store consists of the following tables:
  • fgt_dd_class has the following columns:
  • This number is sum of all fixed and all custom attributes .
  • 2nd bit This 2bit mask is set to see if reports or letters or both can be attached.
  • fgt_dd_attr has the following columns:
  • Customization bit This 4bit mask says if label, required or generation can be customized by end user.
  • Domain bit is set if the attribute is domain id.
  • This table stores the actual SQL code used for object persistence.
  • insert, update, and delete methods typically these are calls to stored procedures containing additional business logic in addition to database calls.
  • fgt_mesg_table has the following columns:
  • 10563 is the code for retrieving an object, 10560 for inserting an object, and 10562 for updating an object.
  • the f gp_domain_ins stored procedure is PL/SQL code defined as: create or replace procedure fgp_domain_ins ( xid char, xtime_stamp varchar2 , xname varchar2 , xdescription varchar2 , xcustomO varchar2 , xcustoml varchar2 , xcustom2 varchar2 , xcustom3 varchar2 , xcustom4 varchar2 , xcreated_on date, xcreated_by varchar2 , xupdated_on date, xupdated_by varchar2 , xparent_id char, xnewts varchar2
  • parent_id cannot be null except for the root */ if (xid ⁇ > 'dominOOOOOOOOOOOOOOOOOOl ' and xparent_id is null) then raise_application_error (-20699, ' ' ) ; return; end if;
  • MAX_VAL, DEFAULT_VAL, LIST_OF_VALS, GEN_MASK) select 'ddoat '
  • all business objects that Saba's Application server manipulates are derived from a single base class called SabaObject.
  • SabaObject class provides save, restore, and delete capabilities by implementing the persistence layer architecture. All subclasses of SabaObject then inherit this behavior and rarely if ever override it.
  • Every SabaObject is expected to know which class it belongs to, and how that class is registered in the meta-data store.
  • each subclass of SabaObject stores a class identifier so that it can tell the system which entry in the meta-data store it corresponds to.
  • Every SabaObject also stores a state flag that determines whether this is a new object, or it is an object that already exists in the data store. This state then determines whether the object invokes an insert method or an update method during a save() invocation.
  • Every SabaObject has an unchangeable, unique identifier that identifies that particular object in the persistence store. The uniqueness of this identifier is guaranteed across the entire persistence store regardless of the type of obj ect.
  • the basic process is identical, except that the invocation of the delete method only requires the unique identifier of the SabaObject to be passed in as its only argument.
  • the persistence mechanism thus created allows the transfer of various kinds of objects to database storage as shown below.
  • Fig 1 Single object to Fig 2: Two objects to ; Fig 3: Single object to a single table single table two tables
  • Query results are transformed into actual SQL code using the following method: private static String processMessage (ResultSet rSet) throws Exception, SabaException
  • ⁇ str buf .toStringO ; return str; ⁇ ⁇ Retrieved messages are also stored in a local cache for improved performance.
  • the Saba persistence mechanism provides built-in support for configurable, runtime definable, custom fields for any object.
  • the basic mechanism is extremely simple.
  • An administrative user interface is provided by which the meta-data definition of a given class can be extended by adding (or removing) custom attributes as needed.
  • custom attributes For each custom attribute, the user only needs to provide some very basic information about the type of the field, whether or not it is required, constraining minimum and maximum values for numeric fields, and a constraining list if the field is to be validated against a list of possible values.
  • the SabaObject implementation then simply picks up these fields during its normal marshalling and unmarshalling of arguments. Further, the SabaObject also performs the basic checks for nullity as it would normally do. To save and restore the custom fields, the actual algorithms are extended from the ones shown earlier. In the case of insert or update the following additional lines are called after the line marked (1) in the algorithm shown earlier: After invoking the basic method M
  • custom field fetch Unmarshall all custom field data and update the relevant fields in the SabaObject.
  • the actual storage where the custom field data for any given instance is stored consists of a single table as defined below. All the custom field data is stored as tag-value pairs in typed columns.
  • This common table provides the storage area for all data stored in the extended custom fields for a given object.
  • BDK also provides a set of core services to perform useful operations on business objects. Some of these services include:
  • BDK provides extremely fine-grained security control to control whether specific users have privileges to perform operations such as creating or viewing a particular class of business object.
  • the system is unique in that it provides a flexible model of security roles and security lists to assign a set of privileges to distinct groups of users, and it employs a scalable notion of domains to differentiate among sets of business objects.
  • the security model is explained in detail in a separate section below.
  • BDK provides the ability to track the history of all changes to an object, including the date of a change, the identity of the user making the change, and a justification for the change.
  • - Internationalization (il ⁇ n).
  • BDK provides utilities for allowing business objects to be internationalized. Internationalization is a standardized process wherein message content, money amounts, dates and various other culture specific data are kept in separate files in order to permit an easy change from one countries language and cultural rules to another. This comprises both storing values of business objects in multiple languages and supporting multiple formats for date, currency, and other data types that vary among countries.
  • BDK provides concurrency services for controlling overlapping write operations on multiple instances of an object, while permitting multiple reads at the same time. This is achieved via comparison of an instance-specific timestamp when committing of an object's state to the persistent store is requested. The timestamp is updated whenever the state of an object is altered and the object is successfully committed to persistent storage.
  • - Transaction Management BDK provides two types of transactional services: procedural and declarative. In the former case, a developer explicitly marks the beginning and end of a unit-of-work using BDK's API.
  • BDK provides logging functionality that can be used for capturing system state and operations in one or more logs.
  • BDK provides the ability to send notifications, such as emails or faxes, to predefined categories of users when the state of identified business objects changes. For example, everyone subscribed to a class may receive a page if the class is cancelled.
  • Saba's learning application provides a set of pre-defined business rules that affect the workflow and behavior of various business objects in the system.
  • the BDK provides a mechanism to enable and disable these business rules. For example, a customer can configure whether a manager's approval is required to register for a class. Similar business rules can be handled for other types of applications.
  • BDK provides the ability to associate arbitrary, free- form text, or "notes,” with any business object in the system.
  • the BDK exposes Application Programming Interfaces (APIs) for use in programming the system.
  • APIs Application Programming Interfaces
  • a variety of APIs with equivalent functionality are supported on top of the persistence framework.
  • the system supports both propriety and industry-standard forms of Java API, as well as XML-based APIs.
  • a Java API is a proprietary "SabaObject" interface to a business object.
  • a SabaObject is a Java class defining a set of operations common to all business objects, including the ability to get and set properties using a variety of data types and the ability to save and restore an object's state.
  • Specific business object classes can subclass SabaObject to add functionality and business logic appropriate to that class.
  • the Java interface for SabaObject is the following:
  • the business object author provides four SQL statements corresponding to selection, deletion, insertion, and updating of the object. Pointers to these statements are provided as part of the metadata for the object as stored in fgt_dd_class.
  • the first two (selection and deletion) types of statements take a single bind variable, namely, the id of the object.
  • the other two take the id as well as all other attribute values in the order declared in the metadata for that object's attributes in the table fgt_dd_attr.
  • the order of retrieval of attributes in the selection statement must also match such order.
  • BDK Upon receiving a request to create an in-memory representation of an object through the "restore()" method, BDK retrieves the selection statement for that class of objects, binds the variable to the id of the object that is desired to be restored, executes the statement, and fills in an instance-specific hashtable of attribute- value pairs with the values so retrieved.
  • a standard SQL statement is executed to retrieve the value of extended custom attributes, and the results are again inserted in the aforementioned hashtable.
  • the execution of these SQL statements is done using the database connection contained in tr, the transaction argument.
  • BDK Upon a subsequent call to "save()" or "save(SabaTransaction tr)," BDK checks for the state of the object. If it is an object that has been marked for deletion, the deletion SQL statement as supplied by the business object author is executed after binding the id, using the database connection in the transaction argument for the "save(SabaTransaction tr)" case. Other possibilities upon execution of the save operation are that the object instance is new, or it is an altered state of an existing object. In these cases, the statements corresponding to insertion and updating are executed, respectively, after the replacing the bind variables with attribute values from the hashtable in the order specified in metadata. In the case of insertion, BDK automatically generates a unique id for the object that is reflected both in the persistent storage and the in-memory representation.
  • Implementation of the setAttrVal() and get ⁇ type>AttrVal() involve setting and accessing values in the hashtable, respectively, using the provided attribute name as the key.
  • getAttributeValues() returns a copy of the object's hashtable whereas getAttributeLabel() looks up the attributes' metadata and returns the label corresponding to the chosen attribute.
  • Java API is based on the industry-standard Enterprise JavaBean
  • EJB EJB model.
  • This model has a notion of "entity beans” that provide the interface to specific business objects.
  • the persistence framework provides a EJB-based abstract class, "SabaEntityBean” that implements the javax.ejb.EntityBean interface.
  • the SabaEntityBean class provides default implementations of the following methods: ejbActivate(), ejbPassivate(), ejbRemove(), setEntityContextQ, ejbCreate(), ejbLoadQ, ejbStore(), and unsefEntityContextQ.
  • Implementations of the ejbLoad(), ejbStore(), ejbCreate, and ejbRemoveO methods rely on the selection, update, insertion, and deletion statements declared as part of metadata (please refer to the discussion of the implementation of SabaObject's API). Other methods are implemented as empty stubs that can be overridden by a developer if desired.
  • the remote interface is the external world's view of the bean and is comprised of the business methods that the bean wishes to expose.
  • the getters and setters for the bean's attributes are also exposed through the remote interface.
  • the home interface declares the life-cycle methods, such as those for creating, removing, or finding beans.
  • the BDK provides two interfaces, ISabaRemote and ISabaHome, which a bean can extend for defining remote and home interfaces, respectively.
  • the ISabaRemote interface extends the standard EJB interface EJBObject and provides the following sets of methods:
  • the ISabaHome interface provides a layer of abstraction over the standard EJB interface EJBHome.
  • the BDK also defines a class SabaPrimaryKey (a thin wrapper around the String class) which can be used by entity beans for defining primary keys.
  • the EJB model also has a notion of "session beans,” higher-level interfaces that represent business processes.
  • the EJB model also has a notion of "session beans,” higher-level interfaces that represent business processes.
  • BDK has standardized on the use of session bean-based interfaces as its public API; these interfaces are known as “session bean managers,” and are implemented using the lower-level entity bean APIs provided by the persistence layer.
  • the BDK provides a SabaSessionBean base class that defines common session bean manager functionality, and a framework for several categories of "helper classes" - additional interfaces used in conjunction with specific session bean managers:
  • the BDK also provides XML-based interfaces for saving and retrieving business objects; these interfaces provide the communication layer with the other Platform servers and components.
  • SCF Staba Canonical Format
  • the Interconnect server system reads and writes SCF to implement the AccessorReader and ImporterWriter for the native Saba system; refer to the Interconnect server section for more details.
  • SCF document representing a business object defining a specific currency
  • ⁇ SabaObj ect type "com. saba . busobj .
  • IXMLObject is a Java object capable of serializing itself into an XML representation.
  • the detail, handle, and primitive helper objects used by session bean managers all implement this interface.
  • the WDK server system uses these objects to generate dynamic web content by invoking the session bean manager APIs, then serializing the resulting objects into XML; refer to the WDK section for more details.
  • the IXMLObject interface conforms to the "Visitor" design pattern, and is defined as follows:
  • An implementation should ask the Visitor to visit each of its public elements (i.e., fields or properties) .
  • a "visitor" object is one which has processes which represent an operation to be performed on the elements of an object structure. A visitor lets one define a new operation without changing the classes of the elements on which it operates. Visitor objects and their operation and use are described in more detail at pages 331-344 of Design Patterns ,by Gamma, Helm, Johnson, & Vlissides, Addison-Wesley 1995, ISBN 0-201-63361-2 which are hereby fully incorporated herein by reference. Those skilled in these arts will recognize that various other implementations of these algorithms and concepts maybe developed without departing from the spirit and functionality of this invention. Additional background information can be found in
  • BDK business applications server may be described as follows, using the context of how a developer and user would use this portion of the system.
  • the developer's use is outlined in the context of a BDK development kit which would be provided by Applicants for use in developing applications which can run on the Platform and by way of indicating some details unique to the Platform through a description of a use of the Business Development Kit.
  • the Business Server embodies a development kit framework which provides a set of interfaces and classes in the form of Java packages, identifies certain services that developers can rely on, and defines an application development model.
  • the framework relies extensively on the server-side component model espoused by Java, namely Enterprise JavaBeans (EJB) components. Selection of EJBs as the server-side component model is driven in part by the requirements of reliance on open standards and backward compatibility.
  • EJBs also enables integration with other Java 2 Enterprise Edition (J2EE) technologies such as Java ServerPages (JSP) and servlets that one would intend to use for web applications development.
  • J2EE Java 2 Enterprise Edition
  • JSP Java ServerPages
  • servlets Java ServerPages
  • a number of EJB-enabled application servers available in the marketplace could be used to deploy the components so developed.
  • the BDK interfaces and classes address the following needs.
  • one of the facilities provided by the development framework is that characteristics of business objects can be varied across deployment. For example, for an attribute, one can optionally specify whether it has a required attribute, the list of values (LOVs) that the attribute can assume, its default value, and its minimum and maximum values. The values can be different across installations, as different customers have different requirements.
  • metadata about the business objects and their attributes is captured in the system.
  • some of the metadata that is currently captured about a class or an attribute could be dynamically determined using the Java reflection API. Examples include the parent ID and attribute count for business objects and attribute type for an attribute.
  • the Java reflection API provides classes Class and Field that can be used to retrieve such information.
  • instead of building a hashtable-based infrastructure for storing and retrieving attribute values one can use methods like set and get in the Field class to operate directly on the attributes, which are declared as member variables of the class.
  • SabaPlatf ormAttribute provides functionality for LOVs, default value, and minimum and maximum values.
  • the classes SabaPlatf ormClass and SabaPlatf ormAttribute themselves are beans — or, entity beans to be more specific — in this alternative embodiment system.
  • the classes SabaPlatf ormClass and SabaPlatf ormAttribute will not be used directly by users of business components (though developers of such components will use them). Typically, the user of these classes will be a class SabaPlatf ormObj ect.
  • SabaPlatf ormObj ect will make use of the functionality provided by these classes as part of an operation (e.g., when setting the value of an attribute, SabaPlatf ormObj ect will use SabaPlat f ormAttribute to determine the minimum and maximum value constraints). In other cases, SabaPlatf ormObj ect will delegate an operation directly to one of these classes (an example would be retrieving the superclass of an object).
  • SabaPlatf ormObj ect implements a set of methods for getting and setting attribute values that provide a centralized point for capturing the logic for such things as auditing and constraint checking, and are used by subclasses of SabaPlatf ormObj ect.
  • a component user will not interact directly with even SabaPlat f ormObj ect. Instead, the component user will deal with a specialization of either a SabaEntityBean or a SabaSessionBean, which are discussed in the next subsection.
  • EJBs will be a basic building block for developing applications using the BDK. Below we provide a brief overview of EJBs. Those skilled in these arts will understand that various books and documents on the "java.sun.com” web site provide additional details on this subject. There are two types of EJBs: 1. Entity Beans, and
  • Entity beans are used for modeling business data and behavior whereas session beans are used for modeling business processes.
  • entity beans could be SabaClass (a training class, not a Java class), SabaPerson, and SabaRegistrat ion. Entity beans typically would map to objects (tables) in the persistent data store. Behaviors associated with an entity bean typically would relate to changing the data in the bean.
  • An example of a session bean could be SabaRegistrar, which uses the entity beans mentioned above and encapsulates the business logic associated with certain tasks, such as registering for a class. Session beans are not persistent, though changes in data of certain entity beans or their creation or removal could result from the actions of a session bean.
  • a session bean can be stateful or stateless.
  • a stateful session bean maintains state information specific to the client using it, such that results of invocation of a method may depend upon the methods invoked earlier on the bean. (An example of a stateful session bean would be
  • SabaShoppingCart which would keep track of items in an order as they are being added, to be followed by either placement of the order or clearing of the cart.
  • This is typically done by storing client-specific data in instance variables of a bean, which are then used by the methods to accomplish their task.
  • a stateless session bean does not maintain any state specific to a client.
  • An example of a stateless session bean would be SabaTaxCalculator, which provides methods for computation of sales and other taxes.
  • the development kit would provide two abstract base classes: SabaEntityBean and SabaSessionBean. (Whether a session bean is stateful or stateless is indicated in something called a deployment descriptor.) These classes implement the j ava . e j b . Ent ityBean and j ava . e j b . SessionBean interfaces, respectively.
  • the intent is to provide a default implementation of certain required methods to enable rapid development of components, yet allow a component to override the default implementation of the methods it chooses.
  • the intent is to provide a default implementation of certain required methods to enable rapid development of components, yet allow a component to override the default implementation of the methods it chooses.
  • SabaEntityBean class provides default implementations of the following methods: ej bActivate ( ) , ej bPassivate ( ) , ej bRemove ( ) , setEntityContext ( ) , ejbCreate ( ) , ejbLoad O , ejbStore ( ) , and unsetEntityContext ( ) .
  • ej bActivate ( ) ej bPassivate ( )
  • ej bRemove )
  • setEntityContext )
  • ejbCreate ejbLoad O
  • ejbStore ejbStore
  • unsetEntityContext )
  • the SabaSessionBean class provides default (empty) implementations of the first four methods in the preceding Hst.SabaEntityBean inherits from SabaPlatf ormObj ect and provides attributes common to all the entity beans, (such as namespace) and has a method toXML ( ) that ensures that all entity beans will provide an implementation for serializing their data to an XML representation.
  • SabaEntityBean implements an interface ISabaXMLRenderable (explained later) and provides two convenience methods: findUsingRQL (String rql ) and f indUsingRQLURI (String URI ) to locate specific entity beans using RQL.
  • the remote interface is the external world's view of the bean and is comprised of the business methods that the bean wishes to expose.
  • the getters and setters for the bean's attributes are also exposed through the remote interface.
  • a developer must implement these methods by calling the getAttrVal ( ) and setAttrVal ( ) methods available in SabaPlatf ormObj ect to take advantage of services like constraint checking and auditing.
  • the home interface declares the life-cycle methods, such as those for creating, removing, or finding beans.
  • the development kit provides two interfaces ISabaRemote and ISabaHome, which a bean can extend for defining remote and home interfaces, respectively.
  • the ISabaRemote interface extends the standard EJB interface E JBOb j ect and provides the following sets of methods: • void setCustomAttrVal (String attr, ⁇ type> value) , and • ⁇ type> getCustomAttrVal (String attr) for Boolean, Timestamp, String, Integer, Float, and Double data types.
  • the I SabaHome interface provides a layer of abstraction over the standard EJB interface EJBHome.
  • the BDK also defines a class SabaPrimaryKey (a thin wrapper around the String class) which can be used by entity beans for defining primary keys.
  • One final interface defined in the BDK for EJBs is ISabaXMLRenderable. This interface extends the j a a . io . Serializable interface and defines a single method, t oXML ( ) .
  • the BDK would come with a few prepackaged beans.
  • One is a stateless session bean named SabaPlat f ormLogin that can be used to authenticate a user.
  • SabaNameSpace Another is an entity bean named SabaNameSpace, which encapsulates characteristics of a namespace, including its place in the hierarchy and the list of users who have access to entity beans in that namespace. The namespace is used for data partitioning and security purposes.
  • Another area in which the BDK provides support is relationships amongst entity beans.
  • relationships between different classes are arranged in four categories: inheritance, association, composition, and aggregation.
  • the inheritance relationship is captured by extending a subclass from a superclass.
  • the other three types of relationships entail constraints between the classes being related. For instance, a composition relationship implies commonality of life span (i.e., destroying the "whole” should result in destruction of the "components") and an association relationship implies referential integrity constraints (i.e., creating an instance of a class which refers to a non-existent interface of another class is not permitted).
  • such relationships can be captured through constraints in the database.
  • the BDK will provide a SabaRelationship class, that has attributes for the name of relationship, the type of relationship, the source class and attribute, and the destination class and attribute.
  • the SabaRelationship class will encapsulate lifetime management constraints implicit in each of the different types of relationships. Thus, if an object is being removed and it is declared to have compositional relationship with some other objects, the SabaRelationship class will ensure the removal of the related objects. Similarly, when creating an object, the SabaRelationship class will ensure that referential integrity constraints are being satisfied.
  • the SabaEntityBean class will delegate calls to the SabaRelationship class within its ejbRemove ( ) and ejbCreate ( ) methods. Any implementation that a component developer provides for these methods for a specific bean would have to call super . e j bRemove ( ) or super . e j bCreat e ( ) as appropriate.
  • an attribute capturing the list of relationships (where each item in the list is of type SabaRelationship) will be defined in the SabaEntityBean class.
  • SabaEntityBean level the list will be defined to be empty.
  • component developers create an entity bean by extending SabaEntityBean, they will be able to declaratively specify relationships between the bean being created and the other beans in the system. Additional relationships may be added to existing beans too when a new bean is created.
  • the declared relationships could also be used for navigational purposes within the object model.
  • the SabaRegistrat ion bean is related to the SabaClass bean, which in turn is related to the SabaLocat ion bean.
  • a new class, SabaCompositeRelationship will allow one to compose navigational paths in terms of basic SabaRelationship objects.
  • the SabaCompositeRelationship class will be able to fetch the destination object(s).
  • the BDK would provide a class Saba J2EEVendor that provides a wrapper around vendor-specific implementations.
  • SabaJ2EEVendor provides static methods that can be used to perform activities in a vendor-neutral fashion in SABA code.
  • An example method in SabaJ2EEVendor is getlnitialContext ( ) , which encapsulates the logic for getting an initial context (at present, the mechanism for this is vendor-dependent).
  • getlnitialContext ( ) An example method in SabaJ2EEVendor is getlnitialContext ( ) , which encapsulates the logic for getting an initial context (at present, the mechanism for this is vendor-dependent).
  • the BDK will provide implementations of this class for a few selected J2EE servers.
  • the BDK also provides the following utility classes that can be useful for developing components: SabaProperties, DateUtil, FormatUtil, LocaleUtil, SystemUtil, and Timer. Also, the following exception classes are supported: SabaException, SabaSecurityException, SabaFatal -Exception, AttributeNotFoundException, and SabaRelationshipViolationException. For logging purposes, the following exception classes are supported: SabaException, SabaSecurityException, SabaFatal -Exception, AttributeNotFoundException, and SabaRelationshipViolationException. For logging purposes, the following exception classes are supported: SabaException, SabaSecurityException, SabaFatal -Exception, AttributeNotFoundException, and SabaRelationshipViolationException. For logging purposes, the following exception classes are supported: SabaException, SabaSecurityException, SabaFatal -Exception, AttributeNotFoundException,
  • BDK provides a SabaLog class and for debugging purposes, the BDK provides a SabaDebug class.
  • the functionality provided by the foregoing classes is similar to that available currently.
  • a number of services are required by application developers to develop robust, flexible, and scalable systems.
  • a number of these services are provided by the commercially available application servers that host the EJB components, hi the following paragraphs we discuss the various services that an application developer can rely on and how these services might be used.
  • a client application (or a bean that relies on another bean) (Subsequent references to a client application should be interpreted to be inclusive of beans that rely on other beans) uses a naming service to first locate the bean and then interact with it, thus making no assumptions about location of any given component.
  • JNDI Java Naming and Directory Service
  • a client application would typically first get an "initial context" (driven by properties such as where to find the EJB server, somewhat analogous to the JDBC connect string for locating a database), and then using the context, look up the home interface of the bean by its name. Using the home interface, the client can find a specific instance of a bean, create a new instance, or remove an instance. The naming service would be used and the interaction would be the same even if the bean instance is present locally (i.e., exists in the same Java Virtual Machine) instead of being deployed on a remote machine.
  • the JNDI naming mechanism also obviates the need for the SabaClassRegistry mechanism that is used at present.
  • the client application looks for a bean by a name (say, Au t hentication). Any bean class that provides the implementation of the remote and home interfaces can be deployed against that name in the application server.
  • the default bean class SabaPlat f ormLogin can be deployed with a name of Authentication, whereas at some other installation, the bean class SabaLDAPLogin can be deployed with the same external name to use a different authentication logic.
  • EJBs One of the benefits of using EJBs is that component developers do not have to worry about persistence of data, as the container hosting the (entity) beans can manage such persistence.
  • Automatic persistence service provided by the application server enhances the productivity of bean developers, is more efficient at runtime, and allows the bean's definition to be independent of the type of data store used for persistence (e.g., a relational database or an object-oriented database).
  • a component developer will be responsible for declaring part or all of the attributes of an entity bean as persistent in its deployment descriptor, and then mapping them to fields in a database at deployment time. The interface and mechanism of such mapping would depend upon the application server being used.
  • the bean is automatically saved to the persistent store when it is created by a client application using the create ( ) method, and when the container decides to synchronize the bean's state with the database if the bean's data has been changed by the client application.
  • the container's decision is based on such factors as transactions, concurrency, and resource management.
  • the container will remove the data from persistent store when the remove ( ) method is called by a client on an entity bean.
  • a component developer does not have to worry about concurrent access to an entity bean from multiple fransactions (such as from several client applications). It is the responsibility of the container hosting the bean to ensure synchronization for entity objects. Indeed, use of the keyword synchronized is prohibited by the EJB Specification. Concurrent access for session beans is not meaningful, since by definition an instance of a stateful session bean can be used by only one client and stateless session beans do not maintain any data that needs to be shared.
  • fransactional attributes are separately declared in the bean's deployment descriptor (for a specific method, or as the bean's default) as one of the following six options: TX_NOT_SUPPORTED, TX_SUPPORTS, TX_REQUIRED, TX_REQUIRES_NEW, TX_MANDATORY, TX_BEAN_MANAGED. Details of these can be found in books on EJB.
  • each entity bean provides a method f indByPrimaryKey ( ) in its home interface.
  • finder methods which must be named in accordance with the pattern f ind ⁇ criterion>
  • container-managed persistence the container generates the implementations of such methods automatically at deployment time.
  • the mapping of finder methods to the database is vendor-dependent at present, though a standardized syntax for the same is a goal of EJB 2.0 Specification effort, hi the meantime, a developer can implement the finder methods in terms of f indUs ingRQL ( ) and f indUs ingRQLURI ( ) methods available in SabaEntityBean.
  • a component may be used by multiple applications in an interleaving fashion.
  • An application could have components distributed over multiple computers - how to assemble a unified log - use a "log server" bean - heavy performance price, impacts debugging class too.
  • an object model of the application domain should be first developed, retaining a separation between objects that represent business processes and those that represent business data.
  • the two types of objects obviously, map to session beans and entity beans in EJB parlance.
  • a controller object for instance, would indicate a session bean whereas an object that persists its data would indicate an entity bean.
  • An application would typically also include UI components (such as JSP pages or servlets) which would use such business components.
  • SabaPerson is a container-managed entity bean useful for explaining some basic concepts in EJBs and the BDK framework.
  • the Remote Interface public interface SabaPerson extends ISabaRemote ⁇ public String getFullName ( ) throws RMIException; public String getFirstName ( ) throws RMIException; public String getLastName ( ) throws RMIException; public void setFirstName (String name) throws RMIException; public void setLastName (String name) throws RMIException;
  • the remote interface provides the business methods or the world's view of the component. In our case, we have a single method that a client can use to get the person's full name. Also recall that ISabaRemote already declares setAttrVal ( ) and getAttrVal ( ) methods for manipulating the attribute values (such as f Name and IName declared in the bean class), so they don't need to be declared again.
  • the Home Interface public interface SabaPersonHome extends ISabaHome ⁇ public SabaPersonEJB f indByPrimaryKey (SabaPrimaryKey id) throws FinderException, RMIException; public Collection f indByName (String fName, String IName) throws FinderException, RMIException; public SabaPersonEJB create (String fName, String IName) throws Create ⁇ xception, RMIException;
  • the container automatically provides an implementation of the f indByPrimaryKey ( ) method and generates the code for other finders (such as f indByName ( ) ) from an external description, which pending EJB 2.0 Specification, is vendor-specific.
  • the Bean Class public class SabaPersonEJB extends SabaEntityBean ⁇ public String id; public String fName ; public String IName;
  • the bean class provides implementations for the business methods declared in the remote interface.
  • the fields in the bean class are declared to be public.
  • the EJB Specification require this for container-managed persistent fields.
  • this is also required by the setAttrVal ( ) and getAttrVal ( ) methods for fields that should be accessible via this methods (the methods use reflection to locate the fields).
  • the consequences of such visibility are limited, however, because the user of a bean only interact with the bean through the home and remote interfaces. It is not possible for a client to directly assign values to or retrieve values from such public fields without going through the accessor and mutator methods defined in the remote interface.
  • the deployment descriptor is an XML file that declares such things as container-managed persistent fields and security and transactional characteristics of the bean and its methods.
  • the following example shows part of a deployment descriptor.
  • the deployment descriptor is a text file with a somewhat different format.
  • the deployment descriptor is generally created using a GUI tool, generally supplied by EJB Server vendors. Additional information on deployment descriptors can be obtained from EJB literature and tool manuals.
  • EJB provides "hooks" or callback methods for implementing additional types of business logic.
  • ej bCreate ( ) and e j bPostCreate ( ) methods that one can use in a manner analogous to insert triggers in a relational database.
  • the method e j bRemove ( ) (implemented with an empty body in SabaEntityBean and SabaSessionBean) can be overridden to encode logic related to deletion of a bean. For example, if we wish to encode the logic that if a person is removed, all the class registrations for that person should also be removed, we can override the ej bRemove ( ) method within SabaPerson in the following manner. The e j bRemove ( ) method is called just prior to actual removal of the data from the persistent store. public void ejbRemove () ⁇
  • Collection regns (Collection) regnHome . findByPersonID (this . id) ;
  • fransactional integrity can be maintained as follows.
  • a session bean which, as part of its remote interface, has declared a method cancelClass ( ) that encapsulates the business process of canceling a class.
  • cancelClass encapsulates the business process of canceling a class.
  • the registration information is maintained by SabaRegistrat ion entity beans.
  • cancelClass ( ) besides updating some attribute of the SabaClass entity bean to indicate cancellation, we would also encode logic for finding the SabaRegistrat ion entity beans corresponding to that class and then removing them.
  • cancelClass ( ) besides updating some attribute of the SabaClass entity bean to indicate cancellation, we would also encode logic for finding the SabaRegistrat ion entity beans corresponding to that class and then removing them.
  • either all these activities must succeed atomically, or no change to persistent store should be made (i.e., the activities constitute a transaction).
  • complex data types can be persisted for container-managed entity beans as follows.
  • entity bean with an attribute that has an array of strings as a data type. Since relational databases do not support such a data type, one cannot directly map the attribute to some column in a database. However, at save time, one can potentially convert the array into a single String by concatenating the elements within the array and using a marker character to delineate various entries. Then, at retrieval time, one can look for the marker character and reconstitute the array.
  • Entity beans provide two callback methods, e j bS t ore ( ) and e j bLoad ( ) that can be used for such a purpose.
  • SabaEnt ityBean by default provides empty implementations of such methods. An application developer can override these methods within the definition of a bean and thus persist complex data types.
  • every class in an application does not have to be a bean. Indeed, with the overhead of locating a bean through a naming service and going through the home and remote interfaces of a bean to perform useful work would negatively impact performance (though some servers will optimize the process for beans located within the same virtual machine).
  • the apphcation developers can implement selected classes as helper classes and not as beans.
  • Sun Microsystems' J2EE Application Programming Model identifies certain instances where helper classes are applicable.
  • One such example is dependent classes that can only be accessed indirectly through other classes (beans).
  • Sun's J2EE APM offers Credi tCard and Address classes as examples of a dependent classes.
  • EJBs are packaged as EJB jar files that are comprised of the .class files for the bean class, the home interface, the remote interface, the primary key class (if applicable), in addition to the deployment descriptor and a manifest.
  • the jar file can be created using the j ar application supplied with JDK, or by using some GUI front-end utility provided by the J2EE server being used.
  • the deployment mechanism varies with the servers. For Weblogic server, an entry can be made in the weblogic . properties file; for Sun's reference implementation, the deploytool utility can be used to achieve this in an interactive manner.
  • the EJB Specification does not provide a mechanism for declaring such constraints, and this would have to be achieved programmatically in the create ( ) and mutator method(s) of the entity beans.
  • JNDI To locate the bean, JNDI is used. There are some variations in how JNDI calls are used with different EJB servers. Here we use the getlnitialContext ( ) method in the SabaJ2EEVendor class for locating the SabaRegistrat ion bean.
  • InitialContext ctxt
  • the Platform's BDK 519 provides an extremely powerful model for assigning security; that is, defining the sets of allowed operations that groups of users can perform. It supports both extremely sophisticated definitions of an allowed operation and a scalable model for assigning and partitioning security. Specifically, the following features are provided:
  • Security operations can be specified according to either the general class of business object or to specific, individual business objects.
  • a Security List Member is any entity that can be assigned privileges in the system. Members can be can be individual users of the system (employees or customers); they can also be associated with generic roles, such as a system administrator, or even an automated process, such as an Interconnect ChangeManager.
  • a Privilege is a set of one or more possible security operations. There are several types of privileges as shown below in Table 1:
  • the Platform 501 supports several pre-defined atomic privileges that apply to all business objects.
  • the pre-defined atomic privileges are shown below in Table 2.
  • the following simple example shows a three-domain organization, with a root "World” domain and two child “US” and "Europe” domains.
  • All business objects are assigned a specific domain and belong to that domain.
  • security privileges are assigned on specific domains.
  • the domain hierarchy is automatically enforced during security checks. This means that users who have access to a domain can access objects in that domain, and that users who have access to ancestors of a given domain also have access to objects in that domain.
  • Extensions to the basic domain model may include the ability to define multiple, independent domain axes. For example, one domain hierarchy might be based on geography, another on business function.
  • Security Lists are the mechanism by which members are matched with privileges.
  • a Security List defines a set of domain-specific privileges and a set of list members. Security Lists are created in a two-step process as follows:
  • a set of privileges are added to a security list, where each privilege is applied to a specific domain.
  • a privilege within a security list - that is, a privilege applied to a specific domain - is known as a "granted privilege.”
  • the Persistence Layer of the BDK 519 automatically takes account of the predefined atomic privileges (new, view, etc) in its behavior. Thus, search results using standard finders will only return objects for which a user has view privileges, and update operations for which a user does not have privileges will automatically throw a Security exception.
  • the BDK 519 provides the ability to explicitly query the security model using the API described below.
  • the BDK 519 provides a Java-based API for managing security. As described in the BDK section, this API uses an EJB-style session manager named "SabaSessionManager" and a set of helper classes.
  • the API includes:
  • IComplexPrivilege A structured privilege, capable of grouping other atomic or complex privileges.
  • public interface IComplexPrivilege extends IPrivilege, IHandle;
  • ISecurityListMember is any interface that can be a member of a security list, including IRole, IParty (IPerson or IOrganization) , or IGroup public interface ISecurityListMember extends IHandle;
  • ISecurityList matches granted privileges to a set of members public interface ISecurityList extends IHandle;
  • a set of concrete classes capturing the available privileges in the system are application-dependent; i.e. there are one set of classes associated with the Learning application built on Platform, another set associated with the Performance application, etc.
  • SabaSecurityManager extends ISabaRemote ⁇ /* methods for creating and updating security lists */ public ISecurityList createSecurityList (SecurityDetail detail); public SecurityDetail getDetail (ISecurityList theSecurityList) ; public void update (ISecurityList theSecurityList, SecurityDetail detail) ; public void remove (ISecurityList theSecurityList);
  • the following code fragment demonstrates how the Security API can be used to create a new security list, assign users to that security list, and check privileges for that user. Note that this code example uses several other session bean managers, such as a DomainManager and PartyManager, provided as part of Platform.
  • ISecurityList securityList theSecurityManager .createSecurityList (theDetail) ;
  • Step 2 grant privileges by adding them to the list */
  • IComponent classesComponent theComponentManager.getComponent ( "Classes") ;
  • Step 4 check a user's privileges */
  • ComponentPrivileges ComponentPrivileges .kEdit, classesComponent
  • boolean canEditClasses theSecurityManager .hasPrivilege (member, editClassPriv, domain)
  • member, editClassPriv, domain ComponentPrivileges .kEdit, classesComponent
  • boolean canEditClasses theSecurityManager .hasPrivilege (member, editClassPriv, domain) ;
  • the Platform's BDK security API focuses on the database structures and SQL used to store and query security information. It also touches on the algorithms used in implementing the Java API.
  • Information related to security is stored database tables as shown below.
  • the Platform's BDK Security System uses Java code to read and write values to these database tables.
  • fgt_domain stores all domains as shown below in Table 6.
  • fgt_ss_privs stores all atomic privileges as shown below in Table 7a.
  • Table 7b fgt list stores all security lists as shown below in Table 8a.
  • Table 8b fgt_list_entry stores all members of a security list as shown below in Table 9.
  • Table 9 fgt_ss_grants stores all granted privileges as shown below in Table 10.
  • the following row from Table 10 describes a grant that allows members of the "Users” security list to create and view orders, but not edit or delete them.
  • the "ddcls" prefix (for "data dictionary class") on the granted_on_id value indicates that this OBJECTID refers to a business object class.
  • the 1 st and 6 bits of the privs flag are on, providing create and view privileges only.
  • the Platform's BDK Security System also utilizes an addPrivilege () method.
  • the addPrivilegeO method has different logic depending on whether a row already exists in fgt_ss_grants for the combination of security list, business object, and domain. If a row exists, it retrieves the existing row, sets the additional bits defined by the IPrivilege parameter, then updates the row. If no row exists, it creates a empty privilege bitmap, sets the bits defined by the Privilege parameter, then inserts a row.
  • the Platform's BDK Security System also utilizes an hasPrivilege() method.
  • the addPrivilege () method executes a SQL query to return all privilege bitmaps for each security list the user belongs to that match the target object and domain parameters. It iterates through each bitmap and returns true if the privilege has been set in any one.
  • the SQL query that is executed is:
  • the BDK Persistence layer also contains code that directly accesses these database tables to check security privileges.
  • a utility class, SabaPrivileges contains a hasPrivs() method that is called at predefined points by the SabaObject and SabaEntityBean implementations, including whenever objects are saved and restored. This method has the following signature:
  • SabaPrivileges contains a Java hashtable that caches privilege for each business object in the system.
  • the hasPrivs() method iterates through these privileges to look for a match, using logic similar to the SabaSecurityManager.hasPrivilegeQ method.
  • the SQL used in this query has two unique features:
  • the Web Content Server 800 enables the present invention to interact with users regardless of the users hardware platforms, locations, and software systems.
  • the Web Content Server 800 allows the present invention to overcome the difficulties of prior art systems associated with having an infrastructure which is tightly coupled to application products, specific hardware platforms and specific
  • the Web Content Server 800 can allow the present invention to interface with many other industry standard software programs to make the exchange and flow of data easy and accurate, and enables interconnection with external systems, special networks, like SabaNet, and the Internet.
  • the Web Content Server 800 is web-enabled and provides a unified set of interfaces for interacting with web based users as well as other users.
  • the Web Content Server 800 can also allow vendors/developers to develop applications on the Platform, make use of core technology for information matching and distribution, and provide standardized access to connectivity with other systems and platforms in a users network.
  • an Web Content Server 800 provides an interface between users 802, 804, and 806 and the Platform.
  • Content Server 800 preferably includes an engine 808, style sheet control system 810 for various user display protocols, a JAVA Virtual Machine 812 and the related runtime support.
  • the Style Sheet Control System 810 contains mechanisms to manipulate various kinds of display style sheets, to generate and execute web links, to manage dynamic content generation and dynamic generation of Javascript.
  • the Style Sheet Control System 810 also can allow vendors/developers to modify, add, or delete the mechanisms in the Style Sheet Control System 810. Thus, vendors/developers can customize the presentation of data to the users. USER GENERATION OF WEB CONTENT
  • Web Content Server 800 can also provide the platform's web content generation engine for use by users to create, render, and present web content while improving the dynamic acquisition of data from a variety of sources followed by its reformatting and display via style sheets.
  • Web Content Server 800 uses web standards for XML and XSL, Web Content Server 800 provides a user with a customizable framework for decoupling data from presentation, and generating web content in a variety of formats, from standard HTML to WML.
  • the Web Content Server 800 provides a "page engine” 808 which allows users (such as developers, consultants and customers) to build web content using a separation between Model, Widget, and View instructions.
  • the engine 808 separates data production, interaction elements and display information, and maintains these aspect of page production in different files.
  • the engine 808 supports three components: (a) Widgets, which are reusable interactive components such as buttons and data entry fields; (b) Models, which encompass the data and user operations used by the application (Data can be simple Strings or complex objects); and (c) Views, which use style sheets to define and control the presentation of output to the user.
  • Widgets which are reusable interactive components such as buttons and data entry fields
  • Models which encompass the data and user operations used by the application (Data can be simple Strings or complex objects); and
  • Views which use style sheets to define and control the presentation of output to the user.
  • Using the system 808 provides, among other things, the following advantages for a user: Improve maintainability of web content.
  • Partition web content development between users (such as component developers, Java developers, and UI developers).
  • the engine 808 uses XML, XSLT (extensible Stylesheet Language Transformations), and RDF (Resource Description Framework), built round a publishing framework called Cocoon to enable the functionality of Web Content Server 800.
  • XML XSLT
  • RDF Resource Description Framework
  • Tools included with the platform 808 help users perform the following activities: (a)
  • Authoring - users need to create and maintain control files, model files, widget files, and view files; (b) Debugging - the process starting with obtaining data and ending with viewing is involved so having tools or methods for debugging problems is essential; and (c) Customization - customizing the final product can certainly be accomplished with the tools used for authoring and debugging, but additional tools can radically simplify tasks like product upgrades or performing simple customizations.
  • the platform 808 allows content, logic and style to be separated out into different XML files, and uses XSL transformation capabilities to merge them resulting in the automatic creation of HTML through the processing of statically or dynamically generated XML files.
  • the platform 808 can also generate other, non-HTML based forms of XML content, such as XSL:FO rendering to PDF files, client-dependent transformations such as WML-formatting for WAP-enabled devices, or direct XML serving to XML and XSL aware clients.
  • the platform 808 divides the development of web content into three separate levels: (a) XML creation - The XML file is created by the content owners.
  • This layer can be performed by users directly, through normal teeditors or XML-aware tools/editors;
  • XML processing The requested XML file is processed and the logic contained in its logicsheet is applied. Unlike other dynamic content generators, the logic is separated from the content file; and
  • XSL rendering The created document is then rendered by applying an XSL stylesheet to it and formatting it to the specified resource type (HTML, PDF, XML, WML, XHTML, etc.).
  • the Web Content Server 800 can be based on XML, XSLT and Java technologies. Using these technologies, the Web Content Server 800 allows for easier user interface customization, more flexibility in page functionality, easier page maintenance and the creation of more easily reusable code. It encourages the separation of data production, interaction elements and display information by separating different aspect of page production in different files.
  • the Model contains all the data and interactivity for a given page. Users are responsible for generating an XML page containing the raw data they wish to display, independent of the appearance of that data or any additional presentation information.
  • the Model can be implemented using a dynamic page engine (JSPs or
  • API 808 provides a variety of helper tagsets to automate common scripting operations, minimizing the amount of custom scripting required by a user.
  • Model Developers are typically Java programmers, since the bulk of development effort is implementing a companion Java Bean that invokes the appropriate SABA Manager API. They then use the dynamic features of the engine (tag libraries and Java scripts) to place data from the bean onto the page.
  • the View contains all style and presentation for a given page. Users are responsible for implementing an XSLT stylesheet that transforms the model into a specific presentation environment. View developers are typically UI designers, since the bulk of authoring effort is crafting the HTML for a static page, then adding in the set of XSLT tags to create a stylesheet for the associated model page.
  • Widgets are a set of predefined UI components and presentation elements common to web applications. Widgets can have user interactivity (fields, links) or be presentation only (images). Widgets can be implemented as XSLT stylesheets.
  • the platform 808 includes a predefined set of common widgets that can be used by both model and view developers. Note also that developers have the option of overriding the default widgets to provide enhanced or custom functionality if required.
  • tag libraries are used in the model and are an aid to dynamic content generation
  • widgets are used in the transform step and are an aid to end-content generation.
  • Tag libraries can be implemented in Java, whereas widgets are preferably implemented as stylesheets.
  • Figure 8B shows how the engine 808 processes/uses these files to produce dynamic web content.
  • the process of creating the HTML to send to the browser begins with reading the control file, 860.
  • the control file 862 is simply a file that identifies the model file 864, the view file 866 and the widget library 868 to use to produce the final HTML result 870.
  • the control file 862 also contains link transformation information that is used to transform links used in the model file 864. This link transformation is used to map model-file hyperlink references contained in the model file 864 to appropriate control file names.
  • the model file 864 is loaded and preprocessed based on the information contained in the control file 862.
  • the preprocessed model file is executed in three steps. In 872, any tags from the tag library are processed.
  • the tag library includes tags for internationalization, command invocation and widget management.
  • the resulting XML file is then further processed to generate a Java class.
  • the Java class is executed to produce the model instance 878.
  • the model instance 878 contains all data and other information needed for display.
  • the model instance 878 will contain the XML form of the data retrieved by the Commands invoked in the model page and it will contain all internationalized labels and widgets.
  • the model instance 878 is first transformed using the widget library 868.
  • the result of the widget transformation is then further transformed using the view transformation file 866 to produce the final result 870.
  • the process outlined above also highlights how the different aspects of developing dynamic web content are separated.
  • the design of a particular web page is the result of answering the following questions: (a) What do I do with parameters sent from the browser and what data is needed to display the page? How do I perform these tasks? (b) How will the user interact with the page? What buttons, entry fields etc. will the user have? and (c) How are the data and the interaction elements displayed on the page?
  • the answer to question (a) results in the model page and the Command objects used by the model page.
  • the model page invokes all needed Commands to perform the tasks of the page and to produce the data needed for display.
  • the answer to question (b) produces a listing of all widgets and their linkages to the data being displayed. Although this list is part of the model page, the list of widgets and their linkages are all declared in a clearly identifiable part of the page.
  • the answer to question (c) produces the view transformation page.
  • the page development process starts with an HTML ockup of the page.
  • the Web Content Server 800 development process can start with the HTML mockup as well. However, users do not modify this mockup to include code. Instead the process illustrated in Figure 8C is followed.
  • the data model specification 886 is developed to meet three basic criteria.
  • the data model needs to contain enough information to drive the interface. For example, if the interface needs to display the name of an object, then the data model must contain the object name in some form.
  • the data model specification should maximize reuse of command objects. For example, if a command object already exists that can retrieve a needed object in a serialized XML format, then the data model of the command object should be reused instead of adopting a new XML representation of the same object.
  • the data model specification should be generic so other pages can reuse the model generation components (Commands).
  • the data model specification 886 should essentially be a sample of the data returned by the Command objects and the specification XML should be wrapped in tags.
  • the widget specification 888 is a list of widgets needed by the page.
  • These widgets include input fields of all types (textboxes, radio button collections, check box collections, dropdown lists, hyperlink buttons, etc.).
  • the specification 888 can also include how these widgets relate to the data model. For example, the page may require an edit button widget for every object it displays. The widget specification 888 can therefore indicate that the edit button is "attached to" those objects.
  • the widget specification 888 can be very incomplete, because users (such as view developers) will typically only need the name of the widget for layout purposes. The widget library will take care of rendering the widget itself.
  • the third specification is the specification of internationalized items 890 (labels, graphics).
  • the specification 890 includes a list of all labels and images used on the page.
  • the specification 890 contains just the name of the label and some sample text for the label.
  • the user or a tool produces a sample model instance 892.
  • the user can use the model instance 892 to test the view stylesheet (by using any standard XSLT tool).
  • the user develops the view stylesheet by converting the original HTML mockup to an XSLT stylesheet to retrieve dynamic data, widgets and internationalized labels from the model instance. This conversion process can mostly be done in an HTML editor.
  • the user can edit the view page in an HTML tool.
  • the user can add ⁇ span>, ⁇ div> etc. tags around the components needed modification, and define the "style" attribute to reflect the desired look and feel changes.
  • the user can wrap the components in ⁇ u>, ⁇ b>, ⁇ font>, etc. tags as needed.
  • Layout changes The cut/copy/paste commands of the HTML editor can be used to perform most layout changes requiring the repositioning of different components.
  • Dreamweaver for example, gives users powerful HTML/XML element selection capabilities that make it easier to move and copy whole HTML/XML document fragments. Adding/removing information content
  • the model specification will result in the production of more content than needed by a particular view.
  • the model for a page that needs to display the parents of a particular security domain only may also produce other information about the security domain (e.g., the description of the domain). This is especially likely when the model page reuses other, already existing command objects. In such cases displaying additional content can simply be done at the view page level: the user needs to place the newly required information somewhere on the view page. Removing information items is also very simple, since users can simply delete a particular HTML/XML fragment if viewing that piece of the model is not needed.
  • Adding a new widget means adding a new widget to the widget section of the model page AND changing the view page to include the new widget. Since the widget section is a separate section of the model page, software engineers (and perhaps UI engineers) can make the required change without disturbing/interfering with any other part of the model page.
  • Components of the platform 808 The control page associates a particular model page, view page and widget library.
  • the model page produces the data needed for displaying the page and it also defines the widgets (interaction elements, such as links, buttons, input fields, etc.) and internationalized resources (labels, graphics) used by the view page.
  • the model page has a well defined structure.
  • Model pages can produce XML representation of data using command managers and command objects.
  • a model page can invoke a command using a tag. After the model page is executed, the tag will be replaced with the XML data produced by the selected Command.
  • the model instance is the XML document produced by executing the model page.
  • the view page displays the data and widgets contained in the model instance (i.e. the XML document produced by executing the model page). If the control page declares a widget library to use, then the view transformation takes place after the widgets have already been transformed to the appropriate format (e.g. HTML).
  • the widget library contains the display transformation for widget components.
  • the model page executes the produced widgets are transformed to the appropriate output format (e.g., HTML).
  • the resulting HTML markup is wrapped in tags so the view transformation page can easily identify and place each widget.
  • the tag library contains tags users can use in their model pages to access common code functionality. This common functionality includes accessing resource bundles, retrieving page parameters, executing commands, declaring widgets, etc. Control Page
  • any platform 808 page is an XML document that serves as a controller.
  • This page is simply an XML document that points to the model, view, and widget documents. This convention creates a clean decoupling between the three constituent pages.
  • web content administrators may substitute a different control page in a deployment environment; this allows them to use the same model while modifying just the view. Coding Guidelines
  • Pages built using the platform 808 employ certain conventions and coding guidelines to ensure consistent operation and simplify some processing steps.
  • All model pages must contain a head page element that defines some information specific to the model. It is used to capture the following: required metadata about input and pass-through parameters values of il8n labels. The convention is that all il8n values are obtained via the il8n utility tag in the model page; this information is then passed on to the stylesheet in a predetermined location within the wdk:head element page title and other useful information about the page.
  • Widget stylesheet The widget stylesheet is simply a list of xsl: includes of the widgets used on this page. The widgets can be from the set of predefined widgets or can be customized widgets.
  • the Web Content Server 800 is a dynamic content generation framework based on the apache Cocoon project. Like other approaches, such as JSP, ASP, ColdFusion etc., the Web Content Server 800 would allow developers to create web pages to display data derived dynamically through some business logic. Unlike other dynamic content generation frameworks, the Web Content Server 800 separates the content from its presentation. This separation makes it easier to customize pages, to provide different versions of pages to different user agents (desktop browsers, handheld devices, etc.). Content production and presentation separation is achieved by following a
  • Model- View- Widget (MVW) paradigm In this paradigm three distinct components are responsible for generating the final output sent to the client (desktop browser, WAP phone, handheld device).
  • the model page is responsible for producing the content as well as the user interaction components (widgets). Widget look and behaviors are added during the widget transformation.
  • the View transformation provides the look and layout for the content and widgets produced by the model page.
  • File Loading algorithm When the Cocoon engine processes the HTTP request, it invokes the getDocument() method of the file producer registered with Cocoon.
  • SabaSite is an object containing a set of properties relevant to a particular saba application. These properties include, but are not limited to:
  • the SabaProducerFromFile uses the request URL to identify the file requested.
  • the getDocument method of this class performs the following steps:
  • the SabaSite is identified as follows: a. Extract the servlet path information from the request object using the HttpServletRequest API (getServietPath()). b. If the servlet path ends with a Web Content Server 800 specific string suffix, then the associated SabaSite name is determined by stripping of that suffix. c. If the servlet path does not end with the Web Content Server 800 specific string suffix, then the system default SabaSite name is retrieved using the SabaSite API. d. The SabaSite is retrieved using the SabaSite API e. Finally the SabaSite is initialized using the request object
  • control file is an RDF document that ties the above-mentioned three components of the Model-View- Widget paradigm together.
  • the control file contains a Cocoon processing instruction (line 2) that is parsed by the Cocoon engine.
  • the cocoon engine uses the processing instruction to look-up the processor it needs to use to process the document.
  • the control file processor performs the following steps:
  • the control file processor returns the document object model containing all these updates, and the Web Content Server 800 engine then processes this DOM. Identifying model, view and widget file
  • the control file contains the following three properties for encoding the three files:
  • • wdk:model: the rdf resource attribute of this property is the path to the model file. (See line 8 in the example above.) • wdk:view: the rdfiresource attribute of this property is the path to the view file. (See line 9 in the example above.) • wdk: widget: the rdfiresource attribute of this property is the path to the widget file. (See line 10 in the example above.)
  • the control file processor inserts another processing instruction:
  • Cocoon engine to use the Web Content Server 800 specific XSLT transformer for the transforming steps (see section below on custom XSLT processor). Furthermore, two ⁇ ?xml: stylesheet ...?> processing instructions are also inserted in the document object model following the above processing instruction.
  • “href data component of these instructions identifies the widget and view stylesheets in that order.
  • the Web Content Server 800 specific XSLT transformer will process these two processing instructions to perform the XSL transformations.
  • Model pages typically contain links that allow the model page to invoke another page, hi order to make model pages reusable with different view pages, page references in a model page always refer to other model pages. This way different confrol files can reuse the same model page but use two different view pages.
  • links pointing to model pages have to be transformed to control page hyperlinks before the final document is produced, since the request URL has to contain information about the control file and not the model file.
  • the control file contains information about how to map a model page reference to a control page reference.
  • the control file contains a single wdk:links element, which contains a number of wdk:link elements. Each wdk:link element has two attributes: model and control.
  • the model attribute is the hyperlink name of a model file, while the value of the control attribute is the hyperlink name of the confrol file.
  • the control file processor locates the wdk:link and wdk:links elements in the control file DOM using the standard DOM API. Once all wdk:links elements are located, the control file processor inserts a wdk:linkMap element in the wdk:head element of the model DOM, and then inserts one wdk:linkMapEnfry for each wdk:link found in the control file using the DOM API.
  • the wdk:lihkMapEntry element has the same attributes as the corresponding wdk:link in the control file.
  • mapping information is made available in the model page, and can be used by either the model page itself or the subsequent widget and view transformations.
  • the wdk link widget makes use of this information to transform model page references to control page URLs.
  • the following code sample shows the XML serialized version of a model file before the ControlFileProcessor updated the DOM.
  • Session sabaSession SessionManager.getSession(sessionKey);
  • This processor adds the following capabilities:
  • the Web Content Server 800 XSP processor can produce intermediate files representing the documents as the model page is transformed from its original form to the Java code that is executed and the actual data that is produced by the Java code. These intermediate files can be inspected to locate the source of a problem more easily.
  • the SabaXSPProcessor can produce intermediate files as the model file goes through the different transformation steps.
  • the helper classes XSPDebugger and DebuggerConfig are used to control which if any intermediate files should be produced. The following properties are introduced in cocoon.properties for controlling debugging behavior:
  • the wdkdebug property can have the following values: • off: No debugging information is produced
  • model Outputs the result of executing the Java code produced from the model page.
  • the wdkdebugoutput property can have the following values:
  • the wdkdisablecache can either be "true” or "false”. If true the cocoon cache is not used.
  • the init method of the SabaXSPProcessor creates an instance of the
  • the XSPDebugger is a subclass of Debugger and it uses the
  • DebuggerConfig object to read the debugger configuration from the cocoon.properties file.
  • the Debugger has the following API: public void readParameters(Dictionary parameters, DebuggerConfig config);
  • the method returns true if the wdkdebug property is either "full” or matches the rui e parameter. protected boolean browserOnlyQ ;
  • the method returns true if the wdkoutput property is set to
  • the XSPDebugger introduces the following methods: public boolean debugLogicsheet(String rule, Document document);
  • Debugger .browserOnlyO is true. If only Debugger.debugThis(rule)is true, then first saves the intermediate result before returning false.
  • Custom XSLT processor The default XSLT processor that comes with Cocoon performs a single
  • Web Content Server 800 requires two XSL transformations after the Java code produces the data. The first transformation replaces the widgets with their HTML representation (the widget transformation) while the second transformation renders the data (the view transformation).
  • processor . type . wdk_xsl com . saba . web . engine . WDK_XS TProces sor
  • the Web Content Server 800 XSLT processor takes as input the document object model produced by executing the XSP page.
  • the processor extracts the xmkstylesheet processing instructions from the DOM, and executes XSL transformations using the stylesheet documents referred to by the "href data element in the processing instructions.
  • the xmkstylesheet processing instructions were inserted in the source document by the control file processor - see the ControlFileProcessor algorithm section for details).
  • the DOM is serialized and saved to a text file.
  • Each XSP page (model page) is transformed to a Java object (source code generated, compiled and the class is loaded).
  • the generated java objects are instances of the SabaXSPPage class, which is a subclass of the XSPPage class.
  • the XSPPage class is the default class provided by Cocoon.
  • This method initializes protected site and logger variables. (See below)
  • Model pages are Extensible Server Page (XSP) pages.
  • XSP pages can contain a mix of static content and content generating programming logic by using xsp directives (tags) defined in the xsp tag library.
  • tags xsp directives
  • an XSP page can make use of an indefinite number of application specific tag libraries.
  • a Web Content Server 800 model page uses the wdktags tag library to simplify certain common programming tasks.
  • Web Content Server 800 model pages have a very well defined structure.
  • the document element of the page is ⁇ xsp:page>.
  • the document element can contain ⁇ xsp:structure> and other xsp directives, but it can contain a single non- xsp element only.
  • the wdk:page element consists of the following subsections:
  • wdk:form - The wdk:form element is one of the elements in the widget library. Since most wdk pages are HTML forms, the wdk:form element is used to generate the HTML form and javascript functions required by a Web Content Server 800 application. For example, a javascript function is generated that can be called by link widgets to submit the form.. • wdk:widgets - widgets (input fields, buttons, hyperlinks, etc.) are all listed in the wdk:widgets section.
  • the wdk: form element can contain the declaration of hidden fields needed by the application, and it contains a singe wdk:model element.
  • the wdk:model element contains all "data" generated by the page.
  • model pages An important property of model pages is the ability to generate/declare dynamic content (through commands) and interaction elements (widgets) independently of each other. This separation of content and widget generation allows for greater reusability. However, at the end of all the processing, the widgets and the content have to be combined. For example, an input text field (a widget) and the "name" property of a business object have to be connected/combined some way to make sure that that particular text field can display that particular property. This connectivity between model elements and widgets is achieved by Web Content Server 800 tag library tags.
  • the wdktags:attachTo tag can be used to "attach" (copy) a particular widget to a model element.
  • a software engineer may author the following simple model document:
  • Line 1 specifies the match condition: this template will match any element that contains a wdktags: attachTo sub-element.
  • Section 2 contains XSL logic for determining what root element should be used as the starting point for the value of the path attribute. If the developer specifies a root attribute, then the value of that attribute is used, otherwise the root element defaults to the wdk:model node of the model page.
  • Section 3 invokes the getNodes() method on the WDKDomUtils class. That method returns the set of nodes that can be accessed from the root node through the path given in the path attribute of the wdktags: attachTo directive.
  • Section 4 checks for error conditions and sets up the iteration through the set of DOM elements returned in section 3.
  • the current xsp node (the value of the xspCurrentNode variable) is saved on a stack, and its value is replaced with the next node from the set of nodes returned in section 3. Since the XSP processor uses the xspCurrentNode variable to mark the current "insertion point" - i.e. the location where the next DOM node will be inserted in the
  • Line 1 specifies the match condition: this rule matches every nodeRef tag.
  • Section 2 determines the root node: if the source attribute is given then the value of that attribute is used, otherwise the value of wdkwidgetNode Java variable is used.
  • the wdkwidgetNode variable is initialized in the wdktags: attachTo template described above. This way, if nodeRef is used in the context of an attachTo tag, the root node is the same node the widget is copied to. The actual node whose value is needed is located by following the path from the root node.
  • the text value of the node is computed by calling the WDKDomUtils.get ⁇ extvaiue() method.
  • View pages are XSLT stylesheets.
  • the role of the view stylesheet is to convert the XML document produced by executing the model file (and the subsequent widget transformation) to a format understood by the user agent. For example, for desktop browsers this typically means conversion to an HTML representation.
  • model pages have a well-defined structure, view pages are also highly regular. For example, there are a number of model page elements that should not be rendered (such as wdk:head element and its content should not be copied to the output).
  • Other model pages nodes have a standard representation in HTML (or in the desired output format). For example, the rule for rendering wdk:page is to generate the ⁇ html> element, the ⁇ head> element containing the ⁇ title> element.
  • Section 1 defines the namespaces used in the stylesheet.
  • Section 2 defines the root level template. This template produces the html tags, and generates the html head element complete with the title element.
  • Section 3 defines the default template: every element, attribute, text and comment is copied to the resulting document, unless a more specific template provides different instructions. Section
  • Section 4 specifies a template for eliminating the wdk:head and wdk:widgets elements and their contents (since the contents of these tags should not be rendered using the default template defined in section 3).
  • Section 5 introduces a template for transforming every widget by wrapping them into a span element replacing the wdk:widget "wrapper". This makes it possible to use CSS styling on a per named- widget basis.
  • section 6 defines the template for processing the wdk:page element.
  • Section 2 imports the stylesheet containing the default templates.
  • Line 3 defines the rule for processing the wdk:model node.
  • Line 4 displays the title of the page by accessing the wdk:title tag inside the wdk:head tag.
  • Section 6 iterates through each "parent" element inside the wdk:model element and displays its name. In section 7 any widget produced by the model page is displayed.
  • the wdk taglibrary The wdk taglibrary
  • the wdk taglibrary contains a number of tags to simplify the development wdk model pages.
  • the tag library includes tags for: • handling resource bundles for page internationalization,
  • processor.xsp.logicsheet.wdktags.java s:/sys/java/web/com/saba/web/xsl/taglib/wdk_taglib.xsl
  • the taglibrary stylesheet contains a number of xsl. ⁇ mport directives to import templates responsible for implementing subsets of tags and it also contains a number of default templates, as the code example below shows:
  • the wdktags-.param is one of the tags defined in the wdk tag library.
  • the purpose of this tag is to simplify the extraction of parameters from the HttpServletRequest object.
  • JSP, XSP or servlet programmers have to write a number of lines of code for the parameters they want to process.
  • the code for each parameter is typically similar to the following:
  • the wdktags :param tag intends to simplify this by allowing developers to declare what parameters they want to use in the model page, and the mundane task of extracting the parameter is performed by the tag itself.
  • Web Content Server 800 developer can write the following in the ⁇ wdk:head> section of the model page:
  • Each parameter can be defined with a single line of XML code and as a result of this line the developer can use a Java variable named "param" in their code wherever the value of the "param” HttpRequest parameter is needed.
  • the wdktags:param tag is implemented in wdk_param.xsl, and is imported by the main taglibrary stylesheet. The following code shows the implementation of wdktags :param:
  • Section 1 declares all namespaces used in the stylesheet.
  • the match condition is given for the template. This template matches on every wdktags:param tag inside a wdktags ⁇ n tag. This nested condition is necessary, because a different template may transform wdktags:param tags inside the wdktags:out tag.
  • Section 3 computes the values to use for parameter type and parameter default value. These values are either determined from the values of "type” and "default" attributes of the wdktags:param tag, or default values are selected (the Java String class for type, and the Java null constant for default).
  • Section 4 produces the Java code declaring the Java variable by the name given in the "name" attribute of the param tag, and the value is initialized either from the HttpServletRequest object or by using the default value computed in line 2.
  • Tags defined in the Web Content Server 800 tag library
  • wdktags:param Provides a convenient method for declaring and using parameters passed in through the HttpServletRequest.
  • wdktags :siteRef Generates an absolute URL from a relative URL based on the current site information.
  • wdktags:il8n.load Declares the il8n resource bundle to use for the labels in the page.
  • wdktags:il8n.path Generates internationalized image path information using site parameters and information from the resource bundle specified by wdktags:il ⁇ n.load.
  • wdktags:il8n.label retrieves internationalized labels from the resource bundle specified by wdktags:il 8n.load.
  • wdktags:repeat Provides the capability to replicate widget components based on elements in the generated model. Used mainly by list widgets to generate the set of options dynamically.
  • the Web Content Server 800 widget library contains rales (XSLT templates) for transforming a number of widgets to their HTML representation.
  • the widget library provides a level of abstraction between the user interaction component (e.g., a text input field) and its presentation (e.g., an HTML input field or a WML input field). This way the content producing model pages can be reused by different control files - one may deliver the content to a desktop browser using the HTML widget library, while another may deliver the same content to a handheld device using a modified version of the widget library (e.g., using WML).
  • the widget library contains widgets for most commonly used inputs and controls, such as:
  • the link widget can be used to display an image button or regular hyperlink;
  • List widgets the list widget can be used to display common dropdown menus, set of radio boxes or set of check boxes;
  • the wdk ⁇ nput widget represents the abstract notion of a text field. If the model page developer needs a text field to get information from the user, he or she needs to use the wdktinput widget.
  • ⁇ wdk: input name "inputZip">
  • CSS Cascading Stylesheets
  • the wdk:input widget is implemented as XSLT templates as shown below:
  • Section 1 contains the match condition for the template: every wdk:input element in the document will be transformed using this template.
  • the name of the input field is computed as well.
  • Section 2 shows that this widget (just like all the other widgets) is nested inside a wdk:widget element, which makes it simpler to place widgets in the view transform.
  • Section 3 shows how the different components (the label and the actual text field) are embedded in an HTML span element.
  • the color of the text label is determined based on the "required" sub-element of the wdk:input widget.
  • the logic in section 5 determines what type of text field to generate: either "password” or regular "text” field.
  • Section 7 shows the template called from section 5 to fill in the attributes of the generated HTML input element.
  • wdk:hidden_element Represents an HTML hidden element. The widget generates the required element and Javascript functions that can be invoked to set the value of this element.
  • wdk:form Generates the HTML form element and Javascript functions needed to manage the form.
  • wdk:input Represents a single line text element. Can render the widget as a PASSWORD or TEXT HTML form field.
  • wdk:list Represents a widget for selecting an item from a set of predefined items. Supports four different HTML renderings:
  • Radiobutton set wdk Represents a link or button. Besides submitting the form, the link widget can be used to:
  • Model pages are responsible for producing an XML representation of the content of the page. This content typically comes from executing complex business logic (e.g., running database queries, exercising business APIs, etc.).
  • complex business logic e.g., running database queries, exercising business APIs, etc.
  • Web Content Server 800 introduces an implementation of the Command pattern (Gamma et al.).
  • a developer can invoke a command from a model page by using the execute Web Content Server 800 tag library tag. For example, the following line
  • ICommand cmd null; private ICommand getCommand(String mngrName, String cmdName) throws Exception ⁇
  • Class mngrClass Class.forName(mngrName);
  • InputSource source new lnputSource(new StringReader(writer.toString()));
  • XercesParser parser new XercesParser()
  • Document doc parser.parse(source, false); return document.importNode(doc.getFirstChild(), true);
  • the stylesheet for the wdktags: execute contains two templates.
  • the first template (named command_header) is a template called by the main taglibrary stylesheet to create class level methods. These methods (getcommand and executeCommand) are called by the code that results from the fransformation of the wdktags: execute tags.
  • the getcommand method takes two arguments: the fully qualified name of a Command manager (see below) and a command name. It returns an ICommand object (see below for details) that is registered with the command manager by the command name.
  • the executeCommand method performs the following steps:
  • the template for the execute tag performs the following steps: 1. Sets up a DOM Node variable for the node generated by the executeCommand method.
  • ICommandManager is the interface implemented by individual command managers. It declares the following method: public ICommand getCommand(String name) throws Exception; For convenience an abstract class implementing the ICommand is defined. This class provides the following API for its subclasses: public void registerCommand (String name, ICommand command); Command managers can extend this class and implement a single method: public abstract void initiaIizeMapStructure() throws Exception; For example, the Domain command manager that manages commands related to security domains has the following implementation:
  • the ICommand interface follows the Command pattern (see Gamma et al., 1995) and the
  • ICommand extends the Java Cloneable interface. ICommand declares the following methods: public void execute (HttpServletRequest req,
  • Web Content Server 800 infroduces the notion of IXML Visitor and IXMLObject following the Visitor pattern (see Gamma et al, 1995.).
  • IXML Visitor declares the following methods: public void visit (String prefix, String tagName,
  • URL value throws XMLVisitorException; public void visit (String prefix, String tagName,
  • IXMLObject value throws XMLVisitorException
  • public void writeOpenTag (String prefix, String tagname) throws XMLVisitorException
  • public void writeCloseTag (String prefix, String tagname) throws XMLVisitorException
  • public void createModel (String className) throws
  • Visit methods are declared for most frequently used data types and for IXMLObject. Besides the visit methods writeOpenTag and writeCloseTag are also declared. These two methods must be used when generating nested XML elements. For example, take the following XML document fragment:
  • a visitor can produce this document fragment with the following sequence of visit calls: visitor. writeOpenTag(null, "doc”); visitor. visit(null, "name”, “A name”); visitor .writeOpenTag(null, "updated”) ; visitor.visit(null, "person", “Jill August”); visitor.visit(null, "date”, aDate); visitor. writeCloseTag(null, "update”); visitor. writeCloseTag(null, "doc”);
  • the IXMLObject interface declares the following methods: public void acceptXML Visitor (IXMLVisitor visitor) throws XMLVisitorException; public String ge TagName ( ) ;
  • getBusinessObj ect(req) method call stands for some business logic that's used to create the business object (e.g., by using some of the business APIs).
  • the present invention provides a solution to the needs described above through a system and method for integrating the disparate applications, and managing the applications processes in a hardware resource and user effort efficient manner.
  • the automated system of the present invention uses a business systems platform comprised of several unique servers to efficiently manage multiple applications which are themselves generally distributed across a network, and to control the execution of the required tasks with minimum use of redundant data input to the several applications, thereby minimizing the use of hardware resources and user input effort.
  • the Platform Interconnect Server allows a platform installation to interconnect with external systems.
  • the Interconnect Server is a platform for information exchange based on XML and supports many types of information exchange across heterogeneous systems.
  • heterogeneous systems could include Enterprise Resource Planning (ERP) systems, e-mail servers, and other Saba installations.
  • ERP Enterprise Resource Planning
  • the Interconnect Server allows interconnection between such external systems and the Interface Server, Business Server, and Information Server.
  • this connection can be for purposes of importing data from ERP systems, exporting billing information to accounting systems, making catalog information available for automated search, or allowing automated purchasing of products.
  • the Interconnect enables collaboration with the Platform network in a bi-directional fashion to allow a Platform-enabled site to share catalog information with the platform network, allow the platform network to place and track orders, and to share and update learner profiles.
  • the process can be reversed: the platform-enabled site can enhance their internal offering of courses by including selected platform network courses in their internal catalog offering.
  • the Interconnect model consists of three parts: (1) the interconnect backbone and the individual interconnect components installed on the interconnect backbone (2) the development API's (both the high- level and the low level interfaces) and (3) the standard protocols used to communicate between heterogeneous systems.
  • the Interconnect Backbone is the framework that supports all Interconnect components.
  • the Interconnect Backbone provides the foundation services required by higher-level services. These foundation services are always present, and include services for reliable messaging, service registration, monitoring and management.
  • the Interconnect Backbone comprises the following components that provide the core Interconnect services:
  • DeliveryService 905 DeliveryService 905, ServiceManager 910 , Locator 915, and Authenticator 920.
  • the core Interconnect services are always present.
  • the Interconnect Backbone provides a framework for registering and resolving services. Services are registered and resolved by name in an interconnect node.
  • the ServiceManager 910 is a core service for the management of services for the Interconnect at a particular location.
  • the ServiceManager 910 tracks installed components, versions and system status.
  • the ServiceManager 910 provides system management capabilities and can be queried for system status: which other components are present and whether they are currently running.
  • Components, which implement Interconnection Services 925, are installed on the Interconnect Backbone at a specific installation by being registered with the
  • the Locator 915 service is a service component that provides a way to register and resolve services by name.
  • the Locator 915 services provides a flat registry of services at a particular interconnect location.
  • the DehveryService 905 is a service component that insures the reliable delivery of messages.
  • the DehveryService 905 understands the sender, the recipient and quality of service, but not the content.
  • DehveryService 905 works over a variety of transport protocols by using different DeliveryTransports.
  • DefiveryTransports are abstract service components that are used by the DehveryService 905 to reliably deliver messages over a particular set of network protocols. Such protocols include sockets, database logging tables, and HTTP.
  • the messaging model provided by the DehveryService 905 provides a mechanism for the delivery of persistent asynchronous messages using a mailbox metaphor.
  • Interconnect Services 925 using the DehveryService 905 register themselves and are assigned an Inbox by the DehveryService 905. Subsequently, the registered service may check for messages at that Inbox.
  • the DehveryService 905 component is described in further detail below.
  • the Authenticator service insures that messages coming into the system have the appropriate credentials. Capabilities can be associated with a particular service and users can be assigned CapabilitySets. When a service is resolved, the Locator 915 calls the Authenticator 920 to validate that the requestmg user has the appropriate capabilities to use the service they are requesting. A Capability is created for each named service in an interconnect location, for example "SAP/Financials/ Accessor". Capabilities have names and in this case the name of the capability will be the same name as the service. Once created, Capabilities can then be given to users who want to access the service. When a message is constructed, the user adds their capabilities to the message.
  • the local DehveryService 905 validates the capabilities with the Authenticator 920.
  • the Authenticator service is the generator of capabilities and capability keys. If a passed in capability doesn't have the appropriate key the capability is not set and the authentication is rejected.
  • the service is also used by other core Interconnect Services for authenticating particular application level requests. Since a capability is a name-key mapping, an interconnect service can create capabilities for any purpose desired.
  • Interconnect Services are implemented like the core Interconnect Services described above. These Interconnect Services register and resolve by name and respond to and send Interconnect messages. Services are configured and managed using Java classes and scripts.
  • interconnect components When interconnect components are installed on the Interconnect Backbone, a site is said to be "connector enabled". These components allow connections to external systems such as ERP systems to import, export, and synchronize data. Key to the Interconnect design is the separation of interface from implementation. Many of the service components are broken into a generic platform independent portion and a platform specific portion that minimizes the impact of changes to the implementation in the future. Most connector components consist of a public service component (which is generic) and a service sub-component (which is system specific).
  • the implementation of a connector in this framework consists of providing concrete implementations for the service sub-components and creating XSL stylesheets that describe mappings between a Local Format (LF) and Interchange Format (IF).
  • Local formats are system-specific representations of the data supported by a service, while Interchange Formats are universal representations used for exchange between systems.
  • these Connectors services may include Monitor 945, Accessor 935, Importer 940, and Updater (not shown). Accessors, Importers, and Updaters are essentially thin wrappers around XSL stylesheet operations. They translate documents between native formats and the Interchange format using a predefined stylesheet. These connector services may also contain additional logic for cases where a single Interchange format document represents multiple native documents, and vice versa. A more detailed description of the service components for these Connector services and their implementation on the Interconnect Backbone follows.
  • the Accessor 935 is a public service component that is used to extract objects from the source representation and convert them to a Interchange Format (IF).
  • IF Interchange Format
  • An Accessor 935 is configured to use a particular AccessorReader 950 to extract the objects from the source system and collaborate with Translators to perform the conversion to IF.
  • the AccessorReader 950 is an abstract service sub- component that is used by an Accessor 935 to extract an object, or set of objects from a source system and convert them into an Interchange Format. Concrete implementations of the AccessorReader 950 are system specific and use the native API of the source system.
  • the Importer 940 is a public service component that is used to import objects from Interchange Format to the target representation.
  • An Importer 940 will collaborate with Translators to perform the conversion from IF and be configured to use a particular ImporterWriter 960 to inject the objects into the target system.
  • the ImporterWriter 960 is an abstract service sub-component that is used by an Importer 940 to convert an object, or set of objects into a Local Format (LF) and write them to a source system. Concrete implementations of the ImporterWriter 960 are system specific and use the native API of the target system.
  • the Monitor 945 is a public service component that monitors changes to local objects and reports changes to interested parties in Interchange Format. Clients can register to receive notification of the change only, or have the changed object sent with the notification.
  • a Monitor 945 is configured to use a particular ChangeManager 955 to map changes in the source system to a standard event format that the monitor can use.
  • the ChangeManager 955 is an abstract service sub-component that is used by a Monitor 945 to map local events into the standard event format. Concrete implementations of the ChangeManager 955 are system specific and use the native API of the source system to capture events.
  • the Monitor 945 receives an event from the ChangeManager 955, it checks to see if the object needs to be sent with the notification. If so, the Monitor 945 will collaborate with the Accessor 935 and Mapper to provide the conversion from source object to Interchange Format.
  • the Monitor 945 uses the Mapper to find the platform ID associated with the local identifier in the event. This platform
  • the Mapper is a utility that provides object and class level mapping services between representations, each connector framework contains a single instance of the Mapper.
  • the Mapper data is persistent this enables the cross reference data to survive restarts.
  • the Mapper maintains maps for (1) Platform ID to Document
  • POID Platform Object Id
  • SeqNo -> is a sequence number that that is unique for a host.
  • Example of a POID is http ://j ade/interconnect/Saba/ 1 this could be a representation of local id emploOOOOOOOOOOOlOOO with class type com.saba.busobj.SabaEmployee. This representation can be converted to instance of POID by using static method in the POID class.
  • POID class definition is public class POID implements IX LRenderable
  • ⁇ mLocallD locallD
  • mURL new URL (getURLPrefixO + locallD.toString () + "/" + mid) ;
  • Mapper stores the cross reference between the local Id and the POID representation of the local Id.
  • the Mapper also stores cross reference between foreign POID and local Id in the case where the Object originated from a foreign system.
  • a Transformer is a utility that provides translation services between representations using mapping data and XSL style sheets.
  • a Transformer wraps a particular XML parser and XSL translator.
  • the Accessor calls an implementation of the transformer and passes the Local Format and the stylesheet, the fransformer translates the Local Format into Interchange Format.
  • Implementing a connector involves building four platform specific components and defining a set of document, object and user mappings.
  • the platform specific components are described in detail below and include the (1) ChangeManager 955 (maps system events to Monitor 945 events), (2) AccessorReader 950 (extracts objects from the system in XML format), (3)
  • ImporterWriter 960 injects objects into the system from XML format
  • LocalObjectID Encapsulates the system object identifier, this is not required if the system can use the GenericObjectlD available.
  • the types of documents to be exchanged need to be defined. Once these are determined and their format defined, XSL style sheets need to be written which convert
  • the ChangeManager 955 monitors the native system for all events such as Insert/Update/Delete on objects. It can interact with the event notification mechanism of the native system to capture all the events and then pass these events to the monitor for further handling.
  • the ChangeManager 955 accepts events from the native system, converts these events into MonitorEvent Objects, and forwards these to the Monitor 945 using the method
  • IChangeManagerAdaptor.notifyO method Once the Change Manager passes an event on to the Monitor 945, it is then the responsibility of the Monitor 945 to reliably deliver the request on to any subscribers who have registered interest. The Monitor 945 will filter out any events that are not subscribed to. Specifically, the Change Manager is responsible for (1) keeping track of all the events that take place in the native system, (2) creating MonitorEvent Objects for all events supported by the native change management, (3) Calling the notify method of the Monitor with a given event.
  • ChangeManager 955 requires a reference to its owning Monitor 945 class to invoke its notifyO event. It also needs a LocalUser object to obtain credential information. These references are provided during construction. public abstract class ChangeManager throws connectorException
  • the ChangeManager 955 converts each system event into a MonitorEvent object, which it passes on to the monitor by calling its notify method.
  • the Monitor Event class is as follows:

Landscapes

  • Engineering & Computer Science (AREA)
  • Computer Networks & Wireless Communication (AREA)
  • Signal Processing (AREA)
  • Information Retrieval, Db Structures And Fs Structures Therefor (AREA)
  • Exchange Systems With Centralized Control (AREA)

Abstract

L'invention porte sur une solution répondant aux besoins susmentionnés grâce à un système et un procédé permettant de gérer l'échange de données entre des systèmes au sein d'un réseau. Les systèmes et les procédés selon l'invention traduisent les données d'un format local spécifique à un système donné en un objet en format d'échange générique, et inversement, avec des feuilles de style prédéfinies en utilisant des éléments génériques et des éléments de service spécifiques à un système donné qui exploite une interface de programme d'application d'origine du système local spécifique.
PCT/US2001/001095 2000-01-14 2001-01-12 Procede et appareil de gestion de l'echange de donnees entre systemes dans un reseau WO2001052502A2 (fr)

Priority Applications (1)

Application Number Priority Date Filing Date Title
AU2001229423A AU2001229423A1 (en) 2000-01-14 2001-01-12 A method and apparatus for managing data exchange among systems in a network

Applications Claiming Priority (2)

Application Number Priority Date Filing Date Title
US17608400P 2000-01-14 2000-01-14
US60/176,084 2000-01-14

Publications (2)

Publication Number Publication Date
WO2001052502A2 true WO2001052502A2 (fr) 2001-07-19
WO2001052502A3 WO2001052502A3 (fr) 2003-04-17

Family

ID=22642909

Family Applications (1)

Application Number Title Priority Date Filing Date
PCT/US2001/001095 WO2001052502A2 (fr) 2000-01-14 2001-01-12 Procede et appareil de gestion de l'echange de donnees entre systemes dans un reseau

Country Status (2)

Country Link
AU (1) AU2001229423A1 (fr)
WO (1) WO2001052502A2 (fr)

Cited By (13)

* Cited by examiner, † Cited by third party
Publication number Priority date Publication date Assignee Title
WO2002059790A1 (fr) * 2001-01-24 2002-08-01 Telefonaktiebolaget Lm Ericsson (Publ) Systeme et procede relatifs a l'acces d'applications/de services
WO2002059791A1 (fr) * 2001-01-24 2002-08-01 Telefonaktiebolaget Lm Ericsson (Publ) Systeme et procede concernant to end user station access of a portal
WO2003036544A2 (fr) * 2001-10-25 2003-05-01 Asera, Inc. Caracteristiques de globalisation et de normalisation de traitement d'objets commerciaux
EP1315101A2 (fr) * 2001-11-20 2003-05-28 Hewlett-Packard Company Procédé et dispositif de génération de données indépendantes de la plate-forme appropriées à la transmission
FR2838902A1 (fr) * 2002-04-23 2003-10-24 Thales Sa Procede simplifiant l'acces a des donnees heterogenes gerees par des outils logiciels
EP1696351A1 (fr) * 2005-02-28 2006-08-30 Microsoft Corporation Architecture de notification fondée sur des requêtes
GB2411994B (en) * 2002-12-03 2006-11-15 David Boxenhorn Networked computing using objects
US9130947B2 (en) 1999-11-12 2015-09-08 Jpmorgan Chase Bank, N.A. Data exchange management system and method
US10169732B2 (en) * 2014-09-15 2019-01-01 Oracle International Corporation Goal and performance management performable at unlimited times and places
CN110321380A (zh) * 2019-07-09 2019-10-11 北京外研讯飞教育科技有限公司 一种数据交换方法、装置及系统
WO2020185891A1 (fr) * 2019-03-13 2020-09-17 Oracle International Corporation Procédés, systèmes et supports lisibles par ordinateur pour la traduction de données à l'aide d'une interface de programmation d'application (api) de transfert d'état représentationnel
US11095691B2 (en) 2019-06-26 2021-08-17 Oracle International Corporation Methods, systems, and computer readable media for establishing a communication session between a public switched telephone network (PSTN) endpoint and a web real time communications (WebRTC) endpoint
US11132334B2 (en) * 2015-12-08 2021-09-28 EMC IP Holding Company LLC Methods and apparatus for filtering dynamically loadable namespaces (DLNs)

Citations (4)

* Cited by examiner, † Cited by third party
Publication number Priority date Publication date Assignee Title
US5119465A (en) * 1989-06-19 1992-06-02 Digital Equipment Corporation System for selectively converting plurality of source data structures through corresponding source intermediate structures, and target intermediate structures into selected target structure
WO1998024020A2 (fr) * 1996-11-27 1998-06-04 Sony Europa B.V. Procede et systeme de creation de code de logiciel
WO1999027460A1 (fr) * 1997-11-24 1999-06-03 Pointcast, Inc. Reconnaissance et traitement de langage de balisage hypertexte comprime (html)
US6012098A (en) * 1998-02-23 2000-01-04 International Business Machines Corp. Servlet pairing for isolation of the retrieval and rendering of data

Patent Citations (4)

* Cited by examiner, † Cited by third party
Publication number Priority date Publication date Assignee Title
US5119465A (en) * 1989-06-19 1992-06-02 Digital Equipment Corporation System for selectively converting plurality of source data structures through corresponding source intermediate structures, and target intermediate structures into selected target structure
WO1998024020A2 (fr) * 1996-11-27 1998-06-04 Sony Europa B.V. Procede et systeme de creation de code de logiciel
WO1999027460A1 (fr) * 1997-11-24 1999-06-03 Pointcast, Inc. Reconnaissance et traitement de langage de balisage hypertexte comprime (html)
US6012098A (en) * 1998-02-23 2000-01-04 International Business Machines Corp. Servlet pairing for isolation of the retrieval and rendering of data

Non-Patent Citations (1)

* Cited by examiner, † Cited by third party
Title
CARLOS O'RYAN, FRED KUHNS, DOUGLAS C. SCHMIDT, OSSAMA OTHMAN, JEFF PARSONS: "The Design and Performance of a Pluggable Protocols Framework for Real-tim Distributed Object Computing Middleware" WASHINGTON UNIVERSITY TECHNICAL REPORT WUCS-99-12, [Online] 1999, pages 1-22, XP002188484 Saint Louis, États-Unis d'Amérique Retrieved from the Internet: <URL:http://citeseer.nj.nec.com/rd/0%2C321 598%2C1%2C0.25%2CDownload/http%253A%252F%2 52Fciteseer.nj.nec.com/cache/papers/cs/140 92/http%253AzSzzSzsiesta.cs.wustl.eduzSz%2 57EfredkzSzpaperszSzpluggable_protocols.ps .gz/kuhns99design.ps.gz> [retrieved on 2002-01-18] & NEC RESEARCH INSTITUTE: "The Design and Performance of a Pluggable Protocols Framework for Real-time Distributed Object Computing Middleware - Kuhns, O'Ryan, Schmidt, Parsons (ResearchIndex)" INTERNET DOCUMENT, [Online] 2001, XP002188485 Retrieved from the Internet: <URL:http://citeseer.nj.nec.com/kuhns99des ign.html> [retrieved on 2002-01-18] *

Cited By (17)

* Cited by examiner, † Cited by third party
Publication number Priority date Publication date Assignee Title
US9130947B2 (en) 1999-11-12 2015-09-08 Jpmorgan Chase Bank, N.A. Data exchange management system and method
WO2002059790A1 (fr) * 2001-01-24 2002-08-01 Telefonaktiebolaget Lm Ericsson (Publ) Systeme et procede relatifs a l'acces d'applications/de services
WO2002059791A1 (fr) * 2001-01-24 2002-08-01 Telefonaktiebolaget Lm Ericsson (Publ) Systeme et procede concernant to end user station access of a portal
WO2003036544A2 (fr) * 2001-10-25 2003-05-01 Asera, Inc. Caracteristiques de globalisation et de normalisation de traitement d'objets commerciaux
WO2003036544A3 (fr) * 2001-10-25 2003-08-21 Asera Inc Caracteristiques de globalisation et de normalisation de traitement d'objets commerciaux
EP1315101A2 (fr) * 2001-11-20 2003-05-28 Hewlett-Packard Company Procédé et dispositif de génération de données indépendantes de la plate-forme appropriées à la transmission
EP1315101A3 (fr) * 2001-11-20 2003-12-17 Hewlett-Packard Company Procédé et dispositif de génération de données indépendantes de la plate-forme appropriées à la transmission
FR2838902A1 (fr) * 2002-04-23 2003-10-24 Thales Sa Procede simplifiant l'acces a des donnees heterogenes gerees par des outils logiciels
GB2411994B (en) * 2002-12-03 2006-11-15 David Boxenhorn Networked computing using objects
US7752335B2 (en) 2002-12-03 2010-07-06 David Boxenhorn Networked computing using objects
EP1696351A1 (fr) * 2005-02-28 2006-08-30 Microsoft Corporation Architecture de notification fondée sur des requêtes
US10169732B2 (en) * 2014-09-15 2019-01-01 Oracle International Corporation Goal and performance management performable at unlimited times and places
US11132334B2 (en) * 2015-12-08 2021-09-28 EMC IP Holding Company LLC Methods and apparatus for filtering dynamically loadable namespaces (DLNs)
WO2020185891A1 (fr) * 2019-03-13 2020-09-17 Oracle International Corporation Procédés, systèmes et supports lisibles par ordinateur pour la traduction de données à l'aide d'une interface de programmation d'application (api) de transfert d'état représentationnel
US11561997B2 (en) 2019-03-13 2023-01-24 Oracle International Corporation Methods, systems, and computer readable media for data translation using a representational state transfer (REST) application programming interface (API)
US11095691B2 (en) 2019-06-26 2021-08-17 Oracle International Corporation Methods, systems, and computer readable media for establishing a communication session between a public switched telephone network (PSTN) endpoint and a web real time communications (WebRTC) endpoint
CN110321380A (zh) * 2019-07-09 2019-10-11 北京外研讯飞教育科技有限公司 一种数据交换方法、装置及系统

Also Published As

Publication number Publication date
WO2001052502A3 (fr) 2003-04-17
AU2001229423A1 (en) 2001-07-24

Similar Documents

Publication Publication Date Title
US6643652B2 (en) Method and apparatus for managing data exchange among systems in a network
US7089583B2 (en) Method and apparatus for a business applications server
US6850893B2 (en) Method and apparatus for an improved security system mechanism in a business applications management system platform
US6721747B2 (en) Method and apparatus for an information server
US20020049788A1 (en) Method and apparatus for a web content platform
US20030229529A1 (en) Method for enterprise workforce planning
Armstrong et al. The J2EE 1.4 tutorial
US7457815B2 (en) Method and apparatus for automatically providing network services
US6615253B1 (en) Efficient server side data retrieval for execution of client side applications
US6529948B1 (en) Multi-object fetch component
US6601192B1 (en) Assertion component in environment services patterns
US6640244B1 (en) Request batcher in a transaction services patterns environment
US6550057B1 (en) Piecemeal retrieval in an information services patterns environment
US6529909B1 (en) Method for translating an object attribute converter in an information services patterns environment
WO2001016734A2 (fr) Systeme, procede et article de fabrication destines a un flux d&#39;autodescripteurs dans un environnement de modeles de services de communication
WO2001016729A2 (fr) Systeme, procede et article de fabrication en matiere de recuperation d&#39;espace reparti dans des motifs de services d&#39;environnement
WO2001052502A2 (fr) Procede et appareil de gestion de l&#39;echange de donnees entre systemes dans un reseau
Jendrock The Java EE 5 Tutorial
Ball et al. The java ee 5 tutorial
EP1222532A2 (fr) Systeme, procede et article manufacture un composant de classe de constante dans un environnement de schemas de services de logique d&#39;affaires
Apte Java connector architecture: building custom connectors and adapters
Ahokas Using XML In Making Legacy Application Data Accessible Through Web Services
Server Chat
Qian A J2EE and XML-enabled, web-based technical report management system
Easy Fravo. com

Legal Events

Date Code Title Description
AK Designated states

Kind code of ref document: A2

Designated state(s): AE AG AL AM AT AU AZ BA BB BG BR BY BZ CA CH CN CR CU CZ DE DK DM DZ EE ES FI GB GD GE GH GM HR HU ID IL IN IS JP KE KG KP KR KZ LC LK LR LS LT LU LV MA MD MG MK MN MW MX MZ NO NZ PL PT RO RU SD SE SG SI SK SL TJ TM TR TT TZ UA UG US UZ VN YU ZA ZW

AL Designated countries for regional patents

Kind code of ref document: A2

Designated state(s): GH GM KE LS MW MZ SD SL SZ TZ UG ZW AM AZ BY KG KZ MD RU TJ TM AT BE CH CY DE DK ES FI FR GB GR IE IT LU MC NL PT SE TR BF BJ CF CG CI CM GA GN GW ML MR NE SN TD TG

121 Ep: the epo has been informed by wipo that ep was designated in this application
REG Reference to national code

Ref country code: DE

Ref legal event code: 8642

DFPE Request for preliminary examination filed prior to expiration of 19th month from priority date (pct application filed before 20040101)
122 Ep: pct application non-entry in european phase
NENP Non-entry into the national phase

Ref country code: JP