Running the Unity Scheduler Installer - Unity Scheduler - Foundation 25.1 - Foundation 25.1 - Ready - OnBase - Premier - external - Standard - Essential - Premier - Standard - Essential - OnBase/Unity-Scheduler/Foundation-25.1/Unity-Scheduler/Installation/Installation/Running-the-Unity-Scheduler-Installer - 2025-03-17 - The Unity Scheduler installer installs the appropriate files, dependencies, and the Unity Scheduler service.

Unity Scheduler

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

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

To run the Unity Scheduler installer:

  1. Open the setup.exe file located in the Unity Scheduler installation files.
    The default location for Unity Scheduler installation files is install\Unity Scheduler\.
    The Unity Scheduler installation wizard is displayed.
  2. Click Next.
    The Destination Folder page is displayed.
    Destination Folder page in the Unity Scheduler Installation wizard.
  3. Enter the top-level installation directory in the field provided, or click Change to browse to the top-level installation directory.
    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.

    Change Destination Folder dialog box.

    Enter a path to the folder in the Folder name field or select the folder from the Look in drop-down list and 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.
    Additional Components Destination Folder page in the Unity Scheduler Installation wizard.
  5. To change the installation location of additional components being installed with the Unity Scheduler (such as the Web Application Management Console), do one of the following:
    • Enter a new folder location.
    • Click Change and navigate to the folder location.
    Note:

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

  6. Click Next.
    The Default Service Instance Option page is displayed.
    Default Service Instance Option page in the Unity Scheduler Installation wizard.
  7. 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 16.
  8. In the Connection String field, enter a valid connection string for connecting 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 website (http://msdn.microsoft.com) under Working With Data Providers in the ADO.NET Entity Framework library. There is also a website devoted entirely to connection strings at http://www.connectionstrings.com.

    The following are sample connection strings for SQL and MSOracle.

    Note: Values in brackets must be replaced before being used as valid connection strings.
    Connection Type Sample String
    SQL Data Source=[DATABASE_SERVER];Database=[DATABASE_NAME]; User Id=[USERNAME];Password=[PASSWORD];Encrypt=[ENCRYPT_TYPE]
    MSOracle Data Source=[TNS_NAME];User Id=[USERNAME];Password=[PASSWORD]

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

    Sample Value Replacement
    [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:

    [DATABASE_NAME] 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:

    [TNS_NAME] is not the data source name of the database connection; it is the Oracle Service Name.

    [USERNAME] Replace this with the user name of a user configured with access to the database. Do not include the brackets ([ ]) in this value.
    [PASSWORD] Replace this with the password for the user configured to access the database. Do not include the brackets ([ ]) in this value.
    [ENCRYPT_TYPE] For SQL Server connection strings, replace this with the encryption type used by your connection string, either Mandatory or Optional. Do not include the brackets ([ ]) in this value.
  9. In the Database Name field, enter the actual name of the database server that is referenced in the connection string.
    This corresponds to the Data Source value in the connection string.
  10. 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.
  11. In the Service Instance Name field, enter the name for the default service instance of the Unity Scheduler.
  12. 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.
  13. If an institutional database is used, enter the Institutional ID in the Institution Id (optional) field.
  14. Click Next.
    The NT Service User Account page is displayed.
    NT Service User Account page in the Unity Scheduler Installation wizard.
  15. 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.
    3. In the Confirm Password field, enter the password again.
  16. Click Next.
    The Service Account page is displayed.
    Service Account page in the Unity Scheduler Installation wizard.
  17. In the User Name field, enter the user name of the service account that has been configured in OnBase.
  18. In the Password field, enter the password of the service account.
  19. In the Confirm Password field, enter the same password that was entered in the Password field.
  20. Click Next.

    If Create Default Service Instance on install was not selected, skip to step 23.

    If Create Default Service Instance on install was selected, the NT Service Options page is displayed.

    NT Service Options page in the Unity Scheduler Installation wizard.
  21. 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.
  22. Click Next.
    The Ready to install page is displayed.
    Ready to Install page in the Unity Scheduler Installation wizard.
  23. Click Install.
    After the installation is complete, the Completed dialog box is displayed.
  24. Select the Launch Web Application Management Console option and click Finish.
    The connection string configuration window of the Web Application Management Console is displayed.
  25. Proceed to Configuring the Connection String in the Web Application Management Console.