Documentation Widget

Overview

Plugin key	BAS Setting key
`accelerator_documentation-widget-container`	`bas-plugin-widget-documentation`

This widget plugin displays documentation within the dashboard as an <iframe/>. It persists the URL of the page being browsed in the dashboard’s state.

Availability

Solution	Enabled
FRTB	✅
Market risk	✅
SIMM	✅
CVARC	✅
Limits	✅
Sign-off	✅

Settings

Key	Type	Description	Example
`documentationBaseURL`	`string`	URL of the documentation page to display

How to modify a setting

To modify a setting, you need to modify the basSettings that you provide to the activate function. The following example shows you how to provide the activate function with the default basSettings while updating the settings for the Documentation widget:

import { activate, basSettings } from "@activeviam/frtb-sdk";

const frtbServerKey = "FRTB";
const customSettings = structuredClone(basSettings);

customSettings[frtbServerKey][
  "bas-plugin-widget-documentation"
].documentationBaseURL = "https://custom/url/to/solution/documentation";

activate({
  configuration,
  basSettings: customSettings,
});

How to disable it

Disable universally

To disable this feature for all solutions, add this line at the end of your extension’s activate function to unregister the plugin:

const extension: ExtensionModule = {
  activate: async (configuration: Configuration) => {
    ...
+    delete configuration.pluginRegistry["widget"]["accelerator_documentation-widget-container"];
  }
}

Disable for specific servers

To disable this feature for a given server, you must delete this feature’s settings for that server key by altering the basSettings parameter before calling the activate function. Example Disabling this feature for the FRTB server only:

+ import {produce} from "immer";
- import {activate as activateFrtb} from "@activeviam/frtb-sdk";
+ import {activate as activateFrtb, basSettings as frtbBASSettings} from "@activeviam/frtb-sdk";
 import {activate as activeMarketRisk} from "@activeviam/mr-sdk";

 const extension: ExtensionModule = {
  activate: async (configuration: Configuration) => {
    ...
+    const frtbBASSettingsWithFeatureDisabled = produce(frtbBASSettings, draft => {
+      delete draft["FRTB"]["bas-plugin-widget-documentation"];
+    });

-   activateFrtb({configuration});
+   activateFrtb({configuration, basSetttings: frtbBASSettingsWithFeatureDisabled})
    activeMarketRisk({configuration});
  }
}

​Overview

​Availability

​Settings

​How to modify a setting

​How to disable it

​Disable universally

​Disable for specific servers