Document processing system with a multi-platform application programming interface

[0002] This patent document includes an Appendix that contains material that is subject to copyright protection. The copyright owner does not object to reproduction of the patent document as it appears in the Patent and Trademark Office patent file or records, but otherwise reserves all copyrights whatsoever.

[0003] The present invention relates generally to automated document processing systems, and more particularly, to methods for and arrangements of multiple types of document processing systems that share a common application programming interface.

[0004] Automated document processing systems have been used for a number of years to process checks, remittances, and other forms of documents. Such systems vary in capabilities in terms of document throughput and mechanisms for extracting data. For example, some systems use optical character recognition techniques while other systems use magnetic ink character recognition. Examples of such systems include the DP 30, DP 500, and DP 1800 document processing systems from Unisys Corporation.

[0005] Many of today's systems do not share a common lineage. That is, today's systems are successors to systems that were developed in different locations by different engineers using different platforms. As a result, DP30 systems evolved to where application programs ran under the Windows and OS/2 operating system environments, DP 500 systems evolved to where application programs ran in a CTOS environment, and DP 1800 systems evolved to where application programs ran on the Motorola 68000 family of microprocessors.

[0006] With multiple types of application environments, it is expensive to develop applications for the various document processing systems because each system requires a programmer having a relatively unique skill-set. To assemble a group of programmers who possesses skills for all three platforms has been found to be difficult. Therefore, separate staffs of programmers have been required for the different platforms. This is expensive for vendors of automated document processing systems, as well as for customers who develop custom applications for different types of systems.

[0007] The present invention is directed to methods for and arrangements of document processing systems that share a common application programming interface. The common programming interface includes an object interface with properties, methods and events. The properties, methods, and events of the object interface are descriptive of multiple types of document processing systems. Instances of the object interface on multiple types of document processing systems provide a common application programming interface on the multiple types of document processing systems.

[0008] In a first aspect of the invention, a document processing system is provided with a generalized programming interface for an application program. The system is comprised of: a first document processor having a first set of capabilities that are accessible via a first set of command codes; an object interface having properties, methods, and events for the first document processor, and having properties, methods, and events for a second document processor having a second set of capabilities; and a track driver coupled to the first document processor and to the object interface, configured and arranged to interface with the first document processor and provide selected ones of the first set of command codes to the first document processor in response to methods initiated via the object interface, and in response to status codes returned from the first document processor, report events to an application program via the object interface.

[0009] Another embodiment of a document processing system with a generalized programming interface for an application program is provided in another aspect of the invention. The system is comprised of: a first document processor having a first set of capabilities that are accessible via a first set of command codes; a data processing system having an input/output port and including an object interface having properties, methods, and events for the first document processor, and having properties, methods, and events for a second document processor having a second set of capabilities; and a track driver coupled to the first document processor via the input/output port and to the object interface, configured and arranged to interface with the first document processor and provide selected ones of the first set of command codes to the first document processor in response to methods initiated via the object interface, and in response to status codes returned from the first document processor, report events to an application program via the object interface.

[0010] A method for operating a document processing system is yet another aspect of the invention. The method is comprised of the steps of: setting in an object interface values of properties that are associated with the document processing system, the object interface additionally having properties of another different document processing system; invoking methods for controlling operations of the document processing system, wherein the methods are defined in the object interface, and the object interface additionally includes methods for controlling different operations of the different document processing system; and processing events generated by the document processing system and reported via the object interface, the object interface additionally having event definitions for the different document processing system.

[0011] In another aspect of the invention, a method is provided for establishing a programming environment for a plurality of document processing systems, each document processing system having a document processor with different capabilities that are accessible via a different set of command codes. The method is comprised of the steps of: defining an object interface having properties, methods, and events that are descriptive of the document processors; establishing a plurality of respective instances of the object interface for the plurality of document processing systems, the instances of the object interface having a common programming interface for implementing application programs; coupling a plurality of respective track drivers to the instances of the object interface, each track driver responsive to methods initiated from the respective instance of the object interface, and configured and arranged to provide predetermined command codes to the document processor and report events back to the object interface.

[0012] The above Summary of the Invention is not intended to describe each disclosed embodiment of the present invention. This is the purpose of the figures and of the Detailed Description that follows.

[0013] Other aspects and advantages of the present invention will become apparent upon reading the following detailed description and upon reference to the drawings in which:

[0014] FIG. 1 is a block diagram of an example document processing system according to one embodiment of the present invention;

[0015] FIG. 2 is a flow chart of an example method for establishing a common application programming interface for multiple types of document processing systems;

[0016] FIG. 3 is a block diagram of a second example document processing system according to an embodiment of the present invention;

[0017] FIG. 4 is a block diagram of a third example document processing system according to an embodiment of the present invention;

[0018] FIG. 5 is a task model diagram of the example document processing system of FIG. 4 when running an example application program;

[0019] FIG. 6 is a task model diagram of the document processing system of FIG. 4 when responding to exception conditions;

[0020] FIGS. 7A, 7B, and 7C comprise a state diagram of a generalized track driver for an example document processing system;

[0021] FIG. 8 is a state diagram for an example exception handler for a document processing system according to an embodiment of the present invention;

[0022] FIG. 9 is a state table that indicates valid methods that may be invoked for particular states of an application program for a document processing system; and

[0023] FIG. 10 is a state table of possible events to which an application program must be programmed to respond.

[0024] While the invention is amenable to various modifications and alternative forms, specifics thereof are shown by way of example in the drawings and the written description. It should be understood, however, that the intention is not to limit the invention to the particular embodiments described. On the contrary, the intention is to cover all modifications, equivalents, and alternatives falling within the spirit and scope of the invention as defined by the appended claims.

[0025] The present invention is believed to be applicable to a variety of document processing systems and arrangements. The invention has been found to be particularly advantageous in various types of document processing systems having different document processors. An appreciation of various aspects of the invention is best gained through a discussion of various application examples operating in such environments.

[0026] FIG. 1 is a block diagram of a first example document processing system according to an embodiment of the present invention. Major components of system 100 include document processor 102, track driver 104, application program 106, and exception handler 108. An example document processor 102 is the DP 35 document processor from Unisys Corporation. An image subsystem 110 is coupled to document processor 102, wherein image subsystem 100 captures and stores digital images of documents moved by document processor 102. Document processor 102 is coupled to track driver 104 via RS232 channel 112 and track command interface 114. Track driver 104 sends commands to document processor 102 via channel 112 and track command interface 114 and receives status codes back from document processor 102 via channel 112 and interface 114. Image subsystem 110 is coupled to track driver 104 via SCSI channel 116 and interface 114. Digital images of documents captured by image subsystem 110 are provided to track driver 104 via SCSI channel 116.

[0027] Various capabilities supported by different document processors include MICR and OCR reading, encoding, endorsing, image capturing, microfilming, and courtesy amount reading. Different document processors are also capable of processing documents at different speeds.

[0028] Track driver 104 is specifically tailored to interface with document processor 102. Specifically, other types of document processing systems, for example, DP 500 and DP 1800 systems, have track driver elements that are different from track driver 104. Track driver 104 generates document processor-specific commands and sends them to document processor 102 via channel 112. Such commands are generated in response to methods of track object interface 118 that are initiated by application program 106. Track driver 104 also reports status information received from document processor 102 to application program 106 via properties of track object interface 118. Track driver 104 is coupled to track object interface 118 via shared memory and semaphore structures as indicated by line 120.

[0029] Track driver 104 handles requests made via object interface 118 from application program 106 and issues commands to control document processor 102. Track driver 104 runs in the background. Driver 104 responds to asynchronous events from document processor 102 and reports the events to application program 106 via object interface 118. For exception type events, driver 104 reports to exception handler 108 via exception object interface 122.

[0030] Exception handler 108 of system 100 reports error status codes received by track driver 104 to an operator. Exception handler 108 is coupled to track driver 104 via exception object interface 122 and shared memory and semaphore structures as indicated by line 124. Exception handler 108 reads customized error messages from database 126, wherein the messages of database 126 are associated with various error codes received by track driver 104. The complexity of application program 106 is reduced because exception handler 108 responds to error codes from document processor 102, thereby relieving application program 106 from having to respond to such error codes.

[0031] Exception handler 108 runs in the background and provides a pop-up display with an explanation for document processor 102 errors when they occur. Errors are indexed by number in exception database 126. Exception handler directs an operator as follows:

[0032] 1. Presents a list of documents that are in error to the operator.

[0033] 2. Directs the operator to reprocess documents with the original application commands.

[0034] 3. Compares code lines on repass to detect operator error.

[0035] 4. Directs the operator to the pocket for pocketing completed items by hand.

[0036] 5. Provides the option to delete the document.

[0037] Exception object interface 122 provides communication between exception handler 108 and track driver 104 and is implemented using Microsoft's object centered exchange.

[0038] Exception database 126 is an Access 2.0-format database containing all information that is viewable via exception handler 108. The information therein includes button labels, error messages, etc. The database contains an empty field next to an English language field for storing nationalized text. The information contained in the exception database pertains to diagnostic information from document processor 102. The text in the database includes step-by-step instructions to guide an operator in correcting a problem with document processor 102.

[0039] Track object interface 118 is the interface between application 106 and track driver 104. Track object interface 118 provides a simplified interface between application program 106 and document processor 102, provides application events that are consistent with Windows event-driven programming, translates properties into message packets, and checks property boundaries. The object interface provides control of document processor 102 based on values of properties set by application program 106, and notifies application program 106 of document processor 102 events through the event reporting mechanism.

[0040] In an example embodiment, track object interface 118 is implemented in an object centered exchange (OCX) that is available with Windows NT from Microsoft Corporation. OCX supports a variety of programming languages for developing application program 106. For example, such languages include Visual C++, Visual Basic, Delphi, and Visual FoxPro. Track object interface 118 is defined for use on a variety of document processing systems. For example, the same track object interface 118 is deployed on DP 35 systems, DP 500 systems, and DP 1800 systems. Properties, methods, and events are constructs that are available with OCX, and track object interface 118 is defined in terms of these constructs. A property describes a characteristic feature of a document processing system 100, a method describes a control sequence that can be initiated for a document processing system 100, and an event indicates status information reported back from a document processor 102. Properties, methods, and events are used by both track driver 104 and application program 106 to control the operation of document processing system 100. By providing a track driver 104 that is tailored to the specific operational requirements for document processor 102 and providing a track object interface 118 that is common to multiple platforms, a single programming interface may be used to develop applications for multiple platforms. The single interface allows programmers to easily program on multiple platforms, and may also provide for portability of code segments.

[0041] An example application program 106 controls all system 100 functions for conventional and image document processing, which includes feeding documents, reading code lines, endorsing, microfilming, encoding, and storing images. Such functions are accomplished by setting values associated with properties in object interface 118 and initiating control methods defined in object interface 118. Object interface 118 notifies application program 106 of events reported by track driver 104.

[0042] FIG. 2 is a flow chart of an example method for establishing a common programming interface on multiple types of document processing systems. Examples of the different types of document processing systems include the DP 35, DP 500, and DP 1800 systems as described above. At block 202, an object interface is defined, where the object interface includes properties, methods, and events for the different types of document processing systems. An example definition of an object interface is set forth in the attached appendix. Continuing now at block 204, the track object interface is established on multiple types of document processing systems. As shown in the example system 100 of FIG. 1, track object interface 118 is installed on a computer system running Windows NT. For each of the different types of document processing systems, at block 206 a system-specific track driver is established and coupled to the track object interface and to the system specific document processor. As shown in the example system of FIG. 1, track driver 104 is coupled to track object interface 118 and to document processor 102. At block 208, a system-specific exception handler is established and coupled to the system specific track driver. For example, exception handler 108 is coupled to track driver 104 of system 100, as shown by exception object interface 122 and shared memory line 124. Once instances of the track object interface, track drivers, and exception handlers have been established on the document processing systems, application programs may be developed using the application programming interface to the track object interface. For example, application program 106 of FIG. 1 may be developed to interface with track object interface 118.

[0043] FIG. 3 is a block diagram of a second example document processing system according to an embodiment of the present invention. System 300 is similar to system 100 of FIG. 1 in that it includes an exception handler 302 coupled to a track driver 304 and an application program 306 that is also coupled to track driver 304. Note that in accordance with the present invention, track object interface 118 for system 300 is another instance of track object interface 118 for system 100. Therefore, even though application program 306 may differ in functionality from application program 106 of system 100, document processor 312 may possess different capabilities, and the interface to document processor 312 is different from the interface to document processor 102, application program 306 and application program 106 may use the same programming interface to control the operations of systems 300 and 100, respectively. As indicated above for document processing system 100, in system 300 exception object interface 308, exception handler 302, and message database 310 are tailored to the specific requirements for system 300. Similarly, track driver 304 is specifically tailored to interact with document processor 312, wherein document processor 312 is an example DP 500 document processor.

[0044] In example system 300, exception handler 302, track driver 304, and application program 306 are software components that execute on a computer system running the Windows NT operating system. A system board is comprised of track control processor 314, track system non-volatile memory 316, and application non-volatile memory 318. Track control processor 314 of the system board is coupled to document processor 312 via cable 320 and coupled to device driver 322 via I/O bus 324. Device driver 322 interfaces with track control processor 314 via an I/O port. Message system 326 defines a protocol for interfacing between device driver 322 and track command interface 328.

[0045] Application NVM 318 is available for storage of data by application program 306, as illustrated by line 330. Note that the physical coupling of application program 306 to application NVM 318 is via bus 324. Track system NVM 316 is similarly available for storage of statistics and recovery data by track command interface 328 as illustrated by line 332.

[0046] FIG. 4 is a block diagram of a third example document processing system according to an embodiment of the present invention. As with systems 100 and 300, system 400 includes an exception handler 402, an exception object interface 404, a message database 406, and a track driver 408, all of which are tailored to the specific requirements for system 400. Example system 400 also includes a DP 1800 document processor 410. Track object interface 118 is yet another instance of the track object interface as described along with systems 100 and 300. Application program 412 controls overall operation of system 400. Exception handler 402, track driver 408, application program 412, and device driver 414 are software components that execute on a computer system operating Windows NT.

[0047] Device driver 414 is a conventional device driver that provides the interface between track driver 408 and interface board 416. Interface board 416 is coupled to device driver 414 via a conventional computer system input/output bus. Cable 418 couples interface board 416 to common API board 420 of DP 1800 document processor 410.

[0048] The attached appendix includes an example application program along with an example specification for track object interface 118. The specification of the database includes properties, methods, and events that are common to the different types of document processing systems 100, 300, and 400, and specifications of properties, methods, and events that are unique to the different types of document processing systems. Those skilled in the art will recognize that there are multiple ways in which a database may be expressed and fall within the scope of the present invention.

[0049] FIG. 5 is a task model diagram for example document processing system 400. In the example task model of FIG. 5, application block 502 corresponds to application program 412 of FIG. 4. Most other blocks in the task model diagram represent various control threads of track driver 408. Generally, dotted lines represent event-driven transitions from one task to another, and solid lines represent commands to and responses from the various tasks.

[0050] Beginning now at task block 502, an application program initiates a method, as indicated by line 504. Task block 506, which is performed as specified by track object interface 118, inserts the method from application block 502 in method queue block 508. Task block 510 monitors queue 508 for methods to perform. Task block 510 sends a command to task block 512, as indicated by line 514, wherein the command is determined according to the method read from method queue 508. An example method is FlowStart. The main state machine of task block 512 inserts the command into a command queue as represented by block 516. A task level track driver of task block 518 reads commands from block 516, as indicated by line 520, and forwards a specific track command to the device driver of task block 522. The device driver of task block 522 then issues a track command to interface board block 524.

[0051] Task block 518 receives status codes from task block 522, as indicated by line 526, and inserts responses from a document processor into the response queue of block 528. The main state machine of block 512 reads responses from block 528 and inserts the responses in an event queue as indicated by line 530 and block 532. An example response results in updating the value of a property in either the track object interface 118 at task block 506 and reporting the property back to application block 502, as indicated by line 534. Other types of status codes returned from the document processor, for example warning codes, are returned to application block 502 via warnings block 538 and task block 540.

[0052] Events that are reported back to application block 502 are generally initiated at track driver block 518 in response to various status codes returned from the document processor. For example, track driver block 518 returns a ReadyToProcess event to state machine 512, as indicated by dotted line 544. State machine block 512 reports the event to receiver thread block 546 via line 548. Block 506 receives events from receiver thread block 546 via line 550, and such events are reported back to application block 502, as shown by line 552.

[0053] Those skilled in the art will recognize that the present invention supports additional functions for document processing. For example, the invention provides for tracking information related to documents in process as indicated by block 556, as well as for loading various configuration information as indicated by block 558.

[0054] FIG. 6 is an example task model diagram for processing exceptions generated from certain status codes returned from a document processor. The task structure for exception handling is similar to the task structure of FIG. 5, and, therefore, the corresponding discussion will not be repeated. Exception handler block 602 remains idle until an exception event occurs. Task block 546 for the receiver thread monitors the events reported by task block 512. Events such as document jams or mis-sorts are events that cause task block 546 to report the event to task block 612. The event is then reported back to exception handler 602 via line 614.

[0055] In an example exception handler function, task block 616 for a document clean-up thread is activated by a method initiated from exception handler 602. Task block 616 reads documents from table 556 and instructs the document processor to reprocess the document as specified by the commands in table 556. When reprocessing documents, if a document is out of sequence, a nested exception occurs, and the operator may elect to rerun the document or pocket the document for later processing.

[0056] FIGS. 7A, 7B, and 7C comprise a state diagram for an example track driver 408. In state transitions, note that “C:” represents a command being issued, and “A:” represents the action taken based upon that command. At state 702, track driver 408 waits for an exception handler 402 to connect to track driver 408. At state 704, track driver 408 waits for a sorter of document processor 410 to initialize. Track driver 408 then waits for an application program 412 to connect, as shown at state 708. Once an application connects to track driver 408, track driver 408 transitions to state 710 to wait for the application program to initiate a PowerUp method. In response to initiation of a PowerUp method from application program 412, appropriate commands are issued to document processor 410, and at state 712, track driver 408 waits for document processor 410 to power-up. State 712 transitions to state 714 if document processor 410 responds with any one of various error codes. Once document processor 410 is in an acceptable powered up state, both states 712 and 714 transition to state 716. At state 716, track driver 408 remains idle until application program 412 disconnects, initiates a GoReadyToProcess method, or initiates a PowerDown method.

[0057] Track driver 408 transitions from idle state 716 to state 718 in response to initiation of a GoReadyToProcess method. At state 718, track driver 408 initializes various devices associated with document processor 410 and transitions to ready state 720 when all devices have been initialized.

[0058] One method that causes track driver 408 to transition from ready state 720 is a FlowStart method. In response to the FlowStart method from an application program 412, track driver 408 transitions to state 722 to get ready to process a flow of documents. In a general scenario, track driver 408 transitions to state 724 of state 7C when document processor 410 is ready to process and processes documents. While documents are flowing through document processor 410, track driver 408 remains in state 724. Under normal conditions, when document processor 410 has completed processing all documents, an event is issued to track driver 408, and track driver 408 transitions from flowing state 724 back to state 722 to get ready to flow documents. Various other events such as a BlackBand document event or a HopperEmpty event cause track driver 408 to transition from state 724 back to ready state 720.

[0059] Track driver 408 transitions from flowing state 724 to exception state 726 upon encountering an error condition, and track driver 408 transitions from state 726 to state 728 in response to a method to refeed a document of exception object interface 404. State 730 refeeds single documents and transitions to state 728 when all documents have been refed, and state 728 transitions to state 726 when all documents have been refed. When the exception condition has been successfully processed, state 726 transitions back to ready state 720 of FIG. 7B.

[0060] Continuing now with FIG. 8, a state diagram is shown of an example exception handler 302 in accordance with the present invention. At state 802, exception handler 402 remains in an idle state until an exception event is detected. When an event exception that involves documents occurs, exception handler 402 transitions to state 804. At state 804, exception handler 402 displays an error message for the operator and prepares to repass the documents. If the operator presses an abort button, exception handler 402 transitions back to idle state 802. However, if the operator makes recovery selections, exception handler 402 transitions to state 806.

[0061] In state 806, the operator can make various selections for processing the documents. If the operator asks to refeed the document, exception handler 402 transitions to state 808. If the document is refed and processed normally, exception handler 402 transitions from state 808 back to next document state 806. If the operator asks to hand pocket or delete the document, exception handler 402 transitions from next document state 806 to state 810. When processing of the document is complete, exception handler 402 transitions from state 810 back to next document state 806. If in processing state 808, exception handler 402 detects another exception event, exception handler 402 transitions from state 808 to nested error state 812.

[0062] Returning now to idle state 802, if exception handler 402 detects an exception event that does not involve documents, exception handler 402 transitions to state 814. At state 814, exception handler 402 displays an error message to the operator and waits for operator action. If the problem is cleared, exception handler 402 transitions back to idle state 802. If the operator indicates that the error should be ignored, exception handler 402 transitions to state 816 where the error condition is cleared, and exception handler 402 then transitions back to idle state 802.

[0063] FIG. 9 is a state table that shows methods that are valid to initiate for different states of an application program in an example embodiment of the invention. An “x” in an entry in the table indicates that when an application program is in the indicated state, it is valid to initiate the corresponding method. An “o” in an entry in the table indicates that for document processing systems such as the example DP 500, when an application program is in the indicated state, it is valid to initiate the corresponding method.

[0064] FIG. 10 is a state table that shows events to which an application program must respond. An “x” in an entry in the table indicates that when an application program is in the state indicated by the “x”, the corresponding event may occur, and the application program must be programmed to respond to the event. Note that as indicated by the legend, various events in the table are associated with DP 500 and DP 1xxx example systems only.

[0065] The above specification, examples and data provide a complete description of the manufacture and use of the composition of the invention. Those skilled in the art will recognize that the arrangements described above are operable on various categories of computer systems and data processing arrangements, and that the described methods operable in such arrangements may be embodied in software, firmware, microcode, A6, PGAs, as well as other forms. Software implementations may be distributed in various forms of computer readable media known in the art. Since many embodiments of the invention can be made without departing from the spirit and scope of the invention, the invention resides in the claims hereinafter appended.

[Inline image omitted. See PDF.]



[Inline image omitted. See PDF.]



[Inline image omitted. See PDF.]



[Inline image omitted. See PDF.]



[Inline image omitted. See PDF.]



[Inline image omitted. See PDF.]



[Inline image omitted. See PDF.]



[Inline image omitted. See PDF.]



[Inline image omitted. See PDF.]



[Inline image omitted. See PDF.]



[Inline image omitted. See PDF.]



[Inline image omitted. See PDF.]



[Inline image omitted. See PDF.]



[Inline image omitted. See PDF.]



[Inline image omitted. See PDF.]



[Inline image omitted. See PDF.]



[Inline image omitted. See PDF.]



[Inline image omitted. See PDF.]



[Inline image omitted. See PDF.]



[Inline image omitted. See PDF.]



[Inline image omitted. See PDF.]



[Inline image omitted. See PDF.]



[Inline image omitted. See PDF.]



[Inline image omitted. See PDF.]



[Inline image omitted. See PDF.]



[Inline image omitted. See PDF.]



[Inline image omitted. See PDF.]



[Inline image omitted. See PDF.]



[Inline image omitted. See PDF.]



[Inline image omitted. See PDF.]



[Inline image omitted. See PDF.]



[Inline image omitted. See PDF.]



[Inline image omitted. See PDF.]



[Inline image omitted. See PDF.]



[Inline image omitted. See PDF.]



[Inline image omitted. See PDF.]



[Inline image omitted. See PDF.]



[Inline image omitted. See PDF.]



[Inline image omitted. See PDF.]



[Inline image omitted. See PDF.]



[Inline image omitted. See PDF.]



[Inline image omitted. See PDF.]



[Inline image omitted. See PDF.]



[Inline image omitted. See PDF.]



[Inline image omitted. See PDF.]



[Inline image omitted. See PDF.]



[Inline image omitted. See PDF.]



[Inline image omitted. See PDF.]



[Inline image omitted. See PDF.]



[Inline image omitted. See PDF.]



[Inline image omitted. See PDF.]



[Inline image omitted. See PDF.]



[Inline image omitted. See PDF.]



[Inline image omitted. See PDF.]



[Inline image omitted. See PDF.]



[Inline image omitted. See PDF.]



[Inline image omitted. See PDF.]



[Inline image omitted. See PDF.]



[Inline image omitted. See PDF.]



[Inline image omitted. See PDF.]



[Inline image omitted. See PDF.]



[Inline image omitted. See PDF.]



[Inline image omitted. See PDF.]



[Inline image omitted. See PDF.]



[Inline image omitted. See PDF.]