Installing the Document Transfer Service - Document Transfer - Foundation 23.1 - Foundation 23.1 - Ready - OnBase - Premier - Standard - external - Standard - Premier

Document Transfer

Document Transfer
Foundation 23.1

Document Transfer requires the OnBase Application Server and the Document Transfer Service. In order to use Document Transfer, the OnBase Application Server and Document Transfer Service must be installed at both the sending and receiving sites.


For instructions on installing the Application Server see Installing the Application Server.

The Hyland Document Transfer Service installer can be run from an installation CD or a local drive. This installer package is usually located in the \install\Document Transfer Service\ folder of your source installation files. If upgrading from a previous installation it is not necessary to uninstall the old components before running the new installer.


Existing files, such as configuration files, are overwritten when performing an upgrade.

To install the Document Transfer Service:

  1. Launch the Hyland Document Transfer Service installer by executing Hyland Document Transfer Service.msi. The welcome dialog box is displayed.

    The installer can also be run from the command line. See Running the Document Transfer Service Installer from the Command Line.

  2. Click Next. The Destination Folder dialog box is displayed.
  3. Enter the top-level installation directory in the field provided, or click Change to browse to it.

    This location does not affect components not installed under the top-level directory. If the installer provides for the installation of multiple components, the specific installation locations of each component can be changed later in the installation process.

    If Change is clicked the Change destination folder dialog box is displayed.

    Enter a Folder name in the field provided or select it from the Look in drop-down list, then click OK.

    If the Destination Folder is not changed, the default location is used.

    The default installation location for the Document Transfer Service is C:\Program Files (x86)\Hyland\Services\Document Transfer\.

  4. Click Next. The Data Source dialog is displayed.

    Select the data source for OnBase from the Select or enter a data source drop-down list, or enter a valid data source if it is not listed.

  5. Click Next. The NT Service User Account dialog is displayed.

    If you would like to specify a domain account under which to run the installed services, select Specify domain account to run NT Services (when applicable).


    If the Local System account provides adequate privileges to run a service, the service is configured to run under the Local System account, even if a domain account is specified.

    • In the User Name field, enter the domain and user name to use to run the installed services. This must be entered in the domain\username format.

    • In the Password field, enter the password that corresponds to the user name provided.

    • In the Confirm Password field, re-enter the password that corresponds to the user name provided. This is used to ensure that the password is typed correctly.


      The domain account specified must have sufficient privileges under the domain to install and run services. The installer assigns the Log on as a service privilege to the user account entered. In most cases, this privilege is all that is required.

    If you do not specify a service account, all installed services run under the Local System account.

  6. Click Next. The OnBase Service Account dialog is displayed. This is the account within OnBase configured to run the installed services in OnBase.
    • In the User Name field, enter the OnBase service account user name to use when accessing the data source selected on the Service Configuration dialog. This user account must be configured as a Service Account in OnBase(see the Configuration module help files for information on creating a Service Account).

    • In the Password field, enter the password that corresponds to the user name provided.

    • In the Confirm Password field, re-enter the password that corresponds to the user name provided. This is used to ensure that the password is typed correctly.

  7. Click Next. The Ready to install... dialog box is displayed.
  8. Click Install. The Completed... dialog box is displayed after installation has completed.
  9. Select Launch Web Application Management Console to open the Web Application Management Console and configure the connection string used to access the OnBase database.

    You must configure a valid connection string in order for Document Transfer to function correctly.

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

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

  11. 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.

    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.

  12. Click Add to start creating a new connection string. The fields on the right become available for interaction.
  13. 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.
  14. In the fields on the right, enter the following information about the data source:



    Data Source Name

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


    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.


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

  15. 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


      Data Source

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


      Enter the name of the SQL Server database.

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

      Oracle.ManagedDataAccess.Client Option


      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.


      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.


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


      Enter the host address of the Oracle database.


      Enter the name of the Oracle database.


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

      • TCP

      • TCPS


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

  16. Enter the following security information:



    Integrated Security

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


    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.


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


    The password of the database user account accessing the database.


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

  17. Enter any additional options.



    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).

  18. Click Test Connection to test whether the entered information forms a valid connection string.
  19. 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.
  20. Select File | Save to save the .config file.
  21. Select File | Close to exit the connection strings dialog box.

    If the service fails to start after installation, ensure that you have configured your Site Information. See Configuring Site Information.