Connector for use with SAP ArchiveLink Installer Overview - Connector for use with SAP ArchiveLink - English - Foundation 22.1 - OnBase - Essential - Premier - Standard - external - Standard - Essential - Premier

Connector for use with SAP ArchiveLink

Connector for use with SAP ArchiveLink
Foundation 22.1

The Connector for use with SAP ArchiveLink module's virtual directory and OnBase side server setup can be installed using the Hyland Connector for SAP ArchiveLink installer. This installer can be found in the ..\install\ArchiveLink folder of your OnBase software build.

To install Connector for use with SAP ArchiveLink using the installer:

  1. Double-click on setup.exe. The setup wizard is displayed
  2. Click Next. The Destination Folder page is displayed.
  3. You can click Change to change the installation location. If you click Change, the Change destination folder dialog box is displayed.
  4. Specify the appropriate path and click OK.
  5. Click Next. The Data Source page is displayed.
  6. Select the appropriate Data Source from the drop-down.
  7. Click Next. The IIS Settings page is displayed.
  8. Select the appropriate option(s).
    • Select Use identity impersonation to run the IIS worker process to use identity impersonation to run your web server under the account specified. If this option is deselected then the web server runs under the local system account.


      The impersonation account is granted modify rights to the web server directory (e.g., AppNet) and its sub-directories. The installer does not add modify rights for any other groups; if impersonation is not used, you may experience permissions errors in modules attempting to modify files on the web server.

    • Select Enable TLS to run the web server via an HTTPS connection. If this option is selected, you must ensure that your server is correctly configured for HTTPS connections.

    • Select Use NT/LDAP Authentication to enable NT or LDAP Authentication for your web server.


      If using Active Directory - Enhanced, the Application Server that is tied to the ArchiveLink server must be configured appropriately in order to log in to the ArchiveLink Administration page. In IIS, under the Feature View of the AuthService.asmc page of the Application Server, Anonymous Authentication MUST be disabled, and Windows Authentication MUST be enabled. For more information,

  9. Click Next. The ArchiveLink Settings page is displayed.
    • Select a Web Site to install the SAP ArchiveLink application to from the drop-down list. The Web Site list is populated with the servers configured in IIS and available to the target machine.

    • Enter a name for the SAP Archivelink application in the Application Name field.

  10. Click Next. The DocPop Settings page is displayed.
  11. If you want to use DocPop as the viewer, select the Use DocPop as Viewer option. Specify the URL for to the DocPop.aspx page.
  12. Click Next. The ArchiveLink Settings page is displayed. The ArchiveLink base URL and Application Sever URL fields are populated with default values.
  13. To modify the address used to access ArchiveLink Administration, enter a valid URL in the ArchiveLink base URL field, or leave the default value as is.

    The URL set here is not the full address used to connect to ArchiveLink Administration, only the first part of the address. When logging in to ArchiveLink Administration using a web browser, you will have to add /admin/login.aspx to this base URL. For example, if you use the default ArchiveLink base URL shown above, to access ArchiveLink Administration you would navigate to http://ComputerName/ArchiveLink/admin/login.aspx.

  14. In the Application Server URL field, enter the address used to connect to your Application Server.
  15. Click Next. The Ready to install page is displayed.
  16. Click Install.
  17. When installation is complete, select Launch Web Application Management Console in order to configure the connection string used to access the OnBase database.

    You must configure a valid connection string in order for the Connector for use with SAP ArchiveLink to function properly.

  18. Click Finish. The connection string configuration window is displayed.

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

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

  20. Click Add to start creating a new connection string. The fields on the right become available for interaction.
  21. 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.
  22. 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.

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

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

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

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