Modifying Application Settings - Administration Portal - Foundation 24.1 - Foundation 24.1 - Ready - OnBase - Premier - external - Standard - Essential - Premier - Standard - Essential - OnBase/Administration-Portal/Foundation-24.1/Administration-Portal/Installation/Installing-the-Administration-Portal/Modifying-Application-Settings - 2024-03-25

Administration Portal
Platform
OnBase
Product
Administration Portal
Release
Foundation 24.1
License
Premier
Standard
Essential

After installing the OnBase Administration Portal, the appsettings.json file requires additional configuration before the OnBase Administration Portal is ready to use.

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 modify the Application Settings for an installation of the OnBase Administration Portal:

  1. Navigate to the folder where the OnBase Administration Portal is installed.
  2. Open the Config folder.
  3. Open appsettings.json in a plain-text editor, such as Notepad.
  4. In the <hyConfigMappings> node, update the fields with information from your IdP and API server endpoints.
    CAUTION:

    Do not include a "/" at the end of any path or URL value entered for the following settings.

    1. For issuer, enter the URL of the Hyland IdP server. Do not include the tenant in the URL. This value is case-sensitive.
    2. For scope, enter openid evolution.
    3. For clientId, enter the unique ID of the client on the Hyland IdP server. This value is case-sensitive and must match exactly the value on the Hyland IdP server.
    4. For idp-tenant, enter the name of the tenant on the Hyland IdP server. This value is case-sensitive.
    5. For redirectUri, enter "https://[ComputerName]/OBADMIN-PORTAL/view/authentication-confirmation", with https being http if secure logins have been disabled during installation and [ComputerName] replaced with the name of the computer where the Administration Portal is installed.
    6. For postLogoutRedirectUri, enter "https://[ComputerName]/OBADMIN-PORTAL/view/unauthenticated", with https being http if secure logins have been disabled during installation and [ComputerName] replaced with the name of the computer where the Administration Portal is installed.
    7. For silentRefreshRedirectUri, enter "https://[ComputerName]/OBADMIN-PORTAL/view/silent-refresh.html", with https being http if secure logins have been disabled during installation and [ComputerName] replaced with the name of the computer where the Administration Portal is installed.
    8. For requireHttps, if the Require SSL option was enabled during installation, enter true. If the Require SSL option was disabled during installation, enter false.
    9. For apiEndpoints, enter the endpoints of the API Server, separated by commas. For example, "https://[ComputerName]/apiserver/onbase/administration".
    10. For apiPath, enter the path to the API Server. For example, "https://[ComputerName]/apiserver/onbase/administration".
    11. For inactivityTimeout, if you would like to log a user out when they are not active, enter true. If you want to allow inactive users to remain logged in, enter false.
    12. If inactivityTimeout is set to true, for inactivityTimeoutInMinutes, enter the number of minutes that a user is allowed to remain inactive before they are logged out. A prompt appears 30 seconds before the user is logged out that allows the user to continue their session.
      If inactivityTimeout is set to false, skip this step.
  5. The sessionChecksEnabled setting controls whether a user is logged out of multiple instances when logging out of a single instance, such as when a user has multiple web browser tabs open and logs out of the OnBase Administration Portal in one tab. If you would like to have a user log out of all instances whenever they log out of any one instance, enter true. If you would like users to log out of individual instances separately, enter false.
    If sessionChecksEnabled is set to true, the following additional steps are required:
    1. Navigate to the folder where the OnBase Administration Portal is installed.
    2. Open the config folder.
    3. Open contentSecurityPolicy.json in a plain-text editor, such as Notepad.
    4. Under Frame, in the "Policies" list, enter the domain of where the IdP is hosted. For example, "https://my.domain"
    5. Save and close the contentSecurityPolicy.json file.
  6. Save and close the appsettings.json file.