Navigation :

Documentation Application Menu

Overview

Plugin key	BAS Setting key
`accelerator_navbar-help-documentation`	`bas-plugin-menu-item-solution-documentation`

This plugin adds an application sub-menu to the Help menu which links to the documentation page configured in its settings.

Availability

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

Settings

Key	Type	Description	Example
`docName`	`string`	The name to be used as the menu label
`docUrl`	`string`	URL of the documentation page to open

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:

+ import { applicationSubMenuHelp } from "@activeviam/activeui-sdk";

const extension: ExtensionModule = {
  activate: async (configuration: Configuration) => {
    ...
+    const helpSubMenu = configuration.rightApplicationMenu.find( menu => menu.key === applicationSubMenuHelp.key);
+    helpSubMenu.children = helpSubMenu.children.filter( child => child.key !== "accelerator_navbar-help-documentation");
  }
}

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-menu-item-solution-documentation"];
+    });

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