Updating the Hyland API Server - Hyland Integration for Encompass - 22.1 - 22.1 - Ready - Other - external

Hyland Integration for Encompass
Platform
Other
Product
Hyland Integration for Encompass
Release
22.1
License

The API Server contains 5_encompass.json configuration file which has several settings related to the Integration for Encompass.

To update the Hyland API Server complete thefollowing steps:

  1. Using Windows Explorer, browse to the API Server installation directory, and edit the 5_encompass.json configuration file in a plain-text editor. In a default installation, this directory is located at C:\Program Files\Hyland\ApiServer\config.
    Note:

    In Windows, the JSON file must be opened with administrative privileges.

  2. Configure the following variables and then save the configuration file:

    Variable

    Description
    Host:AllowedOrigins

    Enter a list of domains allowed to make web service requests. Use commas to separate multiple origins. For example:

    "AllowedOrigins": ["https:/domain-a.com","https:/domain-b.com"]

    In most installations, this field can be left blank.
    IDP:Scope:Name  
    TempFileStorage:Address

    Located under the TempFileStorage element.

    Input the URL to the Hyland API Server.

    e.g. https://myserver.domain.com/apiserver/tempfs
    TempFileStroage:PrimaryNamespace

    Enter a top level folder name to be created within the configured Temp File Service directory
    TempFileStorage:SecondaryNamespace:

    Enter a second level folder name to be created within the configured Temp File Service directory.
    TempFileService:Loc alTempFilePath Enter the directory and filename (without extension) that should be used for the processing lock file.
    Note: : It is recommended to place this file on the same share as the path configured for the Network Staging Location for Off-Ramp workflow actions.
    HISConfiguration:HISServiceAddress Enter the URL to the API Server’s Hyland Integration Services endpoint.

    e.g. https://myserver.domain.com/apiserver/onbase/his
    HISConfiguration:OnRampID Enter the ID of the Encompass Integration On-Ramp.

    This value can be found in OnBase Studio. Select the Integration Services tab, expand HIS On-Ramp, and select Encompass Integration. The On-Ramp ID is available in the Properties window.
    HISConfiguration:OnBaseCoreSessionDisconnect Enter the URL to the Hyland API Server’s session disconnect endpoint.

    e.g. https://myserver.domain.com/apiserver/onbase/core/session/disconnect
    AccessCredential:ClientId Enter the Client ID from the Hyland Identity Provider for the Encompass Token Exchange client
    AccessCredential:Cl ientSecret

    Enter the plain-text client secret used for the Encompass Token Exchange client.

    Note: This secret can be encrypted using SOME UTILITY. See section ???? for information on encrypting the client secret in the 5_encompass.json file.
    AccessCredential:GrantType urn:ietf:params:oauth:grant-type:token-exchange
    AccessCredential:Sc ope onbaseapi evolution
    AccessCredential:SubjectTokenType urn:ietf:params:oauth:token-type:access_token
    AccessCredential:Id pServiceUrl

    The connect endpoint for the Hyland Identify Provider.

    e.g. https://myserver.domain.com/identityprovider/connect/token
    EncompassEndpoints

    This configuration value is similar to the comprehensive list of various Encompass APIs that SHIM API uses to establish a connection with Encompass. These endpoints play a crucial role to enable communication between the Encompass Integration and the Encompass server.

    Note: These endpoints are hardcoded for versions 22.1 and 23.l of Encompass Integration.
  3. Save and close the 5_encompass.json configuration file.
  4. Perform an IISRESET for all configuration changes to take effect.