UI Activation

Each UI project is designed as an extension of the Atoti UI “host application”. This section explains how you can easily combine these extensions into a running Atoti Limits application.

Activating Atoti Limits

1. Download and set up the latest version of the Atoti UI starter application.

2. To activate Atoti Limits, make the following changes:

   In package.json:

   "dependencies": {
   +   "@activeviam/limits-sdk": 3.1.0,
   +   "@tanstack/react-query": ^5.8.1,
    ...
     }
   

   In index.tsx, import and use the activate function, including the Cube-specific and Atoti Limits module settings:

   + import { activate } from "@activeviam/limits-sdk";
   
   const extension: ExtensionModule = {
     activate: async (configuration) => {
       ...
   +   activate({
   +     configuration,
   +     moduleSettings: {
   +      // add module settings here.
   +     },
        });
     }
   }
   

   In env.development.js and env.production.js, ensure the following exist:

   • A server used as the Content Server
   • An Atoti Limits server with the key “LIMITS”
   • All other application servers with their respective keys

   Here is an example of the Atoti Limits module being configured with a Market Risk application server:

   window.env = {
     contentServerVersion: "6.0.0",
     contentServerUrl: "http://localhost:10010/mr-application",
     activePivotServers: {
       MR: {
         url: "http://localhost:10010/mr-application",
         version: "6.0.0",
       },
       LIMITS: {
         url: "http://localhost:3090",
         version: "5.10.x",
       },
     },
   };
   

3. Build and run the starter, now with the Atoti Limits features enabled.

Configuring Atoti Limits

The example above activates Atoti Limits with a default configuration and default settings. Here’s how to modify them.

Change the configuration

The configuration parameter is the entry-point to configuring the Atoti UI “host application”. It is supplied to the activate function that modifies it to add the Atoti Limits features. If you want to make changes like adding or removing a plugin, changing the application’s title or adding an HOC, you can modify the configuration object after invoking activate.

For example:

const extension: ExtensionModule = {
  activate: async (configuration) => {
    // default application name
    configuration.applicationName = "AtotiUI";
     ...
    // changes the application name to Atoti Limits
    activate({
       configuration,
       moduleSettings: {
        // module settings go here
       },
    });
    // Customized application name
    configuration.applicationName = "My Atoti Limits";
  },
};

Change the settings

In addition to the required moduleSettings, the activate function accepts an optional settings and basSettings argument to let you configure the Atoti Limits features and the BAS features respectively. You can use the default values exported from the SDK as an override basis:

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

const extension: ExtensionModule = {
  activate: async (configuration) => {
    ...
    activate({
      configuration,
      moduleSettings: {
        // module settings go here
      },
      settings: {
        ...settings,
        ...{
          // customize here
        }
      },
      basSettings: {
        ...basSettings,
        ...{
          // customize here
        }
      }
    });
  },
};

For more information:

• Atoti Limits settings, see UI settings.
• BAS settings, see UI Components.

Combining Atoti Limits with other solutions or modules

To combine multiple solutions and modules, simply repeat the steps in the combined SDK’s “Activating” section.

Example:

import { activate as limitsActivate } from "@activeviam/limits-sdk";
import { activate as frtbActivate } from "@activeviam/frtb-sdk";

const extension: ExtensionModule = {
  activate: async (configuration) => {
    ...
    limitsActivate(
      configuration,
      moduleSettings: {
        // module settings go here
      }
    );
    frtbActivate({ configuration });
  },
};