# Patent

## Title
Development tool, method, and system for client server applications

## Abstract

A software development method and system having a suite of graphical customization tools that enables developers to rapidly configure all aspects of the underlying application software, including the look-and-feel, behavior, and workflow. This is accomplished without modifying application source code, base objects, or SQL. The sophisticated repository management capabilities of the method and system of our invention allows teams of developers to work efficiently on configuring applications. The application upgrader provides an automated process to upgrade the customizations to future product releases thus protecting the investment in customization. The ease, comprehensiveness, scalability, and upgradeability of the customization process help reduce the total lifecycle cost of customizing enterprise applications.

## Background
CROSS REFERENCE TO RELATED APPLICATIONS
This application is a continuation of U.S. patent application Ser. No. 09/867,263, filed May 30, 2001 now U.S. Pat. No. 6,553,563, which is a continuation of PCT Application No. PCT/US99/28427, filed Nov. 30, 1999, which claims the benefit of U.S. Provisional Application No. 60/110,416, filed Nov. 30, 1998, which are hereby incorporated in their entirety by reference.


FIELD OF THE INVENTION
The method, and system of our invention relate to client server systems, and especially to development tools, methods and systems that build upon functions, routines, subroutines, subroutine calls, or object oriented programming.
BACKGROUND OF THE INVENTION
Programming paradigms built upon such concepts as functions and function calls, subroutines and subroutines and subroutine calls, global variables and local variables, and object orientation are characterized by such features as “reusable code”, and “inheritance.”
In older languages, such as FORTRAN and BASIC, reusability and inheritance were obtained through crafting of functions, routines, and subroutines that were called through global variables in a main program. Subsequently, this has evolved into object oriented programming in such languages as C++ and Java and is built upon a programming paradigm foundation of objects, functions, and class data types. An “object” is a variable that has “functions” associated with it. These functions are called “member functions.” A “class” is a data type whose variable are “objects.” The object's class, that is, the type of the object, determines which member functions the object has.
In a modern, object oriented programming language, such as C++ or Java, the mechanism to create objects and member functions is a “class.” Classes can support “information hiding” which is a critical part of modern program design. In “information hiding”, one programming team may design, develop, and implement a class, function, routine, or subroutine while another programming team may use the new class, function, routine, or subroutine. It is not necessary for the programmers who use the class, function, routine, or subroutine to know how it is implemented.
To be noted is that “object oriented programming” uses the terms “public” and “private” while the older techniques use the terms “global” and “local” for the domain of variables.
One aspect of both paradigms is “code reusability,” whether implicitly by the subroutine or function calls of FORTRAN and the like or explicitly by declaring variables in C++ or JAVA.
There is an especially strong need for a development environment, including development tools, and either functions, routines, and subroutines with global and local variables, or base classes, to allow end users to develop business applications customized to their needs and derived from the supplied functions, routines, and subroutines with global and local variables, or base classes.
SUMMARY OF THE INVENTION
The method and system of our invention is an application development environment. It is designed to meet the customization needs of demanding sales, marketing, and customer service information system deployments.
One embodiment of our invention is a system for customizing an application program. The system includes a plurality of reusable modules (characterized as “base” modules in object oriented programming literature and as functions, routines and subroutines in other programming paradigms) for incorporation into end-user derived modules (characterized as “derived” in object oriented programming literature). At least one of the reusable modules has a set of variables accessible by an end-user (“public” in object oriented programming and “global” in conventional programming) and a set of variables not accessible by the end-user (“private” in object oriented programming and “local” in conventional programming). When a derived module incorporates a reusable module, the derived module inherits attributes of the reusable module.
A further aspect of our invention is the provision of a graphical editor for modifying and managing software modules, and an object visualization editor for graphically representing relationships between modules and variables within modules. A further aspect of our invention is the provision of one or more applet designer modules for doing one or more of modifying and extending lists, forms, dialogs, and chart user interfaces. The system can also include one or more view designer modules for visually modifying existing views, as well as wizard modules for creating end user created modules. In one embodiment of our invention at least one of the wizard modules provides an enumeration of required end-user entries for an end user module, this being in response to an end-user entry of the type of end-user created module to be created.
A directory or module repository manager may be provided to allow only one end-user to modify a module at one time.
Depending on the underlying source code, the system of the invention may include a compiler or translator for incremental compilation or translation of end user created modules.
In a preferred embodiment the system of our invention includes one or more interfaces for accessing data and rules from external applications.
In still another embodiment, especially useful for spreadsheet or database applications, the system includes database extension modules for extending a database and to capture data from new fields in one or more of application screens, and external sources. In a particularly preferred embodiment, the database extension modules may contain modules for triggering updates to client applications that reflect and incorporate new database extensions, and for reflecting new columns in existing end user created modules.
A further aspect of the system of our invention is the provision of modules for notification of conflicts between new end user created modules and existing modules. These modules may be incorporated in the translator or compiler, or in an index to the repository.
A further aspect of our invention is a method having for customizing an application program. This method works with the system of the invention, summarized above, and includes the steps of modifying and managing the end user created modules through a graphical editor; and graphically representing relationships between modules and variables within modules.
A further aspect of the method of our invention is doing one or more of modifying and extending lists, forms, dialogs, and chart user interfaces. Another aspect of our invention is visually modifying existing views.
Another aspect of the method of our invention is creating end user created modules using wizard modules. This may include the additional step of providing an enumeration of required end-user entries for an end user created module in response to an end-user entry of the type of end-user derived module to be created.
Yet another aspect of our invention is storing derived (that is, end user created) modules in a derived module repository manager. This is to allow only one end-user to modify a software module at one time.
A still further aspect of our invention is incrementally compiling a derived module.
Another aspect of our invention is accessing data and rules from external software applications through interfaces.
Another aspect of our invention is extending or scaling a database, that is, modifying its metadata and/or schema, to include new fields and capturing data from new fields in one or more of application screens, and external sources. A further aspect of this is triggering updates to client applications that reflect and incorporate new database extension, as well as reflecting new columns in existing end user created modules.
A further aspect of our invention is providing notification of conflicts between end user created modules and existing modules.
The software development method and system of our invention utilizes a suite of tools that serve as the bases for “reusability”, whether implicitly or explicitly. This enables developers to rapidly configure all aspects of the underlying application software, including the look-and-feel, behavior, and workflow, without modifying application source code, SQL, or base classes. The sophisticated repository management capabilities of the method and system of our invention allows teams of developers work efficiently on configuring applications.
The suite of conventional and object oriented development tools includes a business object designer; a Microsoft Visual Basic-like scripting language, a set of business object interfaces, a Database Extension Designer, and an Application Upgrader.
The application upgrader provides an automated process to upgrade the customizations to future product releases thus protecting the investment in customization. The ease, comprehensiveness, scalability, and upgradeability of the customization process help reduce the total lifecycle cost of customizing enterprise applications.
To be noted is the difference between declarative programming and procedural programming. Declarative programming allows developers to control the behavior of a class by merely setting attribute values, that is, set the property color=black, instead of writing a line of code to set the color the color to black. This may be accomplished under either paradigm.
Also to be noted is that the meta-data repository that contains configuration and customization information can serve to separate this configuration and customization data from the application source code. By this expedient, developers and end-users can configure these objects in an intuitive and easy manner that is less prone to error.



THE FIGURES
The method and system of our invention may be understood by reference to the Figures appended hereto.
FIG. 1 illustrates a screen shot of a Business Component definition.
FIG. 2 illustrates a screen shot of details of a Business Component definition.
FIG. 3 illustrates a screen shot of features of the Applet Designer.
FIG. 4 illustrates a screen shot of features of the view.
FIG. 5 illustrates a screen shot of aspects of the editor and debugger.
FIG. 6 illustrates a screen shot of the components of the application upgrader.



DETAILED DESCRIPTION OF THE INVENTION
Using the method and system of our invention, teams of developers can work together cooperatively, to rapidly customize all aspects of software applications without modifying application source code, SQL, or vendor supplied base classes (referred to herein as “business objects”). This approach to customization results in dramatically lower development and maintenance costs, and provides seamless upward compatibility with future product releases.
The components of the development tool include:

    
    
        1. A business object designer
        2. A language, such as Microsoft Visual Basic, Microsoft Visual C++, Microsoft Visual J++ or the like.
        3. Business object interfaces
        4. A Database Extension Designer
        5. An Application Upgrader
    
    


Business Object Designer
The business object designer gives developers the ability to quickly and easily customize software applications. It includes a business object explorer. This is a graphical editing tool for modifying and managing object definitions. It includes a hierarchical object explorer that allows developers to browse the various object types, an object list editor viewing and editing object definitions, and a properties window for editing object property values. The business object explorer also includes a Windows-style “Find” capability that allows developers to quickly locate objects in the repository.
Object Visualization Views
The Object Visualization Views are a set of graphical representations of the relationships between the various object definitions in the business object repository that help simplify the configuration process. A typical application configuration contains thousands of objects. Developers can use these views to understand and navigate through the object hierarchies. Then, using the editing tools, they can modify the properties of these objects. These views help assess the impact of these modifications, and track down configuration errors. The visualization views can be printed and used as a valuable reference during configuration. FIG. 1 illustrates a screen shot of a Business Component definition, 1, with an objects field, 11, a field indicating the source and type of components, 12, and a field indicating the actions to be taken with respect to a component, 13, while FIG. 2 illustrates a screen shot of the details of a Business Component definition 2 with the account object explorer, 21, the account external products, 22, and the object attributes, 23. It depicts the various Fields in the Business Component, their types, and points to their respective sources—either Columns in underlying database tables, or Fields in other Business Components. A developer can further introspect the properties of an object in this view, by using the Properties window. The other Visualization Views work similarly. The Hierarchy View describes the object hierarchy as it relates to the selected object, i.e., the Objects used by the selected Object and the Objects that use it. For example, the Hierarchy View for a View Object will show the Applets contained in that View, the Business Components on which each of these Applets are based, the Screens and Applications in which this View appears.
Applet Designer
The Applet Designer module is an intuitive drag-and-drop visual programming interface for modifying and extending list, form, dialog, and chart user interface objects (Applets). These objects can be populated with standard Windows controls, including buttons, combo boxes, check boxes, labels, and text fields, as well as ActiveX controls. The Applet Designer of the method and system of our invention leverages the familiarity of developers with popular graphical application development tools such as Microsoft Visual Basic. Features of the Applet Designer 3 are illustrated in FIG. 3. These include the object explorer, 31, and the applet being designed or modified, 32. An account information form is being designed in block 32.
The developer can add, delete, and modify the properties of the controls. The controls can be configured using the Properties Window. For example, a control can be associated with a Field in the underlying Business Component. This is accomplished by setting the Field attribute of the Control to one of the Fields in the Business Component. The choice of Fields is limited to those that belong to the Business Component that the Applet is based on. The behavior of controls can be scripted using the Visual Basic or other script editor. The Applet Designer also helps ensure visually accurate and correctly translated configurations by providing a design-time preview of the Applet on various screen resolutions, and under different language settings. In this mode, the Applet designer simulates the Applet being viewed under the specified settings and allows the developer to quickly detect any presentation errors such as truncation or overlapping controls. Features of the Applet Designer are illustrated in FIG. 3.
View Designer
The view designer module of the development tool method and system of our invention allows developers to visually modify existing views and construct new views by simply dragging and dropping the desired Applets onto the view canvas. There is no additional specification or code required to define the relationships between the Applets. Most other application customization tools require developers to write significant amounts of code to achieve this same functionality. In the prior art, this code had to be replicated for each and every screen in the application. This was inefficient and error-prone. Features of the view designer 4 are illustrated in FIG. 4. To create a View based on a specific Business Object, the developer is presented with a blank canvas with eight sectors and a window 41 containing the list of Applets that can be included in the View (based on the Business Object of the View). The desired Applets can then be simply dragged from the Applets window and dropped on the View canvas in the desired sector. The Applets may be resized at this point, if necessary. The underlying Business Components, and their context within the Business Object determine the relationships between the Applets in the View. Hence, these relationships do not need to be specified again in the definition of the View. They are simply re-used.
Menu Designer
The menu designer module of the development tool method and system of our invention allows developers to customize and extend Siebel menu structures using a visual metaphor. A menu can be created by adding menu items, defining the command to be executed when the menu is clicked, and specifying an accelerator key for easy navigation.
Object Wizards
The development tool method and system of our invention provides a set of Wizards to assist developers in the creation of new objects in the underlying repository. Examples of Wizards include a Form Applet Wizard, Chart Applet Wizard, List Applet Wizard, and Business Component Wizard. The user clicks on the type of the new object he or she wants to create, and the Wizard guides them through the entry of the properties needed for that type of object.
Typically, the graphical user interface guides the user through the various steps of creating an applet, such as selecting the business component that it is based on, the dimensions of the applet, the fields to be included, the buttons that appear in the applet, and the like. Wherever possible, the list of choices are restricted to only those that are applicable—Fields in the underlying Business Component, Projects that have been locked by the developer, etc. Once the developer has gone through the various screens in a wizard, a new Object is created based on the attributes specified. A default layout is generated for the type of Object being created. For example, for a Form Applet, Text box and Check box controls are created for each Business Component Field that is to be included in the Applet, depending on the data type of Field. Labels are also created right next to the Text boxes and Check boxes. All these controls are laid out in an aesthetically pleasing columnar layout.
Business Object Repository Manager
The business object repository manager of our invention provides application developers with an efficient multi-user development environment that includes access to check-in/check-out functionality and version control. In a typical development environment, there is a server repository that contains the master application definition. Each developer on the team has a local repository that the development tools method and system of our invention connects to. The various object definitions in the business object repository are grouped into Projects. Developers lock and check out projects from the server repository onto their local repositories in order to make changes to the object definitions. If another developer tries to check out the same Project, he/she is unable to do so, and is informed that the Project is locked. This prevents other developers on the team from modifying the same project. Once the developer has made the changes and tested them, the project can be checked into the server repository. Before checking in a project, the developer can review the changes that have been made thereby minimizing check-in errors. The check-in/check-out process can be integrated with an external version control system such as Microsoft Visual SourceSafe, PVCS, or ClearCase. This allows the development team to maintain a version history of all changes to the repository.
Business Object Compiler
This tool that is part of the development tool method and system of our invention allows developers to compile the repository or projects either completely or incrementally. Incremental compilation involves a compilation of only a subset of the Projects (typically those that have been modified). The definitions of objects in these Projects are the only ones that are updated. The remainder of the repository file is left untouched. This significantly speeds the development cycle of any project. The compiler generates a repository file that is used to run the underlying application. The storage of the application definition in the repository file is optimized for high-speed access and performance. This repository file is then deployed to the end-users of the application. The application executable reads the application definition from the repository file and instantiated objects based on their definitions stored in the repository file.
Programming Platform
The development tool method and system of our invention includes a development platform. For example, a Microsoft Visual Basic or Microsoft Visual C++ programming platform for integrating enterprise applications with third-party cooperative applications and extending the base functionality of the application screens and business components. In a preferred embodiment of our invention, the Visual Basic provides a Visual Basic-compliant environment that includes an editor, debugger, and interpreter/compiler. This allows application developers to extend and further configure applications. This capability may be integrated with the Applet Designer so developers can attach scripts to user interface element controls such as buttons, fields, and ActiveX controls. Business component behavior can also be further configured using the programming platform. FIG. 5 illustrates some aspects of the editor and debugger screen 5. It includes the object explorer 51 and the object code view, 52.
Business Object Interfaces
Not only can application developers extend applications with the development platform, e.g., Visual Basic, they can also use COM interfaces to access data from third-party applications, provide integration with legacy systems, and automate applications from other external applications. This allows developers to extend application behavior, provide client-side integration to other applications, and enable access to data and business rules from other programs that use Microsoft Visual Basic, Powerbuilder, Java, or ActiveX. COM interfaces expose selected objects to custom routines external from the applications. Developers can access these COM interfaces using a wide variety of programming languages.
Database Extension Designer
When developers require extensions beyond built-in database extensions, the database extension designer module of the method provides a point-and-click interface to extend application tables. Developers can use these database extensions to capture data from new fields in application screens, or from external sources using enterprise integration managers.
The database extension designer is integrated with the business object repository. The developer first defines the extensions in the repository and makes use of these extensions in Business Components and Applets. These changes are then applied to the local database by clicking on the Apply button. This causes the database schema of the local database to be updated. The developer then tests these extensions in the local environment. Once the testing is complete, the changes are checked into the server repository and made available to the rest of the team.
This process allows developers to make one set of changes that automatically triggers updates to client applications that reflect and incorporate the new database extension into mobile users' databases. These changes reflect the appropriate visibility rules for database extensions. New columns are automatically reflected in the business object repository and named appropriately to ensure easy migration to, for example, future releases of applications.
The database extension designer works with client-server applications to provide seamless integration of database extensions for mobile user databases. The database extension designer automatically applies database extension instructions to the server database and these extensions are automatically routed to mobile user databases via remote software distribution applications such as Siebel Remote. Changes take effect automatically the next time mobile users synchronize. The changes are “in-place.” so mobile users do not need to refresh or reinitialize their local database.
Application Upgrader
The application upgrader module of the method and system of our invention dramatically reduces the time and cost of version upgrades by allowing customers to better determine what changes are available with each release and compare unique object customizations from the prior release with changes in the new release. The application upgrader provides systems administrators with notification of conflicts between object customizations and new releases, automatically merges differences between object definitions, and allows administrators to manually override and apply any changes. This tool obviates the need to manually migrate changes from release to release and significantly reduces the total lifecycle cost of ownership of typical business applications as compared to traditional client/server applications. FIG. 6 illustrates the components of the application upgrader 6 of the method and system of our invention. The Application Upgrader screen has two views, an “Application Upgrades” view, 61, and an “Object Differences” view, 62, as well as a “Merge Repositories” choice box 63.
The Application Upgrader identifies customizations made to an Application, and applies these customizations to the newer release of that Application. Application definitions are contained in a repository. The Application upgrader compares three repositories—the Prior Standard Repository, the Customized Repository, and New Standard Repository—and generates a fourth repository (New Customized Repository) based on the new repository but containing the customizations made by the customer. Any object definitions that have been added to the Customized Repository, but not in the New Standard Repository are added to the New Customized Repository. If an object definition has been modified in the Customized Repository and also in the New Standard Repository, the upgrader compares each attribute of the two versions of object definition, and for each conflict encountered (i.e. differing attribute values), selects the value from one of the versions based on a set of predetermined rules. All conflicts and their resolutions are presented to the user who then has the option of reviewing these and overriding the default resolution adopted by the Application Upgrader.
The result of the upgrade process is an upgraded version of the Application that incorporates the features of the new release with the customizations made to the prior release.
While the invention has been described with respect to certain preferred embodiments and exemplifications, it is not intended to limit the scope of the invention thereby, but solely by the claims appended hereto.

## Claims

1. A method comprising:
assisting an end-user in customizing an application program comprising a plurality of existing modules, the assisting comprising
customizing the application program, wherein
the customizing comprises incorporating a distinct reusable module into at least one end-user created module,
the existing modules comprise the distinct reusable module,
the end-user created module is based at least in part on the distinct reusable module that is provided with the application program,
the end-user created module is also based at least in part on one or more edits, and
the edits indicate a difference between the end-user created module and the distinct reusable module;

automatically detecting a conflict between the end-user created module the existing modules; and
creating a notification of the detected conflict for presentation; and receiving an upgrade version of the application program and automatically incorporating the end-user created module in the upgrade version in such a manner that functionality associated with the end-user created module is accessible to an end user of the upgrade version.

2. The method of claim 1 including presenting the created notification to a user.

3. The method of claim 1 wherein the creating of the end-user module based on the provided reusable module is facilitated by a wizard module for that reusable module that guides indicating of the edits by an end-user.

4. The method of claim 1 wherein the edits indicating differences from the reusable module do not include modifications of code associated with the reusable module.

5. The method of claim 1 wherein the reusable module has at least one associated object, and wherein the edits indicating differences from the reusable module include modifications of definitions of one or more of the associated objects.

6. A method comprising:
assisting an end-user in customizing a vendor-supplied application program comprising a plurality of existing modules, the assisting comprising
receiving the application program and multiple reusable modules for the application program from a vendor, the reusable modules each having associated code;
for each of multiple end-user modules,
receiving an indication from the end-user of one of the reusable modules and of one or more edits indicating differences from the one reusable module; and
creating the end-user module based on the one reusable module and the indicated edits such that the end-user module is distinct from the one reusable module;

customizing the received application program, wherein the customizing comprises incorporating at least one of the reusable modules into the created end-user modules, and the existing modules comprise the reusable modules;
automatically checking for a conflict between the created end-user modules and the existing modules; and receiving an upgrade version of the application program and automatically incorporating the created end-user modules in the upgrade version in such a manner that functionality associated with the created end-user modules is accessible to an end-user of the upgrade version.

7. The method of claim 6 wherein the creating of at least one of the end-user modules based on the one reusable module is facilitated by a wizard module for that reusable module that guides the indicating of the edits by the end-user.

8. The method of claim 6 wherein the edits indicating differences from the reusable modules do not include modifications of the code associated with the reusable modules.

9. The method of claim 6 wherein at least some of the reusable modules each have at least one associated object, and wherein the edits indicating differences from those reusable modules include modifications of definitions of the objects associated with those reusable modules.

10. The method of claim 6 wherein the created end-user modules each provide at least one of a list, a form, a dialog, and a chart user interface.

11. The method of claim 6 wherein the receiving of the edits for each of the end-user modules is in response to a provided enumeration of required end-user entries for an indicated type of an end-user module to be created.

12. A computer program product comprising:
a first set of instructions, executable on a computer system, configured to assist an end-user in customizing a vendor-supplied application program comprising a plurality of existing modules, comprising
a first subset of instructions, executable on said computer system, configured to receive the application program and multiple reusable modules for the application program from a vendor, the reusable modules each having associated code;
for each of multiple end-user modules,
a second subset of instructions, executable on said computer system, configured to receive an indication from the end-user of one of the reusable modules and of one or more edits indicating differences from the one reusable module; and
a third subset of instructions, executable on said computer system, configured to create the end-user module based on the one reusable module and the indicated edits such that the end-user module is distinct from the one reusable module;

a fourth subset of instructions, executable on said computer system, configured to customize the received application program, wherein
the customizing comprises incorporating at least one of the reusable modules into the created end-user modules, and the existing modules comprise the reusable modules;

a fifth subset of instructions, executable on said computer system, configured to automatically check for a conflict between the created end-user modules and the existing modules; a sixth subset of instructions, executable on said computer system, configured to receive an upgrade version of the application program and automatically incorporating the created end-user modules in the upgrade version in such a manner that functionality associated with the created end-user modules is accessible to an end-user of the upgrade version; and
computer readable media, wherein said computer program product is encoded in said computer readable media.

13. A method comprising:
assisting an end user in customizing an application program comprising a plurality of existing objects that each have associated functionality, the assisting comprising
executing the application program in such a manner that the functionality associated with the existing objects is accessible to the end user;
for each of multiple new end-user objects,
receiving an indication from the end-user of modifications to one of the existing objects; and
creating the new end-user object from the one existing object based on the indicated modifications in such a manner that the created new end-user object has associated functionality distinct from the functionality associated with the one existing object;

modifying the application program to create a modified application program, wherein
the modifying comprises incorporating at least one of a plurality of reusable objects into the new end-user objects in such a manner that the functionality associated with each of the created end-user objects is accessible from the modified application program, and

the existing objects comprise the reusable objects;
automatically checking for a conflict between the created end-user objects and the existing objects;
in response to not detecting a conflict, executing the modified application program in such a manner that the functionality associated with the created end-user objects is accessible to the end user; and receiving an upgrade version of the application program and automatically incorporating the created end-user objects in the upgrade version in such a manner that the functionality associated with the created end-user objects is accessible to an end user of the upgrade version.

14. The method of claim 13 wherein the functionality associated with the existing objects and the distinct functionality associated with the new end-user objects are for interacting with end users via a graphical user interface of the application program.

15. The method of claim 13 wherein the creating of a new end-user object from an existing object includes creating a new type of object that is derived from a type of the existing object such that the created derived object type inherits attributes and functionality from the existing object type.

16. The method of claim 13 wherein the existing objects are reusable objects designed for use by an end user in creating new end-user objects.

17. The method of claim 13 wherein the creating of at least one of the end-user objects from an existing object is facilitated by a wizard module for that existing object that guides the creating.

18. The method of claim 13 wherein the modifications to the existing objects for the creating of the new end-user objects include modifications of definitions of those existing objects.