Running the Unity Scheduler Installer - Unity Scheduler - English - Foundation 22.1 - OnBase - Essential - Premier - Standard - external - Standard - Essential - Premier

Unity Scheduler
Platform
OnBase
Product
Unity Scheduler
Release
Foundation 22.1
License
Standard
Essential
Premier

The Unity Scheduler installer installs the appropriate files, dependencies, and the Unity Scheduler service.

Launch the Hyland Unity Scheduler installer by executing the setup.exe executable. This executable is usually located in the \install\ Unity Scheduler \ folder of your source installation files.

  1. The Hyland Unity Scheduler installation welcome dialog is displayed.
  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.
    Note:

    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.

  4. Click Next. The Additional Components Destination Folder page is displayed:

    To change the installation location of additional components being installed with the Unity Scheduler(such as the Web Application Management Console), enter a new folder location or click Change to navigate to the folder location.

    Note:

    It is highly recommended to install additional components in a separate directory from Unity Scheduler.

  5. Click Next. The Default Service Instance Option dialog is displayed.
  6. If you want to create a default service instance of the Unity Scheduler service during the installation process, select the Create Default Service Instance on install option.
    If you selected the Create Default Service Instance on install option, proceed to the next step. Otherwise skip to step 14.
  7. In the Connection String field, enter a valid connection string that will connect to a data source.
    Tip:

    Connection strings are a .NET Framework concept. If you need assistance in building a valid connection string there are several resources on the Internet that can be used. Microsoft has posted a detailed explanation of connection strings on the MSDN site (http://msdn.microsoft.com) under Working With Data Providers in the ADO.NET Entity Framework library. There is also a Web site devoted entirely to connection strings at http://www.connectionstrings.com.

    An example of a sample connection string may look like this:

    • SQL: Data Source=[DATABASE_SERVER];Database=[DATABASE_NAME]; User Id=Username;Password=Password

    • MSOracle: Data Source=[TNS_NAME];User Id=Username;Password=Password

    The following values need to be replaced if the sample connection strings are going to be used as the basis of your connection string:

    • [DATABASE_SERVER]: For SQL Server connection strings, replace this value with the name of your SQL instance. For example YourMachineName\SQLSERVER. Do not include the brackets ([ ]) in this value. This value may be case sensitive, depending on how the data source is configured.

    • [DATABASE_NAME]: For SQL Server connection strings, replace this value with the actual name of the database to which the Unity Scheduler Service will connect. Do not include the brackets ([ ]) in this value. This value may be case sensitive, depending on how the data source is configured.

      Note:

      This is not the data source name of the database connection; it is the actual name of the database.

    • [TNS_NAME]: For MSOracle connection strings, replace this value with the Oracle Service Name to which the Unity Scheduler Service will connect. Do not include the brackets ([ ]) in this value. This value may be case sensitive, depending on how the data source is configured.

      Note:

      This is not the data source name of the database connection; it is the Oracle Service Name.

    • Username: This is the username of a user configured with access to the database.

    • Password: This is the password for the user configured to access the database.

  8. In the Database Name field, enter the actual name of the database that is referenced in the connection string.
  9. In the Data Provider drop-down list, select oracle if you are connecting to an Oracle data source, or select sqlserver if you are connecting to a SQL data source.
  10. In the Service Instance Name field, enter the name for the default service instance of the Unity Scheduler.
  11. If you want to add the default service instance of the Unity Scheduler to a task group, enter the name of a task group in the Task Group (optional) field.
  12. If an institutional database is used, enter the Institutional Id in the Institution Id (optional) field.
  13. Click Next. The NT Service User Account dialog is displayed.

    Specify a domain account to run the NT Service.

    Note:

    An NT Service User Account is required to create a default service instance of the Unity Scheduler service during the installation process.

    1. In the User Name field, enter the user name of the account that will be used to run the NT service.
    2. In the Password field, enter the password of the account. Enter the password again in the Confirm Password field.
  14. Click Next. The OnBase Service Account dialog is displayed.
  15. In the User Name: field, enter the user name of the service account has been configured in OnBase.
  16. In the Password: field, enter the password of the service account. Enter the password again in the Confirm Password: field.
  17. Click Next. If Create Default Service Instance on install was selected, the NT Service Options dialog is displayed.
  18. If you want the default service instance of the Unity Scheduler to be started during the installation process, select the Start service during installation option.
  19. Click Next. The Ready to install dialog is displayed.
  20. Click Install to continue with the installation, or click Cancel to cancel the installation.
  21. When the installation is complete, select the Launch Web Application Management Console option in order to configure the connection string used to access the OnBase database.
    Note:

    You must configure a valid connection string in order for the Unity Scheduler service to function properly.

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

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

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

  24. Click Add to start creating a new connection string. The fields on the right become available for interaction.
  25. 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.
  26. 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.
  27. 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.
  28. 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.
  29. 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).
  30. Click Test Connection to test whether the entered information forms a valid connection string.
  31. 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.
  32. Select File | Save to save the .config file.
  33. Select File | Close to exit the connection strings dialog box.