Modifying the JSON Configuration File - Database Reference Guide - Foundation 23.1 - Foundation 23.1 - Ready - OnBase - external

Database Reference Guide
Platform
OnBase
Product
Database Reference Guide
Release
Foundation 23.1
License

Prior to running Foundation DBUtils, you can configure the database creation and upgrade processes 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 --configoverride 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 Running Foundation DBUtils from the Command Line for more information.

You can configure the following settings in the appsettings.json file, or you can 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.

TableSpaceOption

This setting configures the tablespace creation process. Tablespaces can be created using one of the following options:

  • default

  • custom

    Note:

    If the custom option is specified, you must specify the initial size, growth increment, and full path of each DBSpace in either a JSON configuration file or using command line switches.

  • single

Note:

The default and custom options are not supported with Azure SQL Database. When using Azure SQL Database, you must use the single option.

If no option is specified, the default option is used.

For more information on tablespace options, see Tablespace Options.

TableSpaceOptions | Custom | Definitions | dbspace# | size

The initial size (in MB) of the corresponding DBSpace.

TableSpaceOptions | Custom | Definitions | dbspace# | growth

The growth increment (in MB) of the corresponding DBSpace.

TableSpaceOptions | Custom | Definitions | dbspace# | path

The full path to the corresponding DBSpace.

Note:

When specifying a path in a Foundation DBUtils JSON configuration file, you must include two backslashes \\ between subdirectories and at the end of the path.

UserInfo | hsipassword

The password for the hsi user.

Note the following:

  • This setting must be specified when creating an OnBase 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.

  • If this value is not the default hsi password, you are prompted to update the hsi password in OnBase when you first log on to the OnBase Configuration Module. For more information, see the section on changing database user name passwords in the System Administration module reference guide.

UserInfo | viewerpassword

The password for the viewer user.

Note:

This setting must be specified when creating an OnBase 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. For more information on the components of the ConnectionString setting, see Connection String Parameters.

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.