Configuring the WorkView Client - WorkView - English - Foundation 22.1 - OnBase - Premier - external - Premier

WorkView Client
Platform
OnBase
Product
WorkView
Release
Foundation 22.1
License
Premier

Once installed, the WorkView Client needs to be configured to work with your specific installation. To configure the WorkView Client:

  1. Locate the appsettings.json file for the WorkView Client. In a default installation, it is located in the following directory: C:\Program Files\Hyland\wvclient\config
    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.
  2. Open the appsettings.json file. Edit the file to reflect the following values for the settings within the file:

    Setting

    Value

    issuer

    This is the path to the IdP. The following is an example where my.domain is replaced with your domain and identityprovider is replaced with the location of your IdP installation:

    "issuer": "https://my.domain/identityprovider",

    clientId

    This value must match the Client Id assigned to the client connect configured in the IdP Admin interface. The following is an example:

    "clientId": "aa299ea8-ab16-4a10-967f-957c54831ea8",

    idp-tenant

    This must match the tenant configured in the IdP installation you are using for WorkView Client.

    redirectUri

    This must point to the authentication confirmation location for your WorkView Client installation. The following is an example where my.domain is replaced with your domain:

    "redirectUri": "https://my.domain/WVCLIENT/view/authentication-confirmation",

    postLogoutRedirectUri

    This must point to the unauthenticated location for your WorkView Client installation. The following is an example where my.domain is replaced with your domain:

    "postLogoutRedirectUri": "https://my.domain/WVCLIENT",

    apiEndpoints

    This must include the API endpoints for the API Server you are using for your WorkView Client installation and the WorkView Client API. The following is an example where my.domain is replaced with your domain and wvclientapi is replaced with location of your WorkView Client API installation:

    "apiEndpoints": ["https://my.domain/wvclientapi","https://my.domain/ApiServer"],

    connectEndpoint

    This must point to the application's endpoint of the WorkView Client API. The following is an example where my.domain is replaced with your domain and wvclientapi is replaced with location of your WorkView Client API installation:

    "connectEndpoint": "https://my.domain/wvclientapi/applications"

    obApiServer

    This must point to the API Server that is being used by your WorkView Client installation. The following is an example where my.domain is replaced with your domain and ApiServer is replaced with location of your API Server installation:

    "obApiServer": "https://my.domain/ApiServer/onbase/workview",

    inactivityTimeout

    Set this to true.

    wvClientApi

    This must point to the WorkView Client API installation. The following is an example where my.domain is replaced with your domain and wvclientapi is replaced with location of your WorkView Client API installation:

    "wvClientApi": "https://my.domain/wvclientapi",

    appNet

    This must point to your Web Server location. The following is an example where my.domain is replaced with your domain and appnet is replaced with the application name of your OnBase Web Server:

    "appNet": "https://my.domain/appnet/"

    useSilentRefresh

    Set this to true.

    silentRefreshRedirectUri

    Set the location of silent refresh for the installation. The following is an example where my.domain is replaced with your domain:

    https://my.domain/WVCLIENT/silent-refresh.html