Patent Application
20120188584
The present invention relates to document imaging services and, more particularly, to methods and systems for invoking document imaging services.
Document imaging services are operations that manipulate documents through imaging. Document imaging services are often provided by imaging nodes, such as printers, scanners, copiers and multifunction peripherals (MFPs), that are invoked by user interfaces. When considering the document imaging services provided by an imaging node, those services performed on the imaging node itself are sometimes called “native” imaging services. Native imaging services generally include, for example, generating printouts from electronic image files (printing) and generating electronic image files from printouts (scanning). On the other hand, those services performed on external nodes invoked by the imaging node are sometimes called “non-native” imaging services.
Conventionally, imaging node manufacturers have developed their own proprietary protocols for invoking document imaging services on their imaging nodes.
More recently, a standard web services protocol called Devices Profile for Web Services (DPWS) using Web Services Discovery (WS-Discovery), Web Services Print (WS-Print) and Web Services Scan (WS-Scan) has been developed in an attempt to address shortcomings of proprietary protocols. This standard protocol for discovering and invoking document imaging services uses Simple Object Access Protocol (SOAP) methods to carry requests and responses between a compliant sender and receiver. While this standard protocol allows a user interface to invoke document imaging services on imaging nodes made by varied manufacturers, the user interface and imaging node must still be made standard-compliant (e.g., a SOAP stack is required), and only those services that are explicitly supported in the standard are made accessible.
It is also known to deploy document imaging applications on a standalone web server node and invoke these applications from a web browser installed on an imaging node. In these deployments, the applications invoked by the web browser access native imaging services on the imaging node that are needed to deliver requested application functionality using SOAP methods, in a manner similar to DPWS. While these deployments allow native imaging services to be invoked from a web browser, an external web server node is required to mediate between the web browser and the native imaging services using SOAP.
The present invention provides an imaging node that hosts a web server execution environment that exports document imaging services using server-side scripting. The web server execution environment receives Hypertext Transfer Protocol (HTTP) requests from a web browser and runs server-side scripts that resolve HTTP requests to native imaging services. A native imaging execution environment then executes the resolved native imaging services. Moreover, the web server execution environment can run server-side scripts that resolve HTTP requests to non-native imaging services and invoke the resolved non-native imaging services remotely as required. Collocating a web server execution environment with a native imaging execution environment on an imaging node has several advantages, among them: (1) allowing requests for document imaging services to be initiated from any standard web browser; (2) enabling standard web browser technologies to be used in support of request/response flows [e.g., Secure Socket Layer/Transport Layer Security (SSL/TLS) for data privacy, cookies for session support, Hypertext Markup Language (HTML) forms for data submission, HTML frames for presenting data from disparate sources, Document Object Model (DOM) for dynamic data presentation, JavaScript Object Notation (JSON) for simple object representation, Asynchronous JavaScript and Extensible Markup Language (AJAX) for minimizing web page interference while retrieving data, etc.]; (3) allowing native imaging services to be invoked without reliance on proprietary protocols or web services protocols (e.g., DPWS, SOAP); and (4) allowing native imaging services to be invoked without reliance on an intermediary node (e.g., external web server node) to mediate between the user interface and the imaging services.
In one aspect of the invention, an imaging node comprises a native imaging execution environment and a web server execution environment operatively coupled with the native imaging execution environment, wherein an HTTP request is received by the web server execution environment from a web browser and resolved within the web server execution environment to a native document imaging service, and wherein the native document imaging service is executed within the native imaging execution environment.
In some embodiments, the native document imaging service is resolved at least in part by executing a server-side script identified in the HTTP request.
In some embodiments, the native document imaging service is resolved at least in part by mapping a server-side scripting function called by the server-side script to the native document imaging service.
In some embodiments, the HTTP request is further resolved within the web server execution environment to a non-native document imaging service, and wherein the non-native document imaging service is remotely invoked by the web server execution environment.
In some embodiments, the web services execution environment transmits an HTTP response to the web browser.
In some embodiments, the HTTP request is generated by the web browser in response to a command inputted by a user.
In some embodiments, the native document imaging service is a print service.
In some embodiments, the native document imaging service is a scan service.
In some embodiments, the native document imaging service is a copy service. In some embodiments, the native document imaging service is a fax service.
In some embodiments, the native document imaging service is an email, File Transfer Protocol (FTP) or HTTP document transfer service.
In some embodiments, the native document imaging service is an imaging node status monitoring service.
In some embodiments, the web browser is internal to the imaging node.
In some embodiments, the web browser is external to the imaging node.
In another aspect of the invention, a method for facilitating provisioning of document imaging services comprises the steps of resolving by an imaging node an HTTP request from a web browser to a native document imaging service using server-side scripting; and executing on the imaging node the native document imaging service.
These and other aspects of the invention will be better understood by reference to the following detailed description taken in conjunction with the drawings that are briefly described below. Of course, the invention is defined by the appended claims.
Turning now to
NIEE 120, which is internal to imaging node 200, includes an administrative call processor 316, administrative web pages 318, a native call processor 320 and native imaging services 322. Administrative call processor 316 fulfills HTTP requests received from web browser 312 addressed to an administrative endpoint Uniform Resource Locator (URL) by returning administrative web pages 318 read from storage system 250. Administrative call processor 316 is installed in storage system 250 and executed by processing system 240, and administrative web pages 318 are stored in storage system 250.
Native call processor 320 fulfills HTTP requests received from web browser 312 that are addressed to a document imaging endpoint URL by invoking WSEE 130 to run server-side scripts that resolve HTTP requests to native imaging services 322. Native call processor 320 is notified by WSEE 130 of resolved native imaging services 322 and calls resolved native imaging services 322, causing them to execute. Native call processor 320 is installed in storage system 250 and executed by processing system 240. Native imaging services 322 may include, by way of example, print, scan, copy, fax, document transfer (e.g., by email, FTP, HTTP) and/or image node status monitoring. Some of native imaging services 322 (e.g., print, scan, copy, fax) are executed at least in part by imaging engines 230 under the control of processing system 240.
WSEE 130, which is also internal to imaging node 200, includes an HTTP server 324, a scripting engine 326, server-side scripts 328, public application programming interfaces (APIs) 330, a SOAP client 332, an HTTP client 334, resource files 336 and utilities 338. In some embodiments, server-side scripts 328 and resource files 336 are downloaded via network interface 220 as a single application file package that is installed on imaging node 200 under the control of processing system 240.
HTTP server 324 generates and transmits HTTP responses to HTTP requests for document imaging services made by web browser 312. HTTP server 324 invokes standard web technologies, such as SSL/TLS, cookies, HTML forms, HTML frames, DOM and JSON, in support of HTTP request/response flows. HTTP server 324 is installed in storage system 250 and executed by processing system 240.
Scripting engine 326 executes server-side scripts 328 for document imaging services identified in HTTP requests received from web browser 312. Scripting engine 326 is installed in storage system 250 and executed by processing system 240.
Server-side scripts 328 are executables, such as Embedded Server Pages (ESP) and/or Embedded JavaScript (EJS) pages, that are stored in storage system 250 and executed by scripting engine 326. Server-side scripts that address native imaging services, when executed, call server-side scripting functions that public APIs 330 map to native imaging services 322. Server-side scripts that address non-native imaging services 140, when executed, instruct SOAP client 332 and/or HTTP client 334 to invoke non-native imaging services 140 by generating and transmitting external requests. Server-side scripts 328 are stored in storage system 250.
Public APIs 330 map server-side scripting functions called by server-side scripts 328 to native imaging services 322 and instruct native call processor 320 to invoke the resolved native imaging services 322. Public APIs 330 are installed in storage system 250 and executed by processing system 240.
SOAP client 332 remotely invokes non-native imaging services 140 via network interface 220 using SOAP methods. SOAP client 332 remotely invokes non-native imaging services 140 in response to instructions received from server-side scripts 328. SOAP client 332 is installed in storage system 250 and executed by processing system 240.
HTTP client 334 remotely invokes via network interface 220 non-native imaging services 140 using HTTP requests. HTTP client 334 remotely invokes non-native imaging services 140 in response to instructions received from server-side scripts 328. HTTP client 334 is installed in storage system 250 and executed by processing system 240.
Resource files 336 are web resource files, such as custom data files and image files, that may be referenced by HTTP server 324 or scripting engine 326 when formulating HTTP requests and HTTP responses. Resource file types include, for example, Cascading Style Sheets (CSS), Graphics Interchange Format (GIF), HTML, Joint Photographic Experts Group (JPG), JSON, Portable Network Graphics (PNG), text (TXT) and Extensible Markup Language (XML). Resource files 336 are stored in storage system 250.
Utilities 338 perform specialized data manipulation operations and may be invoked by HTTP server 324 or scripting engine 326 when formulating HTTP requests and responses as well as for other purposes. By way of example, utilities 338 may include OpenSSL, invoked to provide encryption/decryption and cryptographic functions; IJG JPEG 6-b, invoked to manipulate JPG files to reduce the size of scan images generated by imaging node 200 and allow thumbnail images to be created from full-size scan images; Unzip-5.52, invoked to install application packages that received in the ZIP file format; and FTP Client Loopback, which emulates FTP transfers to store scan images to storage system 250 in the absence of an FTP server.
In Step 410, the web browser generates and transmits an HTTP request identifying a server-side script corresponding to the command. For example, web browser 312 generates and transmits an HTTP request indicating to fetch a server-side script named scan.esp (assuming the scripting language is ESP) which is included among server-side scripts 328 stored in storage system 250.
In Step 415, an HTTP server on an imaging node receives the HTTP request. For example, the HTTP request transmitted by web browser 312 specifies an address of a document imaging endpoint URL, which results in native call processor 320 relaying the HTTP request to HTTP server 324.
In Step 420, a scripting engine on the imaging node runs the server-side script. For example, HTTP server 324 invokes scripting engine 326, which executes the server-side script scan.esp identified in the HTTP request.
In Step 425, the server-side script calls a server-side scripting function on the imaging node. For example, the server-side script scan.esp, when executed, calls a server-side scripting function server_scan( ).
In Step 430, a public API on the imaging node maps the server-side scripting function to a native imaging service. For example, one of public APIs 330 that is responsible for exporting native scanning operations maps the server-side scripting function to a native function named scan( ).
In Step 435, a native call processor on the imaging node executes the native imaging service. For example, the one of public APIs 330 that is responsible for exporting native scanning operations calls scan( ) which causes native call processor 320 to execute a scanning operation on imaging node 200 using imaging engines 230.
In Step 440, the HTTP server generates and transmits an HTTP response to the web browser. For example, HTTP server 324 generates and transmits an HTTP response to web browser 312 in the form of a status web page indicating that the requested scanning operation has been successfully completed.
In Step 445, the web browser receives the HTTP response, and in Step 450 the user is notified via output. For example, web browser 312 renders the status web page from the HTTP response on the touch screen of front panel 210.
The above example illustrates how within document imaging system 100, through the expedient of internal web server execution environment 130, web browser 312 can initiate a basic scanning operation on an imaging node 200 using HTTP and standard web technologies. Document imaging system 100, however, also permits a web browser 312 to initiate using HTTP and standard web technologies more complex operations and workflows that may involve native imaging services 322, or a hybrid of native imaging services 322 and non-native imaging services 140 (wherein SOAP client 332 and/or HTTP client 334 invoke non-native imaging services 140). Purely by way of example, document imaging system 100 enables web browser 312 to initiate the following operations and workflows: scanning to Google Docs; printing from Google Docs; scanning to Zoho; printing from Zoho; printing from Google Maps; scanning and previewing thumbnails and printing selected pages; and remote device management.
It will therefore be appreciated by those of ordinary skill in the art that the invention can be embodied in other specific forms without departing from the spirit or essential character hereof. The present description is thus considered in all respects to be illustrative and not restrictive. The scope of the invention is indicated by the appended claims, and all changes that come with in the meaning and range of equivalents thereof are intended to be embraced therein.
