Iris Portal - Configuration

Currently there is no interface to manage plugin configuration but eventually there will be. For now you'll just use JSON to manage plugin configuration. Sample JSON is provided below:

{
  "portalName": "Iris Portal",
  "pageTitle": "Iris Poral | Olympus-Grid",
  "bundleResource": "portal",
  "bundleNamespace": "olympus_grid",
  "maintenanceMode": false,
  "banner": false,
  "bannerText": "We are performing scheduled maintenance on 01/25/2024. We should be back online shortly after the maintenance.",
  "bannerColor": "#FFAB00",
  "textColor": "#000000",
  "bannerCanClose": true,
  "bannerTimeOn": "2025-01-20 11:58:00",
  "bannerTimeOff": "2025-01-22 11:58:00",
  "allowBundleDomain": true
}

You can change portal configuration by going to Setup -> Custom Metadata Types -> Manage Records (Olympus-Grid: Plugin) -> Iris Portal. Click Edit and modify the details in Configuration field. If you can't find it, make sure view filter on Manage Records is either set to All or Olympus-Grid: Forge Plugins. Since the JSON is not clearly formatted please make sure you modify it carefully to avoid corrupting the json.

Node: Please do not remove any attributes from the JSON.

portalName

It is used to define name of the portal that will appear in react application on multiple places like header, sidebar, footer etc.

Type: String Default: Iris Portal

pageTitle

Page title is application title that will appear in a Browser tab.

Type: String Default: Iris Poral | Olympus-Grid

bundleResource

Bundle resource refers to static resource name in which you deployed your react application.

Type: String Default: portal

bundleNamespace

Bundle namespace points to package name or namespace which your bundle resource is deployed on salesforce. Make sure it is correct namespace of static resource you've mentioned in bundle resource. You can leave it as empty string if there is no namespace.

Type: String Default: olympus_grid

maintenanceMode

Maintenance mode flag is used to control if site is in maintenance mode. You can change it to true if you ever need to put side into maintenance mode.

Type: Boolean Default: false

banner

Banner flag is used to turn on/off the banner depending on the other configuration. You can change its value to true but be mindful of other settings related to banner. You can use it to inform users of any upcoming features or scheduled maintenance.

Type: Boolean Default: false

bannerText

Banner text is the text that would show up when turn on the banner flag.

Type: String Default: false

bannerColor

Banner color is the background color of the banner. It supports all of the web color formats.

Type: String Default: #FFAB00

textColor

Text color is the color of text on the banner. Make sure you set it in contrast to banner color so that text is clearly visible on the banner.

Type: String Default: #000000

bannerCanClose

As its name suggests, you can use it to allow end user to close down the banner but in some cases you might not want user to close the banner.

Type: Boolean Default: true

bannerTimeOn

Banner time on attribute can be used to control when you want to show banner to user. It works regardless of the banner flag. Value has to be a valid date time when you want banner to show up.

Type: DateTime Default: 2025-01-20 11:58:00

bannerTimeOff

Banner time off attribute can be used to control when you want to hide banner to user. Value has to be a valid date time when you want banner to hide.

Type: DateTime Default: 2025-01-22 11:58:00

allowBundleDomain

It allows you to load resources from localhost domain purely for development purposes and have React's hot reloading working. It should be set to false in production. If allowed, pass bundleDomain=http://localhost:3000 as query parameter for live changes into react application. Here is how final url would look like. https://force-velocity-1541.scratch.my.site.com/portal?bundleDomain=http://localhost:3000

Type: Boolean Default: true