JP2008027171A - Image forming apparatus - Google Patents

Abstract

<P>PROBLEM TO BE SOLVED: To improve the development efficiency of a user application by automatically finding the reason of the occurrence of a logic error by simple configuration. <P>SOLUTION: When exception is detected by an operating system 30, an error analysis program 43 is executed through a job management program 353. The error analysis program 43 causes a processor included in an image forming apparatus to perform the following processing of: referring to an error table 37 in which an API execution order as an error occurrence reason and error content information are stored so as to correspond to each other; judging whether or not the API execution order as the error occurrence reason is included in a log file (API trace result) 202 of the name of an API function acquired from a logging function 44 and its actual argument; when the judgment result is positive, causing a CF memory card to store an HTML file including the API execution order and the error content information to enable a user to browse the HTML file by a host computer which is easier to view and more operable than a control panel; and also causing the CF memory card to store the HTML file of an API function calling log. <P>COPYRIGHT: (C)2008,JPO&INPIT

Description

  The present invention provides an image input means for reading a document image, receiving image data or reading image data from a storage area, an image processing means for processing image data obtained by the input means, and processing the image data. The present invention relates to an image forming apparatus including an image output unit that forms an image on a sheet and transmits image data or stores image data in a storage area, and in particular, a debugging function for a user application created by a user or a third vendor The present invention relates to an image forming apparatus including

  In an image forming apparatus, particularly a multi-function peripheral, a user application or a third vendor can create and execute a user application that can realize a good operability or a special function in a specific application by using an API of an embedded service program. It has become.

Patent Document 1 below discloses a method of connecting an image forming apparatus and a host computer to a network and debugging a user application in the image forming apparatus from the host computer.
JP 2004-62828 A

  However, since a general-purpose debugger is used, a person must investigate the cause of occurrence of a logic error unique to the image forming apparatus, and the development efficiency of the user application is poor. For this reason, a convenient user application function is not used.

  In addition, a configuration for debugging via a network is required, which increases costs. If it is configured to automatically investigate the cause of the occurrence of a logic error, the need for debugging via a network is reduced.

  SUMMARY OF THE INVENTION An object of the present invention is to provide an image forming apparatus that can automatically investigate the cause of occurrence of a logical error and improve the development efficiency of a user application with a simple configuration in view of such problems. .

In the first aspect of the image forming apparatus according to the present invention,
A processor;
Storage means coupled to the processor for storing programs and data;
A removable storage device interface coupled to the processor and to which a removable storage device is coupled;
In an image forming apparatus having
The program includes an operating system, a service program that operates on the upper layer of the operating system and uses the API of the operating system, a vendor application program that uses the API of the service program, a logging function for tracing an API function call instruction, and an error analysis program Including
The removable storage device stores a user application using the API of the operating system, the API of the service program, or the API of the vendor application program,
The data includes an error table in which API execution order that causes an error and error content information are stored correspondingly,
The error analysis program causes the processor to refer to the error table to determine whether or not the API execution order that causes an error is included in the API trace result obtained by the logging function. In such a case, an error information file including the API execution order and error content information is stored in the removable storage device via the interface.

  In a second aspect of the image forming apparatus according to the present invention, in the first aspect, the error analysis program causes the processor to store a file including the trace result in the removable storage device via the interface.

  In a third aspect of the image forming apparatus according to the present invention, in the second aspect, both the error information file and the file including the trace result are in a file format that can be displayed by a browser of a host computer.

  In a fourth aspect of the image forming apparatus according to the present invention, in the second aspect, the API trace result includes an API function name and an actual argument.

In a fifth aspect of the image forming apparatus according to the present invention, in the fourth aspect,
The error table includes an API function argument value in the API execution order and a code indicating that the argument is arbitrary.
If the error analysis program further makes an affirmative decision with respect to the processor, and if the API function in the API execution order includes an argument value, the corresponding argument in the API trace result is set to the value. It is determined whether or not they are equal, and when an affirmative determination is made, the API execution order and the error content information are supplied to the output means.

In a sixth aspect of the image forming apparatus according to the present invention, in the fifth aspect,
The program further includes a job management program,
The job management program causes the processor to execute the error analysis program when the operating system detects an error.

In a seventh aspect of the image forming apparatus according to the present invention, in the sixth aspect,
The program further includes an execution control program, a logging step inserter, and a compiler,
The removable storage device further includes a first source code of the user application,
The execution control program causes the processor to execute the logging step inserter and execute the compiler after the processing is completed.
The logging step inserter causes the processor to detect an API function call instruction included in the first source code, and uses the API function call instruction information as an argument immediately before or immediately after the API function call instruction. Causing the logging function call instruction to be inserted into the first source code, and storing the second source code in which the logging function call instruction is inserted into the first source code in the removable storage device;
The compiler causes the processor to compile the second source code to generate the user application and store it in the removable storage device.

  According to the configuration of the first aspect, the error analysis program is obtained by the logging function by referring to the error table in which the API execution order that causes the error and the error content information are stored corresponding to the processor. It is determined whether the API execution order that causes an error is included in the API trace result, and if an affirmative determination is made, an error information file including the API execution order and error content information is removed via the interface. Since it is stored in the storage device, it is possible to easily know the cause of the logical error by removing the removable storage device from the image forming device, connecting it to the host computer, and browsing the contents of the error information file Therefore, it is possible to improve the development efficiency of user applications with a simple configuration. The frequently paid, which greatly contributes to the increased use of user application functionality.

  According to the configuration of the second aspect, the error analysis program causes the processor to store the file including the trace result in the removable storage device via the interface, so that the cause of the logical error can be grasped in more detail. There is an effect that it becomes possible.

  According to the configuration of the third aspect, since both the error information file and the file including the trace result are in a file format that can be displayed by the browser of the host computer, the file can be easily created and browsed. The effect is that no special software is required.

  According to the configuration of the fourth aspect, since the API function name and the actual argument are included in the API trace result, there is an effect that the cause of the logical error can be investigated in more detail.

  According to the configuration of the fifth aspect, the error table includes a code indicating that an argument value and an argument of the API function in the API execution order are arbitrary, and the error analysis program is provided to the processor. If the API function in the API execution order includes an argument value when the affirmative determination is made, it is determined whether or not the corresponding argument in the API trace result is equal to the value. In this case, the API execution order and the error content information are supplied to the output means, so that the configuration of the error analysis program can be simplified.

  According to the configuration of the sixth aspect, since the job management program causes the processor to execute the error analysis program when the operating system detects an error, the error is automatically generated only when an error occurs. The effect that it can cope is produced.

  According to the configuration of the seventh aspect, the execution control program causes the processor to execute the logging step inserter and the compiler is executed after the processing is completed, and the logging step inserter An API function call instruction included in one source code is detected, and immediately before or after the API function call instruction, the logging function call instruction using the API function call instruction information as an argument is set in the first source code. The compiler causes the processor to compile the second source code in which the logging function call instruction is inserted into the first source code, generate the user application, and store the generated user application in the removable storage device. API required for investigating the cause of an error by executing a user application It is possible to obtain the over scan results easily, an effect that can be executed in the image forming apparatus which use a dedicated user application for each user.

  Other objects, configurations and effects of the present invention will become apparent from the following description.

  FIG. 9 is a schematic block diagram illustrating a hardware configuration of the image forming apparatus 10 according to the first embodiment of the invention.

  In the image forming apparatus 10, an EEPROM 13 N 1, EEPROM 13 N 2, DRAM 13 D, HDD 14, operation panel 15, scanner 16 S, printer 16 P, NIC 17, modem 18, and connector 19 are coupled to the MPU 11 through an interface 12. In FIG. 9, a plurality of interfaces are shown as one block for the sake of simplicity.

  The EEPROM 13N1 and the EEPROM 13N2 are, for example, flash memories.

  The EEPROM 13N1 stores BIOS (Basic Inpit Output System) and BIOS setting data.

  The EEPROM 13N2 stores an OS (Operating System), an OS upper layer service program (SP) and application (APL), and an OS lower layer device driver (DD).

  The DRAM 13D is used for work area and user application development and execution. The HDD 14 is for data storage. The scanner 16S is for image input for copying and fax transmission. The printer 16P includes a print engine, a fixing device, a paper feed unit, a transport unit, and a paper discharge unit, and forms an electrostatic latent image on the photosensitive drum of the print engine based on the supplied bitmap data. This is developed with toner, transferred onto a sheet, fixed, and discharged. The NIC 17 is coupled to the host computer 21 via a cable or a wireless communication medium and used for a print job. The modem 18 is for fax transmission / reception.

  FIG. 7 is a schematic block diagram showing a software hierarchical structure of the image forming apparatus 10.

  A device driver group 31 corresponding to each type of hardware is provided below the OS 30. A basic service program 33 is provided in an upper layer of the OS 30 via an API group 32 for using various functions in the OS 30. The basic service program 33 includes an operation panel control module 330, an image input module group, a data processing module group that processes image data obtained by this module, and an image output module group that outputs processed image data. I have.

  The operation panel control module 330 is for displaying an operation button on the operation panel 15, detecting the pressing thereof, and performing a setting process. The image input module group includes a scan module 331, a FAX reception module 332, and an e-mail reception module 333. The image output module group includes a print module 334, a FAX transmission module 335, and an e-mail transmission module 336. The data processing module group includes a data conversion module 337 that converts the format and gradation of the image data or enlarges / reduces the image, an unillustrated aggregation processing module, a pagination module, and the like. The basic service program 33 further includes an address book module 338 used for destination designation in FAX transmission and e-mail transmission, and a user application service group 339.

  As shown in FIG. 8, the user application service group 339 includes a logging step inserter 40, a compiler 41, an execution control program 42, an error analysis program 43, and a logging program 44, which will be described later.

  Each module of the basic service program 33 uses the function of the OS 30 via the API group 32.

  In the upper layer of the basic service program 33, a vendor application 35 is provided via an external API group 34, which includes a copy module 350, a FAX module 351, an e-mail module 352, a job management module 353, and an operation panel module 354. include. Modules 350 to 354 may be one integrated application as a whole, or each may be an application.

  The vendor application 35 is a program created using a module of the basic service program 33 via the external API group 34. For example, the copy module 350 is configured by combining a scan module 331 and a print module 334. The FAX module 351 is configured by combining a FAX reception module 332, a FAX transmission module 335, and an address book module 338.

  In the upper layer of the vendor application 35, an external API group 36 for using various functions of the vendor application 35 is provided.

  The above program is stored in the EEPROM 13N2 of FIG.

  A user application 201 exists in the upper layer of the external API group 36. The user application 201 can use any of the API groups 32, 34, and 36. The vendor application 35 is an application service program when viewed from the user application 201.

  In FIG. 9, by connecting a compact flash (registered trademark, hereinafter referred to as CF) memory card 20 in which a source code file 200 is stored to the connector 19, processing described later is performed, and the user application is connected to the CF memory card 20. 201, a log file 202, and an error information file 203 are stored.

  FIG. 1 is a functional block diagram of processing related to the user application 201.

  When the execution control program 42 detects that the CF memory card 20 is connected to the connector 19, the execution control program 42 first activates the logging step inserter 40. The logging step inserter 40 reads an instruction sentence line by line from the source code file 200, inserts a logging step as will be described later, creates a source code file 200A, and stores it in the CF memory card 20.

  FIG. 2 is a detailed flowchart showing the processing of the logging step inserter 40. In the following, the step identification codes in the figure are shown in parentheses.

  (S0) Referring to the directory in the CF memory card 20, the source code file 200 is searched based on the file identifier, and its name list is displayed on the operation panel 15.

  (S1) When the user operates the operation panel 15 to select one source code file 200, the process between step S2 and step S8 is repeatedly executed for the entire sentence in the source code file 200.

  (S3) One sentence is read. With reference to the external API groups 34 and 36, it is determined whether or not this statement is an API function call instruction statement. If a positive determination is made, the process proceeds to step S5, and if not, the process proceeds to step S7.

  (S5) The API name and argument are used as arguments of the logging function call instruction.

  (S6) The logging function call instruction is written into the source code file 200A in the CF memory card 20.

  (S7) One sentence read in step S3 is written in the source code file 200A in the CF memory card 20. By such processing, a source code file 200 as shown in FIG. 3A is given to an API function call instruction, for example, fncAPI (x, y), as shown in FIG. A logging function call instruction fncLogAPI (fncAPI, x, y) having the function name and argument of this function as arguments is inserted.

  Returning to FIG. 1, when the processing by the logging step inserter 40 is completed, the execution control program 42 starts the compiler 41 and loads the contents of the source code file 200A in the CF memory card 20 onto the DRAM 13D. The user application 201 that is an executable file is generated in the DRAM 13D, and the user application 201 is stored in the CF memory card 20.

  Next, the execution control program 42 activates the user application 201 in the DRAM 13D. Since a logging step is inserted in the user application 201, the logging program 44 is called at this step, and the log of the API function to be executed from now on is stored in the log in the CF memory 20 via the buffer area in the DRAM 13D. It is stored in the file 202. The log file 202 is, for example, an HTML file or an XML file.

  For example, in the case of the user application 201 as shown in FIG. 4A, a log file 202 as shown in FIG. 4B is created. In FIG. 4, the source code of the high-level language is simplified and described for easy understanding, and the arguments are expressed in an easy-to-understand manner using characters.

  For example, the user application 201 in FIG. 4A scans a document, sends a copy of the document by e-mail to itself, and performs facsimile transmission to the customer in the G3 normal mode with one touch. Calling commands for three APIs included in the external API group 34 shown in FIG. 4A relate to facsimile transmission, and are as follows.

(1) fncScan (256level, 400dpi, 400dpi, file1)
The original is scanned with 256 monochrome gradations and a resolution of 400 dpi × 400 dpi, and the data is stored in the file file1.

(2) fncConv (file1, binary, 1/2, 1/2)
The image of the file file1 is converted into a black and white binary image, and is reduced and converted at an x-direction reduction rate of 1/2 and a y-direction reduction rate of 1/2.

(3) fncSendFAX (file1, normal, address (3))
The image of the file file1 is transmitted by facsimile to the destination registered in the serial number 3 in the address book in the normal mode.

  If there is an error in the argument in (2) and the API function call instruction in (3) violates the G3 facsimile standard, an error occurs. During execution of the user application 201, access to the hardware is performed via an API function call instruction in the OS 30, and when the OS 30 detects an exception, for example, a segment fault, the processing stops there. The job management module 353 monitors error detection by the OS 30 by periodic timer interruption, and activates the error analysis program 43 in response to this error detection.

  The error analysis program 43 performs error analysis based on the contents of the error table 37 and the log file 202 and outputs the result as an error information file 203.

  The error table 37 includes a table 370 as shown in FIG. 6A and a table 371 as shown in FIG.

  The table 370 includes fields for serial number No, prohibited API order, and error code. The table 371 includes fields for error codes and corresponding error contents.

  The function names f1, f2, and f3 in the table 370 are simplified descriptions of the function names fncScan, fncConv, and fncSendFAX in FIG. 4A, respectively. The sign “−” in the function indicates an arbitrary value. For example, in the prohibition API order of the row of No = 1 in the table 370, there is no function f2 between the function f1 and the function f3, and the resolution in the main scanning direction and the sub scanning direction for the function f1 is 400 dpi. Indicates. In this case, since it is out of the G3 facsimile standard, an error occurs regardless of the argument of the function f3.

  FIG. 5 is a flowchart showing processing by the error analysis program 43.

  The process between step S10 and step S14 is repeatedly executed for all API prohibition orders in the table 370.

  (S11) The prohibited API order and error code in the row of No = i are read.

  (S12) It is checked whether or not this prohibited API order exists in the log file 202. If it exists, the process proceeds to step S13, and if not, the process proceeds to step S11 via step S14.

  (S13) Using the error code read in step S11 as a key, the table 371 is referenced to read the error content. The error contents and the contents of the prohibited API read in step S11 are written to the error information file 203 and displayed on the operation panel 15 or are displayed on the host computer 21 via the NIC 17 by the error information file 203, for example, an HTML file or XML Provide a file so that you can check error information in your browser.

  According to the first embodiment, the error analysis program 43 refers to the error table 37 in which the API execution order that causes an error and the error content information are stored in correspondence with the MPU 11, and is obtained by the logging function 44. It is determined whether the API execution order that causes an error is included in the log file (API trace result) 202, and if the determination is affirmative, the API execution order and error content information are displayed in the CF memory card 20. Thus, the CF memory card 20 is removed from the image forming apparatus 10 and connected to the host computer 21, and the contents of the error information file 203 are viewed on the host computer 21 that is easier to see than the operation panel 354 and has good operability. Therefore, it is possible to easily understand the cause of the logic error, and the user can use a simple configuration. An effect that it is possible to improve the application development efficiency. In addition, it is possible to automatically investigate the cause of occurrence of a logic error and improve the development efficiency of the user application. As a result of this automatic investigation, there is no need to use the complicated configuration of debugging by connecting the host computer 21 to the image forming apparatus 10 and linking them together as in the above-mentioned publication.

  Further, since the error analysis program 43 causes the MPU 11 to store the log file 202 that can be browsed by the browser in the CF memory card 20, the cause of the logical error can be grasped in more detail on the host computer 21 side as described above. There is an effect that it becomes possible.

  Furthermore, since both the error information file 203 and the file including the trace result 202 are in a file format that can be displayed by the browser of the host computer 21, the creation of this file is easy and no special software is required for browsing. There is an effect.

  In addition, since the API trace result 202 includes the name and actual argument of the API function, there is an effect that the cause of the occurrence of the logic error can be investigated in more detail.

  Furthermore, when the error table 37 includes a code indicating that the argument value of the API function in the API execution order and the argument are arbitrary, and the error analysis program 43 makes an affirmative determination to the MPU 11, the error table 37 If the API function in the API execution order includes an argument value, it is determined whether or not the corresponding argument in the API trace result 202 is equal to the value. Since the error content information is output, the configuration of the error analysis program 43 can be simplified. In other words, if an error determination program corresponding to each API execution order that causes an error is created, the configuration of the error analysis program 43 becomes complicated, and each time an API execution order that causes an error is newly added. The error analysis program 43 must be revised.

  Further, since the job management program 353 causes the MPU 11 to execute the error analysis program 353 when the operating system 30 detects an exception, it is possible to automatically deal with the occurrence of an error only when an error occurs.

  Furthermore, the execution control program 42 causes the MPU 11 to execute the logging step inserter 40 and finishes the processing, and then executes the compiler 41. The logging step inserter 40 causes the MPU 11 to execute the API function in the source code 200. A calling instruction of the logging function 44 having the information of the API function calling instruction as an argument is inserted into the source code immediately before the API function calling instruction is detected, and the source code 200A is generated. Causes the MPU 11 to compile the source code 200A and generate the user application 201. By executing the user application 201, the API trace result 202 necessary for investigating the cause of the error can be easily obtained.

  Further, since the compilation result is stored in the CF memory card 20, there is an effect that the image forming apparatus 10 can execute this using a dedicated user application for each user.

  In addition, since the logging function call instruction is inserted immediately before the API function call instruction, even if an exception occurs during the execution of the called API function and the operation is stopped, the log of the API function call instruction can be acquired and more reliably. In this way, the cause of error occurrence can be obtained.

  Note that the present invention includes various other modifications.

  For example, the logging function call instruction may be inserted immediately after the API function call instruction. In particular, when this API function is executed as a new thread, the logging function call instruction is executed in parallel with this thread. Therefore, even if an exception occurs during execution of the API function and the operation stops, this API function call instruction is executed. Log can be obtained.

It is a functional block diagram of the process regarding the user application of Example 1 of this invention. It is a detailed flowchart which shows the process of the logging step inserter in FIG. FIG. 3 is an explanatory diagram of the processing of FIG. 2, and (A) and (B) are source code explanatory diagrams before and after logging step insertion, respectively. (A) is an explanatory diagram of a user application including an API function call instruction, and (B) is an explanatory diagram of a log file obtained by executing this user application. It is a flowchart which shows the process by the error analysis program in FIG. (A) And (B) is explanatory drawing of the relational table which comprises an error table. 1 is a schematic block diagram illustrating a software hierarchical structure of an image forming apparatus according to Embodiment 1 of the present invention. It is a block diagram which shows the structure of the user application service group in FIG. 1 is a schematic block diagram illustrating a hardware configuration of an image forming apparatus according to Embodiment 1 of the present invention.

Explanation of symbols

10 Image forming apparatus 11 MPU
12 interface 13N1, 13N2 EEPROM
13D DRAM
14 Hard disk 15 Operation panel 16S Scanner 16P Printer 17 NIC
18 Modem 19 Connector 20 CF Memory Card 200 Source Code File 201 User Application 202 Log File 203 Error Information File 21 Host Computer 30 OS
31 Device driver group 32 API group 33 Basic service program 330 Operation panel control module 331 Scan module 332 FAX reception module 333 E-mail reception module 334 Print module 335 FAX transmission module 336 E-mail transmission module 337 Data conversion module 338 Address book module 339 User Application service group 34, 36 External API group 35 Vendor application 350 Copy module 351 FAX module 352 E-mail module 353 Job management module 354 Operation panel module 37 Error table 370, 371 table 40 Logging step inserter 41 Compiler 42 Execution control program 43 Error Analysis program 44 logging program

Claims (7)

A processor;
Storage means coupled to the processor for storing programs and data;
A removable storage device interface coupled to the processor and to which a removable storage device is coupled;
In an image forming apparatus having
The program includes an operating system, a service program that operates on the upper layer of the operating system and uses the API of the operating system, a vendor application program that uses the API of the service program, a logging function for tracing an API function call instruction, and an error analysis program Including
The removable storage device stores a user application using the API of the operating system, the API of the service program, or the API of the vendor application program,
The data includes an error table in which API execution order that causes an error and error content information are stored correspondingly,
The error analysis program causes the processor to refer to the error table to determine whether or not the API execution order that causes an error is included in the API trace result obtained by the logging function. If the error information file includes the API execution order and error content information, the error information file is stored in the removable storage device via the interface.
An image forming apparatus.   The image forming apparatus according to claim 1, wherein the error analysis program causes the processor to store a file including the trace result in the removable storage device via the interface.   3. The image forming apparatus according to claim 2, wherein both the error information file and the file including the trace result are in a file format that can be displayed by a browser of a host computer.   The image forming apparatus according to claim 2, wherein the API trace result includes an API function name and an actual argument. The error table includes an API function argument value in the API execution order and a code indicating that the argument is arbitrary.
If the error analysis program further makes an affirmative decision with respect to the processor, and if the API function in the API execution order includes an argument value, the corresponding argument in the API trace result is set to the value. Whether or not they are equal to each other, and when an affirmative determination is made, the API execution order and the error content information are supplied to the output means.
The image forming apparatus according to claim 4. The program further includes a job management program,
The job management program causes the processor to execute the error analysis program when the operating system detects an error.
The image forming apparatus according to claim 5. The program further includes an execution control program, a logging step inserter, and a compiler,
The removable storage device further includes a first source code of the user application,
The execution control program causes the processor to execute the logging step inserter and execute the compiler after the processing is completed.
The logging step inserter causes the processor to detect an API function call instruction included in the first source code, and uses the API function call instruction information as an argument immediately before or immediately after the API function call instruction. Inserting the logging function call instruction into the first source code;
The compiler causes the processor to compile the second source code in which the logging function call instruction is inserted into the first source code, generate the user application, and store the user application in the removable storage device.
The image forming apparatus according to claim 6.

Images