Configuring the Virtual Print Driver for Client-Side Use - Virtual Print Driver - Foundation 24.1 - Foundation 24.1 - Ready - OnBase - Premier - external - Standard - Essential - Premier - Standard - Essential - OnBase/Virtual-Print-Driver/Foundation-24.1/Virtual-Print-Driver/Configuration/Configuring-the-Virtual-Print-Driver/Configuring-the-Virtual-Print-Driver-for-Client-Side-Use - 2024-03-25

Virtual Print Driver

Platform
OnBase
Product
Virtual Print Driver
Release
Foundation 24.1
License
Premier
Standard
Essential

Each client or listener needs to be configured properly before the documents it prints can be imported into OnBase.

Client/Listener

Configuration

OnBase Client

To enable the Virtual Print Driver in the OnBase Client, you must apply the -PRINTMON command line switch to your OnBase Client executable. When you open the OnBase Client with this command line switch, the Print Monitor will become active. As long as the Print Monitor is active, it will detect any jobs that are sent to the Virtual Print Driver.

Unity Client

To enable document import using the Virtual Print Driver in the Unity Client, the Virtual Print Driver feature must be enabled in the Unity Client's configuration file. The VPDMailslot attribute must also be enabled. For more information on the Unity Client configuration file, see the Unity Client documentation.

Note:

If desired, you can automatically enable the Delete Files After Import option when importing documents from the Virtual Print Driver. To do so, you must modify the deleteAfterUpload setting in the Unity Client configuration file. See the Unity Client documentation for more information on this setting.

Web Client

To enable the Virtual Print Driver in the OnBase Web Client, open the Web Server's web.config file. Under appSettings, set the following setting to true:

<add key="enableVirtualPrintDriver" value="false"/>

Virtual Print Driver Listener

To enable document import using the Virtual Print Driver in the Unity Client, the Virtual Print Driver feature must be enabled in the Unity Client configuration file.

In addition, the following attributes must be enabled in the Unity Client configuration file:

  • ServiceMode (available in the Hyland.Canvas.Client element)
  • VPDMailslot (available in the Hyland.Canvas.Automation.Services element)

For more information on the Unity Client configuration file, see the Unity Client documentation.

Note:

If desired, you can automatically enable the Delete Files After Import option when importing documents from the Virtual Print Driver. To do so, you must modify the deleteAfterUpload setting in the Unity Client configuration file. See the Unity Client documentation for more information on this setting.