A new instance of the Unity Scheduler Service is created by using the /create command-line option with its associated parameters. This creates the Windows Service and makes all the changes necessary to grant access to the OnBase system specified by the command-line parameters.
To install a Unity Scheduler Service instance using the /create command line, you must first modify the Hyland.Core.Scheduler.NTService.exe.config file to include a valid connection string. For more information about configuring connection strings, see Connection Strings in Web.config. Once this connection string has been configured, all created service instances that reference the data source use that connection string. If Windows authentication is specified for the connection string, the current Windows User Account must have Windows authentication connection authority for the SQL Server when registering the Windows service.
Add the required parameters to the /create command line, as shown in the following example, where [path] represents the file path to Hyland.Core.Scheduler.NTService.exe:
"[path]\Hyland.Core.Scheduler.NTService.exe" /create -sn="service name" -obu="service account name" -obp="service account password" -obd="connection string name"
Add optional parameters to the /create command line with the other required parameters, as shown in the following example, where [path] represents the file path to Hyland.Core.Scheduler.NTService.exe:
"[path]\Hyland.Core.Scheduler.NTService.exe" /create -sn="service name" -obu="service account name" -obp="service account password" -obd="connection string name" -obg="task group name" -dn="display name" -desc="description" -u="Windows User Name" -p="Windows Password" -st="Start Type"
When creating an instance of the Unity Scheduler Service using the command line, you must configure the settings of the Service by using the parameters listed in the following table.
|
Parameter |
Description |
|---|---|
|
-sn |
This parameter defines the service name. Example: -sn="My Scheduler" Note:
The Unity Scheduler Service instance has _UnityScheduler affixed to the end of the service name. |
|
-obu |
This parameter specifies the name of the OnBase Service Account that executes Tasks. Example: -obu="Service Account" |
|
-obp |
This parameter defines the OnBase Service Account password. Example: -obp="Password" |
|
-obd |
This parameter specifies the name of the ADO.NET connection string configured as the data source. Example: -obd="Connection String Name" |
When creating an instance of the Unity Scheduler Service using the command line, if an optional parameter is not included, the default value is configured for that parameter, if available.
|
Parameter |
Description |
|---|---|
|
-obg |
This parameter defines the Task Group name. Note:
If not specified, the default value of this parameter is <Unassigned>. Example: -obg="Production" |
|
-dn |
This parameter specifies the Unity Scheduler Service display name. Note:
If not specified, the default value of this parameter is the same as the service name specified with the -sn parameter. Example: -dn="My Display Name" |
|
-desc |
This parameter defines the service description. Note:
If not specified, the default value of this parameter is Executes Unity Scheduler Tasks. Example: -desc="My Description" |
|
-u |
This parameter specifies the Windows User Account that the Unity Scheduler Service executes under. This account should have access to the OnBase Disk Groups. Note:
If not specified, the default value of this parameter is LocalSystem. Example: -u="MyDomain\MyAccount" |
|
-p |
This parameter defines the password associated with the Windows User Account under which the Unity Scheduler Service executes. Note:
This parameter is case sensitive. Example: -p="MyWindowsPassword" |
|
-spf |
This parameter defines the path to the Sensitive Parameters File. The Sensitive Parameters File is a simple text file which contains name and value entries, written as name, value. The name corresponds to a reference that can be used in the command line to substitute for sensitive data that exists in the Sensitive Parameters File. The value corresponds to the actual value used for service installation. For example, the Sensitive Parameters File could contain AdminPWRef, [AdminPassword] to allow command-line switches to reference an administrative password (using AdminPWRef) without actually using or displaying the password in the command line. To reference values within the Sensitive Parameters File, enter command-line option parameters with references placed between << and >> delimiters followed by the -spf parameter with its file path defined. In the following example, the OnBase Service Account user (-obu) and password (-obp) are defined using references to the user (UserReference) and password (PasswordReference) values contained in the SensitiveParameters.txt file: -obu="<<UserReference>>" -obp="<<PasswordReference>>" -spf="\\MyServer\MyShare\SensitiveParameters.txt" |
|
-st |
This parameter specifies the Unity Scheduler Service startup type.
Note:
If not specified, the default value of this parameter is m for manual startup. Example: -st="a" |
|
-cfl |
This parameter is used with the /create or /createdo command-line option. This parameter specifies an instance-specific configuration file (instead of the default, common configuration file) to be used by the Unity Scheduler Service. Example: -cfl="Site2.config" |
|
-dc |
This parameter is used with the /create or /createdo command-line option. This parameter defers creation of the database-based configuration data until the newly-created Service Instance is started for the first time. This parameter may be executed by a Windows user whose user account does not have the security privileges to access the OnBase database, such as a Windows Account with only Local Administrator privileges. |
To verify the service was successfully created, open the Microsoft Management Console and ensure the service is listed. Start the service when it is ready to be used.