Installing the Client Tools in v5.0

Using DocuNECT v5.0
Capture User Help
Installing and Configuring DocuNECT v5.0



There are different installers for the client tools depending on whether you have a 32 or 64 bit Windows operating system. To find out whether your machine is 32 or 64 bit view the computer information from the Control Panel or view your computer properties from Windows Explorer. The following screenshot shows Windows 8, however, the process can be used for Windows 7.

Windows10System.png

Before You Begin

1. Review the Component Compatibility page to ensure that the target environment meets the necessary specifications.

2. The target machine(s) must have the Microsoft .NET Framework v4.5 installed (if not already present). A link to the foundation classes can be found in the Downloads page.

3. The target machines(s) must have the prerequisites from the Downloads page installed.

4. Remove all previous versions of the DocuNECT product.


Installation

To install the client tools.

1. Double-click on the msi installer file (either the 32 bit or 64 bit version).

2. Click through the wizard, reviewing the license agreement and location where the application will be installed.

3. You will be prompted with a screen to build the connection settings to the DocuNECT web server. Click on the Build button and the following screen will be displayed:

DCConnect.png

The following table provides details about the different information required to connect to a DocuNECT system:

Information Description
Scheme This indicates whether the DocuNECT system is accessed using a security protocol. If the system is installed inside your organization then typically the scheme would be http. If you are accessing a DocuNECT system in the Portford Cloud then you will need to select https.
Server Name The name of the DocuNECT web server. If you are accessing a DocuNECT system in the Portford Cloud then use hosting.portfordservices.com.
Port If this field is left blank then it will default to port 80. Leave this blank if you are connecting to DocuNECT in the Portford Cloud.
Instance Name

This is name of your DocuNECT system. You can determine the name of your DocuNECT system by the URL you use to access DocuNECT web. For example, in the following URL the instance name is PFDemo.

https://cloud.portfordsolutions.com/DocuNECTWeb/**PFDemo**

4. You will be prompted to configure the Virtual Print Driver (VPD) authentication settings.

VPDAuth.png

The following table provides details about the different information required to configure your login:

Information Description
Login Mode User indicates whether a user will accessing DocuNECT through the user interface. There is also a Headless mode that allows some operations of DocuNECT (the Virtual Print Driver) to be run in the background. The typical setting is User.
Login Method
  • User Enters Login Information Each Time
  • Anonymous
  • Windows (The username and password you login into the network with)
  • DocuNECT (DocuNECT's own security mode)

Note, if you are connecting to DocuNECT in the Portford Cloud then select the DocuNECT mode and enter your username and password.

5. You will be prompted to select the lifecycle mode for the Virtual Print Driver (VPD).

VPDLifecycle.png

6. You will be prompted to configure the Desktop Capture (DC) authentication settings.

DCAuth.png

The following table provides details about the different information required to configure your login:

Information Description
Login Mode User indicates whether a user will accessing DocuNECT through the user interface. There is also a Headless mode that allows some operations of DocuNECT (the Virtual Print Driver) to be run in the background. The typical setting is User.
Login Method
  • User Enters Login Information Each Time
  • Anonymous
  • Windows (The username and password you login into the network with)
  • DocuNECT (DocuNECT's own security mode)

Note, if you are connecting to DocuNECT in the Portford Cloud then select the DocuNECT mode and enter your username and password.

7. If you have a desktop scanner they are typically shipped with a scanning application. Desktop Capture can drive this application for you. Once you have finished scanning they will be atomically imported into the Desktop Capture for indexing. The following screen shows the configuration that required you to browse to the .exe file for the scanning software and browse to a folder where the documents will be scanned.

8. You will be prompted to configure the Desktop Capture (DC) scan application settings. Note, this step is optional and can be configured later.

DCScanSettings.png

9. The files will then be installed on your system. Note, depending on what rights you have on your computer you may be prompted by the Microsoft Security adviser to confirm the installation.


Folder Permissions

The DocuNECT Client Tools requires the following folder permissions:

Default Path Requirements Permissions
Program Files\Portford Solutions Group, Inc\DocuNECT Client Tools Read and Write
Program Files\Portford Solutions Group, Inc\DocuNECT Client Tools\DTK Read and Write
Program Files\Portford Solutions Group, Inc\DocuNECT Client Tools\iTextSharp Read
Program Files\Portford Solutions Group, Inc\DocuNECT Client Tools\LibTiff Read
Program Files\Portford Solutions Group, Inc\DocuNECT Client Tools\Temp Read & Write
The selected scan folder as selected during the installation process, or post install configuration. Read & Write

Automated Install

The client tools can also be installed via a command-line to make it easier for IT departments to automate the deployment of the client tools components.

The following table defines the different command-line parameters:

Parameter Description
SERVICEADDRESS The full URL to the web service.
VPDLOGINMODE Either User or Headless.
VPDAUTHENTICATIONHEADLESS Either DocuNECT, Windows, or Anonymous. Use this property if VPDLOGINMODE = Headless.
VPDAUTHENTICATIONUSER Either DocuNECT, Windows, or Anonymous. Use this property if VPDLOGINMODE = Headless.
VPDUSERNAME Use if VPDAUTHENTICATIONHEADLESS = DocuNECT or VPDAUTHENTICATIONUSER = DocuNECT
VPDPASSWORD Use if VPDAUTHENTICATIONHEADLESS = DocuNECT or VPDAUTHENTICATIONUSER = DocuNECT.
VPDSELECTIONMODE

Either User, or Application

This property determines the lifecycle selection mode. User = user will select the lifecycle; Application = a predefined lifecycle will be used. Use Application if VPDLOGINMODE = Headless, or when the VPD has a predefined lifecycle.

VPDLIFECYCLE To be specified if VPDSELECTIONMODE = Application.
DCAUTHENTICATION Either DocuNECT, Windows, or Anonymous.
DCUSERNAME Used if DCAUTHENTICATION = DocuNECT.
DCPASSWORD Used if DCAUTHENTICATION = DocuNECT.
CONFIGURESCANSETTINGS Either Yes, or No.
DCSCANFOLDER To be specified if CONFIGURESCANSETTINGS = Yes.
DCSCANAPPLICATION To be specified if CONFIGURESCANSETTINGS = Yes.

Example Command Line

The following example that runs the CT x64 install with parameters . To use this example in the command line, modify the properties to your specific environment, and make sure all the parameters are written on a single line.

Notes:
1) Use optional parameter /passive for the installer to display only progress information, or /quiet to display no UI.
2) Enclose parameter values that have spaces with double-quotes ("").

msiexec /i ClientToolsSetup64.msi /passive SERVICEADDRESS=http://<Web Server Name>/DocuNECTWeb/<Your Instance Name>/services/main.asmx VPDLOGINMODE=User VPDAUTHENTICATIONUSER=DocuNECT VPDUSERNAME=<Username> VPDPASSWORD=<Password> VPDSELECTIONMODE=User DCAUTHENTICATION=DocuNECT DCUSERNAME=<Username> DCPASSWORD=<Password> CONFIGURESCANSETTINGS=No

msiexec /i ClientToolsSetup64.msi /passive SERVICEADDRESS=http:////<Web Server Name>/DocuNECTWeb/<Your Instance Name>/services/main.asmx VPDLOGINMODE=Headless VPDAUTHENTICATIONHEADLESS=User VPDAUTHENTICATIONUSER=User VPDUSERNAME=<Username>// VPDPASSWORD=<Password> VPDSELECTIONMODE=Application VPDLIFECYCLE="Upload Corporate Documents" DCAUTHENTICATION=DocuNECT DCUSERNAME=<Username> DCPASSWORD=<Password> CONFIGURESCANSETTINGS=No


Automated Uninstall/Repair

The following command lines can be used for uninstalling and repairing the client tools.

To uninstall: msiexec /x ClientToolsSetup64.msi /passive

To repair: msiexec /f ClientToolsSetup64.msi /passive


Display Office 2013 Documents in DocuNECT Web and Desktop Capture

Download and run the attached registry fix file.

fixoffice2013.reg

Note, backup your registry before apply the fix.