/createconnect Command-Line Option - Unity Scheduler - Foundation 24.1 - Foundation 24.1 - Ready - OnBase - Premier - external - Standard - Essential - Premier - Standard - Essential

Unity Scheduler

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

As of OnBase 18, the Unity Scheduler Service connects to the database using an ADO.NET connection string. You can update an existing Unity Scheduler Service instance with a connection string by using the /createconnect command line with its associated parameters. The command prompt must be run under Administrative privileges.

You can create a connection string in two ways using the /createconnect command-line option:

  • Enter the entire connection string using the -cs parameter.

  • Enter the individual components of the connection string using the -csds, -csdb, -csu, and -csp parameters.

If you are using the -cs parameter, parameters are added to the /createconnect command line, as shown here:

"[path]\Hyland.Core.Scheduler.NTService.exe" /createconnect -obd="data source name" -pt="provider type" -cs="Data Source=data base name; User Id=user name; Password=password"

If you are using the -csds, -csdb, -csu, and -csp parameters, parameters are added to the /createconnect command line, as shown here:

"[path]\Hyland.Core.Scheduler.NTService.exe" /createconnect -obd="data source name" -pt="provider type" -csds="server\instance" -csdb="database name" -csu="user ID" -csp="password"

When creating connections for 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. If an optional parameter is not included, the default value is configured for that parameter, if available.

Parameter

Description

-obd

Name of the ADO.NET connection string configured as the data source.

Note:

This parameter is required.

Example: -obd="data source name"

-pt

The provider type of the connection string.

Note:

This parameter is required.

The following values are possible:

  • sqlserver- Creates a SQL Server connection string.

  • oracle- Creates an Oracle connection string.

Example: -pt="sqlserver"

-cs

The complete connection string. The exact configuration of this connection string will depend on the provider type.

Note:

If you are specifying a complete connection string, this parameter is required.

SQL Server connection string example: -cs="Data Source=server\instance; database="data base name" User Id=user name; Password=password"

Oracle connection string example: -cs="Data Source=database name; User Id=user name; Password=password"

-csds

Name of the ADO.NET connection string configured as the data source.

Note:

If this is used with a SQL Server connection string, this parameter is required. If this is used with an Oracle connection string, this parameter is optional, and if it is not specified the value is set to the value of the -odb parameter.

SQL Server connection string example: -csds="server\instance"

Oracle connection string example: -csds="data source name"

-csdb

Name of the database.

Note:

This parameter is only used with SQL Server connection strings. If this parameter is not specified, the value is set to the value of the -odb parameter.

Example: -csdb="database name"

-csu

The user with rights to connect to the database.

Note:

When used with Oracle connection strings, this parameter is required. If used with SQL Server connection strings, this parameter must be accompanied by the -csp parameter. If this parameter is omitted from SQL Server connection strings, the connection string will use the current Windows account to connect.

Example: -csu="user ID"

-csp

The password for the user that will connect to the database.

Note:

When used with Oracle connection strings, this parameter is required. If used with SQL Server connection strings, this parameter must be accompanied by the -csu parameter. If this parameter is omitted from SQL Server connection strings, the connection string will use the current Windows account to connect.

Example: -csp="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 database user (-csu) and password (-csp) are defined using references to the user (UserReference) and password (PasswordReference) values contained in the "SensitiveParameters.txt" file: -csu="<<UserReference>>" -csp="<<PasswordReference>>" -spf="\\MyServer\MyShare\SensitiveParameters.txt"