Edit the SmartPlant Foundation Web Client configuration (retired) - HxGN SDx - HxGN SDx - Reference - Hexagon

This functionality was removed in Update 23. From Update 23, Smart API Manager is the default authorization server provided with HxGN SDx. The following applies if you are editing the SmartPlant Foundation Web Client configuration using a version of the software before Update 23.

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

   C:\SmartPlant Foundation Server Files\SPFWebClient_Sites\[WebClientSite]\settings.js

2. Edit the following values in the authorization section:

   Name	Description
   URL	The URL location of Smart API Manager. For example: https://[SAMHostServer].[Domain]/SAM/oauth
   clientID	The client ID value generated by Smart API Manager when registering the Smart Client.
   redirectUri	The fully qualified URL of the SmartPlant Foundation Web Client web application. For example: https://[LocalHost].[DomainServer]/SPFWebClient/
   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 SmartPlant Foundation Web Client web application. For example: https://[LocalHost].[DomainServer]/SPFWebClient/
   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": {

"url": "https://[SAMHostMachine].[domain].com/spf/sam/oauth",

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

"redirectUri": "https://[SPFWebClientHostMachine].[domain.com]/SPFWebClient/"},

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

"postLogoutRedirectUri": "https://[SPFWebClientHostMachine].[domain.com]/SPFWebClient/"},

"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.

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

SPFServerManager.exe /updatesdasite sn:SPFClient /oauthissuerurl: https://[SAMHostMachine].[domain].com/spf/sam/oauth /clientid: SPF01A75-F501-44FA-B1E9-902210 /oauthredirecturi: https://[SPFWebClientHostMachine].[domain.com]/SPFWebClient/ /postoauthRedirecturi:https://[SPFWebClientHostMachine].[domain.com]/SPFWebClient/scopes:”” /identityprovider:"F53ECC91-08DB-4B4A-8C40-99C6B4D010DD"