Release Notes

For user-facing changes, refer to the What’s New page. For information on upgrading from previous versions, see the Limits module 1.0.0 Alpha Migration Notes

1.0.0 Alpha

2022-05-10

Download the distribution files here

You can download the following zipped distribution files:

  • UI source code
  • UI build
  • Source files to build the module
  • Maven repository required to build the project and run the tests. The ActiveViam 5.10.9 Maven repository files can be downloaded from here

Summary

  • Remove hardcoded AsOfDate from KPIUtils: We now properly read in the AsOfDate properties map from limits.properties
  • New workflow names : The workflows have been renamed.
    - Straight through: no approval needed, created in approved state.
    - Four eyes: previously called single eye. One person creates the workflow, another person approves.
    - Six eyes: previously called 4 eyes. One person creates the workflow, two people approve.

To make sure your limit workflow works as expected, please discard any previous testing data in the datastore and activiti databases. On top of the workflow name changes, the reference implementation now has the Role_Users by default to be able to create the limit definition instead of Role_Managers.

  • Added property to specify the URL of the Limits Module: Limits now supports being run from any location; previously Limits was assumed to be running at localhost.
  • Audit trail screen : New audit trail screen is available in the Limits Inventory Widget. For more information, see Viewing the audit history
  • Added validation to Limit Definition: Limit Definitions are validated when loaded through CSV or File Upload.
  • Ui changes : Upgrade to AUI 5.0.11, Acc-sdk 5.0.7, added Audit trail tab in Limits Inventory, enabled Lazyloading for Limits Inventory Widget, numerous bug fixes, added column sorting to the Limits Inventory Widget, enabled Storytelling, better error handling.
  • Provided AP 5.9 LookupPostProcessor: Added AP 5.9 LookupPostProcessor Module to limits-lookup-postprocessors
  • Limits on Calculated Measures: Limits can now be created on Calculated Measures via File Upload.
  • Workflow after editing and deleting a limit: After editing or deleting a limit in the Limits Inventory Widget, the workflow is triggered. Editing triggers the Limit Change Workflow, deleting triggers the Straight through workflow and an audit record is created in the audit database.
  • Roles: All the KPIs created by the Limits module now have LIM_ROLE as the owner and viewer.

Known issues

Issue Key Details
LIM-351 Evaluation limit endpoint doesn’t work properly when the limit definition has more than one scope.
LIM-349 File Upload doesn’t display error messages in the UI.
LIM-347 The Limits workflow has stability issues.
LIM-346 Limits on calculated measures only work through File Upload, not through the UI.
LIM-343 When deleting a limit, the content editor is not updated automatically. As a workaround, reload the content editor after deleting a limit.
LIM-342 The Audit screen doesn’t display details about editing a limit.
LIM-341 Editing a limit with STP doesn’t work as expected.
LIM-338 Creating a limit in the Limits Inventory breaks the UI if a required field is not set.
LIM-326 Limit scope definition on identical levels that exist in multiple hierarchies is not supported.
LIM-320 Calculated measures need to be included in Pivot Table Query in order to view a Limit’s KPI in the Pivot Table. See Measures for more on how to create a query Limits on calculated measures.
LIM-314 The workflowTypeArray UI setting does not dynamically generate the workflows section of the Limits drawer form.
LIM-312 The Six Eyes workflow is not working as expected. The limit goes into the Approved state once the Examiner approved it, instead of pending approval until the Approver review.
LIM-311 Managers can edit and approve their own changes on limits with the Four Eyes workflow.
LIM-302 After editing or deleting a limit in the Limits Inventory Widget, the workflow is triggered.
LIM-290 For the Limits Inventory view, the sort only works on the first column. To sort on other columns, you can change the table column order to put the desired column first and then sort.

Dependency versions

Component Version
ActivePivot 5.10.9
ActiveUI 5.0.11
Data Connectors 2.2.2-AP5.10
Java JDK11
accelerator-sdk 5.0.7

Added

Issue Key Details
LIM-96 Added validation of Limit Definitions. When loading a Limit Definition, the validity of Server, Cube, Measure, and Scope Keys (Cube Level Members) parameters are checked within the given Server.
LIM-125 Added Audit screen to the Limits Inventory Widget drawer. Additionally, there is a new optional setting to set on the UI side limits_inventory-widget.server.params.auditTrailNodeColors, which allows users to map their workflow statuses to three timeline colors.
LIM-164 Hardcoded values, such as Limits server name and rest endpoint settings, have been externalized to a global settings file.
LIM-180 Added server side support to show audit trail.
LIM-193 Added the context menu to the Limits Inventory Widget table, which includes column sorting.
LIM-202 By default, Limits Module uses ROLE_LIMITS as owner when creating the KPI.
LIM-208 Added new property acc.auth.map to limits.properties. More can be read in the Accelerator Authentication section of the Integrating Active Pivot page.
LIM-220 Added functionality to auto generate scopes for a Parent-Child level.
LIM-239 Added better exception handling, which will let the user know if there are certain levels which need to be part of the query running inside of the Limits Inventory Widget table.
LIM-254 Utilize REST endpoint to construct scopes for Parent-Child hierarchies within the Create Limit drawer.
LIM-270 Enabled Storytelling for the Limits and FRTB cubes by default through the Limits settings file.
LIM-275 Initial load and file upload utilizes REST endpoint to generate Parent-Child scopes.
LIM-283 Enabled Lazyloading for Limits Inventory Widget.
LIM-313 Approve endpoint properly handles Forbidden user error, and sends back response.

Changed

Issue Key Details
LIM-175 Reorganized and improved the ScopeDetails component for clarity and performance.
LIM-192 The workflows have been renamed. The new workflows are: Straight through, Four eyes, Six eyes.
LIM-210 Reduced memory consumption by caching limit scope’s keys and values.
LIM-216 Added a scrollbar and fixed height to the selected members for a given scope.
LIM-231 We now properly read in the AsOfDate properties map from limits.properties.
LIM-236 The KPI Goal value is represented as a Double.
LIM-297 Upgraded ActivePivot to 5.10.9.
LIM-303 Removed Timestamp from the Alerts file directory and added it to the alerts csv file name.

Removed

Issue Key Details
LIM-188 Removed unnecessary columns from the Limits Inventory Widget’s table. Only key fields populate the widget’s table.
LIM-265 Creating Limit Rules of Between and Not Between has been disabled.

Fixed

Issue Key Details
LIM-156 Fixed bug where resizing columns broke the Limits Inventory Widget.
LIM-179 Fixed bug which prevented copying cells from the Limits Inventory Widget table.
LIM-189 Fixed bug which prevented columns from being moved around inside of the Limits Inventory Widget.
LIM-204 Content Editor is refreshed automatically after creating, deleting or editing a limit.
LIM-207 The Limit icon is now placed in the correct position.
LIM-208 Improved performance of refreshing and creating new KPIs. Now KPIs are only refreshed when changed.
LIM-217 When a Limit is deleted, the Limit’s KPI will only be deleted if no other Limits use that KPI.
LIM-244 Fixed bug where long measure names would push the Measure field onto a new line.
LIM-264 Fixed the warning of the Greater Than KPI status. The warning level on a Greater Than limit now triggers a breach when the limit utilization is within the defined percentage.
LIM-271 Fixed bug which prevented the user from defining a scope.
LIM-280 Fixed bug where the Absolute Value Indicator value was being set by the Warning Threshold. Also, amber status logic was being applied incorrectly to KPIs.
LIM-299 Fixed bug where creating a scope of a level that was previously selected and deleted, did not render the Member Selector popover.
LIM-305 Fixed bug where a manually created limit with an empty “End Date” will populate it with the current date.
LIM-308 Fixed bug where scopes with Parent Child and non-Parent Child levels couldn’t be processed by ETL.

0.3.0

2022-03-01

Download the distribution files here

You can download the following zipped distribution files:

  • UI source code
  • UI build
  • Source files to build the module
  • Maven repository required to build the project and run the tests. The ActiveViam 5.10.7 Maven repository files can be downloaded from here

Summary

  • UX re-design: Based on feedback from demos we have redesigned the UX of the Limits Module. Limits creation screen based on UX design Limits edit and delete. Approval screen
  • Upgrade: to ActivePivot 5.10.7 and ActiveUI 5.0.7.
  • Amber support: Amber support has been added through the use of warningThreshold field. This lets you specify a percent of the limit value where the KPI should show amber status. For more information, see Create a New Limit.
  • New KPI Types: Previously, all limits were interpreted as “Greater Than”. Now, through the KPI Type field, you can specify “Less Than”, “Between”, and “Not Between”. For more information, see Create a New Limit.
  • AlertTask output modifications: AlertTask outputFile as well as AlertDefinition store fields have been re-organized and new fields have been added.
  • Replace per-limit AsOfDate: AsOfDate (the date that limits should be evaluated on in AlertTasks) is now set globally via AsOfDateTuplePublisher.
  • Use Start Date and End Date: Limit Start Date and End Date are now used to determine limit values at runtime. The Limits Module has the AsOfDate in the AsOfDate datastore, which is uploaded from the AsOfDate.csv file. All limit evaluations against the business cubes, such as MRA and FRTB, are based on the AsOfDate. At the start of the business day, the Limits Module expects that a new AsOfDate.csv file is uploaded through Data Connectors, to roll the date.
  • Removed property cube.rest.path: Instead, the cube.rest.path should be appended to the REST path defined in the acc.url.map property.
  • Added support for Atoti+: For steps on how to use the Limits Module with Atoti+ please read the Integrating the Limits Module with Atoti+ page.
  • Added SameSiteConfig Configuration Class : SameSite Cookie policy can be configured by setting the SameSite property.
  • Workflow support: activiti dependency
  • General Code Cleanup: Refactoring to clean up code-base and simplify logic.

Known issues

Issue Key Details
LIM-140 Workflow Entitlement doesn’t work fully yet. In 0.3.0, only managers can create new limits using the UI.
LIM-223 Currently, you can only edit a limit from the UI when the limit is in initiated state. In such cases, the limit change workflow does not start after the update.
LIM-144 Currently, only explicit Limit Scopes are support for evaluating Alerts. Evaluating an Alert Task using the /evaluate endpoint for a given KPI, if an underlying Limit’s Scope contains Wildcards, causes the evaluation to fail for that Limit.
LIM-176 Levels are not a unique identifier in a Cube. Two levels of the same name can refer to different data. In this case a Limit’s Scope defined on a level could have multiple meanings.
LIM-204 / UI-6969 After creating new limits, you need to refresh the UI in order to see the KPIs created.
LIM-203 Limits upload error handling occurs when the measure name is incorrect. The Limits module currently doesn’t produce an error message when a measure name is incorrect.
LIM-217 Deleting a Limit Definition from within the Limits Inventory will cause the corresponding KPI to be removed from the Server even if other Limit Definitions use that KPI. Creating a dummy Limit Definition through the Limits Inventory will re-create all KPIs (including the deleted one) which will fix this issue.

Dependency versions

Component Version
ActivePivot 5.10.7
ActiveUI 5.0.7
Data Connectors 2.2.1-AP5.10
Java JDK11
accelerator-sdk 5.0.4

Added

Issue Key Details
LIM-18 Added support for Less Than, Between, Not Between KPIs
LIM-108 Added amber status support
LIM-99 Added SameSite policy configuration class SameSiteConfig which can be enabled/set through the SameSite property.
LIM-41 Added approval workflow supports
LIM-122 UI and Workflow Integration
LIM-89 KPI goal now shows more information including absolute value, kpiType, WarningThreshold, and limit value(s) where applicable and formatted value.
LIM-190 REST endpoint has been added to prevent unauthorized users from creating a limit.

Changed

Issue Key Details
LIM-68 Updated the Limits UI based on UX design
LIM-101 Added new fields to AlertTask output file and AlertDefinition store; re-organized fields
LIM-103 AsOfDate removed from limit input files; replaced by global AsOfDate value. Start Date and End Date are now used in evaluation of limit values at runtime
LIM-127 For Between and Not Between KPI’s, setting a Warning Threshold has been disabled. Between and Not Between Limits with a Warning Threshold value will be rejected when loading a file.
LIM-151 Success and failure messages for the Approve and Reject buttons are determined by the server’s response to the REST requests.
LIM-171 The column with View and Delete links has been renamed to “Actions”

Removed

Removed Desciption
cube.rest.path property The cube REST path is now included in the acc.url.map property value.

Fixed

Issue Key Details
LIM-94 Fixed issue where limit values were not evaluated on factless hierarchies.
LIM-172 File export of the Limits Inventory widget has been fixed and no longer only contains headers.

0.2.0

2021-09-30

Download the distribution files here

Summary

  • Support Multiple ActivePivot Instances : The Limits Module now supports multiple ActivePivot instances. Clients can use one Limits Module to monitor and create KPI in Limits Inventory Dashboard, such as monitoring LIM and FRTB in one place.
  • On-Demand Limits Monitoring/change : LimitEvaluation restful endpoint is available for clients to trigger the evaluation on demand. The result is written into alert csv files with timestamps and exposed in the Breach Count measure.
  • Trend Analysis of Limits: By including AsOfDate hierarchy in the business cubes, users can now analyze KPI goal changes over a period of time.
  • Upgrade to AUI 4.3.17
  • Documentation Improvements

Known issues

None.

Dependency versions

Component Version
ActivePivot 5.10.6
[ActiveUI]https://activeviam.com/activeui/documentation/5.0.6/) 5.0.6
Data Connectors 2.2.1
Java JDK11
accelerator-sdk 5.0.3

Added

Issue Key Details
LIM-12 Adds endpoints, within the Limits Inventory widget, to create, upload, and export limits. Please see New Limits Widget.
LIM-27 Implements a custom widget to display Limit Definitions.
LIM-23 Allows multiple servers to connect to the same Limits Module.
LIM-32 Adds testing framework for unit, integration, and regression tests.
LIM-40 Integrates the DEE for the Limits Inventory widget’s export button.
LIM-43 Allows a client’s orchestrator to create and trigger Alert Tasks.
LIM-58 LookupPostProcessor factors AsOfDate for trend analysis of Limits.
LIM-67 Added tests to create, upload, and export limit definitions from the Limits Inventory widget.
LIM-104 Support functionality to edit and delete limits from the Inventory Table.

Changed

Issue Key Details
LIM-65 Upgrade Limits module to AP 5.10
LIM-66 Upgrade Limits module to ActiveUI 5
LIM-62 Renamed the MDX constant for Limits widget.
LIM-55 Changed ‘Accelerator Name’ to ‘Server Name’ in the Limits definition.
LIM-48 Parameterized the Alert file path location.
LIM-38 Modified the MDX so the KPI status populates when the KPI’s goal is not null.

Fixed

Issue Key Details
LIM-53 Changed the Upload input file format to accept exported files.
LIM-50 Fixed NullPointerException in Upload endpoint by including the Accelerator.
LIM-31 Added logic to remove alert tasks from expired dates.
LIM-112 Fixed bug where a rule’s upper bound value could be smaller than the rule’s lower bound value.
LIM-114 Fixed bug where the rule message display would not reset when the rule was deleted.

0.2 Alpha

  • Support multiple AP servers
  • Change the way alert evaluation works. Intra-day observation frequency runs every 20 seconds by default. Other observation frequencies are required to invoke by client’s alert orchestrator.

0.1

  • Initial release
  • Input file formats for the CSV files that can be used by clients as input to the ActivePivot Limits Module Reference Implementation.
    • Limits definition files need to be replaced with the organization’s data.
search.js