Configuring the appsettings.json File - Combined Viewer - Foundation 24.1 - Foundation 24.1 - Ready - OnBase - external - OnBase/Combined-Viewer/Foundation-24.1/Combined-Viewer/Combined-Viewer-Installation/Combined-Viewer-Installation/Configuring-the-appsettings.json-File - 2024-03-25

Combined Viewer
Platform
OnBase
Product
Combined Viewer
Release
Foundation 24.1
License

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

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 hyConfigMappings element. In the Address attribute, enter the URL of your Hyland IdP server.
  3. Update the values of the following attributes in the authConfig element to match your environment. All values should be included in quotation marks.

    Attribute

    Description

    issuer

    The URL of the previously configured Hyland IdP server. Set the value to "[IDP_URL]". Replace [IDP_URL] with the URL of the IdP server.

    scope

    The scope for the IdP server. Set the value to "openid offline_access evolution".

    clientId

    The Client ID for the Combined Viewer. Set the value to match the appropriate tenant in the idpconfig.json file of the IdP server.

    idp-tenant

    The IdP tenant value. Set the value to match the appropriate tenant in the idpconfig.json file of the IdP server.

    redirectUri

    The URL to redirect authenticated users to. Set the value to the root URL to which the Combined Viewer 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 Combined Viewer is deployed and add /view/unauthenticated.

    Note:

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

    connectEndpoint

    The endpoint on your API server that the Combined Viewer will connect to. Set the value to "[API_SERVER_URL]/onbase/core/file-types/1". Replace [API_SERVER_URL] with the URL of your API server.

    apiEndpoints

    The endpoints for the APIs utilized by the Combined Viewer. Add the following endpoints:

    "[API SERVER INSTALL_URL]"

    Replace [API SERVER INSTALL_URL] with the full URL of your API server, including /ApiServer. Replace [SERVER URL] with the URL of your API Server without /ApiServer.
  4. Update the values of the following attributes in the appInfo element to match your environment. All values should be included in quotation marks.

    Attribute

    Description

    cv_api_url

    The URL of the Combined Viewer API. Set the value to "[API SERVER INSTALL_URL]/onbase/combined-viewer".

    Replace [API SERVER INSTALL_URL] with the URL of your API Server, including /ApiServer. For example, "https://server.domain.net/ApiServer/onbase/combined-viewer".

    dm_api_url

    The URL of the Document Management API. Set the value to "[API SERVER INSTALL_URL]/onbase/core".

    Replace [API SERVER INSTALL_URL] with the URL of your API Server, including /ApiServer. For example, "https://server.domain.net/ApiServer/onbase/core".

    graphql_api_url

    The URL of the GraphQL API. Set the value to "[API SERVER INSTALL_URL]/graphql".

    Replace [API SERVER INSTALL_URL] with the URL of the API Server, including /ApiServer. For example, "https://server.domain.net/ApirServer/graphql".

    document_action_count_limit

    The maximum number of documents that a user can download at one time. The default value for this attribute is 10.

    document_action_size_

    limit

    The threshold used to break up larger document files into smaller files. The default value for this attribute is 10000000, which is 10 megabytes.
  5. Save the changes to the appsettings.json file.
  6. 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.