Use SPFServerManager.exe with the /updatewcsite argument to update a site.
The following optional arguments are available:
/sitebackuppath:[path] - copies the contents of the site to a .zip file that is saved to the specified path.
/instrumentationkey:[App Insights instrumentation key] - sets the instrumentation key setting for the Web Client site for use with the Application Insights performance monitoring tool. To reset this key to have no value, enter a value of NULL or leave it blank.
/bravastampsurl:[Brava Stamps URL] - identifies the fully-qualified URL to the Brava! stamps library (stamps.json). If your environment is hosted on a cloud, the URL must be external. If you are using Okta as your external OAuth authorization provider, the URL must be all lowercase.
-
The rootURL in the stamps.json file must point to the folder location of the stamps.json file. The stamps.json file is delivered to: [drive]:\SmartPlant Foundation Server Files\WebClient_Sites\[SiteName]\viewers\resources\stamps.
-
If your environment uses Chromium and the stamps.json file is not delivered by the application server, you must use IIS to add the following CORS attributes to the viewers resources folder:
-
Access-Control-Allow-Origin set to the fully-qualified URL for your application server
-
Access-Control-Allow-Credentials set to true
-
Access-Control-Allow-Headers set to x-requested-with
-
/bravasymbolsurl:[Brava Symbols URL] - identifies the fully-qualified URL to the Brava! symbols library (symbols.json). If your environment is hosted on a cloud, the URL must be external. If you are using Okta as your external OAuth authorization provider, the URL must be all lowercase.
-
The rootURL of the symbols.json file must point to the folder location of the symbols.json file. The symbols.json file is delivered to: [drive]:\SmartPlant Foundation Server Files\WebClient_Sites\[SiteName]\viewers\resources\symbols.
-
If your environment uses Chromium and the symbols.json file is not delivered by the application server, you must use IIS to add the following CORS attributes to the viewers resources folder:
-
Access-Control-Allow-Origin set to the fully-qualified URL for your application server
-
Access-Control-Allow-Credentials set to true
-
Access-Control-Allow-Headers set to x-requested-with
-
/odataurl:[OData URL] - sets the fully-qualified OData URL of the Smart API Services entry point for Web Client. For example: /odataurl:http://localhost/SPFserver/api/v2/SDA.
/tlp - sets the path to the trace configuration log file folder location (optional). Use to change the path to a new trace log folder location; if not set, the path defaults to server trace log folder set in the configuration file.
/downloadfilesizethreshold: - sets the download file size threshold limit (MB). Default value set to 200MB.
/downloadfiletimeout: – sets the download file timeout (minutes). Default value set to one minute.
/oauthissuerurl:[OAuth Issuer URL] - identifies the OAuth issuer URL.
/clientid:[Client ID] - identifies the OAuth client ID.
/identityprovider:[Identity Provider] - identifies the identity provider for OAuth.
/scopes:[Scopes] - identifies the OAuth scopes.
/oauthredirecturi:[OAuth Redirect URL] - sets the fully-qualified URL of the Web Client logon page. For example: /oauthredirecturl:http://localhost:4200/.
/oauthredirecturi2:[OAuth Redirect URI2] - sets the fully-qualified URL of the Web Client logon page. For example: /oauthredirecturi2:http://localhost:4200/.
/postoauthlogoutredirecturi:[OAuth Post Logout Redirect URL] - sets the fully-qualified URL to where users are redirected after logout. For example: /oauthlogoutredirecturi:http://localhost:4200/.
If the site uses a SAM server when the OAuth redirect options are being updated, you must provide the SAM administrator credentials as follows:
/samusername - Provides the SAM administrator user name.
/sampassword - Provides the SAM administrator password.
If the site using the Intergraph Authorization Server (STS) when the OAuth redirect options are being updated, the administrator credentials must be provided as follows:
/stsusername - Provides the STS administrator user name.
/stspassword - Provides the STS administrator user name.
This example updates a site named SPFClient.
SPFServermanager.exe /updatewcsite /sn:SPFClient
This example uses the /log: argument to generate a log file that stores results and errors from the operation.
Specify a path and file name for the target log file (an extension is not required
for the filename).
SPFServermanager.exe /updatewcsite /sn:SPFClient /log:"C:\SmartPlant Foundation Server Files\Temp\ServerManager\SPFClientupdate"
When a Web Client site is updated, the existing Stamps and Symbols folders will not
be be overwritten. For example, \WebClient_Sites\[Site]\viewers\resources\symbols\ and \WebClient_Sites\[Site]\viewers\resources\stamps\ will not be overwritten with any content from the installation
folder, such as \SPF\SPFClient\viewers\resources\. Also, any existing .ttf or slug font files, folders, or
other files in the fonts directory folders will not be overwritten if the content
does not exist in the installation folder.
This example updates a site if the site is using Smart API Manager for authorization:
SPFServermanager.exe /updatewcsite /sn:SPFWC /oauthredirecturi:http://localhost/4200/ /postoauthlogoutredirecturi:http://localhost/4200/ /samusername:admin /sampassword:1
This example updates a site if it is using the retired Intergraph Authorization Server (STS):
SPFServermanager.exe /updatewcsite /sn:SPFWC /oauthredirecturi:http://localhost/4200/ /postoauthlogoutredirecturi:http://localhost/4200/ /stsusername:admin /stspassword:1
This example updates a Web Client site and sets download file size threshold to 300MB and download file timeout to 10 mins.
SPFServermanager.exe /updatewcsite /sn:SPFClient /downloadfilesizethreshold:300 /downloadfiletimeout:10
This example updates a Web Client site with an upload file chunk size in mb setting of 3.
SPFServerManager.exe /updatewcsite /sn:SDXWC /filechunksizeinmb:3
This example updates a Web Client site with a peek search setting of 3.
SPFServerManager.exe /updatewcsite /sn:SDXWC /peeksearchcharacterscount:3