Connector for IRISPowerscan™ / xSuite Capture
For integration with the IRISPowerscan™ alias the xSuite Capture Prism scanning application (in the following, referred to as "Powerscan"), a connector is included. This connector communicates with the REST web service input interface of xSuite Interface (i.e., with the "WebServiceInput" input system).
Technically, this is a connector for the output target "IRISConnect". Therefore, to use it in a Powerscan project, first select "IRISConnect" as the primary target. In the subsequent selection dialog, select the connector "xSuiteCapture".
With a version change of Powerscan and thus possibly also of the IRISConnect included, an update of the Connector may also be necessary if the technical interface to IRISConnect has changed in the process. Currently, the Connector is delivered in a version that is compatible with IRISConnect 2.14.3, which is included in Powerscan 11.1.
Perform the following two steps manually for installation:
Copy all Connector files
IRISConnect.xSuiteInterface.*and all required additional libraries, including the subdirectoryde-DEfrom the installation directory of xSuite Interface (subfolderConnectors\IRISConnect) to the program directory of the Powerscan installation (subfolderIRISConnect)Register the Connector in IRISConnect via the command line call
{Powerscan program directory}\IRISConnect\IRISConnect.exe /target:IRISConnect.xSuiteInterface.dll /register
The setup dialog of the Connector, which can be called up within the Powerscan project designer, allows the following configuration parameters to be set:
Parameter | Description |
|---|---|
Web Service Base URL* | Base address of the target web service (i.e., the web service input interface of xSuite Interface) In the global xSuite Interface configuration, this is composed of the properties |
Tenant* Scenario* | Name of the tenant and the target scenario in xSuite Interface The name of the tenant is "Default" if no dedicated tenants are configured. Both parameters can be generated dynamically from values of the Powerscan indexing fields, using the syntax |
Windows Authentication | Switch setting whether an authentication against xSuite Interface will be performed with the Windows account of the Powerscan user This requires the |
Timeout [s] | Maximum waiting time in seconds, determining the time to wait for a response from the web service before throwing an client-side timeout error |
LogFile Folder | Path specification of a local target folder when writing a client-side log file about the processing steps (optional) The name of the log file is fixed with |
Debug Logging | Switch setting whether additional debug information for error analysis will be output in the log file |
Upload Files Separately | Switch setting whether the scan files will be transmitted to the web service in separate calls when transmitting a Powerscan batch The data transfer from Powerscan to the Connector is basically per document, while the processing logic of xSuite Interface provides for the transfer of a complete batch. The Connector therefore first collects all documents locally, not sending them to the web service as a common batch until receiving the last document. Depending on the size of the batch (i.e. the number of documents and the number/size of their constituent batch files), a large volume of data must be transferred in a single call. In order to circumvent possible problems with the available memory resources of the client, the data can thus be sent successively. The scan files are forwarded to xSuite Interface directly after the transfer from Powerscan to the Connector, locating the intermediate storage of this data on the server side instead of on the client. |
If a transfer error occurs and the final transfer of a batch to the web service has to be repeated, the individual documents are already deleted in Powerscan if automatic deletion after transfer is activated there. Because of the transfer by document to the Connector, this has been successful from Powerscan's point of view. Although the Connector does perform a precautionary check of the connection to the web service before receiving the first document, it is still recommended that you deactivate automatic deletion in Powerscan in order to avoid having to scan the same documents again.
Powerscan also always sends typed field values (number, date fields, etc.) as text values to the Connector, which sends them unchanged in this form to the web service. However, if the target fields are typed in the xSuite Interface scenario, a reconversion must be performed (i.e., a parsing of the text values into the target data type). When using common syntax variants for numbers and especially date values, this usually works implicitly. Otherwise, explicityl define a suitable .InputFormat in the index data reader.