/delete Command-Line Option - Unity Scheduler - Foundation 24.1 - Foundation 24.1 - Ready - OnBase - Premier - external - Standard - Essential - Premier - Standard - Essential - OnBase/Unity-Scheduler/Foundation-24.1/Unity-Scheduler/Installation/Installation/Installing-the-Unity-Scheduler-Service/delete-Command-Line-Option - 2024-09-03

Unity Scheduler

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

An existing instance of the Unity Scheduler Service can be deleted by using the /delete command-line option with its associated parameters. This will delete the Windows Service and disable the instance of the Unity Scheduler Service in the OnBase system specified.

Parameters are added to the /delete command line, as shown here:

"[path]\Hyland.Core.Scheduler.NTService.exe" /delete -sn="service name" -obu="service account name" -obp="service account password"

When deleting a 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

Service name.

Note:

This parameter is required.

Example: -sn="My Scheduler"

Note:

The Unity Scheduler Service instance will have _UnityScheduler affixed to the end of the service name.

-obu

Name of the OnBase Service Account that will execute Tasks.

Note:

This parameter is required.

Example: -obu="Service Account"

-obp

OnBase Service Account password.

Note:

This parameter is required and is case sensitive.

Example: -obp="Password"

-spf

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 paramters 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"

Tip:

To verify the service was successfully deleted, open the Microsoft Management Console and ensure the service is not listed.