PROPOSAL BASED ARCHITECTURE SYSTEM

Abstract: A proposed based architecture system that converts a transaction submission process into a generic object in a computer environment. A preferred embodiment of the invention provides a tool set which allows the user to create a set of Proposal Specifications which define the structure of the possible components of a Proposal. The Proposal is accessed via multiple User Interfaces (UI), and allows the user to add a Web or Graphical User Interface (GUI) front-end without having to rewrite a back-end application. A UI coordinator maps user input fields to components of the Proposal and communicates with different user interfaces. A set of Transaction Processing/Data Processing (TP/DP) interfaces are provided to communicate with back-end transactional interfaces such as Database Management Systems (DBMS), Transactional Processing (TP) Monitors, and Object Oriented Databases.

Description: Proposal Based Architecture System BACKGROUND OF THE INVENTION TECHNICAL FIELD The invention relates to the conversion of transaction submission processes into a generic object in a computer environment. More particularly, the invention relates to the conversion of transaction submission processes in an information processing application into a generic proposal object in a computer environment. DESCRIPTION OF THE PRIOR ART The information processing industry faces a mounting backlog in developing applications to handle transactions. Significant parts of the development process have been sped up through the use of tools, architecture, and reusable components. Referring to Fig. 1 , few efficiencies have been gained in programming the large stretch of the application 102 that links user interface 101 with the database manager or transaction monitor 103 that controls changes to the stored database. This area of programming 102 is made from scratch, by hand, for each of the perhaps thousands of applications that an organization might need in a year. With respect to Fig. 2, the basic problem is a semantic mismatch between the two ends of the system. User input enters the system front-end 201 as "atoms" of information, while the back-end resource 203 deals with large, complex data "molecules" The input that user interfaces 201 collect is fine-grained - typed characters, clicked buttons, scanned-in codes, etc., with little built-in sense of relationship among them. There is usually some organization of characters into fields and occasionally of fields into "pages" but user interface structure stops at this point. It falls to the application programmer to individually map each small field or page to its proper place in the large and complex structure that will be presented to the transactional back-end 203. These mappings consist of programmatic hardwiring 202. So even a simple transactional application has at its center 202 a maze of hand-built, application-specific connections that are time-consuming to construct and difficult to change. A labor-intensive redesign is required whenever new features are desired. It would be advantageous to provide a proposal based architecture system that isolates the transaction submission process making it independent of both the front-end and back-end thereby creating an object that can be accessed via multiple user interfaces and detachable from the back-end, thus freeing up the back-end resources. It would further be advantageous to provide a proposal based architecture system that takes advantage of the generic properties of the object, thereby allowing it to be reusable for any new types of transactions that the user desires. SUMMARY OF THE INVENTION The invention provides a proposal based architecture system. The invention utilizes an easy to use toolset to create a generic object that duplicates a transaction submission process, thereby creating an object that is independent from the user interface front-end and the transaction processor back-end. In addition, the invention provides a system that is aware of its own hierarchical structure and preserves data validity. A preferred embodiment of the invention provides a tool set which allows the user to create a set of Proposal Specifications which define the structure of the possible components of a Proposal. The user defines the complete characteristics (meta-data) for any kind of Proposal. Proposal Specifications define the hierarchy of domain relationships, interaction modes, validation references, and assumptions. The actual Proposal instance is formed using the definitions in the Proposal Specifications. A Proposal allows a user to add, change, and annotate data. It is self aware and navigates between pages and skips to appropriate fields automatically and supports n-level undo/redo. Additionally, it tracks all versions of data updates and the user that is responsible for each data update and recognizes and corrects stale data. It also enables long-lived transactions, off-line transaction processing, and collaborative transactions. A Proposal is accessed via one or more User Interfaces (UI). This breaks the close coupling between the front-end and the back-end, thereby allowing the user to add a Web interface or Graphical User Interface (GUI) or other kind of front-end without having to rewrite the back-end application. A UI coordinator maps user input fields to components of the Proposal. It communicates with different user interfaces such as: Internet; Graphical User Interface (GUI); Object Oriented User Interface (OOUI); proprietary interface; and devices such as bar code readers or keypads. The invention also provides a default UI and components. A set of Transaction Processing/Data Processing (TP/DP) interfaces are provided to communicate with back-end transactional interfaces such as Database Management Systems (DBMS), Transactional Processing (TP) Monitors, and Object Oriented Databases. Other aspects and advantages of the invention will become apparent from the following detailed description in combination with the accompanying drawings, illustrating, by way of example, the principles of the invention. BRIEF DESCRIPTION OF THE DRAWINGS Fig. 1 is a schematic diagram of a transaction process according to the invention; Fig. 2 is a schematic diagram of the mapping of atoms to molecules in a transaction process according to the invention; Fig. 3 is a schematic diagram of the invention sitting between a user interface and a back-end according to the invention; Fig. 4 is a schematic diagram of a Proposal object mediating between a front- end and a back-end according to the invention; Fig. 5 is a block schematic diagram of the components of a preferred embodiment of the invention according to the invention; Fig. 6 is a block schematic diagram of the User Interface (UI) Coordinator as an interface between multiple Ul's and a Proposal object according to the invention; Fig. 7 is a block schematic diagram of the lifecycle of a Proposal object according to the invention; Fig. 8 is a block schematic diagram of a generic Proposal according to the invention; Fig. 9 is a block schematic diagram of multiple UI'S communicating through a Proposal object to a back-end resource according to the invention; Fig. 10 is a block schematic diagram of the different locations of a Proposal in a computer environment according to the invention; Fig. 11 is a block schematic diagram of the structure of a Proposal according to the invention; Fig. 12 is a block schematic diagram of a Proposal PropSpec metadata set according to the invention; Fig. 13 is a block schematic diagram of a basic Proposal structure according to the invention; Fig. 14 is a block schematic diagram of the version classes according to the invention; Fig. 15 is a block schematic diagram of the error class according to the invention; Fig. 16 is a block schematic diagram of the annotations class according to the invention; Fig. 17 is a block schematic diagram of the resource coordinators class according to the invention; Fig. 18 is a block schematic diagram of the assumptions class according to the invention; Fig. 19 is a block schematic diagram of a screenshot of a field dictionary interface according to the invention; Fig. 20 is a block schematic diagram of a screenshot of a proposal structure interface according to the invention; Fig. 21 is a block schematic diagram of a field group page according to the invention; Fig. 22 is a block schematic diagram of a screenshot of an assumptions page according to the invention; Fig. 23 is a block schematic diagram of a screenshot of a Proposal viewer interface according to the invention; Fig. 24 is a block schematic diagram of a Proposal toolbar according to the invention; Fig. 25 is a block schematic diagram of Proposal arrow buttons according to the invention; Fig. 26 is a block schematic diagram of a Proposal Tree View according to the invention; Fig. 27 is a block schematic diagram of a Proposal action button according to the invention; Fig. 28 is a block schematic diagram of a Proposal checkbox according to the invention; Fig. 29 is a block schematic diagram of a Proposal field according to the invention; and Fig. 30 is a block schematic diagram of a Proposal field panel according to the invention. DETAILED DESCRIPTION OF THE INVENTION The invention is embodied in a proposal based architecture system transaction submission processes in a computer environment. A system according to the invention provides an easy to use toolset to create a generic object that duplicates a transaction submission process, thereby creating an object that is independent from the user interface front-end and the transaction processor back-end. In addition, the invention provides a system that is aware of its own hierarchical structure and preserves data validity. Many existing approaches require extensive labor intensive redesigns whenever front-end or back-end requirements change. The invention builds upon the premise that a generic pattern for the middle area between the user interface (the front-end) and the transactional back-end {i.e., Database Management Systems (DBMS), Transaction Processing (TP) Monitors, and Object Oriented Databases) in a transactional application exists. The generic pattern is applied to any kind of transactional application and will take over 80 or 90% of the front-to-back-end coordination work. A preferred embodiment of the invention abstracts and automates generic application co-ordination behaviors. Essentially, the invention takes over the data and function mapping process. It provides an intelligent hierarchic framework that lets the programmer assign each field or group of fields to a certain level in the hierarchy; the transactional request gets structured automatically, and every bit of user input is assigned to its proper place in the transactional whole. Referring to Fig. 3, this framework is embodied in the object 302, which sits between the front 301 and the back ends 303 and mediates between them. The framework is not hard-wired to either end. It is a separate entity that shuttles between them, sometimes communicating with one end, sometimes the other, sometimes detached from both. This object represents a packaging-up of the entire process that goes into preparing a transaction for submission. It includes not just the data mapping behavior, but other useful transaction-formation behaviors such as document navigation, error and annotation-handling, and versioning. As a reusable object, it implements features that would be too expensive to program in to a single application. The object that encapsulates these behaviors is called a Proposal. Like a proposal in the human world - to buy a house, get married, do a certain job for a certain fee - it occupies the space between mulling something over and signing an iron-clad contract. A proposal is how a deal gets shaped. It moves between the parties as a vehicle for discussion. It is tentative, negotiable, and probably not perfect at first. It may go through multiple versions. A proposal makes sure that the parties understand each other and that the terms of the final deal mean the same thing to each. And a proposal eventually reaches a point where it either turns into a contract or is abandoned. With respect to Fig. 4, a Proposal object 402 serves a similar function in the preparation of the transactional "contract." It mediates between the front 401 and the back end 403, replacing the hard-wiring that used to join them. Referring to Fig. 5, the invention provides a tool set called the Proposal Spec Builder 501 which allows the user to create a set of Proposal Specifications 502 which define the structure of the possible components of a Proposal 503. The user defines the complete characteristics (meta-data) for any kind of Proposal. The actual Proposal instance 503 is formed using the definitions in the Proposal Specifications 502. A Proposal 503 is accessed via multiple User Interfaces (UI). This breaks the close coupling between the front-end and the back-end, thereby allowing the user to add a Web or Graphical User Interface (GUI) front-end without having to rewrite the back-end application. The invention provides a default UI and components 504. The User can define his own UI 505 in place of the default UI 504. Either UI communicates through a UI coordinator 506 to tie the UI elements with the appropriate elements defined in the Proposal. A set of Transaction Processing/Data Processing (TP/DP) interfaces 507 are created to communicate with back-end transactional interfaces such as Database Management Systems (DBMS) 508, Transactional Processing (TP) Monitors 509, and Object Oriented Databases 510. With respect to Fig. 6, the UI Coordinator 603 coordinates actions between the Proposal 604 and any UI consumer. The interface between the UI Coordinator 603 and User-defined UI 601 or default UI components 602 makes the coordination independent of how the UI is implemented. A Proposal object is self-aware, which means that it contains detailed knowledge of its own form and contents. For example, it : • Knows the type of its contents. • Knows how contents are arranged (hierarchy). Knows validation criteria for its contents. Keeps track of errors accruing on data. Holds annotations to data. Tracks significant versions and who is responsible for each version. Knows how particular pieces of data will have to interact with the back-end to simulate the transactional conversation that it is replacing. Remembers assumptions on which it is based, so they can be checked for continued validity. Referring to Fig. 7, the lifecycle of a Proposal is shown. A developer 701 defines the Proposal Specification 702 using the Proposal Specification Builder 703. Each Proposal Specification 704 that is defined is placed in a repository 705 which holds all of the possible specifications for a Proposal. A user 706 selects the appropriate Proposal Specifications for the desired type of Proposal from the repository 705. The Proposal is created through the Proposal Factory 707 and a Proposal 708 is made available to all users 706, 709. The users 706, 709 add, change, and annotate data to the Proposal 708. Proposal updates are submitted to the DBMS or TP monitor 710. If any errors occur in the updates, error messages are added to the Proposal 708. In effect, the invention turns a real-time activity into a durable thing. This brings architecture to a large area of the system that has until now been a sinkhole of programmer time and development dollars. A number of benefits follow. • With respect to Fig. 8, development is greatly simplified. Proposal-based architecture handles complex front-end problems with a reusable, generic infrastructure 801. This infrastructure 801 contributes many features (undo/redo, annotation, etc.) that would otherwise have to be programmed manually. • There is now a roadmap for the region between consumer and database. A programming task that is currently ad-hoc, idiosyncratic, and unpredictable becomes rationalized. The invention's architecture contributes not only a set of behaviors, but also standard procedures and approaches. Even that code which is application-specific has clearly-defined sockets; the development job becomes less improvisational and more like filling in the blanks. The invention makes possible reliable project plans, staffing requirements and time/expense estimations. • Navigation comes built in. A Proposal, self-aware like all objects and even more introspective than most, knows a great deal about its own structure. It knows the type of its contents, how the contents are arranged, and the validation criteria for its contents. It "turns pages" and skips to appropriate fields automatically. The complex programming currently required for multi- page, hierarchic documents is avoided, because navigational intelligence is part of the proposal object's infrastructure. • Applications developed using proposals are easy to change. With the front and the back no longer closely-coupled, a change to one end does not involve corresponding changes to the other. Alterations are localized. Proposal behavior can be changed with a change to the metadata. Adding a new user interface — enabling a Web browser, for instance, or hooking up to a bar-code reader — involves work at that interface and nothing more. Back-end changes are made at the TP/DB interface. Implementing these changes may still require extensive programming, but the programming is isolated. • Referring to Fig. 9, a Proposal 902 decouples the user interface 901 from the transaction processor 903. The Proposal 902, not the user, addresses the back end 903. On the other end, the Proposal 902 accepts input from virtually any user interface 901 (since the essence of a Proposal is non- visual, viewers are "dumb" and easily created). Thus, a single back end 903 can support several different user interfaces 901 — Internet, GUI, Object- Oriented (OO) UI, proprietary interface, a device like a bar code reader or keypad — simultaneously or serially. A Proposal could be initiated on a scanner, sent over the Net to a human using a Mac, reviewed on a Web browser by his supervisor, and launched toward the TP monitor from a PC. • Inherently independent of the server, Proposals work equally well for on-line, real-time interactions and for off-line data gathering. They are ideal for mobile computing. • The invention enables new-wave Internet security, including authorization, authentication and digital signatures. Individual versions can be set up to support reliable signatures indicating who requested what changes. A Proposal object can display both its current, cumulative state and also a linked list of changes, signatures, and dates and traces what happened at every point. The CIA could, for example, go back and identify every transaction that Aldrich Ames had a hand in. • Proposals concretize the transactional conversation. A transactional conversation — ephemeral, like all conversations-vanishes once completed or aborted, leaving no record of the process. A Proposal, on the other hand, contains a detailed history of its own evolution: preliminary attempts, annotations, approvals and overrides. Since it layers every step in its development like overlapping transparencies, a Proposal can be rolled back to any earlier point. Full n-level undo/redo is automatic. Proposal objects can also be archived, creating a full "paper trail" for later audit. • Proposals model the way humans work, and are therefore more pleasant and more efficient to use. The transaction monitor (or equivalent function within the database) demands certain input in a certain order, and the user must scramble to oblige. With a Proposal as intermediary, the process becomes more flexible and forgiving. A Proposal can be pended and worked on over time. It can be moved around among users, so that collaborative computing becomes easy. It will accept tentative, incomplete, even erroneous input and flag it for further work later. A Proposal can carry annotations, notes to oneself or to a colleague. • Proposal-based architecture adds value throughout the process of preparing a unit-of-work. Current technology kicks in only at the very end of what can be a long, collaborative, start-and-stop process that has to be assembled on paper and routed through the organization by people walking around from desk to desk. Proposals get the computer involved from the beginning. They can tolerate tentative, half-done, interrupted, even erroneous data, and help shape it into a formal transaction. For example, a new-hire procedure could start the day the applicant comes in for the initial interview, follow her throughout the interview/background check/skills-test process, and finally, if all goes well, turn into a formal "AddEmployee" request to the HR database. • Proposal-based architecture lets transactional applications take advantage of Workflow. The two technologies are strongly complementary: workflow provides the transport system, Proposals package up the contents of what is transported. A one-user/one-mainframe conversation cannot be transported around an organization, but an object can. Proposals turn transactional conversations into routable entities that a Workflow system can handle. None of the above capabilities is unheard of in transactional applications. But where they exist, they have been achieved with great effort, and on a one-time- only basis. The significance of the invention is that these capabilities are innate. They are built into the infrastructure, available to any application that wants to make use of them. In a sense, they come free. The invention's approach to conceptualizing, object-izing, and architecting the vast application logic piece of transactional systems offers many advantages. • Developers find a ready-made framework that contributed large chunks of useful infrastructure, dramatically reducing the time and effort of building transactional apps. They also get a formalized methodology for organizing that kind of development job. • Users find an accommodating face on formerly unforgiving applications. If a TP monitor is like an impatient and demanding boss who will kick you out of his office if you haven't got all your ducks in a row, a Proposal is like a sympathetic admin sitting out in the anteroom, helping you organize your presentation, gather your supporting documents, and checking in with the boss of your behalf. • Organizations find their aging applications catapulted into the 90s. Adding Web front-ends, using Workflow, implementing mobile computing and collaborative computing become trivial jobs instead of major undertakings. The invention restructures applications so they are ready to take advantage of new developments as they come along. ADDING PROPOSAL-SPACE TO COMPUTER APPLICATIONS Where Does a Proposal Live? With respect to Fig. 10, a Proposal lives between the consumer and the resource. This does not tie it to any specific platform, tier, or machine. In a client/server interaction, the Proposal would reside either on the client (fat client) 1001 or the server (thin client) 1002. In a three-tier system, it would probably occupy the middle tier 1005. In a monolithic system 1003, it would sit between user and data on the mainframe. It is a great advantage of a Proposal that it moves freely among platforms. It can change its location on an interaction-to- interaction basis. What Does a Proposal Have to Do? To accomplish its job, a Proposal must assume a number of responsibilities for its own metadata, the application-specific data entrusted to it, and many navigational and organizational chores. Each of these responsibilities is implemented via behaviors built into the generic Proposal object, and state specific to that particular instance. Much greater technical detail follows in the "implementation" section of this paper. 1. Know Its Own Definition. Referring to Fig. 11 , a Proposal has a great deal of self-awareness. It is what is called a "highly introspective" object. It knows the type of its contents. It knows how those contents are arranged hierarchically, and it knows the cardinality of that hierarchy. The Proposal is aware of whatever customized validation strategies have been specified. It knows enough about itself to perform reasonable data mutation on a metadata change. State: Metadata 1108 Methods: Define 1107, Mutate 1106 2. Act as a Container for Proposal Data All data related to a specific Proposal is encapsulated in that instance of the Proposal object. This data can be saved in any partially-completed form. Hierarchic navigation through the data, a sort of "page-turning" through a complex document, comes built in. User interactions with the data are standardized. State: Proposal Data 1108 Methods: Navigate 1101, Access 1102/S 3. Keep Versions of Itself Each modification to a field in a field-group is interpreted as a new "version." All versions are retained for the life of the Proposal, or until explicitly disposed of. This versioning permits unlimited undo/redo, even across session boundaries. A Proposal can be customized to associate a digital signature with each version, creating a record of who made what change when. State: Versions 1108 Methods: Undo/Redo 1103 Retain and Track Errors Proposals will accept, hold and tag erroneous or incomplete data. Any number of errors can be associated with any Proposal element — page, etc., down to field level. Errors can be externally manipulated; set by a "review agent," for instance. Errors and error notices persist across sessions and across locales; they travel with the Proposal. The Proposal infrastructure includes an error- search mechanism that makes sure all errors are resolved prior to submission. State: Errors 1108 5. Hold Annotations As with Errors (which are really a specialized form of Annotation), a Proposal can associate any number of Annotations with any Proposal element. Annotations are versioned, and thus undo/redo-able. They can be externally manipulated and scanned for summary review. State: Annotations 1108 6. Interact With a Variety of Consumers A Proposal is a non-visual object that can support a wide variety of consumers. It implements standard viewers into the Proposal object. It co-ordinates events and messages for both the consumer and the Proposal. With this setup, even non-human automatons can be "consumers," for example... Method: Co-ordinate Front End 1105 7. Interact With Server At its other end, the Proposal interacts with the server that holds the datastore. The interface between the Proposal and the back end is dictated by the parameterized interaction mode. • The interface to a database system (JDBC) can automate "data-mapped" back ends. • The interface to a transaction processor defines the protocol for "function- mapped" back ends. • The interface to an 00 database can automate "object-mapped" back ends. Method: Co-ordinate Back End 1104 8. Protect Against Stale Data Since the Proposal "withdraws" data from the database and works with it over what may be a long period of time, it needs to make sure that the data has not become stale in the interim. The invention accomplishes this with built-in optimistic locking. Behavior called "assumptions" defines optimistic parameters. Interference can be keyed off of a timestamp or off of arbitrary fields. The developer can specify, on a field-by-field basis, what the disposition should be when a mismatch is found: commit / rollback, notify/ hush, a custom fixup, or any combination — commit with notification, for example. Custom fixup strategies — LastUpdaterWins, for example-can be specified in Java. The invention implements a strategy called "proximate intentionality" to assure reasonable behavior, (explain). State: Assumptions 1108 PROPOSAL-BASED ARCHITECTURE: IMPLEMENTATION The invention consists of the following components: • Proposal Framework. The underlying library of software (implemented as 00 classes) that supplies the algorithms and data structures required for implementing Proposals and their metadata, both at development time and at runtime • Proposal Tools. The applications that let the Proposal adapter configure specific Proposal templates to be used for specific business applications. • Proposal-Aware Components. Software gadgets with built-in awareness of Proposal data structures that can be assembled to quickly assemble applications that will work with Proposals. Proposal Framework Technical Notes • The invention's implementation has been designed and implemented using object-oriented practices and terminology. A good overview is Object- Oriented Analysis and Design by Grady Booch. • Diagrams in this document follow the widely-used Object Modeling Technique (OMT) notation. These diagrams were produced by Rational Rose 3.0. • Since proposals need to collaborate intimately with transactions, much language and concept related to transaction processing is included. We use the definitions provided in Transaction Processing: Concepts and Techniques by Jim Gray. • In the succeeding pages, accessor methods are assumed for the state that is represented in the object diagrams. • There is frequent reference in this document to design or implementation "patterns." Patterns are a relatively new way of describing portions of a software design in a standard and succinct format. The defining book of the Patterns movement is Design Patterns: Elements of Reusable Object-Oriented Software by Gamma, Helm, Johnson and Vlissades (Addison-Wesley, 1995). This text is so universally used it has been nicknamed GoF (Gang-of-Four). All patterns mentioned in this White Paper are GoF patterns. The following is a brief definition of those patterns we especially rely in the invention's implementation, with the GoF definition quoted and then put into the invention's context. • Composite "Compose objects into tree structures to represent part-whole hierarchies. Composite lets clients treat individual objects and compositions of objects uniformly". Composite is used in numerous parts of the invention to implement tree structures. Its principle uses are the Proposal object and the PropSpec object — both of which subclass the same Composite behavior. • Facade "Provide a unified interface to a set of interfaces in a subsystem. Facade defines a flexible alternative to subclassing for extending functionality". The Proposal is a Fagade. It hides dozens of classes behind a single interface that gives the illusion of a single class interface. • Command "Encapsulate a request as an object, thereby letting you parameterize clients with different requests, queue or log requests, and support undoable operations". The Proposal object itself is a specialized type of Command. It stands for the consumer's request to perform a transaction. Commands are also used to implement the Undo/Redo behavior of versions. • Iterator "Provide a way to access the elements of an aggregate object sequentially without exposing its underlying representation". Both Proposal and PropSpec Composites have their own Iterators for "walking" the tree of data or metadata. • Observer "Define a one-to-many dependency between objects so that when one object changes state, all its dependents are notified and updated automatically." The Proposal object has an Observer for watching for its state changes. The UlCoordinator and BackendCoordinator are clients of this Observer and benefit from the Observer's vigilance. • Strategy "Define a family of algorithms, encapsulate each one, and make them interchangeable. Strategy lets the algorithm vary independently from clients that use it." Both the TypedObject structure (shown in the PropSpec class diagram) and the Backend ResourceCoordinators are Strategy patterns. They allow alternative behaviors to be supported as options to the execution context. . Visitor "Represent an operation to be performed on the elements of an object structure. Visitor lets you define a new operation without changing the classes of the elements on which it operates." Visitors are used throughout the architecture. These are analogous to "user exits" from mainframe days. A user can supply supplementary behavior and install it into the invention to customize it. For example, the TypedObject supports a Visitor called a Validator. An adaptor can write a custom component to check the validity of a particular PartNumber format. He then installs it as a Visitor to customize the PartNumber. Visitors are also used in Assumptions and ResourceCoordinators. Responsibilities into Objects The invention uses "responsibility-based design," which describes an object's responsibilities and then implements each in terms of state (data structure) and behavior (algorithms). The Proposal responsibilities, to summarize from the Concept section, are: 1. Knowing its own definition 2. Acting as a container for proposal data 3. Keeping versions of itself 4. Retaining and tracking errors 5. Holding annotations 6. Interacting with consumers 7. Interacting with the back-end server 8. Protecting against stale data We discuss each in detail below. Class diagrams show what object classes are needed and how they relate to other classes. These diagrams are followed by a spreadsheet that contains a more detailed legend of the vocabulary used in the diagram. In some cases, specialized algorithms needed by the classes are discussed and/or diagrammed. Implementing this state and behavior with a programming language produces a software machine that actually executes any kind of Proposal. 1. Knowing its own definition Most simple software programs don't need to "know" much about themselves. They simply do what they do; for example, an AccountsReceivableAging report knows how to look through its database of accounts and print out a list of who is late in paying. However, more sophisticated programs need to adapt themselves for use in multiple situations. A Database Management System (DBMS) is an example. When the software is first purchased, it knows a great deal about data storage and manipulation but knows nothing about any particular application. The database programmer "trains" it to understand a specific database structure by providing it with "metadata," data that describes the data. The DBMS "learns" about a particular application area by absorbing and adding to its repertoire detailed definitions of the use to which it is being applied. This ability of programs to customize themselves to particular situations by absorbing using metadata is called "introspection" by object practitioners. The Proposal implementation is introspective. In itself it is a generic component that knows nothing about any particular application. It is adapted by a software developer for a particular use — ustomized into a NewHire Proposal, for example. The developer does this by supplying metadata to the Proposal object. The metadata describes the particular business usage that the Proposal object is being called upon to simulate. For example, a developer may be building a NewHire proposal that will be used to perform the business function of hiring an individual into a company. The developer provides metadata describing the various data fields of a NewHire (name, address, education history, job history, etc.) and how they relate to one another. The newly-trained Proposal object is now available to the end user, perhaps a manager or a person in the personnel office. By this time, the NewHire Proposal knows the organization's hiring procedures along with the generic Proposal behaviors (how to annotate, change, navigate, etc.) that derive from its internal expertise as a Proposal object. The end-user will use an instance of the NewHire Proposal every time a candidate is to be hired: there will be the HireJohnSmith Proposal, the HireSallyJones Proposal, etc. The first responsibility of a Proposal, then, is to hold the adapter-supplied metadata that turns it into a NewHire Proposal, a ShipProduct Proposal, or whatever. The invention accomplishes this through a structure called a PropSpec, or Proposal Specification. The PropSpec is the container for Proposal metadata. With respect to Fig. 12, a class diagram shows the major classes in the PropSp PropSpec Definitions Comments 1. The PropSpec class implements a Fagade pattern, a pattern used to create a single interface to a number of collaborating classes. 2. The principle class in the PropSpec is the FieldGroupSpec. This class defines the characteristics of each "FieldGroup." A FieldGroup is a group of fields related by a common key definition. It is roughly analogous to the fields that would be on each logical page of a multi-page proposal document. 3. Notice in the Class Diagram that FieldGroupSpec recurses (it can include itself any number of times). It is this line that defines the n-level hierarchy of the proposal. The proliferation of FieldGroupSpecs is bounded by the min and max values which indicate how many times the current FieldGroupSpec can (or must) occur within its particular parent. 4. The recursive FieldGroupSpec structure is best implemented as a Composite pattern with companion Iterator. 5. FieldGroupSpecs contain many FieldDefs, each of which contain detailed information about one field in the FieldGroupSpec. 6. Terminology note: it will become clear when comparing this section to the next that a parallel set of class structures are defined for the actual elements that the PropSpec defines. We've attempted to keep the names parallel: a FieldGroupSpec defines the specifications of a FieldGroup; a FieldDef specifies the definition of a Field; and so forth. 7. Supplementary information is kept for fields that are keys. In the invention, a key is a field or group of fields that defines the uniqueness of a FieldGroup. Note that the KeyDef keeps track of whether a key field is "owned" by a parent fieldgroup. Parent ownership means that the particular key field in question is defined in the current fieldgroup or by one of its ancestors. Consider this example: We are currently modifying a SalesOrder proposal and are positioned to the second line item for Product Sweeper of SalesOrderNo 1234. This particular FieldGroup has two keys SalesOrderNo and Product. Both keys are required, since neither alone would uniquely specify this FieldGroup. Product is defined "locally" to this group - thus it could be changed in the current FieldGroup. But SalesOrderNo is owned by a parent FieldGroup (OrderHeader) and can only be changed in the parent. 8. The TypedObjectSpec is the top of an inheritance structure that defines different basic types to the system. Currently seven types are provided. Users can easily extend these types by adding new classes to the system. 9. The PropSpec needs to "persist." This is covered under "Proposal Persistence" in the section that follows. 2 . Acting as a container for proposal data Once metadata has been put into the Proposal to describe its application- dependent properties, it becomes possible to use the Proposal as a container for application data. Referring to Fig. 13, a class diagram shows the basic Proposal structure. Proposal Definitions Comments 1. Notice the congruence between the PropSpec and Proposal classes. This congruence has been reflected in the naming conventions used {e.g., FieldDef and Field). Both support Facade patterns to encapsulate the PropSpec objects (in the former case) and the Proposal itself (in the latter case). 2. The Proposal is implemented as a Composite pattern with Iterator. 3. Proposal objects (like the PropSpec object) are 100% non-visual. While other components may act as viewers, these objects are built for quiet use. This is a major feature: It allows these objects to be accessed and manipulated by non-human automata as well as human-driven user interfaces. 4. The Proposal object makes extensive use of the currentFieldGroup. This term designates the FieldGroup that is the current focus of attention. 5. An extensive amount of special behavior is associated with inserting data into the Proposal hierarchy. This will be covered under "Insert Processing" below. 6. Once the data is inserted into the hierarchy, navigation is simply a matter of invoking the various iterator functions (up, down, next, previous, top, bottom). 7. OverrideMode is a Proposal attribute that can be set so that errors are accepted without any notification to the user. It is useful when a batch program or other non-human consumer wants to push data into a Proposal and have it reviewed later. When OverrideMode is on, the Proposal still performs the error checks and marks the Fields in error; it simply doesn't complain to the consumer about the error. 8. ValidationMode allows new data to be entered with no error checks at all. It is used to speed up loading of data that has already been validated by some other process. 9. The validate methods are used to fire Visitor objects. These are dynamically loaded validations written in a scripting environment that the user can supply. 10. Special processing associated with building the actual tree is covered in the subsequent section "Insert Processing." 11. Proposal state needs to be saved. This is covered in the section "Proposal Persistence" below. Insert Processing Inserting into a Proposal poses a greater challenges than all the other navigation operations combined. The reason is simple: Insert mode has the responsibility for properly shaping the multi-level FieldGroup tree, where other operations simply travel on an already-constructed shape. Before describing the insert algorithms, it would be helpful to describe a sample application for use as a reference point. Consider a hypothetical sales order entry system. It consists of Order Header (customer info, shipping info) Lineltems (product code, qty, amount - min=1 , max=99) Shipment(shipQtyCommitment, shipDate - min 0, max 5) Special Instructions A given sales order in this sample: • has one and only one header. • must have at least one lineitem, and can have up to 99. • can optionally have partial shipments, up to a max of 5, under each lineitem. • can optionally have a single section of Speciallnstructions. As this sample indicates, there are numerous points in the order entry sequence in which an operator may either want to proceed to the next logical step, or skip to the next type of FieldGroup (example: I've entered two Shipments under Lineitem 1 and have no more to enter, so I now want to proceed to Lineitem 2). The invention accordingly provides two different user interface events that signal these two different kinds of Insert: InsertOK and InsertCancel. These two events can be assigned to specific keyboard keys (the default is InsertOK is a FunctionKey12 and InsertCancel is Escape), or to U I widgets such as buttons or menu items. InsertOK means to keep going "down" the tree (preorder traversal) until the max count is exhausted. Examples: I've entered the Order Header; go to Lineitem 1. I've entered Lineitem 1 ; go to Shipment 1. I've entered Shipment 5; go to Lineitem 2 (the max has been reached). InsertCancel means to escape from the current path and try the next logical type Examples: I've canceled from Lineitem 2; go to Speciallnstructions. I've canceled from Shipment 3; go to next Lineitem. An insert technique (in pseudocode) for implementing entry of this sample (or any other arbitrarily deep tree structure) is as follows: Fgs = FieldGroupSpec Fg = FieldGroup If (Fg is empty) Insert(RootFieldGroupSpec) Return If (InsertKey is InsertCancel) goto Cancel If (current Fg's type has a descendent type) //e.g. Lineitem has a Shipment lnsert(Descendent Type) Return If (current Fg's own type is not exhausted (exceeded max)) lnsert(Another Fg type) //e.g. Shipment follows Shipment Return; Cancel: If (any peer type of this type in the Fgs (that is not exhausted)) Insert(PeerType) //e.g. Item goes to Special Instructs Return While (this node has a parent in the Fgs) Make parent node the current If (there is any child node that is non-exhausted) lnsert(it) Keep trying until root Stop trying... the Proposal is full. Tentative Inserts The algorithm specified above solves most of the problems relating to a Proposal insert. However, there is still one outstanding discrepancy. When a user decides on the node to insert there is still a gap between the time the new FieldGroup is created and the time that the keys that define this node's existence are specified. For example, a user might have executed an InsertCancel to finish work on Lineitem 2 and now positions to Lineitem 3. Until the full key is set (in this case OrderNo and Product) a canonic FieldGroup cannot be recognized by the Proposal object. This condition is called the Tentative Insert condition. The FieldGroup in this condition is called an "underspecified FieldGroup". The Proposal object has several methods for dealing with Tentative Insert. When an underspecified FieldGroup is created, it is automatically flagged as such. As key fields are subsequently entered, the Proposal notes when key field collection has been completed. At this moment the Proposal internally switches gears from Tentative Insert into Full Insert mode. It also fires an event that any interested party can "hear," signaling the change in status of the Proposal. An external consumer has the option to abandon a Tentative Insert by executing the cancellnsert method and moving on to the next available nodeType. For example, consider the case where the user is at Lineitem 2, Shipment 3. Hitting the first InsertCancel makes the Proposal object start a tentative insert at Lineitem 3. But if there are no further lineitems, a subsequent InsertCancel moves the user on (without penalty) to the Speciallnstructions. Yet another InsertCancel terminates entry into the Proposal altogether. In each of these cases a Tentative Insert was initiated, canceled, then passed onto the next candidate type. Proposal Persistence The Proposal and PropSpec will need to be saved to some "external form" so that they can persist between sessions or when passed around to users on different platforms. Unfortunately there is still no standard, portable mechanism for storing in-memory objects onto an external form. There are many such mechanisms that are specific to a language or platform, and a Proposal implementer can choose any of these mechanisms that are convenient or available. However, to satisfy those who need more options, The invention has defined its own formats for PropSpec and Proposal persistence. These storage models support all of the invention's features and functions described in this document. In both the PropSpec and Proposal cases, the internal objects are converted into a standard textual representation that can be read and written on any computer that supports text. It can be stored on any medium, sent over any communication (it can even be printed out on one computer and rekeyed into another, though this is not a recommended method of Proposal transfer). Proposal persistence to text files and to a relational database come as built-in features; almost any other kind can be added to the framework. The Proposal files can appear in two forms: • PropSpec file , which contains only information related to a single PropSpec • Proposal files, which contain all the information specific to a given Proposal, plus the PropSpec information that defines the Proposal. Proposal syntax The following syntax definitions show how the Proposal and PropSpec state is formatted for persisting onto any external definition. These style of these definitions is rendered in a "relaxed" version of the standard Backus-Naur Form (BNF) that has been used for years to document the syntax of programming languages. A quick summary of this relaxed BNF is given below: • The left-justified word that begins each "paragraph" is the name of the term being defined. • Italicized text represents the usage of a defined term or an informal comment that describes the usage of multiple terms {e.g., "One of the following"). • Normal, non-italicized text represent the literal word used • A term is defined before it is used. • Words enclosed in angle-brackets {e.g., <fieldName>) are used merely to delimit terms in a context with intermixed terms or literals. Proposal text: One or more PropBlocks PropBlock: Fields { FieldBlock } FieldGroup { FieldGroupBlock } Proposal { ProposalBlock } FieldBlock: One or more FieldDefinitions FieldDefinition: <fιeldName>, <typeDefinition>, <lengthSpecifier>, <descriptionString>, <default>, <validatorList>; [Note: all zones after typeDefinition are optional] /7e/α7Va.τ.e: A fieldName with leading letter, Followed by letters, digits, or '_' TypeDefinition: One of the following: Int Num Dec Char Date Time Timestamp < UserDefιnedType> L/serDe/.t7edType: A string with a Visitor object defined to implement type behavior Length Specifier: Either: Whole number that represents external length Real number that represents <length>.<precision> Default: Default value of appropriate type Validatorϋst: [ validators | <validator1>...<validatorN>] Validator. [<validatorProcedure> | Zero or more args separated by semicolons] PropBlock: <specifιer1> = <specValue1>; <specifιerN> - <specValueN>; [ fields | <fιeldUse> <fieldUseN> ] [ subFieldGroups | <subFieldGroup>;<subFieldGroupSpec>] [ assumptions | <assumption>; <assumptionN> ] Specifier: One of the following: Domain [Note: Backend resource name] InteractionMode [Note: Default interaction mode] <userdefιnedvalue> SpecValue: Appropriate value for specifier FieldUse: <FieldldentifierlnContext>,req [Note: "req" presence is optional] FieldldentifierlnContext: ieldName [Note: indicates a key field] fieldName [Note: indicates a nonkey field] SubFieldGroupSpec: [ <subFieldGroupName> | <subFieldGroupType> ( <keyfields-comma-delimited>); <min>; <max> interaction Mode> ] InteractionMode: One of the following: Null Exists Default Update New Delete Assumption: <fieldGroupName>, <fιeldName-or-list>, <commitAction>, <notifyAction>, <fιxupAction> Action: <same format as Validator> [Note: Name of visitor that defines that action] ProposalBlock: <speci fieri > = <specValue1>; <specifierN> = <specValueN>; <fιeldGroupBlock> <versions> fieldGroupBlock: [ <fιeldGroupName> \ <fιeldContent> ; <fιeldContentN> ; <fιeldGroupBlock>] [ Note: internal <fieldGroupBlock> is optional] fieldContent: <fieldValue> [@fldNote| <name>;<time>;<noteString>] [@fldErrs | #</ ' <-/> ; <errorcodeMessage> ] [Note: fldNote & fldErrs are optional depending on their existence] versions: [©commands | #<id> ; <action>; <fιeldGroup>; <fieldName>; <keys>; <oldFields>; <newFields>; <note>; <positionToPlace> ] keys: List of comma-delimited fieldnames that are the keys <oldFields> <newFields> <fieldName> = <fieldValue>, <fieldNameN> = <fieldValueN> Sample Proposal This Sample Proposal is in external form. It is composed of fragments of the file. It is semantically incomplete. Its purpose is to demonstrate the syntax. fields collected { empld,num,6; name,char,20; addrType,char,8; street1,char,30; street2,char,30; city,char,20; state, char,2; zip,num,5; emailService.char, 15; } fieldGroup Employee { domain=PersonDomain; interactionMode=New; [fields|*empld,req;name] [subFieldGroups|[HomeAddress|HomeAddress(empld,*);1 ;1 ;default]; [OtherAddress|OtherAddress(empld, * );0; * ;default]; [EmailAddress|EmailAddress(empld, * );0;3;default]; [Education|Education(empld,*);1 ;*;default]; rWorkHistory|WorkHistory(empld,*);0;*;default]; [Club|Club(empld,*);0;*;default]; 3) fieldGroup HomeAddress { domain=Address; interactionMode=New; [fields|*empld,req;*addrType,req;street1 ;street2;city;state;zip] fieldGroup OtherAddress { domain=Address; interactionMode=New; [fields|*empld,req;*addrType,req;street1 ;street2„ [validators|[Policy.RangeCheck|90000;99999]];city;state;zip,, [validators|[Policy.RangeCheck|90000;99999]]] } fieldGroup EmailAddress { domain=Email; interactionMode=Update; [fields|*empld,req;*emailService,req;email] } Proposal this { highCommandld=0; highErrorld=2; [Employee| 1234; John Tibbetts; [HomeAddress|1234;Home;289 Douglass St;;San Francisco;CA;94114;] [OtherAddress|1234;Mom's;42240 Parm Ave;77777 [@fldErrs|[#1|street2 value of 77777 is below min value 90000]]; Mission San Jose;CA;66538 [@fldErrs|[#0|zip value of 66538 is below min value 90000]];] [OtherAddress|1234;Vacation;999 Mountain Road[@fldNote|Default;970324.123121 ;teststreet1];;Santa Cruz[@fldNote|Default;970324.123113;tescity ];CA;95432[@fldNote|Default;970324.123102;test zip];] [EmailAddress|1234;lnternet;john@kinexis.com;] [EmailAddress|1234;AOL;johntib@aol.com;] [Education|1234;Bellarmine;9Q59;6Q63; [Course|1234;Bellarmine;LibEd;Liberal Ed;] [Course|1234;Bellarmine;Judo;Judo;]] [Education|1234;LoyolaU;9Q70;6Q71; [Course|1234;LoyolaU;Engr;Electrical Engineering;]] [WorkHistory|1234;Tymshare;9Q71 ;8Q76; [JobTitle|1234;Tymshare; Application Consultant;] [JobTitle|1234;Tymshare;TASC Sales;] [JobTitle|1234;Tymshare; Regional Tech Manager;]] [WorkHistory|1234;Noesis;9Q76;3Q81 ; [JobTitle|1234; oesis; Vice President;]] [WorkHistory|1234;Datalex;3Q81 ;8Q87; [JobTitle| 1234; Datalex; President;] [JobTitle|1234;Datalex;Chief Technology Officer;]] [WorkHistory|1234;Kinexis;9Q87;12Q99; [JobTitle| 1234; Kinexis; President;]] [Club|1234;OS/2 User;Evangelist;]] [@commands| [#0|970324.123101 ;101 ;OtherAddress;zip; [keys|1234;Vacation];;;[note|Default;970324.123102;test zip];;] [#11970324.123113;101 ;OtherAddress;city; [keys| 1234; Vacation]; ; ; [note| Default;970324.123113;tescity ];;] [#2|970324.123121;101 ;OtherAddress;street1 ; [keys|1234;Vacation];;;[note|Default;970324.123121 ;teststreet1];;]] } 3. Keeps versions of itself There are two quite distinct advantages to having a Proposal keep versions of itself. Undo/Redo A Proposal can use the version list to undo actions that have been previously accepted. Further, a Redo operation can allow OundoneO operations to be redone. These two operations let an end-user can scroll back and forth through previous versions of the Proposal to position on the exact candidate version from which he would like to continue. Auditing Since a Proposal can be passed among numerous parties during their life span, it is useful to be able to examine the Proposal later in its life to see exactly who was responsible for what changes in the Proposal. With respect to Fig. 14, a class diagram shows the version classes. Comments • The overall design of Versions is implemented with the Command pattern. This pattern records actions performed by some agent. Playing these actions backwards yields "undo;" replaying them forward yields Oredo.O Notice that the naming convention follows the Command pattern usage even though the elements end up representing Proposal versions. • The granularity of Proposal version control is at the FieldGroup level. For example, a user who changes three fields in Lineitem 2 generates a single version entry for Updating a Lineitem. • Logged changes record only fields that are relevant to a change. In the example above, only the three updated fields are logged, not the fields that remained the same. • The version contains both the values before and after the change. This allows complete ability to undo or redo without reconstructing context. • The signature field is a holder for any implementer-defined object or objects that identify the consumer making the change. This field can be as minimal as a character string that holds the person's name or as complete as a fully- constituted encrypted digital signature that could support high reliability and non-repudiation needs. Version information persists with the Proposal object. Even if the Proposal is routed to another user and reentered on another day, all of the previous versions are still available for either undo/redo or auditing purposes. 4. Retains and tracks errors A conventional transactional system rejects errors immediately. Incorrect or incomplete data will not even make it through the user interface, and usually terminates the transactional conversation. But with Proposals as part of the system, errors can be accepted, held, and monitored. The Proposal signals immediately that a field has been filled in with erroneous or incomplete information, then gives the user the option of fixing or retaining it. If the error is retained, the Proposal tracks it so that it can be found and resolved later. All errors must be eliminated before the Proposal turns into a transactional request at submission time. For example, an international Purchase Order Proposal object might signal an error if the end-user requests the shipment of a certain technology that cannot be legally exported. The user can continue to work on the Proposal, and route it later to a specialists in export policy who can perform a more informed fixup. Referring to Fig. 15, a class diagram shows the error class. Comments • Error messages can be associated with any of three tiers in a Proposal: the Proposal Object itself, each FieldGroup, or each Field within each FieldGroup. This allows errors to be owned by their proper domain. For example, an error message signaling an invalid zip code would be associated with the faulty zip field, while a credit limit failure on the whole purchase order would be associated the Proposal object itself. • Any number of error messages can be associated with any of the available slots. Error messages are saved with the Proposal object. Thus they can be retained across sessions and routed to other consumers of this object. 5. Hold annotations Annotations are similar to error objects, except they contain informational notations rather than error messages. They can be used to record a user's notes to himself or to colleagues, giving instructions for the Proposal, making comments, suggestions, explanations or justifications. With respect to Fig. 16, a class diagram shows the note class. Comments • The annotation is signed and time-stamped. This positions it relative to the other Proposal activity. • Annotations make version entries. They are audited just as data changes are. They can also be undone/redone. The preceding sections have reviewed the characteristics of the non-visual Proposal faςade and the PropSpec, its metadata framework. The next sections discuss how these objects communicate with the outside world. 6. Interacts with a variety of consumers This section deals with the collaboration between the Proposal and the front end. The front end can be any type of consumer interface technology, but it is typically a graphical user interface or Web browser. The Proposal interface documented in section 2 above satisfies most consumer- interface needs. With these components a GUI widget, for example, can access a field value from the Proposal object and display it. Conversely, a button-press will cause a FieldGroup to be deleted. However, additional consumer interfaces may be needed. Proposal event structure This is the primary additional interface required. It allows the Proposal object to notify interested external parties about change in its internal state. Notification is accomplished via the Observer pattern (also called Publish- Subscribe). Consider this example: a user is using a ChangeOrder Proposal that will allow a change to be made an existing order. He has entered the SalesOrderNo and the Proposal has accessed a database to populate its internal Field objects. Now the Proposal needs to notify various UI elements that the data has changed so that they will now display the populated values. It does this by firing the FIELDGROUP_CHANGED event. The following is the list of Proposal events: PROPOSALJNIT A Proposal instance has been just created PROPOSAL_CHANGED A data field has changed value FIELDGROUP_ADDED A FieldGroup insert or append has been done FIELDGROUP_REMOVE A FieldGroup has been deleted FIELDGROUP_ENTRY Proposal navigation has entered a FieldGroup FIELDGROUP_EXIT Proposal navigation has exited a FieldGroup FIELDS_CHANGED A group of Fields has changed FIELD_CHANGED A specific Field has changed FIELDSTATE_CHANGED Internal entry requirements (fieldState) changed FIELDGROUPCHGPEND Get ready for FieldGroup switch KEYS_NEEDED Keys needed in FieldGroup KEYS_RESOLVED Keys have just been satisfied NONKEYS_NEEDED Non keys needed POPULATE_FIELDGROUP Populate fieldGroup COMMIT_FIELDGROUP Commit fieldGroup UlCoordinator The Proposal event structure is sufficient to provide a two-way interface between a consumer component and the Proposal. However, since it is common in GUI front-ends to tie many components to a "model" object (the Proposal is a kind of model object), it is desirable to have a flexible mechanism for binding these components to the Proposal. The UlCoordinator provides this additional level of functionality. Specifically, UlCoordinator provides these features: • The UI components have a single point to register their interest in a proposal. • The component can specify which types of Proposal events it is interested in tuning in on (event filtering). • The component can further specify which particular Proposal fields it is interested in observing. The coordinator will only notify of change to that particular field. • The Coordinator can "autoregister" many components. "Autoregistration" needs additional explanation. Registration is the process by which a Component makes itself known to the coordinator. In certain environments, it would be desirable for this registration to happen automatically.. Consider a visual builder that constructs a GUI from "Proposal-aware" components. A coordinator might be dragged onto the visual palette to act as the intermediary for all activity between the Proposal and its components. These components — also dragged on to the GUI by developer — may number in the dozens: pushbuttons, fields, fieldPanels, labels, etc. All will need registration to the coordinator. In most GUI environments this represents separate gestures that "link" the coordinator to the component. Autoregistration is the aspect of this system that automatically provides the linkage, assuming there is no ambiguity. The coordinator initiates autoregistration after all the components have had a chance to register manually. It visits its parent "container" and takes a scan at all its descendents; in a GUI this means it asks its parent window for a list of all descendents. It then goes through each, spots the "Proposal-aware" ones (that is, the candidates for registration), then invites each to dynamically register. The table below shows the interactions between component, coordinator, and proposal. 7. Knows how to interact with server The last section examined how the Proposal interacts with the front end. Now we examine how it will interact with the back end. The back end is where the managed resource (usually data but sometimes data and behavior) lives. This is a typically some sort of database, transaction processing environment, or more recently, object environment. In all of these cases the Proposal architecture "proposes" and the backend "disposes" of the Proposal. The invention provides a separate interface for each of three styles of back end "resource coordinator." All three of these ResourceCoordinators share a common superclass. In most operating environments a particular user would only use one of these three back end alternatives, depending on the needs and legacy of their system architecture. To allow for a Proposal conversation to reach all the way from Proposal to ultimate resource, the invention implements two translation stages: low-level, which links Backend Coordinator to ResourceCoordinator, and high-level, which links Proposal to Backend Coordinator. Low-level translation - BackendCoordinator to ResourceCoordinator The low-level translation provides the mapping between the BackendCoordinator and the diverse backend resource types. Internally the BackendCoordinator issues its request to the subclasses using a standard set of inputs: • Type of low-level operation being performed 1. Select - read data by keys from the resource 2. Insert - insert data into the resource 3. Update - update resource data that matches the key 4. Delete - delete resource data that matches the key FieldGroup being worked on List of fields manipulated To make sense of how we can map these operations to the lower-level resources requires that we understand more about the precise interface style of each resource. Referring to Fig. 17, in very general terms, these three backend ResourceCoordinators represent the three ways that any client can interact with any server: Data-oriented interface (DBCoordinator) 1703 Used with a database backend. Interaction is characterized by a standard data manipulation operation on specified data. Function-oriented interface (TPCoordinator) 1704 Used with any kind of function-oriented server (TP monitor, RPC, DCE, etc). Interaction is characterized by a verb (function to be invoked) and arguments to the function. Object-oriented interface (OOCoordinator) 1705 Used with an interface to any OO environment. Interaction is characterized as a message with arguments sent to a particular object that interprets the message in its own particular way. The following table summarizes how the inputs listed at the top of the page match the particular characteristics of each ResourceCoordinators. Comments on the DBCoordinator column This is the simplest form of back end mapping. BackendCoordinator operations exactly match the SQL DML verbs, FieldGroups = Tables, Fields = fields Comments on the TPCoordinator column This is the most complex form of back end mapping. There are no standards whatsoever for implementing business function in a function- oriented server (such as a TP monitor). The FunctionMapper is a Visitor object (user-supplied class) that takes two inputs: Action and FieldGroup. These two inputs are used to compute the server function to be executed; for example, Operation Select on FieldGroup Employee might compute a result that is ReadEmployeeData. The actual method of computation is left up to each installation of the invention. A simple form might be a two dimensional array that fills in all possible functionNames for each of the four operations and all the FieldGroups. Alternatively, a more architected solution would be to support invention-compatible naming conventions that would simply map to something like SelectEmployee. This last solution makes the FunctionMapper trivial but assumes that the server behavior has been explicitly modified for the invention. • The DataMapper is a Visitor object that maps input arguments and return values (resultsets). The values that are passed (or returned) are simply lists of Field objects. For example, a TerminateEmployee might define the Field object EmployeeNumber and TerminationDate. The DataMapper allows these fields to be converted to the appropriate values that interface to the signature of the TerminateEmployee transaction. Like the FunctionMapper above, the DataMapper is user- supplied. It can be complex if it is interfacing to a server that has no previous knowledge of the invention. Conversely, if field arguments are architected to match between the resource and the invention, the DataMapper might do nothing at all. Comments on the OOCoordinator column The OOCoordinator falls somewhere between the previous two in terms of complexity. Depending on the outcome of Business Object standards they could quite readily become as trivial as the DBCoordinator. • Two of the three interface categories (FieldGroup becomes class; Field becomes accessor) provide a simple interface, assuming that the backend implementation has conformed to the standards outlines above. • The Action operation depends on currently non-standardized object instantiation and access rules. Various ObjectDatabase technologies resolve these issues with propriety command sets. Failing that, an object implementer can use the Flyweight pattern to implement conformant activity. • Action mapping involves using the keys for the object Logical Object ID (LOID). • The actions correspond to: 1 select - access an object in domain space by keys (LOID) 2 insert - instantiate an object with keys = LOID 3 update - modify the object with keys = LOID 4 delete - stop referencing object with keys = LOID High- evel translation - Proposal to BackendCoordinator The high-level translation converts the more coarse-grained Proposal operations into the finer-grained low-level operations seen above. The high-level resource operations that the Proposal uses are the following: • Populate Populate is used when a FieldGroup needs its data fields filled. For example, a Meritlncrease proposal might take an Employeeld and look up relevant employee info (e.g., Name and CurrentSalary) and fill it in to the FieldGroup. • Commit Commit is used when a consumer has indicated that a Proposal is ready to be transacted. The FieldGroups data is then moved over to the BackendCoordinator. • Validate Validate is used immediately before the commit (or earlier in a Proposal life if the consumer wishes) to validate that the data currently held in the Proposal is still current with the data that is kept on the server. The order of invocation of these operations is qualified by a parameter in the FieldGroupSpec class of the PropSpec called InteractionMode. The InteractionMode defines the context of the resource action sufficient to allow the BackendCoordinator to translate it into the appropriate low-level actions. The values of the InteractionMode are: InteractionMode: New This FieldGroup subtree is "New" to the resource, t requires that at populate time it does not preexist in the resource, t requires that at commit time it can be inserted in the resource. nteractionMode: Exists This FieldGroup subtree currently "Exists" in the resource, t requires that at populate time it preexists in the resource. nteractionMode: Update This FieldGroup subtree is going to be "Updated" in the resource, t requires that at populate time it preexists in the resource, t requires that at commit time it is updated in the resource. nteractionMode: Delete This FieldGroup subtree is going to be "Deleted" from the resource, t requires that at populate time it preexists in the resource, t requires that at commit time it will be committed. nteractionMode: <user-defined> A user-defined InteractionMode has been defined, t will be implemented by a Visitor pattern (user-exit). Notice from the PropSpec Class Diagram that each FieldGroup of the PropSpec tree has its own value for InteractionMode. While it is most common for all the FieldGroups in a PropSpec to have the same InteractionMode {e.g., all parts of an OrderEntry Proposal object are "New"), it is sometimes useful to have mixed subtrees of InteractionMode usage (e.g., an ExtendSubscription Proposal (IM: New) may include an optional AddressChange (IM: Update) subtree). The following tables show the full set of interactions for Proposal activity interacting with the back end. There is one table for each of the predefined InteractionModes. Note that a particular user can define his own table for highly-specialized InteractionModes. (Note: Where the diagrams below refer to "Event: Validate", this deals with the optimistic concurrency control that is discussed in the next section. See the next section for details.) InteractionMode: New InteractionMode: Exists [Note: Exists is similar to Update except that is for read-only data. It still performs optimistic checks (if specified in the Assumptions — see next section)] InteractionMode: Update InteractionMode: Delete 8. Protects against stale data The invention's design creates a potential data integrity problem that must be guarded against. In many cases, data will be removed from the datastore (via a Populate) and stored for some period of time in the Proposal itself. This time period can be a few seconds, or it can be several weeks or months. During this period, the data back on the server might change while, of course, the replicated data in the Proposal would not. This mismatch could cause data corruption when the Proposal is eventually submitted and the data rewritten. Even without such a possibility (as in InteractionMode: Exists), the data the user is working on is still "stale". The invention resolves this problem with a well-documented technique usually called either "Optimistic Concurrency Control" or "Optimistic Locking." However, the invention's approach is unusual in the following ways: • The approach builds the supplementary information needed to perform reasonable optimistic techniques right into the PropSpec technique. • A variety of recovery mechanisms are designed into the architecture. The advantages to this approach are the following: • Optimistic concurrency control typically requires significant application design and implementation work. By building in the structure of the solution, the invention makes most if not all of this work unnecessary. • In cases where supplementary behavior is required (e.g., a Fixup Visitor), the user needs only to supply the particular algorithm. The rest of the concurrency framework is already in place. • This approach does a much better job of resolving the "data interference" that stale data causes. Typically, optimistic techniques are used in the databases and their replicas. The problem with this approach is that, by the time the data is put into the database, it is a mere artifact of the data interference event that caused it. In the invention, however, the optimistic recovery environment is encapsulated within the event itself that knows the reason for the change. This is called "proximate intentionality". The closer a fixup method can be to the source of the problem, the better the chance of fixing it correctly. For example, an address change that has grown stale might be resolved differently depending on whether: a) parking spaces are being reassigned, b) the employee has died, or c) insurance renewal notices are about to be sent out. To implement optimistic techniques, the invention defines a set of objects called "Assumptions." They establish what is assumed to be consistent between the datastore and the Proposal replica. They also contain information that defines the disposition when a failure in the assumption is detected. With respect to Fig. 18, a class diagram shows the Assumptions class. Comments • Assumptions are associated with the FieldGroup. Notice that the Assumption processing is fired when the high-level Validate resource operation is fired (see previous section). • Though not shown in the interaction diagrams, a consumer can choose to invoke Validate any time in the life of a Proposal. While it must be fired during Commit processing (in the relevant InteractionModes), it can optionally be fired earlier to ensure that the data being worked on has not gotten stale. • The original values of a FieldGroup (those that specified in the fieldList of the Assumptions) are retained in a special container object called the Pouch. This is required because the user could be making modifications in the very Proposal fields that need to be used subsequently to check currency. • The default interference check is to check all fields in the datastore against all the matching fields in the Proposal. The <fieldList> value in the Assumption metadata allows a subset of fields to be checked. For example, in a well-architected system only a timestamp need be checked against the data that the Proposal holds. • The default detect algorithm is to check that the value of the datastore data equals the value of the Proposal data. A user can configure other detection methods using a Visitor (e.g., in a temporal database, ensure that a date is within a datastore date range). • AbortCommit is a flag that indicates whether or not commit processing should proceed when stale data has been detected. • The Notifier is a Visitor that provides a mechanism for notifying the NotifyParty parameter that interference has happened. This notification could be any specified technique (a system alert, an email, a console message to an operator, etc.). NotifyParty is an opaque object used to provide whatever information is necessary to execute the Notifier. • Fixup is a Visitor that provides a user-defined fixup procedure. For example, a common fixup might be LastUpdaterWins (compare replica with datastore; update with the later timestamp begins canonic). • Some Proposals may be processed very quickly and not required Optimistic Concurrency Control. A Proposal Policy Visitor can specify user-defined locking policies, (e.g., Use standard (pessimistic) database locks until the user decides to "disconnect" from the server. Then switch to optimistic). The combination of the above techniques provides an enormous amount of flexibility. Essentially the developer can choose what combination of commit processing, notification, and fixup will happen for each instance of stale data is noticed. Tools Proposal Builder The ProposalBuilder has four tabbed panels on which a developer enters the specifications (PropSpec) for the new Proposal he wishes to build. Panel 1: Defining the field dictionary. The field dictionary is the container that holds field definitions that are common across all proposals in any proposal family. These field definitions are stored in a text file FIELDS. DCT that exists in a repository subdirectory. Many such subdirectories can exist, each containing any number of PropSpecs. Referring to Fig. 19, the top three fields in the ProposalBuilder are outside of the tabbed space and contain information common to the whole PropSpec. They are: Repository 1901 : The name of the subdirectory that contains the field dictionary file and all the PropSpec files that are associated with any family of Proposals. This "family" is heuristically defined as all proposals that share some common set of field definitions. For example, one repository might contain HR Proposals and another the Football pool proposals. Proposal Name 1902: This is the file name of the PropSpec that we are currently working on. It contains all the elements associated with a single Proposal. A Proposal can be of virtually any size. For example, a tax form with its many required and optional supporting schedules could be a single Proposal. Proposal Policy 1903: This is the name of a Java class that can implement user defined behavior that is common to any part of this proposal. There is more information about such Policy classes in the Validator section below. Dictionary 1904: The Dictionary page contains information about the fields common to all Proposals in this family. This field information can be entered manually or automatically generated by preparing the appropriately formatted FIELDS. DCT file. Now we turn to the tabbed fields. The Fields Listbox 1905 on the left side of the page contains a summary of all the fields defined. Selecting any particular field will display its detailed metadata in the field on the right side (the field "zip" has been selected in the screenshot). Here they can be viewed or modified. New fields can be added by entering new field information and pressing the Update button. The Remove button removes the field. The FieldName 1906 is the name of this field. It can be any sensible length, alphanumeric with no embedded spaces. The Type field 1907 allows the selection of any predefined Proposal type. Currently types are limited to Integer, Numeric, and Character. New types are easily added to the framework by merely adding a new class per type. For example, we might want to add Money, Date, or Bookldentifier. The concept of Proposal type is implemented as a Strategy pattern. The Size field 1908 gives the length of the field. It's usually an integer, though some types — Numeric, for example-can accept a decimal point (e.g. 9.2). The whole part represents the whole length with a decimal precision of the fractional part. The Default field 1909 gives the value that the field will assume before any data is entered. The Description field 1910 contains a more explanatory string than the FieldName. It can also be used for automatically creating GUIs. The Validators listbox 1911 contains a list of all the validators that associated with this field. A validator is Java behavior that applies user-defined editing to some part of the proposal. Note that this validator will be fired wherever this field is used regardless of how many PropSpecs it is used in. (This differs from the "field use" validators below which are only applied in a specific Proposal.) For example, a Dictionary validator that applies PositiveOnly to Zip means that all zips must be positive numbers. In certain proposals we may want to further reduce Zip to a more constrained set. Here is an example of the Java source for a validator: package Policy; import Proposal. Proposal; public class RangeCheck extends Validator { public void validate(Proposal proposal, String fieldName, String fieldValue, Stringrj args) throws PolicyException { double bottom = Double. alueOf(args[0]).doubleValue0; double top = Double.valueOf(args[1]).doubleValue0; double value = Double. valueOf(fieldValue).doubleValueO; if (value < bottom) { throw new PolicyException( fieldName + " value of " + fieldVaiue + " is below min value " + bottom); } if (value > top) { throw new PolicyException( fieldName + " value of " + fieldVaiue + " is above max value " + top); } } } Panel 2: Defining the Proposal Strucuture A Proposal is a composed of a hierarchy of sections called field groups. Each field group is associated with some flattened sets of fields in the same logical domain. The Structure page defines the detailed structure of the proposal. Note that this information is used at runtime to provide automatic navigation of the Proposal. With respect to Fig. 20, the centerpiece of the Structure page 2001 is a hierarchic TreeView of the PropSpec 2002. Notice that some of the FieldGroups (each line of the treeview) are descendents of the root node (e.g. an Employee has a HomeAddress and Education information). Other FieldGroups are descendents of the descendents (e.g. Education is composed of many Course FieldGroups). Selecting a fieldgroup displays the detail of the field group in the entry fields at the bottom where they can be viewed or edited. Lists of the key fields 2003 and nonKey fields 2004 appear on the bottom right but not editable (until the next page). The concept of key fields is essential to managing the Proposal architecture. A key field is that field or set of fields that defines the uniqueness of the fieldgroup. This is analogous to the formal relational use of "key". Notice that the key field names are included in the TreeView, providing a quick view of the domain structure of the Proposal. The tree can be restructured with the buttons on the top right. AddChild 2005 allows the addition of new child fieldgroup to any node. InsertPeer 2006 inserts a new fieldgroup in front of the one currently selected. Delete 2007 eliminates the selected node (and all its descendents). Combinations of these buttons can create any logical tree structure. The Name field 2008 specifies the unique name of this fieldgroup. Domain 2009 specifies some logical grouping of each of these fields. This field is used by BackEndCoordinator. If the Proposal framework is talking to a relational database this might be the name of the table that is being operated on. If an object backend, it might be the container of objects that are logically grouped together. If a TP monitor, it might be the name of the function to invoke to invoke fields of this kind. Min 2010 and max 2011 specify the cardinality of the fieldgroup. A min of 0 means the fieldgroup is optional. A max of "*" means that any number of fieldgroups can be entered or maintained. Specific constraints come in the form: min=3 & max=6. InteractionMode 2012 determines the pattern of interaction between Proposal and BackEndlnterface. It is this field that parameterizes the type of conversation that takes place between the proposal and BackEnd. FieldGroup Policy 2013 specifies any Java Visitor code that might be useful in working on this fieldgroup. Panel 3: Defining the field use Once a fieldgroup exists fields (both key and nonKey) need to be added to it and subsequently maintained. Referring to Fig. 21 , the Fields page 2101 performs this manipulation. The FieldGroup 2102 shows which fieldgroup is presently being worked on. This fieldgroup value is not editable. The field group shown here is the one that is selected on the previous page. The center listbox 2103 contains all the fields in the field dictionary (the first page) in alphabetical order. If a needed field has not been entered, return to the Dictionary page, enter it, and flip back. The arrow buttons add (left-pointing) 2104 or delete (right-pointing) 2105 field definitions to either the pool of key fields or nonKey fields. On an add, if no target field is selected, the field as appended to the end. If a target field is selected, the added field is inserted at that position. The top key field 2110 in the screen shot is surrounded by braces to show that it is inherited from the parent fieldgroup and cannot be removed. You will need to flip to the parent fieldgroup and remove it there. The ProposalBuilder stays aware of certain constraints in field placement. For example, you cannot put data fields before key fields, nor can you put local keys in front of inherited keys. The Field Details field 2108 provides a quick summary of the attributes of the field. The Field Validators 2109 specify Java Visitor objects that add user-defined validation. As above, any validator that is inherited from the field dictionary is shown in brackets and cannot be removed (except by removing it from the dictionary). New validators can be added that are only applied to the use of "zip" (in this example) in this particular PropSpec and FieldGroup. Notice that the MessageLine (at the bottom) reports that the requested Policy.SFCountyOnly class could not be found by the ProposalBuilder. This is simply a warning to the builder that this object could not be found in the development environment. It still builds the ValidatorCommand (ValidatorCommands are implementations of the Command pattern) object that will invoke the validator at runtime. If the class cannot be found at runtime, the entry data can still be forced into the Proposal; an error will be noted. Panel 4: Defining the PropSpec Assumptions The Assumptions section defines the rules for detecting and correcting stale data in the Proposal. Stale data can occur when a Proposal replicates data from an authorized datastore and works on this data over time. The underlying data back in the datastore may change in the interim, so that the assumptions that the Proposal is working on are no longer current. The discrepancy creates obvious problems at commit time. A Proposal object does not necessarily need to go through a stale-data analysis before it commits. It is possible to configure a Proposal to perform standard pessimistic concurrency control (implemented by locks), so that as soon as the Proposal is instantiated at populate time, the data is locked until the subsequent update. In this mode the Proposal is merely acting as a smart forms system. This is fine for those Proposals that will be converted to transactions immediately. However, a Proposal that will be long-lived-deferred, routed, pended, etc. — cannot keep the data locked for hours, days or weeks. It will need to deal with the possibility of stale data by using optimistic concurrency control. The Proposal object itself does not change depending on whether it's using pessimistic or optimistic locking. This locking mode is merely a mode of operation. The consumer may begin pessimistically but switch (releasing locks) to optimistic when he decides that the operation will take longer than anticipated. Proposals can be configured to switch mode based on application context or user gestures. The end-user will not need to know anything about the details of these issues. With respect to Fig. 22, a screenshot is shown that is an example of the capabilities of Assumptions. The Domain column 2201 shows which Domain (as entered in the Structure section) is being checked. The Field column 2202 specifies the target of the staleness check: a field, list of fields, or no field. The field(s) specified will be compared with the datastore before the commit to see if they are still current (that is, if they hold the same values as in the PropSpec). A particularly good idea is to check a TimeStamp field in the datastore (if it is built with one). The Detect field 2203 allows the placement of a Java Visitor to further analyze the staleness check. The Commit? Field 2204 indicates whether a commit should be attempted even if stale data is found. The Notify? Field 2205 defines a Java Visitor that will notify someone (somehow) that stale data has been identified. The Correct Field 2206 is a Java Visitor that will attempt to fix the stale data. For example, LastUpdaterWins could resolve data interference in favor of the most recent occurrence. Of course, these can be used in many different combinations. Some data elements may work well with a combination of commit with a simple fixup and a notification to a relevant overseer. Certain standard strategies will be built into the framework. ProposalViewer The ProposalViewer is a simple Proposal editor. It can view and manipulate all aspects of any Proposal object the moment the object is created. It can be used for simple applications, or those that need to be used immediately. It is ideal as a Proposal "inspector." Referring to Fig. 23, an example screen shot of the ProposalViewer is shown. A standard menu frame surrounds this viewer. New proposals can be created, read or saved using the standard commands of the file menu. The Proposal field 2301 at the top left is the name of the PropSpec being used for this Proposal. The TreeView 2302 is similar to that in the ProposalBuilder. But real Proposal data has an extra degree of dimensionality, the repeating data itself. The actual fieldgroup instances are shown with their instantiated keys as the nodes of the tree. Selecting or scrolling through the treeview causes the position of the data to change. The fields on the left 2303 are dynamically constructed as each FieldGroup type changes. The labels shown are the fieldNames. Descriptions can also be specified. Notice that there are two small buttons to the right of every field. These buttons are for Notes (top button) 2304 and ErrorMessages (bottom button) 2305. They change color to yellow and red if there is content. Depressing the button brings up a pop showing the list of notes or errors. The arrow buttons 2306 provide another way to move through the Proposal. The buttons are generally similar to a VCR toolbar. The double up-arrow goes to the root position. Undo/Redo 2310, 2311 will cause the proposal to walk backward or forward (through previous Undos) all the way back to the beginning of the proposalόs history. The Override checkbox 2312 indicates whether the Proposal is in Override mode. In Override, erroneous data entry is immediately entered (with the errors caught and marked). With Override off, a popup asks whether an erroneous data element should be kept, changed, or returned to its original value. Further Customization Most applications that use the invention will want their own, programmer-built "composed views" of Proposals on the front end. There are already several ways to approach add custom U.l.s. • Custom programming to the Proposal facade Application Programming Interface (API) Since the Proposal is a completely nonvisual object it can be used with any kind of user interface— visual or non-visual, interactive or batch, GUI, Webbed, etc. In this mode, the surrounding application code must be able to talk directly to Java. • Using the Proposal component interface Since the Proposal API is also wrapped as a component (Bean), it can be accessed by any application or development environment that supports construction from parts. Kinexis has built a preliminary set of Beans (see below) for Proposal-based visual construction. Using an ORB The Proposal object will support an ORB wrapping. Then it can be accessed by any CORBA-compatible object environment written in any language on any machine. Components The Proposal toolkit includes a starter set of Proposal-aware components for use in Java visual development environments. All are currently implemented as Transitional Beans under the Symantec Visual Pro development environment. These concepts should extend reasonably well to other Bean-based development environments as well as to subsequent versions of Beans. In this document Visual Pro tools are rendered to give an idea of the development capability. With respect to Fig. 24, a screenshot shows an example of the Proposal Toolbar 2401. Each of the icons is a separate component that will be discussed separately. Proposal Component The primary component is a wrapper for the Proposal object itself. This is a non- visual component (it has no runtime appearance). It encapsulates the full data and metadata of the currently-loaded Proposal object. All other objects need to connect ("register" with this component in order to have source for their smarts. Registration can happen in two ways. The developer can draw a link between the proposal component and some other component. This method is very precise because it explicitly states the connection. However it can be tedious if there are many components to register. Alternatively, in many cases the components will "autoregister". Autoregistration means that at startup time the Proposal component will seek and demand allegiance of any recognizable component contained in any descendent of its own containment. As an example of autoregistration, a developer may decide to drag a Proposal component onto a visual palette. He may then drag on a Proposal Label object and set the label property to ProposalName. When the Proposal component is loaded the label will be set to the Proposal name. No registration is required. Autoregistration will not work when: • there are multiple Proposals in the same container. Note, though, that by multiple Proposals, we mean cases where the application is dealing with multiple Proposal objects simultaneously. Any number of Proposals can be dealt with serially by the same Proposal component. For example, the application may be a compare utility between two selected Proposals. components are in completely different container hierarchies. It may be desirable to have a "Remote Control" toolbar that floats anywhere on the Desktop in its own frame. This window still needs to find the Proposal that it is bound to. Consequently, it will take explicit development-time registration to bind these components together. Session Manager This component is currently a simple one. It encapsulates the UserName of the current user. Proposal components registered with this component will "log in" their proposal to this user for all subsequent updates to that Proposal. (Updates to a Proposal are logged to a user on a per-field basis). Proposal Label This read-only label object places various internal values of the Proposal on the UI. Which of these values is used is set as a Label property. The Proposal Label can assume values for: ProposalName Name of the current proposal FieldGroupName Name of the current field group FieldName Name of the current field Proposal Errors Number of errors in this proposal FieldGroupErrors Number of errors in this fieldgroup FieldErrors Number of errors in this field Proposal Notes Number of notes in this proposal FieldGroupNotes Number of notes in this fieldgroup FieldNotes Number of notes in this field Etc. Proposal Arrow Buttons Referring to Fig. 25, Proposal Arrows are used to control the movement through a proposal tree. The button uses properties to transform itself into one of the six built-in buttons LeftArrow 2503 Previous fieldgroup RightArrow 2504 Next fieldgroup (preorder traversal) UpArrow 2501 Go to parent of this node DoubleLeft 2502 Go to the root node DoubleRight 2505 Go to the end node DownArrow Go to first child of current Note that each button is a different instance of the same component. The arrow on the button is dynamically painted. Thus the button can be stretched and sized to any possible rectangular shape. Proposal TreeView This a type of Panel that displays a tree rendering of the current Proposal. Selecting or scrolling through the tree changes the Proposal position. With respect to Fig. 26, an example of a Proposal Treeview 2601 is shown. Proposal Action Button These components are pushbuttons that send action requests into the Proposal. Referring to Fig. 27, an example of a Proposal Action Button configured to perform an Undo 2701 is shown. These actions buttons are governed by a property that configures which action they will eventuate: OK Accept the changes in this fieldgroup Cancel Escape from the entry context of this fieldgroup Override Force in the error on the currently active field Insert Find the next insert point and ready the fieldgroup Delete Delete the fieldgroup Undo Walk back the undo change Redo Redo undone changes Setting the action property will also change the button label accordingly. Proposal Checkbox With respect to Fig. 28, a Proposal Checkbox 2801 will enable or disable some proposal option. Currently only one option is enabled: Override Forces all errors into immediate entry (recording the error) Proposal Message Area The Proposal Message Area is a TextArea that acts as a log that displays any Proposal errors These can include: • Semantic navigation errors (e.g., at end of Proposal) • Data entry error messages • Problems opening or closing the Proposal • Any uncaught Java exception Proposal Field Referring to Fig. 29, the Proposal field object 2901 is a control that is used for displaying and entering data from a particular field of a particular fieldgroup of the Proposal. The buttons on the right side of the field indicate the presence of a Note (top button) 2902 or Error (bottom button) 2903. These buttons will turn Yellow or Red respectively. Pressing the button will display a pop up for viewing and maintaining Notes or Errors. All field views governed by a Proposal component are coordinated by an Observer on the Proposal. This ensures that all updates to a Proposal field are instantly updated by all viewers. Proposal Field Panel This component is a dynamically constructed panel of all the fields in the current proposal fieldgroup. There are a number of properties which govern this panel's behavior: Whether key, nonKey, or all fields are displayed Whether key, nonKey, or all fields are editable Various formatting characteristics Are prompts formed by fieldName or Descriptions With respect to Fig. 30, an example of a sample use of a field panel 3001 is shown. Note that the fields in the field panel are not standard field objects, they are PropField objects (see ProposalField). Also note that all field views governed by a Proposal component are coordinated by an Observer on the Proposal. This ensures that all updates to a proposal field are instantly updated by all viewers. Adapting the Framework Writing a program to manipulate a Proposal The invention supports a framework of classes for manipulating all aspects of Proposals, their data, metadata, etc. Most simple proposal access is through a single class named Proposal. Proposal acts as a facade (the Facade pattern) for typical proposal manipulation behavior. The following simple program creates a Proposal and puts some data in it. The Proposal metadata is specified in a preexisting PropSpec file (that may have been built with the ProposalBuilder). String data is put in through a simple data structure called a StringVector (a Vector with both label and value fields). There are actually several ways that data can be put into a Proposal. The individual Proposal methods are documented in JavaDoc format. The program is as follows: import Proposal.*; import PropSpec.*; import PropUtil.*; import CompositePattem.*; import TypedObject.*; public class TestProposal3 { public static void main(String[] args) throws PropSpecException, ProposalException, TypedObject Exception, LabeledVectorException { //Logs on user PropSystemObject pso = PropSystemObject.getDefaultO; pso.setUserName("jjt"); Proposal proposal; //Build proposal object from PropSpec in args proposal = Proposal. BuildProposal(args); //Force in any errors proposal. setOverrideModeftrue); //Create StringVector for top fieldgroup StringVector mailTo = new StringVector("name,address1 ,address2,city,state,zip"); //Insert top fieldgroup mailTo.parseStringValues("john,289 Fern St„Oakland,CA,94114"); proposal. insertf ailTo", mailTo); //Create StringVector for children StringVector sub = new StringVector("name, phone, email"); //Insert children sub.parseStringValues("john, 555-1212john@kinexis.com"); proposal. insert("subMail", sub); sub.parseStringValues("john,800-1212jt@kinexis.com"); proposal. insert("subMail", sub); //write out to System.out System. out.println(proposal.toStringO); Although the invention is described herein with reference to the preferred embodiment, one skilled in the art will readily appreciate that other applications may be substituted for those set forth herein without departing from the spirit and scope of the present invention. Accordingly, the invention should only be limited by the Claims included below.

Claims: CLAIMS 1. A process for converting a transmission submission process into a reusable, generic object, breaking the close-coupling between the front-end and back-end of a transactional application in a computer environment, comprising the steps of: defining a set of specifications for each metadata component of said generic object; creating said generic object by using a combination of said specifications, wherein said specifications describe said transmission submission process; coordinating user interfaces with said generic object, said user interface coordinator maps user input fields to components of said generic object, accepts user data input and outputs data from said generic object; providing a back-end interface, wherein said generic object transmits data to back-end resources through said back-end interface; and wherein said specifications define, among others, the hierarchy of domain relationships, interaction modes, validation references, and assumptions. 2. The process of claim 1 , further comprising the step of: providing a set of default user interfaces and components, wherein said user interface coordinator communicates with said default user interfaces. 3. The process of claim 1 , wherein said user interface coordinator communicates with a user-defined user interface. 4. The process of claim 1 , wherein said user interface coordinator communicates with different user interfaces such as: Internet, Graphical User Interface (GUI), Object Oriented User Interface (OOUI), proprietary interface, and devices such as bar code readers or keypads. 5. The process of claim 1 , further comprising the step of: providing a specification builder tool to create said specifications. 6. The process of claim 1 , wherein said back-end interface communicates with resources such as Database Management Systems, Transaction Processing Monitors, and Object Oriented Databases. 7. The process of claim 1 , wherein said back-end interface can be disconnected and later reconnected to said back-end resources, allowing said generic object to be temporarily pended, routed to another party, or otherwise worked on over time. 8. The process of claim 1 , wherein said generic object can be disconnected and later reconnected to any existing user interfaces, allowing said generic object to be temporarily pended, routed to another party, or otherwise worked on over time. 9. The process of claim 1 , wherein said generic object is self aware and navigates between pages and skips to appropriate fields automatically. 10. The process of claim 1 , wherein said generic object supports n-level undo/redo of data. 11. The process of claim 1 , wherein said generic object allows a user to add, change, and annotate data. 12. The process of claim 1 , wherein said generic object tracks all versions of data updates and the user that is responsible for each data update. 13. The process of claim 1 , wherein said generic object supports data security through authorization, authentication, and digital signatures. 14. The process of claim 1 , wherein said generic object accepts and records error messages from an external object, keeps track of any error messages for each data entry and manages said errors until said errors are resolved. 15. The process of claim 1 , wherein said generic object recognizes stale data and offers the user options for dealing with said stale data, said options include user correction, rule based correction, or flagging as an error. 16. The process of claim 1 , wherein said generic object is structured as a quantified hierarchy tree with cardinality. 17. The process of claim 1 , further comprising the step of: providing a simple component-based assembly process for creating custom user interfaces. 18. The process of claim 1 , further comprising the step of: providing a standard default visual editor for any generic object having no programming requirement. 19. An apparatus for converting a transmission submission process into a reusable, generic object, breaking the close-coupling between the front-end and back-end of a transactional application in a computer environment, comprising: a module for defining a set of specifications for each metadata component of said generic object; a module for creating said generic object by using a combination of said specifications, wherein said specifications describe said transmission submission process; a module for coordinating user interfaces with said generic object, said user interface coordinator maps user input fields to components of said generic object, accepts user data input and outputs data from said generic object; a module for providing a back-end interface, wherein said generic object transmits data to back-end resources through said back-end interface; and wherein said specifications define, among others, the hierarchy of domain relationships, interaction modes, validation references, and assumptions. 20. The apparatus of claim 19, further comprising: a module for providing a set of default user interfaces and components, wherein said user interface coordinator communicates with said default user interfaces. 21. The apparatus of claim 19, wherein said user interface coordinator communicates with a user-defined user interface. 22. The apparatus of claim 19, wherein said user interface coordinator communicates with different user interfaces such as: Internet, Graphical User Interface (GUI), Object Oriented User Interface (OOUI), proprietary interface, and devices such as bar code readers or keypads. 23. The apparatus of claim 19, further comprising: a module for providing a specification builder tool to create said specifications. 24. The apparatus of claim 19, wherein said back-end interface communicates with resources such as Database Management Systems, Transaction Processing Monitors, and Object Oriented Databases. 25. The apparatus of claim 19, wherein said back-end interface can be disconnected and later reconnected to said back-end resources, allowing said generic object to be temporarily pended, routed to another party, or otherwise worked on over time. 26. The apparatus of claim 19, wherein said generic object can be disconnected and later reconnected to any existing user interfaces, allowing said generic object to be temporarily pended, routed to another party, or otherwise worked on over time. 27. The apparatus of claim 19, wherein said generic object is self aware and navigates between pages and skips to appropriate fields automatically. 28. The apparatus of claim 19, wherein said generic object supports n-level undo/redo of data. 29. The apparatus of claim 19, wherein said generic object allows a user to add, change, and annotate data. 30. The apparatus of claim 19, wherein said generic object tracks all versions of data updates and the user that is responsible for each data update. 31. The apparatus of claim 19, wherein said generic object supports data security through authorization, authentication, and digital signatures. 32. The apparatus of claim 19, wherein said generic object accepts and records error messages from an external object, keeps track of any error messages for each data entry and manages said errors until said errors are resolved. 33. The apparatus of claim 19, wherein said generic object recognizes stale data and offers the user options for dealing with said stale data, said options include user correction, rule based correction, or flagging as an error. 34. The apparatus of claim 19, wherein said generic object is structured as a quantified hierarchy tree with cardinality. 35. The apparatus of claim 19, further comprising: a module for providing a simple component-based assembly process for creating custom user interfaces. 36. The apparatus of claim 19, further comprising: a module for providing a standard default visual editor for any generic object having no programming requirement. 37. A program storage medium readable by a computer, tangibly embodying a program of instructions executable by the computer to perform method steps for converting a transmission submission process into a reusable, generic object, breaking the close-coupling between the front-end and back-end of a transactional application in a computer environment, said method steps comprising: defining a set of specifications for each metadata component of said generic object; creating said generic object by using a combination of said specifications, wherein said specifications describe said transmission submission process; coordinating user interfaces with said generic object, said user interface coordinator maps user input fields to components of said generic object, accepts user data input and outputs data from said generic object; providing a back-end interface, wherein said generic object transmits data to back-end resources through said back-end interface; and wherein said specifications define, among others, the hierarchy of domain relationships, interaction modes, validation references, and assumptions. 38. The method of claim 37, further comprising the step of: providing a set of default user interfaces and components, wherein said user interface coordinator communicates with said default user interfaces. 39. The method of claim 37, wherein said user interface coordinator communicates with a user-defined user interface. 40. The method of claim 37, wherein said user interface coordinator communicates with different user interfaces such as: Internet, Graphical User Interface (GUI), Object Oriented User Interface (OOUI), proprietary interface, and devices such as bar code readers or keypads. 41. The method of claim 37, further comprising the step of: providing a specification builder tool to create said specifications. 42. The method of claim 37, wherein said back-end interface communicates with resources such as Database Management Systems, Transaction Processing Monitors, and Object Oriented Databases. 43. The method of claim 37, wherein said back-end interface can be disconnected and later reconnected to said back-end resources, allowing said generic object to be temporarily pended, routed to another party, or otherwise worked on over time. 44. The method of claim 37, wherein said generic object can be disconnected and later reconnected to any existing user interfaces, allowing said generic object to be temporarily pended, routed to another party, or otherwise worked on over time. 45. The method of claim 37, wherein said generic object is self aware and navigates between pages and skips to appropriate fields automatically. 46. The method of claim 37, wherein said generic object supports n-level undo/redo of data. 47. The method of claim 37, wherein said generic object allows a user to add, change, and annotate data. 48. The method of claim 37, wherein said generic object tracks all versions of data updates and the user that is responsible for each data update. 49. The method of claim 37, wherein said generic object supports data security through authorization, authentication, and digital signatures. 50. The method of claim 37, wherein said generic object accepts and records error messages from an external object, keeps track of any error messages for each data entry and manages said errors until said errors are resolved. 51. The method of claim 37, wherein said generic object accepts and records error messages from an external object, keeps track of any error messages for each data entry and manages said errors until said errors are resolved. 52. The method of claim 37, wherein said generic object is structured as a quantified hierarchy tree with cardinality. 53. The method of claim 37, further comprising the step of: providing a simple component-based assembly process for creating custom user interfaces. 54. The method of claim 37, further comprising the step of: providing a standard default visual editor for any generic object having no programming requirement.

Inventors: TIBBETTS JOHN J, TIBBETTS, JOHN, J.
Applicants: KINEXIS
Application year: 1999
Main classification: G06F9
IPC codes: G06F9