The Hyland Data Capture Server x64 Setup Wizard - Data Capture Server - Foundation 23.1 - Foundation 23.1 - Ready - OnBase - Essential - Premier - Standard - external - Standard - Essential - Premier

Data Capture Server Deployment Guide

Platform
OnBase
Product
Data Capture Server
Release
Foundation 23.1
License
Standard
Essential
Premier

The Data Capture Server is installed using the Hyland Data Capture Server x64 Setup wizard. By default, the Data Capture Server Windows Service, which processes OCR work on the Data Capture Server, is also installed through the wizard.

Note:

The Hyland Data Capture Server x64 Setup wizard is only supported in 64-bit environments.

To install the Data Capture Server and its related components:

  1. Copy the Hyland Data Capture Server x64 Setup wizard's executable (Hyland Data Capture Server x64.msi) to the server that will be running your solution's processes.
  2. Launch the setup wizard by double-clicking on the executable. The setup wizard's Welcome screen is displayed.
  3. Click Next to proceed to the Destination Folder screen.
  4. From the Destination Folder screen, you can select the location where the Data Capture Server files are installed on the server.

    By default, the Data Capture Server files are installed in C:\Program Files\Hyland \Services\Data Capture. To change this location, manually enter the path to the folder where you would like the Data Capture Server files to be installed or click Change to browse to the location.

    Once the installation location is set, click Next.

  5. The Data Source screen is displayed.

    Select or enter the name of the data source used to connect to your OnBase database and then click Next.

  6. The NT Service User Account screen is displayed.
    • If you wish to specify a domain account to run the Data Capture Server Windows Service, select Specify domain account to run NT Service. Then enter the user name and password for the domain account into the User Name, Password, and Confirm Password fields, and then click Next.

    • If you do not wish to specify a domain account to run the Data Capture Server Windows Service (i.e., if you wish to use a local user account to run the NT Service), deselect Specify domain account to run NT Service. Then click Next.

      Tip:

      Once the installation is complete, you can still change which account will run the Data Capture Server Windows Service by using the Windows Administrative Tools (see the Windows help files for details on using the Administrative Tools).

  7. The OnBase Service Account screen is displayed.

    Enter the OnBase user name and password for a previously-created OnBase Service Account in the User Name, Password, and Confirm Password fields, and then click Next.

  8. The Verify Hyland OCR Engine Path screen is displayed.

    The path to the OCR engine must be specified in the configuration file for the Data Capture Server.

    Verify the path to the folder containing the OCR installation files is correct. If it is not correct, manually enter the path to the correct folder or click Change to browse to it.

    When finished, click Next.

  9. The Ready to install Hyland Data Capture Server x64 screen is displayed.
  10. Click Install to begin the installation. The Completed the Hyland Data Capture Server x64 Setup Wizard dialog box is displayed after installation is completed.
  11. Select Launch Web Application Management Console to open the Web Application Management Console and configure the connection string used to access the OnBase database.
    Note:

    You must configure a valid connection string in order for the Data Capture Server to function correctly.

  12. Click Finish. The connection string Configuration dialog box is displayed.

    The connection strings dialog box allows you to configure connection strings.

  13. To encrypt all connection strings configured in the application's .config file, ensure the Options | Encrypt Connection Strings menu option is selected. This option is automatically selected by default every time you open the connection strings dialog box, and the connection strings are encrypted when the .config file is saved.
    CAUTION:

    It is strongly recommended to encrypt the connection strings. If they are not encrypted, all data source connection information is visible in the .config file and could expose sensitive data, including any entered database user names and passwords.

  14. Click Add to start creating a new connection string. The fields on the right become available for interaction.
  15. If you are configuring Reporting Dashboards with a secondary connection string with a read-only database user account, select Options | Populate Read-Only User. This optional feature populates the User ID and Password fields with the credentials for the read-only user. See the Reporting Dashboards documentation for more information.
    If you are creating a connection string for any other purpose, skip this step.
  16. In the fields on the right, enter the following information about the data source:

    Option

    Description

    Data Source Name

    A unique name that you create to identify the connection string.

    Note:

    This identifying name may be different from the name of the actual database.

    Data Provider

    The data provider type used for the database. Select one of the following:

    • System.Data.SqlClient: Select this for a SQL Server database.

    • Oracle.ManagedDataAccess.Client: Select this for an Oracle database.

    Note:

    Only SQL Server and Oracle data providers can be used to connect to the OnBase database.

  17. Depending on your selection for Data Provider in the previous step, enter the following database connection information:
    • If System.Data.SqlClient is selected (for a SQL Server database):

      System.Data.SqlClient Option

      Description

      Data Source

      Enter the server\instance name of the SQL Server instance hosting the database.

      Database

      Enter the name of the SQL Server database.

    • If Oracle.ManagedDataAccess.Client is selected (for an Oracle database):

      Oracle.ManagedDataAccess.Client Option

      Description

      TNS Connection String

      Select this option to enter a full TNS connection string to connect to the Oracle database. Deselect the option to use the connection name instead.

      Note:

      Selecting this option enables the Host, Database, Protocol, and Port fields for interaction.

      Data Source

      Enter the TNS name or connect descriptor of the Oracle database.

      Note:

      This field is available only if the TNS Connection String option is deselected.

      Host

      Enter the host address of the Oracle database.

      Database

      Enter the name of the Oracle database.

      Protocol

      Select the protocol to use for connecting to the Oracle database. Options are:

      • TCP

      • TCPS

      Port

      Enter the port to use for connecting to the Oracle database.

  18. Enter the following security information:

    Option

    Description

    Integrated Security

    Select this option to use Windows Authentication to connect to the database.

    CAUTION:

    It is strongly recommended to use integrated security instead of a database account for authentication. To use integrated security, the Windows user connecting to the database must be the same user that is running the connecting server or service (such as the Application Server). This user must also be configured with the configgp role in the database.

    User ID

    The user name of the database user account accessing the database.

    Note:

    This user name is for a database user account, not a user account for OnBase.

    Password

    The password of the database user account accessing the database.

    Note:

    This password is for a database user account, not a user account for OnBase.

  19. Enter any additional options.

    Option

    Description

    Additional Options

    Any additional options for the connection string. For more information on available connection string options and syntax, see the documentation for your database provider (SQL Server or Oracle).

  20. Click Test Connection to test whether the entered information forms a valid connection string.
  21. Click Create to save the information in the fields and create the connection string. The name of the data source is added to the Data Sources list on the left, and the connection string is displayed in the Connection String section.
  22. Select File | Save to save the .config file.
  23. Select File | Close to exit the connection strings dialog box.
  24. Start the Hyland Data Capture Server Windows Service using the Windows Administrative Tools (see the Windows help files for details on using the Administrative Tools).
    Note:

    If you are licensed for Intelligent Capture for AP, you must fully configure a scan queue for ICAP processing in both the OnBase Configuration module and the Data Capture Configuration Tool before you can start the Hyland Data Capture Server Windows Service. For more information, see the configuration procedures outlined in the Intelligent Capture for AP module reference guide.

    Note:

    The Hyland Data Capture Server Windows Service is installed with a Manual Startup Type. If the machine running the service is restarted, the service will not restart automatically. To allow the service to restart automatically, change the Startup Type to Automatic or Automatic (Delayed Start).