Method and apparatus for upgrading a software application in the presence of user modifications

[0001] This application is a continuation of U.S. patent application Ser. No. 09/377,892, filed on Aug. 19, 1999, issued as U.S. Pat. No. 6,367,077, on Apr. 7, 2002, which is a continuation of PCT International Application No. PCT/US98/03575, filed Feb. 24, 1998, which claims the benefit of the filing date of U.S. Provisional Application No. 60/039,467, filed Feb. 27, 1997. These related applications are incorporated by reference herein in their entirety.

[0002] This invention relates to a system and method for providing updates to a network of partially replicated relational database systems and for providing efficient access to a database by a remote client using a networked proxy server. More particularly, it provides for a system and method of migrating to a successive level of a software distribution incorporating local modifications.

[0003] Relational databases are a commonly-employed data structure for representing data in a business or other environment. A relational database represents data in the form of a collection of two-dimensional tables. Each table comprises a series of cells arranged in rows and columns. Typically, a row in a table represents a particular observation. A column represents either a data field or a pointer to a row in another table.

[0004] For example, a database describing an organizational structure may have one table to describe each position in the organization, and another table to describe each employee in the organization. The employee table may include information specific to the employee, such as name, employee number, age, salary, etc. The position table may include information specific to the position, such as the position title (“salesman”, “vice president”, etc.), a salary range, and the like. The tables may be related by, for example, providing in each row of the employee table a pointer to a particular row in the position table, coordinated so that, for each row in the employee table, there is a pointer to the particular row in the position table that describes that employee's position. A relational database management system (RDBMS) supports “joining” these tables in response to a query from a user, so that the user making a query about, for example, a particular employee, may be provided with a report of the selected employee, including not only the information in the employee table, but also the information in the related position table.

[0005] Relational databases may be much more complex than this example, with several tables and a multiplicity of relations among them.

[0006] With the widespread use of inexpensive portable computers, it is advantageous to replicate a database onto a portable computer for reference at locations remote from the central computer. The replicated database may then be referenced by the user of the portable computer, without requiring reference to the main database which may be maintained at a central location inconvenient to the user of the portable computer. However, there are a number of difficulties with the use of a replicated database.

[0007] One disadvantage is that a full copy of the central database may require more data storage than is desired or economical. For example, a salesman working in the field may need to refer to the database for information regarding sales opportunities in his sales area, but have no need to refer to any information regarding sales opportunities outside of his area. One possible approach to reduce the amount of required data storage is to simply replicate only that portion of the database that is needed by the user. However, this approach does not recognize that the criteria to determine which portions of the data are required is likely to vary over time. For example, the salesman may have a new city added to his territory. Under conventional approaches, the salesman would need to re-replicate his local copy of the database, this time selecting data including the added city. Such a practice is inconvenient, subject to error, and time-consuming.

[0008] A further disadvantage to a replicated database is the difficulties encountered in attempting to update data using the replicated copy. A change made to the replicated database is not made to the central database, leading to a discrepancy between the information that is stored in the replicated copy of the database and the information that is stored in the central database. Although it is possible to journal modifications made to the replicated copy and apply an identical modification to the central database, one problem that this approach faces is the possibility of colliding updates; that is, where a user of a replicated copy makes a change to data that is also changed by a user of the central copy of by the user of another replicated copy.

[0009] In addition, the system, including the central database and replicated database, involves a considerable amount of software which is often customized to meet the needs of a particular enterprise. A great deal of effort is expended on configuring the software and writing custom modules and objects. If the software is upgraded to a new release, a considerable amount of programming time and effort are required to configure the new release and reimplement the customer-specific functionality of the earlier version.

[0010] It is therefore desirable to provide a capability to maintain one or more partially-replicated copies of a central database, in such a way that the degree of replication may be easily changed without requiring a refresh of the entire replicated database, and that permits updates to be coordinated among users of the central database and users of the partially replicated databases. Additionally, it is desirable to provide a facility which allows enterprises to rapidly migrate their changes from one version of the software to another version of the software, such as configurations and objects.

[0011] The present invention is directed to a method of maintaining a partially replicated database in such a way that updates made to a central database, or to another partially replicated database, are selectively propagated to the partially replicated database. Updates are propagated to a partially replicated database if the owner of the partially replicated database is deemed to have visibility to the data being updated. Visibility is determined by use of predetermined rules stored in a rules database. In one aspect of the invention, the stored rules are assessed against data content of various tables that make up a logical entity, known as a docking object, that is being updated.

[0012] In another aspect of the invention, the stored rules are assessed against data content of one or more docking objects that are not necessarily updated, but that are related to a docking object being updated. In one embodiment, the visibility attributes of the related docking objects are recursively determined.

[0013] In yet another aspect of the invention, changes in visibility are determined to enable the central computer to direct the nodes to insert the docking object into its partially replicated database. Such changes in visibility are determined so as to enable the central computer to direct a node to remove a docking object from its partially replicated database.

[0014] In a further aspect of the invention, the predetermined rules are in declarative form and specify visibility of data based upon structure of the data without reference to data content.

[0015] In still another aspect of the invention, the transactions made to the database are ordered and processed in such a way as to reduce the computational resources required to calculate the visibility of the transactions.

[0016] In another aspect of the invention, a facility is provided to allow an enterprise to rapidly migrate its changes in one version of the software to another version of the software.

[0017] In yet another apsect of the invention, provision is made for migrating customized ODF and RC files from a previous version into a new release.

[0018] These and other aspects of the inventions will become apparent to one skilled in the art by reference to the following drawings and detailed description.

Overview

[0028] FIG. 1 depicts an overview of the operation of one embodiment of the present invention. FIG. 1 depicts a central computer system 1 and three remote computer systems (or “nodes”) 21-a, 21-b, and 21-c. Each of nodes 21-a, 21-b and 21-c are depicted in various states of communication with central computer system 1, as will be more fully explained. Central computer system 1 includes a central database 3, a docking manager 5, a merge processor 7 and a log manager 9. Central computer system 1 additionally optionally includes update manager 11 responsive to user input 13.

[0029] Node 21-a is a remote computer system, such as a mobile client such as a laptop computer. Node 21-a includes a partially replicated remote database 23-a, update manager 31-a responsive to user input 33-a, docking manager 25-a and merge manager 27-a. In operation, update manager is responsive to user input 33-a to make changes to remote database 23-a as directed by the operator of node 21-a. Updates made are recorded, or journaled, in node update log 35-a.

[0030] At some point at the convenience of the operator of node 21-a, node docking manager 35-a is activated, and enters into communication with central docking manager 5. Update log 35-a is taken as input by node docking manager 25-a, and provided to central docking manager 5. Central docking manager 5 creates a received node update log 19, which contains all the information that had been recorded in update log 35-a. Optionally, partial log 17-a is taken as input by central docking manager 5 and provided to node docking manager 25-a, as more fully described herein.

[0031] At some point in time, at the convenience of the operator of central computer system 1, merge processor 7 is activated. Merge processor 7 takes as input received node update log 19, and applies the updates described therein to central database 3. In the process of applying the updates from received node update log 19, merge processor journals the updates applied to central update log 15. Optionally, update manager 11, responsive to user input 12 makes additional changed to central database 3 as directed by the operator of central computer system 1. The updates made by update manager 11 are additionally journaled in central update log 15.

[0032] At some point in time, at the convenience of the operator of central computer system 1, log manager 9 is activated. Log manager 9 takes as input central update log 15 and produces as output a set of partial logs 17-a, 17-b and 17-c according to visibility rules as will be further described herein. Each of partial logs 17-a, 17-b and 17-c corresponds to one of nodes 21-a, 21-b and 21-c. When a node docking manager such as node docking manager 25-a enters into communication with central docking manager 5 and optionally requests transmission of its corresponding partial log, central docking manager 5 takes as input the appropriate partial log, such as partial log 17-a, and presents it to node docking manager 25-a. Node docking manager 25-a then replicates partial log 17-a as merge log 37-a.

[0033] At some point in the future, at the convenience of the operator of node 21-a, merge processor 27-a is activated. Merge processor 27-a takes as input merge log 37-a, and applies the updates described therein to partially replicated database 23-a.

[0034] In addition to node 21-a, FIG. 1 also depicts two additional nodes 21-b and 21-c. Node 21-b is depicted in communication with central computer 1. However, unlike node 21-a, the operator of node 21-b has requested only to send his updates to central computer system 1, and has not requested to be presented with changes made elsewhere to be made to his partially replicated database 23-b. This may be, for example, if the operator has an urgent update that must be made as soon as possible, but does not have the time to receive updates from other nodes. Accordingly, FIG. 1 shows only transmission of node update log 35-a from node docking manager 25-b to central docking manager 5, and no transmission from central docking manager 5 to node docking manager 25-b. Accordingly, the merge manager for node 21-b is not activated and is not shown.

[0035] Likewise, node 21-c is depicted as not in communication with central computer system 1. Accordingly, the docking manager for node 21-c is not activated and is not shown.

[0036] By the cycle described above, updates made by each of nodes 21-a, 21-b and 21-c are presented to central computer system 1, permitting central database 3 to be updated accordingly. In addition, each of the updates made by each of the nodes 21-a, 21-b and 21-c, as well as updates made on central computer system 1, are routed back to each of nodes 21-a, 21-b, and 21-c, thereby keeping each of partial databases 23-a, 23-b and 23-c in synchronization with each other and with central database 3.

Database Structure

[0037] The synchronization of central database 3 with node databases 23-a, 23-b and 23-c is performed using a construct called a Docking Object. A Docking Object consists of Member Tables (including one Primary Table), Visibility Rules, Visibility Events, and related Docking Objects.

[0038] A Member Table is a table of the relational database that makes up a docking object. When a docking object is propagated from central database 3 to one of node databases 23-a, 23-b or 23-c, the propagation takes the form of an insertion into each of the Member Tables associated with the particular docking object. Similarly, when a docking object is scheduled to be removed from a database, that removal consists of deleting records from the member tables associated with the docking object. For example, a docking object that represents a sales opportunity may include tables that represent the opportunity itself (e.g., named “S_OPTY”), the product whose sale is represented by the opportunity (e.g., named “S_OPTY_PROD”), the contact for the opportunity (e.g., named “S_OPTY_CONTACT”), etc. Each of these tables is said to be a member table of the “Opportunity Docking Object.”

[0039] A Primary Table is a Member Table that controls whether a particular instance of a Docking Object is visible to a particular node. The Primary Table has a Primary Row-ID value that is used to identify a row of the Primary Table being updated, deleted or inserted. For example, the “Opportunity Docking Object” may have as a primary table the table S_OPTY. The row-id of that table, i.e., S_OPTY.row_id, is the Primary Row-ID for the Opportunity Docking Object.

[0040] A Visibility Rule is a criterion that determines whether a particular instance of a Docking Object is “visible” to a particular node 21. If a Docking Object is visible to a particular node, that node will receive updates for data in the Docking Object. Visibility Rules are of two types, depending on the field RULE_TYPE. A Visibility Rule with a RULE_TYPE of “R” is referred to as an SQL Rule. An SQL Rule includes a set of Structured Query Language (SQL) statements that is evaluated to determine if any data meeting the criteria specified in the SQL statements exists in the Docking Object. If so, the Docking Object is visible to the node. A Visibility Rule with a RULE_TYPE of “O” is referred to as a Docking Object Rule. A Docking Object Rule specifies another Docking Object to be queried for visibility. If the specified Docking Object is visible, then the Docking Object pointing to it is also visible.

[0041] A Related Docking Object is a Docking Object that is propagated or deleted when the Docking Object under consideration is propagated or deleted. For example, an Opportunity Docking Object may have related Docking Objects representing the sales contacts, the organizations, the products to be sold, and the activities needed to pursue the opportunity. When an Opportunity Docking Object is propagated from Central Database 3 to one of node databases 23, the related docking objects are also propagated.

[0042] FIG. 2 depicts a database schema that shows the relationship of the various components that make up a Docking Object. The schema is a meta-database, in that it does not describe the data being accessed in the database. Rather, the schema is a separate database that defines the structure of the database being accessed. That is, it is a database comprising tables that describe the relationships and data contexts of another database.

[0043] Each of the tables shown in FIG. 2 is a table in a relational database, and as such is in row-column form. Many columns represent fields that are common to all the illustrated tables. Such fields include for example, a ROW_ID to identify a particular row in the table, as well as fields to tack the date and time that a row was created and last modified, and the identity of the user who created or modified the row. In addition, each table contains fields specific to that table, and which are described in detail below.

[0044] Table S_DOBJ 61 describes the Docking Objects in an application. Table S_DOBJ 61 includes the fields OBJ_NAME and PRIMARY_TABLE_ID. Field OBJ_NAME defines the name of the Docking Object being described. Field PRIMARY_TABLE_ID is used to identify the primary table associated with this Docking Object.

[0045] Table S_DOBJ_INST 63 describes whether a particular instance of a Docking Object, described by table S_DOBJ 61, is present on a particular node's database. Table S_DOBJ_INST 63 includes the fields NODE_ID, DOBJ_ID and PR_TBL_ROW_ID. Field NODE_ID points to a particular node table 65. Field DOBJ_ID points to the Docking Object to which the Docking Object instance applies. Field PR_TBL_ROW_ID is used to select a particular row in the Primary Table of the Docking Object. This value identifies the Docking Object instance.

[0046] Table S_REL_DOBJ 67 describes the related Docking Objects of a particular Docking Object, described by table S_DOBJ 61. Table S_REL_DOBJ 67 includes the fields DOBJ_ID, REL_DOBJ_ID, and SQL_STATEMENT. Field DOBJ_ID identifies the Docking Object that owns a particular related Docking Object. Field REL_DOBJ_ID identifies the related Docking Object that is owned by the Docking Object identified by DOBJ_ID. Field SQL_STATEMENT is an SQL statement that may be executed to obtain the Primary ID value of the related Docking Object.

[0047] Table S_DOBJ_TBL 69 describes the member tables of a particular Docking Object, described by table S_DOBJ 61. Table S_DOBJ_TBL 69 includes the fields DOBJ_ID, TBL_ID, and VIS_EVENT_FLG. Field DOBJ_ID identifies the Docking Object that contains the member table described by the row. Field TBL_ID identifies the particular table in the database that is the member table described by the row. Field VIS_EVENT_FLG is a flag that indicates whether a change to this Docking Object can result in a visibility event. A value of “Y” indicates that a change can result in a visibility event; a value of “N” indicates that it cannot.

[0048] Table S_DOBJ_VIS_RULE 71 contains the visibility rules associated with a particular Docking Object. S_DOBJ_VIS_RULE 71 contains the fields DOBJ_ID, RULE_SEQUENCE, RULE_TYPE, SQL_STATEMENT and CHECK_DOBJ_ID. Field DOBJ_ID identifies the Docking Object with which a particular visibility rule is associated. Field RULE_SEQUENCE is a sequence number that indicates the sequence, relative to other visibility rules in table S_DOBJ_VIS_RULE 71, in which the particular visibility rule should be run. RULE_TYPE specifies whether the particular visibility rule is of type “R,” indicating an SQL visibility rule or of type “O,” indicating a Docking Object visibility rule.

[0049] If RULE_TYPE is equal to “R,” field CHECK_DOBJ_ID is not meaningful, and field SQL_STATEMENT contains an SQL statement that is evaluated using the Primary ROW-ID of the primary table associated with this Docking Object and a particular Node 21. If the SQL statement returns any records, the Docking Object is deemed to be visible to the Node 21 for which visibility is being determined.

[0050] If RULE_TYPE is equal to “O,” both field CHECK_DOBJ_ID and field SQL_STATEMENT are meaningful. Field CHECK_DOBJ_ID specifies a docking object whose visibility should be determined. If the specified docking object is deemed to be visible, then the docking object associated with the visibility rule is also visible. Field SQL_STATEMENT contains a SQL statement that, when executed, returns the Row-ID of the docking object identified by CHECK_DOBJ_ID that corresponds to the docking object instance associated with the visibility rule.

[0051] Table S_APP_TBL 73 is an Application Table that describes all the tables used in a particular application. It is pointed to by table S_DOBJ_TBL 69 for each member table in a docking object, and by table S_DOBJ for the primary table in a docking object. S_APP_TBL 73 points to table S_APP_COL 75, which is an Application Column Table that describes the columns of data in a particular application. S_APP_TBL 73 points to table S_APP_COL 75 directly through a primary key and indirectly through such means as a Foreign Key Column Table 81, User Key Column Table 83, and Column Group Table 85. The relationship of an Application Table, Application Column Table, Foreign Key Column Table, User Key Column Table and Column Group Table are well known in the art and are not further described.

Update Processing

[0052] FIG. 3 depicts steps performed by an update manager 31 such as update manager 31-a, 31-b or 31-c in updating a database, such as a node database 23-a, 23-b or 23-c, responsive to user input. Execution of update manager 31 begins in step 101. In step 103, the update manager 31 accepts from the user input 33 in the form of a command requesting that the data in database 23 be altered. The request may be in the form of a request to delete a row of a table, to add a row to a table, or to change the value of a cell at a particular column of a particular row in a table. In step 105, using a well-known means, the update manager 31 applies the requested update to database 23. In step 107, the update manager 31 creates a log record describing the update and writes it to update log 35.

[0053] The contents of a log record describe the update made. Each log record indicates the node identifier of the node making the update, an identification of the table being updated, and an identification of the type of update being made, i.e., an insertion of a new row, a deletion of an existing row, or an update to an existing row. For an insertion, the log record additionally includes an identifier of the row being inserted, including its primary key and the values of the other columns in the row. For a deletion, the log record identifies the primary key of the row being deleted. For an update, the log record identifies the primary key of the row being updated, the column within the row being updated, the old value of the cell at the addressed row and column, and the new value of the cell.

[0054] After writing a log record in step 107, the update processor exits for this update. The foregoing description of the update processing preferably includes additional steps not material to the present invention, for example, to assure authorization of the user to make the update, to stage and commit the write to the database to allow for rollback in the event of software or hardware failure, and the like. These steps are well-known in the art and are not described further.

[0055] An update manager 11 executing in central computer system 1 operates in an analogous manner, except that it updates central database 3 and writes its log records to central update log 11.

Docking Processing

[0056] FIG. 4 depicts steps performed by a Docking Manager 25 such as Docking Manager 25-a, 25-b or 25-c to transmit and/or receive one or more transaction logs. Docking Manager 25 is invoked by the user of a remote node such as node 21-a, 21-b or 21-c, whereby the user requests that the node dock with central computer 1 to upload an update log such as update log 35-a to central computer 1, to download a partial log such as partial log 17-a, or both. Execution of Docking Manager 25 begins in step 121. In step 123, Docking Manager 25 connects with central computer 1 under the control of Central Docking Manager 5. This connection can be any connection that enables data exchange. It is anticipated that the most common form of a connection is a telephone line used in conjunction with a modem, but other forms of data connection, such as a Local Area Network or a TCP/IP connection may also be used. Step 125 checks to see whether the user has requested that node update log 35-a be uploaded to the Central Computer 1. If so, execution proceeds to step 127. If not, step 127 is skipped and control is given to step 129. In step 127, Docking Manager 25 uploads its update log to central computer 1. The upload may be accomplished with any known file transfer means, such as XMODEM, ZMODEM, KERMIT, FTP, ASCII transfer, or any other method of transmitting data. In step 129, Docking Manager 25 checks to see whether the user has requested that a partial log such as partial log 17-a be downloaded from Central Computer 1. If so, execution proceeds to step 131. If not, step 131 is skipped and control is given to step 133. In step 131, Docking Manager 25 downloads its partial log from central computer 1. The download may be accomplished with any known file transfer means, such as XMODEM, ZMODEM, KERMIT, FTP, ASCII transfer, or any other method of transmitting data. In step 133, having completed the requested data transfer, Docking Manager 25 exits.

Merge Processing

[0057] Merge processing is performed by a processor such as node merge processor 27-a, 27-b, or 27-c, or central merge processor 7. The merge process serves to update its associated database with a transaction that has been entered by a user of a computer remote from the computer where merge processing is being performed. Merge processing is analogous to update processing and is similar in form to update processing as previously disclosed with reference to FIG. 3, with three differences. First, the input to a merge processor is not an update entered directly by a user, but rather is a log file that is obtained from a computer remote from the computer where the merge is executing. A second difference is that, as shown by in FIG. 1, merge processing does not produce a log when performed at a node. The function of a log on a node is to record a transaction for propagation to Central Computer system 1 and thence to other nodes as required. A transaction that is the subject of a merge in a node has been communicated to Central Computer System 1, and there is no need to re-communicate it.

[0058] A third difference is that merge processing must be capable of detecting and resolving multiple conflicting transactions. For example, assume that a field contains the value “Keith Palmer.” Assume further that a user at node 27-a enters a transaction to update that field to “Carl Lake,” and a user at node 27-b enters a transaction to update the same field to “Greg Emerson.” Without collision detection, data among various nodes may become corrupt. When the transaction for user 27-a is merged, the field is updated from “Keith Palmer” to “Carl Lake.” Without collision handling, when the transaction for node 27-b is merged, the field would be updated to “Greg Emerson,” and the central database would then be out of synch with the database of node 27-a. Furthermore, when merge processing is performed on each of nodes 27-a and 27-b, each node will update its database with the other's transactions, leaving at least one node out of synch with the other node and with central database.

[0059] Therefore, merge processing must also have a means of detecting collisions and correcting them. In the above example, a simple way to detect and correct a collision is to compare the value in the database to the value that the merge log reflects as being the previous value in the node database. If the two values do not match, Merge processor 7 may reject the transaction and generate a corrective transaction to be sent to the node from which the conflicting transaction originated. In the above example, when the transaction for node 27-b was presented to merge processor 7, merge processor 7 would compare “Keith Palmer,” the prior value of the field as recorded by node 27-b to “Carl Lake,” the present value of the field as recorded in central database 3. Detecting the mismatch, merge processor 7 may then generate a transaction to change the value “Greg Emerson” to “Carl Lake,” and write that transaction to update log 15. In a subsequent docking operation, that transaction would be routed back to node 27-b to bring its database 23-b in synch with the other databases.

[0060] The above is one example of a collision and a resulting corrective action. Other types of collisions include, for example, an update to a row that has previously been deleted, inserting a row that has previously been inserted, and the like. Merge processing must detect and correct each of these collisions. This may be performed using any of a number of well-known methods, and is not discussed further.

[0061] FIG. 5 depicts the steps performed by merge processor such as central merge processor 7. Although it depicts merge processor 7 writing to central database 3 and to transaction log 15, it is equally representative of a node merge processor such as node merge processor 27-a, 27-b or 27-c updating a node database 23-a, 23-b or 23-c. Merge processing begins at step 141. In step 143, merge processor 7 finds the first unprocessed transaction on received log 19. In step 147, merge processor 7 selects a transaction from received log 19. In step 149, merge processor 149 attempts to update database 3 according to the transaction selected in step 147. In step 151, merge processor 7 determines whether the database update of step 149 failed due to a collision. If so, merge processor proceeds to step 153, which generates a corrective transaction. Following the generation of the corrective transaction, the merge processor returns to step 149 and again attempts to update database 3. If no collision was detected in step 151, execution proceeds to step 157. In step 157, merge processing checks to see if it is executing on central computer 1. If so, step 155 is executed to journal the transaction to log 15. In any case, either if step 157 determines that the merge processing is being performed on a node or after step 155, execution proceeds to step 159. Step 159 checks to see if any transactions remain to be processed from log 19. If so, execution repeats from step 147, where the next transaction is selected. If not, merge processing exits in step 161.

Log Management

[0062] FIG. 6 depicts the steps to be performed by log manager 9 to prepare a partial transaction log such as partial transaction log 17-a, 17-b, or 17-c. The procedure depicted in FIG. 6 is executed for each node available to dock with central computer system 1. Log manager 9 begins execution in step 171. In step 173, Log Manager 9 finds the first unprocessed transaction for the node whose partial transaction log is being prepared. In step 175, log manager 9 selects a transaction for processing. In step 177, log manager 9 checks to see whether the selected transaction originated on the same node for which processing is being performed. If so, there is no need to route the transaction back to the node, and control proceeds to step 179. Step 179 checks to see whether there are any transactions remaining to be processed. If so, control is given again to step 175. If not, control passes to step 189, which records the last transaction that was processed for this node, and then exits at step 191. If the transaction originates in other than the same node as the node for which processing is being performed, control is given to step 181. Step 181 calls a visibility calculator to determine whether the selected transaction is visible to the node being processed. The Visibility calculator routine is described in detail further herein. In step 183, merge processor 9 checks to see whether the visibility calculator determined that the transaction is visible. If it is not visible, control is passed to step 179, which performs as disclosed above. If the transaction is visible, control is passed to step 185. Step 185 writes a record for this transaction to the partial transaction log for the node being processed, for example, partial transaction log 17-a for node 21-a. In step 187, the log manager 9 records the last transaction that was processed for this node, and then passes control to step 179, which determines whether to select additional transactions or exit, as disclosed above.

Visibility Calculation

[0063] FIG. 7 depicts a flowchart describing the process a visibility calculator for calculating visibility for a docking object as invoked by step 181 of log manager 9. The visibility calculator is called with the node-id of the node for which visibility is being calculated, the docking object for which the visibility is being calculated, and the row-id of the docking object whose visibility id being calculated. The visibility calculator uses this information, in conjunction with information obtained from meta-data stored in the schema depicted in FIG. 2, to determine whether a particular transaction that updates a particular row of a particular docking object is visible to a particular node.

[0064] The Visibility calculator begins execution at step 201. In step 203, the visibility calculator makes a default finding that the transaction is not visible. Therefore, unless the visibility calculator determines that a transaction is visible, it will exit with a finding of no visibility. In step 205, the visibility calculator selects the first visibility rule associated with the docking object. This is done by finding the table S_DOBJ_VIS_RULE 71 associated with the current Docking Object as pointed to by table S_DOBJ 61. In step 205, the visibility calculator selects the row of table S_DOBJ_VIS_RULE 71 with the lowest value for field RULE_SEQUENCE.

[0065] In step 207, the Visibility Calculator checks the field RULE_TYPE for a value of “R.” The value of “R” indicates that the rule is a SQL visibility rule. If so, the Visibility Calculator proceeds to step 209. In step 209 the Visibility Calculator obtains a SQL statement from field SQL_STATEMENT and executes it. An example of such an SQL statement might be:

[0066]

	SELECT ‘X’ FROM S_OPTY_EMP
	WHERE OPTY_ID = :PrimaryRowId
	AND EMP_ID = :NodeId;

[0067] This SQL statement causes a query to be made of application table S_OPTY_EMP. The query selects any records meeting two criteria. First, the records selected must have a field OPTY_ID, which is a row id or key, equal to the Primary Row-ID of the Docking Object whose visibility is being determined. Second, the records selected must have a field EMP_ID, which may be for example, an identifier of a particular employee, equal to the NodeId of the node for whom visibility is being determined. In ordinary language, this SQL statement will return records only if a row is found in a table that matches employees to opportunities, where the opportunity is equal to the one being updated, and the employee to whom the opportunity is assigned is the operator of the node.

[0068] This is a simplistic example, provided for maximum comprehension. More complex SQL statements are possible. For example, the rule:

[0069]

	SELECT ‘X’ FROM
	&Table_Owner.S_ACCT_POSTN ap
	&Table_Owner.S_EMP_POSTN ep
	WHERE ap.POSITION_ID = ep.POSITION_ID
	AND ep.EMP_ID = :NodeId;

[0070] This rule queries the tables S_ACCT_POSTN (which relates a particular account with a particular position in the organization that is responsible for the account) and S_EMP_POSTN (which relates what employee corresponds to a particular position). The condition “ap.POSITION_ID=ep.POSITION_ID” requires finding a row in the account-to-position table that has the same position as a row in the employee-to-position table. The condition “ep.EMP_ID=:NodeId” further requires that the selected row in the employee-to-position table also have an Employee ID equal to the ID of the user of the Node for which visibility is being determined. In ordinary language, this condition allows visibility if the employee occupies the position that has responsibility for the account in the docking object being updated.

[0071] There is no particular limit to the complexity of the conditions in the SQL statement used to evaluate visibility. Particular implementations of SQL may impose limitations, and resource considerations may make it desirable to use less complex statements, but these limitations are not inherent in the invention.

[0072] Step 211 evaluates whether the execution of SQL_STATEMENT in step 209 returned any records. If records were returned, this indicates that the Node for which visibility is being checked has visibility to the docking object being processed. Accordingly, if records are returned, the Visibility Calculator proceeds to step 213. In step 213, the transaction is marked visible. Because no further rules need to be evaluated to determine visibility, the visibility calculator proceeds to step 228. Step 228 synchronizes the databases by determining whether the calculated visibility requires the insertion or deletion of a docking object into a particular node's partially replicated database. This may occur, for example, if a node is determined to have visibility to a docking object due to a change to a related docking object. For example, an owner of a node may be assigned to a particular activity that is related to a particular sales opportunity. As a result, the node should be provided with a copy of the object representing the sales opportunity.

[0073] FIG. 8 depicts the steps performed to synchronize a partially replicated database in response to a change in data visibility. Execution begins in step 241. In step 243, the Visibility Calculator references the visibility just calculated for a docking object. If the Docking Object is visible, execution proceeds to step 245. Step 245 references the S_DOBJ_INST table, to verify that a row exists for the Docking Object for the current node. If a row exists, this indicates that the node in question already has a copy of the referenced Docking Object, and the routine proceeds to step 255, where it exits. If, however, no row exists for the Docking Object at the node being processes, this indicates that the node in question does not have a copy of the Docking Object on its partially replicated database. The routine then proceeds to step 247, where a transaction is generated to direct the node to insert the Docking Object into its partially replicated database.

[0074] If step 243 determines that the Docking Object is not visible, execution proceeds to step 249. Step 249 references the S_DOBJ_INST table, to verify that no row exists for the Docking Object for the current node. If step 243 determines that no row exists in the S_DOBJ_INST table for the current docking object for the current row, this indicates that the node in question does not have a copy of the referenced Docking Object, and the routine proceeds to step 255, where it exits. If, however, a row exists for the Docking Object at the node being processed, this indicates that the node in question does have a copy of the Docking Object on its partially replicated database. The routine then proceeds to step 251, where a transaction is generated to direct the node to delete the Docking Object from its partially replicated database.

[0075] Referring again to FIG. 7, following the data synchronization routine of step 228, the Visibility Calculator proceeds to step 229, where it exits. Referring to FIG. 6, as previously described, the resulting finding of visibility is available to be checked by the log manager in step 183 to determine to write the transaction.

[0076] Referring again to FIG. 7, if step 211 determines that no records were returned by the execution of the SQL statement in step 209, execution proceeds with step 215. Step 215 checks to see whether there are any remaining visibility rules to be assessed. If not, the visibility calculator proceeds to step 228 to synchronize the database, and then to step 229, where it exits. In this case, the default mark of no visibility that was set in step 203 remains set. This value will also be used by the log manager as shown in FIG. 6, step 183, to determine not to write the transaction.

[0077] Referring again to FIG. 7, if rules remain to be assessed, control proceeds to step 217, which selects the next rule to be processed. Control is then given again to step 207 to begin processing the new rule.

[0078] The preceding text provided a description of the processing or SQL visibility rule; that is, visibility rules of type “R.” If step 207 determines that the visibility rule is not of type “R,” the visibility rule is of type “O.” Type “O” indicates a docking-object visibility rule. In such a case, the docking object being processed will be considered to be visible if it is related to a particular related docking object that is visible. If field RULE_TYPE is not equal to “R,” then. execution proceeds to step 221. Step 221 determines the related Docking Object whose visibility must be determined to determine whether the current docking object is visible. The related Docking Object identifier is obtained from field CHECK_DOBJ_ID in table S_DOBJ_VIS_RULE 71. In step 223, the Visibility Calculator determines which row in the related Docking Object must be queried for visibility. In order to determine this, the Visibility Calculator obtains a predetermined SQL statement from the field SQL_STATEMENT and executes it. The SQL statement is a query that select one or more rows of the Docking Object that, for example, correspond to the docking object for which the Visibility Calculator was invoked.

[0079] For example, assume that it is desired to indicate that a record for a sales opportunity should be visible if the Node has visibility to any sales quote made for that sales opportunity. This may be accomplished using the following SQL statement:

[0080]

	SELECT“_ID” FROM
	&Table_Owner.S_DOC_QUOTE
	WHERE OPTY_ID=:Primary RowId

[0081] This SQL statement accesses a table S_DOC_QUOTE that contains all sales quotes. The WHERE clause specifies retrieval of all rows where the Opportunity ID of the row is equal to the Row-ID of the opportunity for which visibility is being calculated. The Visibility manager retrieves the specified Row-Ids, thereby identifying the rows of the S_DOC_QUOTE table whose visibility must checked.

[0082] Having determined the a related docking object and the row-ID of that related docking object upon whose visibility the visibility of the current docking object depends, the Visibility Calculator proceeds to step 225. In step 225, the Visibility Calculator recursively invokes itself to determine visibility of the related docking object. The recursively invoked Visibility Calculator operates in the same manner as the Visibility Calculator as called from the Log Manager 9, including the capability to further recursively invoke itself. When the recursive call concludes, it returns a visibility indicator for the related Docking Object, and control proceeds to step 227. In step 227, the Visibility calculator determines whether the related Docking Object was determined to have been visible. If so, the Visibility Calculator proceeds to step 213 to mark the originally current Docking Object as visible, and then to step 228 to synchronize the database and then to step 229 to exit. If the related Docking Object was not determined to be visible, control proceeds to step 215 to determine whether additional visibility rules remain to be assessed.

[0083] The Visibility Calculator, in conjunction with the Log Manager is therefore able to determine what subset of update transaction data is required to be routed to any particular node. This operation serves to reduce the transmission of unneeded data from the Central Computer 1 to the various nodes such as nodes 21-a, 21-b and 21-c that utilize partially replicated databases, and to reduce the system resources such as disk space needed to store, and the CPU time needed to process, what would otherwise be required to maintain a fully replicated database on each remote node.

[0084] The operation of the log manager 9 in conjunction with the Visibility Calculator herein described will be apparent from reference to the description and to the drawings. However, as a further aid in the description of these facilities, a pseudocode representation of these facilities is hereto attached as an Appendix.

Application Upgrader

[0085] An Application Upgrader in accordance with the invention significantly reduces the time and cost of version upgrades by allowing enterprises to better determine what changes are available with each release and compare unique object customizations from prior releases with changes in the new release. The Application Upgrader notifies system administrators of conflicts between object customizations and new releases, automatically merges differences between object definitions, and allows administrators to manually override and apply any changes. The administrator will be able to better determine what has changed in the new release, compare object customizations with new changes delivered in the new release, and select which changes to apply, whether made by the customer or by the software developer in the new release. The Application Upgrader thus facilitates rapid application of previous customizations to a new release, improving the customer's ability to quickly absorb new technology and quickly roll out tailored production applications, and will be described by non-limiting reference to its use in a specific application; namely, an upgrade from SSE 2.1 to SSE Bluebird.

[0086] FIG. 9 depicts a schematic of a typical migration path. Using the Siebel Sales Enterprise (SSE) software as an example, FIG. 9 shows the evolution of the software along two distinct paths. In the first path, the software is configured and customized by a customer to produce Customer X's Configured SSE Version 2.1. In the second path, the software is developed to produce a new version called SSE Bluebird. The goal then becomes merging the customer's changes with SSE Bluebird, as indicated at the far right.

[0087] In an embodiment of the invention, the Application Upgrader (also called Business Object Upgrader) is configured to migrate customized ODF (Object Definition File) and RC (Resource) files into the new release. This Business Object Upgrader has several components:

• • [0088] GUI. The Graphical User Interface ties into an Object Explorer (described below) interface, with extensions to support visual comparison of differences between objects from two or more versions of the product. In addition, menu items and dialogs permit the administrator to initiate the difference and merge processes.
  • [0089] Difference Engine. This component compares two sets of Business Objects and creates a list of differences between the two.
  • [0090] Merge Engine. The merge process is similar to the difference process, except that a third common ancestor set of Business Objects is used to determine which differences are conflicting, and which are compatible. In addition, a facility for defining conflict resolution rules on a per-object basis may be created to reduce the number of conflicts that need to be manually resolved. Thus, referring to FIG. 9, the two sets under comparison would be from the Customer X's Configured SSE Version 2.1 and the SSE Bluebird, while the third common ancestor set would be from the SSE Version 2.1.
  • [0091] Reports Engine. A report engine produces reports that summarize the differences between sets of Business Objects.
  • [0092] ODF/RC File Readers. The pre-Bluebird business objects are configured via .ODF and .RC files, and thus must be imported into the Bluebird Business Object Repository before difference and merging operations can begin. The readers may be implemented as command-line utility programs, or be integrated with any Business Object Upgrader GUI.
  • [0093] Business Object Repository. This underlying object store supports the query and update operations needed for difference and merging multiple sets of objects.
  • [0094] OBJECT Explorer. The Object Explorer GUI provides access and editing of the business objects, and is the framework in which the Business Object Upgrader interfaces with the user.

[0095] Thus, the automated upgrader described above can handle the ODF and RC files and optionally others, as follows:

• • [0096] Business Object Definitions (.ODF files). These are the key object definitions that are upgraded by the Business Object Upgrader. The ODF import utility loads these into the repository. To keep the different product releases separate, different repositories in the same database with the same table-owner are used to hold the object definitions for each release, including the user's customized version of SSE 2.1.
  • [0097] Form Resources (.RC files). As a core piece of the repository, these files are loaded into the repository just like the ODF files, and are migrated using the same techniques.
  • [0098] Microsoft Help Files (.HLP/.CNT files).
  • [0099] RDBMS tables and their contents. A change to an object definition can trigger necessary changes in the default RDBMS upgrade script. For example, a customer may choose to migrate data that it had stored in extension columns into base product columns that were introduced in a new release. The Business Object Upgrader contains at least enough information to identify the corresponding RDBMS upgrade.
  • [0100] Microsoft Access Reports (.MDB files). Migration tools may be provided for customized Access reports.
  • [0101] String tables.

[0102] The generic difference and merge algorithms can be table-driven out of the meta-data in the repository. Object and object-type rules are defined as annotations in the repository tables. The table driven algorithms are described as follows:

Common Steps Performed by Both Difference and Merge Algorithms:

[0103] To avoid needing to have hard-coded knowledge of specific object types and their attributes, the first step is to query the meta-data in the repository to collect the definitions of the various objects. The required steps are:

• • [0104] Instantiate a BusObj/BusComp for the Repository Types table. Query up the list of object types, which contains the name of the BusComp used to fetch each object type out of the repository.
  • [0105] Instantiate a BusObj/BusComp for the Repository Object Type. Acquire a list of Repository Object instances. There may need to be other hard-coded references to the Main and Project Object Types as well, in case the Main root object is required to query its children repository objects.
  • [0106] For each object type, instantiate the corresponding business component to collect the list of objects of that type, as well as the attribute values.
    Difference Processing
  • [0107] Object names are the standard mechanism to determine if both Repositories have the same object. If the objects with the same name do exist, then a comparison of attributes occurs. If not, it is assumed that an Addition or Deletion operation has occurred.
  • [0108] The basic sweep through the Aparent-less@ objects in the repository is by object type, because it is assumed that the structure of the Projects in a repository cannot be relied upon to be consistent across versions. For example, all Business Objects are compared, then all Business Components are compared, and so on, in breadth-first search fashion.
  • [0109] Addition of a Aparent-less@ object such as a Business Component is fairly common, so there are typically many additional objects as well, for all the children objects of a Business Component. For a GUI presentation style of differences, all these changes may be grouped hierarchically under the top-level category of Added Business Component Foo@, rather than grouping the entire set of added objects in a breadth-first search summary of changes by object type.
  • [0110] Optimization: In the case of comparing versions of objects in the same repository, it should be possible to use the unique Object ID instead of the Object Name to determine if the Asame@ object has changed.
    Merge Processing

[0111] A merge is essentially a combination of performing difference checks between a common ancestor version and each of the two revisions to be merged. The result will be two sets of differences, some of which are independent and others that are in conflict. The following section describes the various cases:

[0112]

Conflict Scenarios
	Normal
Type of Difference	Case	Conflict Case	Conflict Resolution
User Adds New	No impact	Bluebird adds	Support adding both
Object		Object with	with forced rename
		same name	of User's
User Changes	Conflict	Conflict with	Support User's
Attribute	with V2.1	V2.1 and	change if attribute
	value	Bluebird's value	flag indicates it is
			superficial (e.g.
			labels)
User Deletes	No impact	Bluebird	Disregard User's
an Object		references Object	Deletion
Bluebird Adds	No impact	Conflict with	See above
New Object		User's name
Bluebird Changes	No impact	Conflict with	See above
Attribute		User's value
Bluebird Deletes	No impact	User references	Leave User
an Object		Object	reference dangling.

[0113] The merge attributes (flags, etc.) mentioned above are stored in the repository along with the definitions of the specific object types and attributes.

[0114] The following examples of user scenarios illustrate the application of the Business Object Upgrader.

User with SSE 2.1 Upgrades to Bluebird

[0115] User has a Production 2.1 system, and a development 2.1 system. The Bluebird release CDROM is unloaded onto a new Bluebird development system, and the server database is loaded, including the seed data and repository. The basic configuration is started to ensure that Athe basics@ work. The User's 2.1 ODF and RC files are imported (after running some preliminary steps required by the ODF Reader). The Business Object Upgrader can then be run to generate a new configuration. The parallel task is to create a new database from a recent backup of the production database, and apply the normal upgrade scripts to move the data to the Bluebird schema. The Business Object Upgrader can also be run from this environment to generate their Bluebird development system. Then at the time of deployment, the production system will be cut over from 2.1 to Bluebird.

Siebel Developer Merges Laptop Changes into Master Repository

[0116] Mobile developers will be operating out of their local databases (i.e. Watcom), but their remote changes will need to be merged back into the main development database. The most unusual aspects of this case are that the destination of the merged results will also be one of the sources. Multiple simultaneous connections to different databases will be required, and in addition the merge results will need to be checked in as new revisions to existing objects. Before the merge results are applied, the necessary checkout locks are established before attempting to update any of the affected merged objects.

[0117] Multiple SSE configurations can reside in multiple databases and can be simultaneously accessed by the Business Object Upgrader. This is important for cross-database merging, particularly with mobile developers merging their changes back into a central database.

[0118] The baseline SSE 2.1 configuration can be loaded into the repository for a 3-way merge. The common ancestor is of particular utility in the merging process. The repository may be seeded with the SSE 2.1 Business Objects, or the Business Objects can be imported into the repository in a manner similar to the importation of the User's final 2.1 ODF files. Following is a description of some of the screens that are contained in Application Upgrader as applied to a Siebel software product.

Merge Repositories Dialog Box

[0119] The Merge Repositories dialog box is used to specify the repositories to be merged or compared. Access to the dialog box may be in the form of a selection on a pull-down menu, a button on another dialog box, or other means as are well-known in the art. This dialog box also brings up the Application Upgrader Object List screen in the background. The following table lists the Merge Repositories dialog box options:

[0120]

Merge Repositories Dialog Box Options
OPTION	DESCRIPTION
Merge Button	Initiates the merge or compare process.
Cancel Button	Cancels the current merge request and closes the
	Merge Repositories dialog box. The Application
	Upgrades Object List screen remains.
Advanced Button	Brings up the Merge Options dialog box. The box
	is described below.
Prior Standard	Prior Siebel release.
Repository
Prior Customized	Customized version corresponding to the Prior
Repository	Siebel Repository.
New Standard	New version v3.x Siebel release.
Repository
New Customized	Final result of the merge process.
Repository

Merge Options Dialog Box

[0121] The Merge Options dialog box is used to specify options to modify the merge process. The default settings are recommended settings. As with the Merge Repositories dialog box, this dialog box may be accessed by pull-down menus, buttons, or other means.

[0122]

Merge Repositories Dialog Box Options
OPTION	DESCRIPTION
Skip logging . . .	Reduces the number of object differences to
Checkbox	only high priority objects. High priority objects
	are v2.x objects that have been changed. Low
	priority objects are new v3.x objects that have
	been added.
	The default is TRUE to improve performance by
	not logging thousands of new v3.0 objects that
	would otherwise be logged to the results table.
OK Button	Accepts the changes to the merge options.
Delete UI objects . . .	Enables the merge process to delete applet
Checkbox	control objects and list column objects that have
	been deleted in the Prior Customized
	Repository.
Cancel Button	Cancels the current merge options request and
	closes the dialog box.
Abort merge . . .	If more than the specified number of errors
	occur, the upgrade process automatically stops.
	This is useful when the administrator wants to
	avoid waiting for the entire merge process to
	complete when major problems have occurred.

Application Upgrades Object List Screen

[0123] The Application Upgrades Object List screen lists the results of the merge process and is accessed via pull-down menus or other means.

[0124]

Application Upgrades Object List Screen Lists
LIST	DESCRIPTION
Application Upgrades	The top list shows the overview of the merge
	process. Only merge operations performed by
	the current user are shown.
Object Differences	The middle list shows the objects that were
	found to be different. By default, the most
	important object differences are shown first,
	with any errors at the very top. Any error
	information is displayed in the Status column.
	The various AIn . . . @ columns show which
	repositories contain the object. The AAdd
	To . . . @ column shows whether it was be
	copied into the Customer v3.x repository.
Attribute Differences	The bottom list shows the attributes of the
	current object that were found to be different.
	The Override flag can be checked if the
	administrator doesn't like the default
	resolution as shown in the Resolution field.

[0125] The fields in the Object Differences list indicate common types of object differences. The table below describes four common type differences.

[0126]

Common Object Type Differences from the Object Differences List
COMMON OBJECT		ADD TO NEW	IN PRIOR	IN PRIOR	IN NEW
TYPE DIFFERENCE	CONFLICT	CUSTOMIZED	STANDARD	CUSTOMIZED	STANDARD
Indicates an			U	U
object that
became obsolete
in v3.0.
Indicates an		U		U
object added by
the customer.
Indicates an	U	U	U	U	U
object that has
been modified.
The Attribute
Differences list
will then show the
attribute
differences.
A new v3.x					U
object. This will
not be normally
shown. To show
these objects, the
Skip Logging . . .
checkbox on the
Advanced Merge
Options screen
must be turned
off.

Application Upgrades Attribute List Screen

[0127] The Application Upgrades Attribute List screen lists the results of the merge process in a slightly different format than the Application Upgrades Object List screen, and is accessed via a pull-down menu or other means.

[0128]

Application Upgrades Attribute List Screen Lists
LIST	DESCRIPTION
Application Upgrades	The top list shows the overview of the merge
	process. Only merge operations performed by the
	current user are shown.
Attribute Differences	The lower list shows the objects with their
	attributes that were found to be different.
	The Override flag can be checked if the
	administrator doesn't like the default resolution
	as shown in the Resolution field. By default,
	the most important object differences are shown
	first, with any errors at the very top. Any
	error information is displayed in the Status
	column.

Viewing the Differences Between Repositories

[0129] The administrator can also use the Application Upgrader to perform a compare between repositories in order to view the differences without performing the merge process. The administrator can test a possible merge by creating a preview showing the differences between the three different object repositories, in the same manner as if a merge had been performed. The Application Upgrades screens can then be used to view and print the differences.

[0130] To run a test merge comparing three repositories, the following steps are performed:

• • [0131] Fill in all the fields in the Merge Repositories dialog box except for the New Customized Repository.
  • [0132] Click on the Merge button.
  • [0133] Use the Application Upgrades screens as in a normal merge, to view or print out a report that displays the differences between the three object repositories.

[0134] The Merge Repositories process can also be used to compare two repositories. This is useful to compare or summarize all changes made during a configuration. To compare two repositories, the following steps are performed:

• • [0135] Fill in the Prior Customized Repository and the New Standard Repository fields in the Merge Repositories dialog box.
  • [0136] Click on the Merge button.
  • [0137] Use the Application Upgrades screens as in a normal merge, to view or print out a report that displays the differences between the two object repositories.

[0138] Various modifications to these embodiments will be readily apparent to those skilled in the art, and the generic principles defined herein may be applied to other embodiments without the use of inventive faculty. Thus, the present invention is not intended to be limited to the embodiments shown herein, but is to be accorded the widest scope consistent with the principles and novel features disclosed herein.

[0139] All publications and patent applications mentioned in this specification are herein incorporated by reference to the same extent as if each individual publication or patent application was specifically and individually indicated to be incorporated by reference.

[0140] The invention now being fully described, it will be apparent to one of ordinary skill in the art that many changes and modifications can be made thereto without departing therefrom.

[0141] Writing User Transaction Log File for a Given Laptop Node

[0142] This program will be called by a server-side process that processes transaction log entries for all Laptop Nodes. For each Laptop Node, the calling process is building the UserTrxnLogFileName and calling Program 1.

Input Parameters

• • [0143] LaptopNodeId—node_id of the destination laptop
  • [0144] UserTxnLogFileName—full path of the file where txns will be written
  • [0145] MaxBatchTxns—number of txns between commits and updates to the S_DOCK_STATUS table
  • [0146] MaxTxns—number of txns to process in this session. Use this parameter to limit processing.
    Main Algorithm

[0147]

Main Algorithm
-- Check parameters
IF (MaxTxns < 1 ∥ MaxBatchTxns < 1) THEN
Invalid Parameter
END IF
-- Get last LOG_EXTRACT number for the
Laptop from S_DOCK_STATUS
last_txn_commit_number = UTLDStatGetLogNum(LaptopNodeId);
-- Initialize Variables
NumTxns = 0; -- Total number of txns processed
NumBatchTxns = 0; -- Total number of txns written in the current batch
-- Read Docking Object and Table definitions into memory structures
StartDictApi ( );
-- Open the User Log Txn file
Open User Log Txn file
-- Select and process new txns in S_DOCK_TRANSACTION_LOG
-- where txn_commit_number > last_txn_commit_number
FOR each new txn LOOP
-- Stop processing if reach MaxTxns
IF NumTxns = MaxTxns THEN
break;
END IF;
-- Prevent circular txns. Do not send the txn back to the originating laptop
IF txn.OriginNodeId = LaptopNodeId THEN
Goto next transaction
END IF;
-- Process all other types of transactions
-- This is the visibility calculator!
-- This routine also processes implicit visibility events
-- Later: Data Merge can call this function to check whether a txn is
-- still visible when merging txns into a laptop or server database.
CheckVisibility
(LaptopNodeId, LogRecordType, TableName, TransRowId);
IF txn is visible THEN
-- Write transactions to UserTxnLog file depending on the
-- type of LogRecordType.
Write the txn to the user log file
++NumBatchTxns
END IF;
-- Finished processing the txn
-- Commit (if needed)
IF NumBatchTxns = MaxBatchTxns THEN
-- Assume that separate process comes around and deletes
-- Txns in S_DOCK_TRANSACTION_LOG that have been processed
-- for all nodes. So, no need to delete the txns from the log.
Update last LOG_EXTRACT number for Laptop in S_DOCK_STATUS
Commit;
NumBatchTxns = 0
END IF;
++NumTxns
End Loop; /* Each transaction in the Txn Log table */
-- Commit
Update last LOG_EXTRACT number for Laptop in S_DOCK_STATUS
Commit;
-- Close log file (if needed)
IF UserTxnLogFileP != NULL THEN
Close File;
END IF;
StopDictApi ( );
Check Visibility Routines
-- Check if a record in the txn log is visible to a LaptopNodeId
BOOL CheckVisibility
(LaptopNodeId, LogRecordType, TableName, TransRowId)
{
-- SQLStatements routed based on the destination list
IF LogRecordType in (‘SQLStatement’) THEN
IF Laptop Node in destination list THEN
return TRUE;
END IF;
-- Shadow and Multi Record LogRecordTypes are routed to all nodes
-- No visibility events with these LogRecordTypes.
ELSIF LogRecordType in (‘ShadowOperation’, ‘MultiRecordDelete’,
‘MultiRecordUpdate’) THEN
return TRUE;
-- Simple Deletes need more processing
ELSIF LogRecordType in (‘Simple Delete’) THEN
IF (table.visibility in (‘Enterprise’, ‘Limited’)) THEN
return TRUE;
END IF;
-- Simple Inserts and Simple Updates need more processing
-- CheckTxnVisibility( ) also processes implicit visibility events
ELSIF LogRecordType in (‘Simple Insert’, ‘Simple Update’) THEN
IF (table.visibility = ‘Enterprise’) THEN
return TRUE;
ELSIF table.visibility = ‘Limited’ THEN
IF CheckTxnVisibility (LaptopNodeId, Table, RowId) THEN
return TRUE;
END IF;
END IF;
END IF;
}
-- Check if a record in the txn log is visible to a LaptopNodeId
static BOOL CheckTxnVisibility (LaptopNodeId, Table, RowId)
{
BOOL bVisible = FALSE;
Find the Table in the Dictionary;
IF Table not found THEN
Error: Table not defined
END IF;
FOR all docking objects that the table belongs to LOOP
-- Generate SQL to get PrimaryId values of the Docking Object
GeneratePrimaryIdSQL (Table, RowId, DockingObject);
FOR each PrimaryId value retrieved LOOP
CheckObjectVisibility (LaptopNodeId, PrimaryTable, PrimaryRowId)
IF object is visible THEN
-- Because CheckObjectVisibility( ) also processes implicit
visibility events, we must loop through ALL docking objects
-- even if we already know that the Txn is visible.
-- Exception: if the table has VIS_event_FLG = ‘N’
-- then we can return immediately.
IF Table.visibilityEventFLG = ‘N’ THEN
return TRUE;
ELSE
bVisible = TRUE;
END IF;
END IF;
END LOOP;
END LOOP;
return bVisible;
}
-- Check if an instance of a docking object is visible to the laptop user.
-- Also processes implicit visibility events!
BOOL CheckObjectVisibility
(LaptopNodeId, DockingObjectName, PrimaryRowId)
{
FOR each visibility rule for the Docking Object LOOP
IF RuleType = RuleSQL THEN
Run the select SQL statement using PrimaryRowId;
IF any rows returned THEN
-- row is visible
-- Process an implicit Download Object
DownloadObjectInstance (LaptopNodeId, PrimaryTableName,
PrimaryRowId);
return TRUE;
END IF;
ELSIF RuleType = CheckDockingObject THEN
Run the ParameterSQL using PrimaryRowId to get newPrimaryRowId
FOR each record retrieved by ParameterSQL LOOP
-- RECURSIVE!
CheckObjectVisibility (LaptopNodeId, CheckDockingObjectName,
newPrimaryRowId);
IF rc = TRUE THEN
-- Process an implicit Download Object
DownloadObjectInstance (LaptopNodeId, PrimaryTableName,
PrimaryRowId);
return TRUE;
END IF;
END LOOP;
END IF;
END LOOP;
-- Object is not visible.
-- Process an implicit Remove Object
RemoveObjectInstance
(LaptopNodeId, PrimaryTableName, PrimaryRowId);
return FALSE;
}
Generate SQL Statement to Get PrimaryId
-- Generate the SELECT SQL statement to get the PrimaryId value of
-- the docking object for the given MemberTable
--
-- SQL statement looks like:
-- SELECT tp.<row_id>
-- FROM <table_owner>,<Table>t1,
-- <table_owner>.<PKTable>t2,
-- . . . one or more intermediate tables between the table
-- and the PrimaryTable
-- <table_owner>.<PKTable>tN
-- <table_owner>.<Primary/Table>tp
-- WHERE t1.ROW_ID = :row_id /* row_id in transaction log */
-- /* join to PK table t2 */
-- AND t1.<FKColumn>= t2.<PKColumn>
-- AND <t1 FKCondition>
-- /* any number of joins until reach the table that joins
-- to the PrimaryTable */
-- /* join from t2 to tN */
-- AND t2.<FKColumn> = tN.<PKColumn>
-- AND <t2 FKCondition>
-- /* join to the PrimaryTable */
-- AND tN.<FKColumn> = tp.<PKColumn>
-- AND <tN FKCondition>
--
-- Note that there may be one or more paths from the Member Table
-- to the Primary Table. We need to generate a SQL select statement
-- for each of the paths and UNION the statements together.
--
-- This function assumes that there are no loops in the definition.
--
-- These SQL statement do not change for each Table in a Docking Object,
-- so we can calculate them one and store them in memory.
--
struct
{
CHAR* selectList;
CHAR* fromClause;
CHAR* whereClause;
UINT numTables;
/* also the number of joint to reach the Primary Table */
}GenStmt;
GeneratePrimaryIdSQL (Table, DockingObject)
{
/* there may be more than one SQL statement, so we have a dynamic
array of SQL statements. Each element in the array is a path
from the Table to the Primary Table*/
DynArrId GenStmtArr;
GenStmt newGenStmt;
CHAR* sqlStmt;
DynArrCreate (GenStmtArr);
-- Create the first element and initialize
newGenStmt = malloc( );
newGenStmt.numTables = 1;
newGenStmt.selectList = “SELECT row_id”;
newGenStmt.fromClause = “FROM <Table>t1”;
newGenStmt.whereClause = “WHERE t1.ROW_ID = :row_id”;
DynArrAppend (GenStmtArr, &newGenStmt);
/* Recursively follow FKs to the PrimaryTable */
Build the select, from and where clause simultaneously */
AddPKTable (Table, DockingObject, GenStmtArr, 0);
-- Union all the paths together
numStmts = DynArrSize (GenStmtArr);
FOR all elements in the array LOOP
tmpSqlStmt = GenStmtArr[j].selectList∥ GenStmtArr[j].fromClause ∥
GenStmtArr[j].whereClause;
sqlStmt = sqlStmt ∥ ‘UNION’ ∥ tmpSqlStmt;
END LOOP;
DynArrDestroy (GenStmtArr);
IF sqlStmt = NULL THEN
Error: no path from Table to Primary Table.
END IF;
}
-- Recursively follow all FKs to the Primary Table
AddPKTable (Table, DockingObject, GenStmt, InputStmtNum)
{
UINT numFKS = 0;
UINT StmtNum;
GenStmt newGenStmt;
FOR all FKs for the table LOOP
IF PKTable is a Member Table of the Docking Object THEN
-- If there's more than one FK, then there is more than one path
-- out of the current table.
-- Copy the SQL stmt to a new DynArrElmt to create a new path
IF numFKs > 0 THEN
-- Create a new element and copy from GenStmt[InputStmtNum]
newGenStmt = malloc( );
newGenStmt.numTables = GenStmt[InputStmtNum].numTables;
newGenStmt.selectList = GenStmt[InputStmtNum].selectList;
newGenStmt.fromClause = GenStmt[InputStmtNum].fromClause;
newGenStmt.whereClause = GenStmt[InputStmtNum].whereClause;
DynArrAppend (GenStmtArr, &newGenStmt);
StmtNum = DynArrSize (GenStmtArr);
-- Put a check here for infinite loops
IF StmtNum == 20 THEN
Error: Probably got an Infinite loop?
END IF;
ELSE
StmtNum = InputStmtNum;
END IF;
-- Append the new PKTable to the fromClause and whereClause
GenStmt[StmtNum].fromClause =
GenStmt[StmtNum].fromClause ∥“,\n <Table>t<numTables + 1>”;
GenStmt[StmtNum].whereClause =
GenStmt[StmtNum].whereclause ∥
“AND t<numTables>.<FKColumn> = t<numTables +
1>.<PKColumn>”∥
“AND <FKCondition for Table if any>”;
++GenStmt.numTables;
-- PKTable is the Primary Table then Done.
IF PKTable = PrimaryTable THEN
RETURN;
ELSE
AddPKTable (PKTable, DockingObject, GenStmt, StmtNum);
END IF;
-- Only count FKs to other member tables in the same Docking Object
++numFKs;
END IF;
END LOOP;
RETURN;
}
Process Visibility Events
-- Download an Object Instance to a Laptop
-- This function also downloads all Related Docking Object instances.
BOOL DownloadObjectInstance
(LaptopNodeId, ObjectName, PrimaryRowId)
{
-- Check if the object instance is already downloaded to the laptop
Find the object instance in the S_DOBJ_INST table
IF exists on laptop THEN
return TRUE;
END IF;
-- Register object instance in S_DOBJ_INST table
-- Write Download Object records to the Txn Log
FOR each member table of the docking object LOOP
Generate SQL select statement to download records
Write each retrieved record to the User Txn Log file
END LOOP;
-- Download records for Parent Object instances
FOR each RelatedDockingObject LOOP
Run ParameterSQL to get newPrimaryId ofRelatedDockingObjects
FOR each newPrimaryId retrieved LOOP
-- Check if the instance of the object is visible to the laptop user
CheckObjectVisibility (LaptopNodeId, ObjectName, PrimaryRowId)
IF visible THEN
DownloadObjectInstance (LaptopNodeId,
RelatedDockingObject, newPrimaryRowId);
END IF;
END LOOP;
END LOOP;
return TRUE;
}
-- Remove an Object Instance to a Laptop
-- This function also removes all Related Docking Object instances.
BOOL RemoveObjectInstance
(LaptopNodeId, ObjectName, PrimaryRowId)
{
-- Check if the object instance is already downloaded to the laptop
Find the object instance in the S_DOBJ_INST table
IF does not exist on laptop THEN
return TRUE;
END IF;
-- Delete the object instance from S_DOBJ_INST table
-- Write Remove Object records to the Txn Log
FOR each member table of the docking object LOOP
Generate SQL select statement to get records to delete
Write each retrieved record to the User Txn Log file
END LOOP;
-- Remove for Parent Object instances
FOR each RelatedDockingObject LOOP
Run ParameterSQL to get newPrimaryId of RelatedDockingObjects
FOR each newPrimaryId retrieved LOOP
-- Check if the instance of the object is visible to the laptop user
CheckObjectVisibility (LaptopNodeId, ObjectName, PrimaryRowId)
IF not visible THEN
RemoveObjectInstance (LaptopNodeId,
RelatedDockingObject, newPrimaryRowId);
END IF;
END LOOP;
END LOOP;
return TRUE;
}