Edit the Web Client configuration (modified in an update) - SmartPlant Foundation - SmartPlant Foundation 2020 - Help - Hexagon

SmartPlant Foundation and Web Client Modified and Retired Functionality

Language
English
Product
SmartPlant Foundation
Search by Category
Help
SmartPlant Foundation / SDx Version
10
SmartPlant Markup Plus Version
10.0 (2019)

The following applies if you use a version of the software before Update 50. From Update 50, the Web Client settings.js file has been renamed to settings.json file. For the latest information, see Edit the Web Client configuration.

  1. Navigate to the Web Client virtual directory and open the settings.js file. For example:

    C:\SDx Server Files\SDxWebClient_Sites\WebClientSite\settings.js

  2. Edit the following values in the authorization section:

Name

Description

clientId

The client ID value generated by Smart API Manager when registering the Smart Client.

redirectUri

The fully qualified URL of the Web Client web application. For example:

https://[LocalHost].[DomainServer]/SDxWebClient/

identityProvider

The identity provider value in Smart API Manager to be used by the web application.

Options include:

  • External identity providers already available in SAM such as IWA and SiteMinder

  • Local identity provider for spf

postLogoutRedirectUri

The fully qualified URL of the Web Client web application. For example:

https://[LocalHost].[DomainServer]/SDxWebClient/

Scopes

""

usePKCE

True

dummyClientSecret

The client secret value generated by Smart API Manager when registering the Smart Client.

You must ensure the Redirect URIs are entered exactly as shown, including trailing forward slashes.

The following is an example of a settings.js file:

var Settings = {

"authorization": {

"clientId": "SDx01A75-F501-44FA-B1E9-902210",

"redirectUri": "https://[SDxWebClientHostMachine].[domain.com]/SDxWebClient/"},

"identityProvider": "F53ECC91-08DB-4B4A-8C40-99C6B4D010DD",

"postLogoutRedirectUri": "https://[SDxWebClientHostMachine].[domain.com]/SDxWebClient/"},

"scopes": "",

"usePKCE": "true",

"dummyClientSecret": "qZVhdY!LZXO%sg*D%@NXJ.O;s(fhmE%@0y^V-P+Y!5S)gFty7F!rytaH!mUC}qxo"

},

You can use the Logout Redirect URL setting in Server Manager to provide a separate redirection path after logout to avoid OAuth authentication loops. For more information, see Post logout redirect authentication loop.

SHARED Tip You can also edit the settings.json file using the Server Manager command line. The following example demonstrates how to configure the settings shown above:

SDxServerManager.exe /updatesdasite sn:SDxClient /oauthissuerurl: https://[SAMHostMachine].[domain].com/spf/sam/oauth /clientid: SDx01A75-F501-44FA-B1E9-902210 /oauthredirecturi: https://[SDxWebClientHostMachine].[domain.com]/SDxWebClient/ /postoauthRedirecturi:https://[SDxWebClientHostMachine].[domain.com]/SDxWebClient/scopes:”” /identityprovider:"F53ECC91-08DB-4B4A-8C40-99C6B4D010DD"