Configuring the Limits Module

This section explains how to configure properties files, data files, and ActiveViam components.

Project configuration

Properties files

Location: limits-starter/src/main/resources

ActiveUI

Location: In the delivered source file code for the UI, limits-UI/src

You will need to specify in the ActiveUI configuration file where the ActivePivot project is running.

Note, the end-user’s browser will be connecting to the URL you specify here, so you should specify the exact host name as opposed to localhost.

The standalone application contains a limits_env.js file which will need to be updated with the correct server URL:

# The URL to use to connect to ActivePivot
activePivotServerUrl: 'http://localhost:3090',

Configuring the LimitsSettings.ts file

The Limits Settings file contains both necessary and optional settings which will be used to customize and configure your Limits UI. At the moment, the Limits module has only one custom widget. Therefore, to use it properly, you will need to customize the unique settings specific to the Limits Inventory Widget. These can be found in the table below, and should be set within the “limits_inventory-widget.server.params” as shown below.

"accelerator_story-telling-action.whitelist": ["LIMITS", "FRTB"], // This is how you turn on storytelling.

  "limits_inventory-widget.server.params": { //These are where you place your settings to configure the Limits Inventory Widget.
    settingName: settingValue // All possible settings can be found in the table below!
    ...
  },

{
  green: string[],
  blue: string[],
  red: string[]
}

{
  green: [“INITIATED”],
  blue: [“APPROVED”],
  red: [“REJECTED”]
}

{
  workflow1: {
    name: string,
    participants: string[ ]
  }
}

limitsWorkflowMap:{
  FourEyes: {
    name: “FourEyes”,
    participants: [“Examiners”],
  },
  SixEyes: {
    name: “SixEyes”,
    participants: [“Examiners”, “Approvers”],
  },
  StraightThrough: {
    name: “StraightThrough”,
    participants: [],
  },
},

{
  accelerator:string,
  cube: string,
  measures: string
}

{
  accelerator: “accelerator”,
  cube: “cube”,
  measures: “measures”
}

{
  greaterThan: string,
  lessThan: string
}

{
  greaterThan: “Greater than”,
  lessThan: “Less than”
}

ActiveUI Module Federated Endpoints

The Limits UI is based on the activeUI module federated app. The activeUI app has a couple of endpoints you can use to configure it further. In the case of the Limits project, there are two endpoints that need to be used for the project to work properly. They can be found inside of the index.tsx file of the project. These are:

import {
  withClientSettings,
} from "@activeviam/accelerator-sdk";
import { limitsSettings } from "./configurations/LimitsSettings";
import { limitsStoreEnhancer } from "@activeviam/limits-sdk";

const accSdkHoc = withClientSettings(limitsSettings);

configuration.higherOrderComponents = [accSdkHoc];
configuration.storeEnhancers = [
      ...(configuration.storeEnhancers || []),
      limitsStoreEnhancer,
    ];

WithClientSettings HOC

The withClientSettings HOC builder allows you to store settings inside of the HOC, which wraps the entire application. The limitsSettings object mentioned in the previous section contains all configuration required for our widgets to work. These widgets read from the HOC using the useAccSdkSettings hook, which you can import from accelerator-sdk. Feel free to add your own “configurations” or “settings” into this withClientSettings builder, making sure that there aren’t any conflicts in key names. If there are conflicting keys, the application will break.

LimitsStoreEnhancer

The limitsStoreEnhancer is a redux store enhancer used for some functionality in the Limits Inventory widget. Without it, the Limits Inventory Widget will not work properly. You can read more about activeUI store enhancers on the activeUI documentation.

Configuring multiple servers for limits in env.js