Configuring an exporter

Note: This topic describes exporting batches via Windows Message Queue. This obsolete export method is provided for compatibility with previous versions of SCAN CLIENT. Newer export programs, for example the XBOUND Exporter and the ReadSoft INVOICES exporter, are custom components.

When scanned batches are released, by default they are closed directly (status Ready). (See What happens when batches are closed (released)? for more information.) However, you can configure SCAN CLIENT to transfer batches to an external exporter program. Use the below procedures.

Tip: There are separate, specific instructions for:

• Configuring blank page removal

• Configuring the XBOUND Exporter

• Configuring the Exporter for ReadSoft INVOICES

Before configuring an exporter

Microsoft Messaging Queue must be installed. The procedure for doing this depends on your operating system. As an example, this is the procedure to use on Microsoft Windows 7:

1. In Windows 7, open the Control Panel and click Turn Windows features on or off.

2. In the Windows Features dialog, expand Microsoft Message Queue (MSMQ) Server.

3. Select Microsoft Message Queue (MSMQ) Server.

   

4. Click OK and wait for installation to complete.

5. Repeat the above procedure on each scan station.

Configuring an exporter

1. Select Scan profiles > Scan profile management. The Scan profile management dialog is displayed.

2. In the left pane, right-click a scan profile and select Export configuration to open the Export settings dialog.

3. Select Call an external exporter program after batch completion.

4. Specify a name for the message source used in Microsoft Message Queue. Two message queues are created for the current user:

   • <User name>_<message source>_scanclient

   • <User name>_<message source>_export

   You can access these in Windows by selecting Computer Management > Services and Applications > Message Queuing > Private Queues. (Show me.)

   

   The external program must know the name of the message source, for example via a configuration file.

5. Specify the complete name of the executable file. If it is not located in the SCAN CLIENT program directory, specify the path, as well.

6. Specify parameters for the external program. Use semicolons to separate multiple parameters.

   Note: SCAN CLIENT does not check whether the parameters or their formats are correct. The exporter must be able to interpret the parameters.

7. Optional: Select Export batch while scanning to close batches automatically when they are complete.

8. Click OK to save the settings.

9. Optional: Open the Configuration dialog > Batch settings and set Reopen batch after export error to True. Otherwise, batches remain closed in that case.

Related topics

What happens when batches are closed (released)?

Configuring and using your SCAN CLIENT custom component (add-on)

© 2019 Kofax, Inc. All rights reserved. | Terms of Use