Configuring the appsettings.json File - Reporting Dashboards - Foundation 24.1 - Foundation 24.1 - Ready - OnBase - external

Reporting Dashboards

Platform
OnBase
Product
Reporting Dashboards
Release
Foundation 24.1
License

Once the Reporting Dashboards is installed, the appsettings.json file must be edited to properly connect the Reporting Dashboards to the API Server. The appsettings.json file is located in the config folder of the Reporting Dashboards installation location. By default, this location is ..Program Files\Hyland\ReportingDashboardsWebSuite\.

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 edit the appsettings.json file:

  1. Open appsettings.json using a text editor, such as Notepad.
  2. Locate the authConfig element in the hyShell element.
  3. Update the values of the following attributes:

    Attribute

    Description

    issuer

    The URL of the previously configured IdP server, including /idp.

    scope

    The scope of the IdP server, defined in the idpconfig.json file for that server. You must include both "openid" and "offline_access" in the scope. For example, at minimum, this value should be set to "open id offline_access".

    clientId

    The client ID defined in the idpconfig.json file for that server.

    idp-tenant

    The tenant defined in the idpconfig.json file for that server.

    redirectUri

    The URL to redirect authenticated users to. Set the value to the root URL to which the Reporting Dashboards is deployed and add /view/authentication-confirmation.

    Note:

    The value for redirectUri also needs to be set in the idpconfig.json file.

    postLogoutRedirectUri

    The URL to redirect unauthenticated and logged out users to. Set the value to the root URL to which the Reporting Dashboards is deployed and add /view/unauthenticated.

    Note:

    The value for postLogoutRedirectUri also needs to be set in the idpconfig.json file.

    apiServerUrl

    The UPRL of the API server, including the port.

    connectEndpoint

    The API Server endpoint that will be accessed to establish an OnBase session when using Reporting Dashboards Web Suite. For example: https://my.domain/ApiServer/onbase/reporting/authorize

    Note: Make sure the use of HTTP or HTTPS matches the configuration of your domain in IIS.

    apiEndpoints

    The URL of the API Server. For example: https://my.domain/ApiServer

  4. Save the changes to the appsettings.json file.
  5. Close the text editor.

After completing the editing of the appsettings.json file, you must perform an IIS reset for the changes to take effect.