Specifying stamps and symbols locations - HxGN SDx - Update 63 - Administration & Configuration

Administration and Configuration of HxGN SDx

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

From the command line or using Server Manager, you must specify:

\viewerstampsurl:[Stamps Library URL] - identifies the fully-qualified URL to the 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

  • If you are upgrading from Update 36 36 and both \bravastampsurl and \viewerstampsurl are set, \viewerstampsurl takes precedence.

\viewersymbolsurl:[Symbols Library URL] - identifies the fully-qualified URL to the 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

  • If you are upgrading fromUpdate 36 and both \bravasymbolsurl and \viewersymbolsurl are set, \viewersymbolsurl takes precendence.

  • For help with setting these options using Server Manager or from the command line, see SDx Web Client Sites node or Server Manager commands.

  • You can edit the VIEWER_ACTIONPINS_URL property in the Web Client settings.json file to add custom action pin images to your environment. For help, see Configure the Web Client settings.json file.

  • If the VIEWER_SYMBOLS_URL, VIEWER_STAMPS_URL, or VIEWER_ACTIONPINS_URL setting is not present, HxGN SDx will use the default path for stamps and symbols. For example, if the URLs are not present in settings.json, the URL and file path will be defaulted to:

    URL: https://[localhost]/[SiteName]/viewers/resources/stamps/stamps.json

    JSON file: [drive]:\SDx Server Files\WebClient_Sites\[SiteName]\viewers\resources\stamps\stamps.json