Modifying the JSON Configuration File - Upgrade Guidelines - Foundation 23.1 - Foundation 23.1 - Ready - OnBase - Essential - Premier - Standard - external - Standard - Essential - Premier

Upgrade Guidelines

Platform
OnBase
Product
Upgrade Guidelines
Release
Foundation 23.1
License
Standard
Essential
Premier

Prior to running Foundation DBUtils, you can configure database connection information by editing the corresponding appsettings.json file. By default, this file is stored in the same directory as the application. You can also create a custom JSON configuration file.

Note the following:

  • In order for the options in a custom JSON configuration file to be respected, you must apply the --configoverride switch when running the Foundation DBUtils application. See Command Line Switches for Foundation DBUtils for more information.

  • Any options specified in a custom JSON configuration file override the corresponding option specifications in the default appsettings.json configuration file.

  • Any options specified by applying command line switches override the corresponding option specifications in any default or custom JSON configuration files. See Command Line Switches for Foundation DBUtils for more information.

CAUTION: Be very careful when updating the JSON configuration files. If a copy exists with a similar naming scheme (for example, appsettings.backup.json), and that copy is not deleted, the incorrect JSON configuration file may be used. Configuration files are read in lexicographic order, or the order in which they are loaded. This means that the last file saved is the first file loaded. The order of precedence for the loading of the configuration sources is: 1) appsettings.json file, 2) appsettings.{AltName}.json file, 3) Key-per-file directories, 4) Environment variables, and 5) Command Line arguments. As a result, if a JSON configuration file is configured with an alternate name, and is the most recently saved version of the JSON configuration file, the file with the alternate name will take precedence, which causes major errors during login.

To connect the Foundation DBUtils application to your database, configure the following settings in the appsettings.json file, or add these settings to a custom JSON configuration file:

Settings

Description

datasource

A unique name, defined by the user, to identify the connection string used to connect to the database.

Note the following.

  • This identifying name may be different from the name of the actual database.

  • If this setting is not specified in the default appsettings.json file, you must specify it in an alternative JSON file or using a command line switch.

ConnectionStrings | [DataSourceName] | ConnectionString

The connection string used to connect to the database.

Note the following:

  • When specifying a SQL Server and instance in a Foundation DBUtils JSON configuration file, you must include two backslashes \\ between the server and instance.

  • If this setting is not specified in the default appsettings.json file, it must be specified in an alternative JSON file or using a command line switch.

ConnectionStrings | [DataSourceName] | providerName

The data provider type used for the database. Only SQL Server and Oracle data providers can be used to connect to the OnBase database. Use one of the following:

  • For a SQL Server database:

    "System.Data.SqlClient"

  • For an Oracle database:

    "Oracle.ManagedDataAccess.Client"

Note:

If this setting is not specified in the default appsettings.json file, you must specify it in an alternative JSON file or using a command line switch.