Overview

UI Components refer to features that are used on multiple Atoti business solutions.

You have the option to disable these features via the configuration object’s plugin registry, the procedure is detailed for each feature on the Features Page.

Settings

Most features require some configuration in the form of settings that need to be specified for each applicable server on which the feature is expected to work. When using or combining solutions using the default settings with their default server keys, no changes are required. If you are using different server keys or want to alter settings, you can do so via each solution’s activate function by overriding the basSettings parameter.

For more details on activating and configuring solutions, see the Configuring the UI documentation in each solution. Here’s the example for Atoti FRTB.

Features at a glance

For details of what the UI Components have to offer, see the Features section.

Solution and Module activation

Each Atoti Business Solution comes with an activate function built to work seamlessly with the standard Atoti UI App. These activate functions accept the configuration object from the Atoti UI App, and mutate it to include all of the features from that specific solution.

In addition to this, you have the option to use the activateIfServerIsAvailable helper function (available in versions 5.2.1 and above) in conjunction with the activate function. This optional helper function will first attempt to ping the associated server before activating the solution. It can also run additional code in case the server is unreachable, using the onServerNotReached optional callback.

Additionally, you can provide your own call to action message to be displayed using the optional callToActionMessage property on activateIfServerIsAvailable. In particular, if you implement a specific response to the server being unavailable, the steps a user need or need not take will be different from the default call to action.

Below is an example of how to use activateIfServerIsAvailable alongside the activate function of the frtb-sdk package:

import {
  Configuration,
  ExtensionModule,
} from "@activeviam/atoti-ui-sdk";
import { activate } from "@activeviam/frtb-sdk";
import { activateIfServerIsAvailable } from "@activeviam/activation";

const extension: ExtensionModule = {
  activate: async (configuration: Configuration) => {
    await activateIfServerIsAvailable({
      configuration,
      activateFn: () => {
        activate({
          configuration,
        });
      },
      serverKey: "FRTB",
      onServerNotReached: () => {
        //If the server at serverKey "FRTB" is not available, this function will run.
      },
      callToActionMessage:
        "Custom error notification text to be displayed if the server is unavailable.",
    });
  }
}