Captiva Cloud Runtime Redistribution

Captiva Cloud Runtime

The Captiva Cloud Service acts as a local web capture server to process ImageGear ISIS API calls to perform tasks such as scanning and manipulating images. The service is part of the Captiva Cloud Runtime Components which must be installed on each client computer that will access your application. The Captiva Cloud Runtime installer is installed when you install ImageGear .NET, and the Captiva Cloud Runtime Components can optionally be installed, which is necessary to use the ImageGear ISIS functionality.

By default, the Captiva Cloud Service is configured to start automatically when the computer starts. When the service starts, it scans for available TCP network ports that your application can use to communicate with the local web capture server. The server listens on port 49732, 49733, or 49734 for HTTP and on port 49735, 49736, or 49737 for HTTPS. If none of the ports are available, then an error is logged in the Windows System event log.

Redistribution

For an application to use the ImageGear ISIS features, the Captiva Cloud Runtime components must be installed on the application user’s system. The runtime components might be installed as a standalone package, or with another piece of software such as a scanning application. Users running your application must also have Microsoft .NET Framework 3.5 SP1 installed. You can download a redistributable package from the Microsoft website and include it in your distribution. The Captiva Cloud Runtime installer files are installed by default to the location below:

C:\Users\Public\Documents\Accusoft\ImageGear .NET v24\Resources\Redistributable

If a browser is installed after the toolkit runtime is installed, then the Captiva Cloud Service must be restarted before the browser will have access to the local security certificate that enables secure communications over HTTPS. If a browser is open during installation of the toolkit runtime, then the browser might have to be restarted. If the service or the browser is not restarted, the operator might be presented with security warnings when using your application.

The following redistribution options are available. You need to use only one of these.

Merge Module

A merge module lets you include toolkit components in an installer application. Use this option when you want to install the runtime alongside additional software. You can add a merge module file to your installation project following the instructions provided with Visual Studio.

The following merge modules are available:

EMC.OpenText.CaptivaCloud.msm: Contains all of the files needed for ImageGear ISIS applications to use scanners via the ISIS driver interface.
pixtwain.msm: Contains PixTWAIN, which is an application that enables ISIS commands to work with TWAIN drivers. ISIS is often preferred, but not all scanners have ISIS drivers. Include this package if you might need to support TWAIN drivers.

This version of PixTWAIN can be used only by applications using the Captiva Cloud Runtime.

Installer

The installer is an executable file (plus supporting files) that can be used to distribute only the toolkit components. The installer can be run from a number of different contexts. A silent installation option is available, but by default the installer is interactive. You can distribute the installer if you want to allow users to decide where to install the files.

You can redistribute the runtime installer in many ways, such as on an intranet site, via an automatic deployment tool such as Microsoft Systems Management Server (SMS), or simply by making it available on a network share. Your distribution package must include all of the files in the Redistributable folder. The runtime can be installed by running setup.exe.

To perform a silent installation, run the installer using the following command:

setup.exe /S /v/qn

Additional command line arguments are available. Run the following command to display a list of arguments that you can specify:

setup.exe /?

The Windows Installer program itself (MsiExec.exe) accepts a number of additional arguments that can be passed with the /v argument. Run MsiExec.exe /help for more information about these arguments.

Configuring the Service to Restart Automatically

To help ensure continuous availability of toolkit functionality, you can configure the OpenText Captiva Cloud Service to restart automatically on failure when you install it. Windows services are configurable from a command line that you can call from your installer. Refer to the operating system documentation or the Microsoft web site for information about configuring the behavior for a service that fails. The service name is Emc.Captiva.WebCaptureService.