Work Modes "Web Scan" and "Stack Organizer" in the Index Client
The Web Scan and Stack Organizer components put the Index Client into special working modes. In these working modes, it is possible to edit files at page level. Additional functions are available for file nodes and page nodes in these modes.
Notice
In "Stack Organizer" mode, the functions for adding individual documents and files are not available. Additional documents and files can only be created by separating existing files.
The Web Scan component is used to generate new files in the form of paper documents to be digitized. These files can be mixed within a batch with existing files that originate from the file system. However, this is not possible at page level. It is only possible in mixed operation of image files that are scanned directly and image files that are imported from the file system via the scan component, provided their file format is identical. TIFF files are implicitly generated from scanned images. Imported images can also be made available as PDF files.
Handling file attachments
One special feature of the Web Scan and the Stack Organizer is the handling of file attachments. Within a document, the first file is always regarded as the primary file. All subsequent files are regarded as attachments to this primary file. The first file might be an invoice, for example, and the other files might be documents accompanying the invoice.
The need for such file separation depends on the type of downstream processing in the xSuite Interface scenario. In order to distinguish between the primary file and the attachments in the scenario, different names for primary and attachment files can be configured in the mask definition. In the Stack Organizer, this distinction is predefined by name. Attachments will always have the suffix .attach. In the document view of the Index Client, the pages of attachment files are identified by a paper clip symbol in the top right-hand corner of the thumbnail preview.
Scan Web Service
To enable the Web Scan component to communicate with the driver of scanner hardware connected locally to the workstation, install and start an additional program at this workstation. The Scan Web Service implements a web server, running locally, communicating from the web application of the index client via the address localhost. If this address cannot be called up, it will be assumed that the Scan Web Service has not yet been installed or started. In this case, an EXE file will be offered for download to install the Scan Web Service (file IndexClient\xSuiteInterfaceIndexWebClientScanStarter.exe below WebService.WebRootFolder).
Notice
Due to security guidelines, administrative support may be required for the download and initial installation.
Notice
The program file of the Scan Web Service is a processor-independent variant that is implicitly executed as a 64-bit application on 64-bit systems. If execution as a 32-bit application is to be forced on such a system (e.g., because a scanner driver to be addressed is only installed in a 32-bit version), the program variant xSuiteInterfaceIndexWebClientScan32.exe can be used as an alternative.
Google Chrome and other web browsers based on the same browser engine do not allow a connection to the localhost address from a session on another server by default. The Scan Web Service can only be used without errors if such a connection is explicitly permitted via a registry entry:
HKLM\Software\Policies\Google\Chrome\InsecurePrivateNetworkRequestsAllowed = 1 [DWORD]
The program file xSuiteInterfaceIndexWebClientScan.exe, including the additional libraries, is saved by the installer under %APPDATA%\xSuite\Interface\xSuiteInterfaceIndexWebClientScan, and is started automatically. To call the local Scan Web Service TLS-encrypted, generate a certificate issued to localhost and bind it to the address of the web service. TLS encryption is always required if the Index Client Web Service hosted by xSuite Interface is also configured to use HTTPS. Since a current web browser does not allow a mixed security context without further intervention in the security settings, all web services called from an application must communicate in encrypted form. To bind the localhost certificate, execute the program with local administrator rights.
The HTTP(S) address to which the Scan Web Service should listen is stored in the configuration file xSuiteInterfaceIndexWebClientScan.cfg in the local program directory. This address must correspond to the address stored under .ScanServiceUrl in the "WebServiceIndexClient" input system on the server side.
The Scan Web Service runs in the background and can be recognized by a tray icon. Help functions can be called up via the context menu, such as a status window with analysis information.
The working directory xSuiteInterfaceIndexWebClientScan.Work is created for the working files of the web service, in which the temporary data of a scan batch being processed is temporarily stored until final transfer to the server. Local data storage enables restoration of an unfinished scan batch, as well as continued processing after premature termination of the web application. The scan batch will automatically be offered the next time the application is started if it is available in the working directory and the option Automatic caching of changes to a scanned document batch has been activated in the general settings.