Update a Web Client site from the command line - HxGN SDx - Update 60 - Administration & Configuration

HxGN SDx Server Manager Help

Language
English
Product
HxGN SDx
Search by Category
Administration & Configuration
SmartPlant Foundation / SDx Version
10

Use SDxServerManager.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.

/inactivityTimeout: - sets the period of time, in minutes, before the application on the server times out due to inactivity. The default is set to 10 minutes.

/defaultPageSize: - specifies the number of objects returned in one page of a paged query. This can be set between 1 and 1000. The default is set to 25.

/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]:\SDx 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]:\SDx 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

/domainurl:[Domain URL] - sets the network domain URL for the Web Client site. For example, /domainurl:"https://serverhost" or /domainurl:https://SWI-PPM-TEST.ingrnet.com.

/serviceNamel:[Service Name] - sets the name of the client services server for the Web Client. For example, /serviceName:"appserver" or /serviceName:"SDXDEVServer".

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

/filechunksizeinmb: - sets the file chunk size in MB when uploading files in batches to the server. The default size is 1MB.

/enablecontextpanel: – enables the Context Panel dashboards configured in the Web Client to be displayed in the results grid. The default is True.

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

/oauthacrvalues:[OAuth ACR Values] - Defines a specific set of assurance level requirements that the protected resource requires from the authentication event associated with access and ID tokens. Setting this value overrides the default value set in the /identityprovider. For more information, see Advanced authentication support for Okta and third-party OAuth providers.

/oauthextraproperties:[OAuth Extra Properties] - Indicates the extra properties that can be used for user authentication and added to the authorization request. Setting these properties overrides any previous properties. You can add multiple property values separated with a comma. For example, prop1=value1,prop2=value2,prop3=value3.

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

/domainuser:[User] - identifies the user name of the domain user to set the application pool identity.

/domainpassword:[Password] - identifies the domain user password for setting the application pool identity.

/domain:[Domain] - identifies the network domain name of the user to set the application pool identity.

/peeksearchcharacterscount: - Sets the number of characters that must be typed before a peek search is invoked to avoid unnecessary peek search requests. The default peek search value is set at 3. The minimum value is 3 and the maximum is 9.

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

SDxServermanager.exe /updatewcsite /sn:SDxClient

SHARED Tip 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).

SDxServermanager.exe /updatewcsite /sn:SDxClient /log:"C:\SDx Server Files\Temp\ServerManager\SDxClientupdate"

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 \SDx\SDxClient\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:

SDxServermanager.exe /updatewcsite /sn:SDxWC /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):

SDxServermanager.exe /updatewcsite /sn:SDxWC /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.

SDxServermanager.exe /updatewcsite /sn:SDxClient /downloadfilesizethreshold:300 /downloadfiletimeout:10

This example updates a Web Client site with an upload file chunk size in mb setting of 3.

SDxServerManager.exe /updatewcsite /sn:SDXWC /filechunksizeinmb:3

This example updates a Web Client site with a peek search setting of 3.

SDxServerManager.exe /updatewcsite /sn:SDXWC /peeksearchcharacterscount:3

This example updates a Web Client site with the /oauthacrvalues and /oauthextraproperties arguments.

SDxServerManager.exe /updatewcsite /sn:SSDXDEVWC /oauthacrvalues:acr value /oauthextraproperties:prop1=value1,prop2=value2,prop3=value3