Migration notes 1.1.0
This page explains the changes required to migrate to the stated version of the Limits Module.
Migrate to 1.1.0
Upgrading from version 1.0.1 See Limits 1.1.0 Release Notes.
The Accelerator is using ActivePivot 5.10.9 and ActiveUI 5.0.18.
For new features and fixes included in these releases, please see the ActiveUI documentation and ActiveUI Migration Notes, and the release notes for ActivePivot.
Headline announcement
- Email notifications: The Limits Module can be configured to send email notifications about limit breaches. See Configuring breach email notifications for details.
- Auto-Configuration : The Active Pivot server can now auto-configure itself for Limits to connect. See Auto-configuration.
- View Utilizations context menu action: A new context menu action has been added that lets you view the utilization of limits from a pivot table. This is helpful when investigating exceptions. The feature works on all pivot tables in the Limits project, including the Limits Inventory widget. See View Utilizations for details.
- Copy action : Limits can now be duplicated in the Limits Inventory. For more information, see Limits Inventory.
- Swagger UI is available at {base.url}/swagger-ui/index.html. This will display some REST endpoints exposed by the Limits server. It can be enabled/disabled by setting property
swagger.enabletotrue/false. - Server Sub-folder for Limit definitions: Limit definition files, such as limits-approve.csv, should now be included in a subfolder of the same name (case-sensitive) as the server the limits pertains to, for example, FRTB.
Input file formats
Modified
| Modification | File | Field | Optional | Description |
|---|---|---|---|---|
| Added | limits-approve.csv | ExceptionWorkflow | N | Exception workflow type, the workflow that handles a limit with a BREACHED or WARNING status. |
| Deleted | limits-approve.csv | WarningWorkflow | N | |
| Deleted | limits-approve.csv | WarningWorkflowParameters | N | |
| Deleted | limits-approve.csv | BreachWorkflow | N | |
| Deleted | limits-approve.csv | BreachWorkflowParameters | N | |
| Changed | limits-approve.csv | From -> Start Date | N | Field name has changed. |
| Changed | limits-approve.csv | To -> End Date | N | Field name has changed. |
| Changed | limits-approve.csv | FrequencyType -> Frequency Type | N | Field name has changed. |
| Changed | limits-approve.csv | PollingFrequency -> Polling Frequency | N | Field name has changed. |
| Changed | limits-approve.csv | KpiType -> Kpi Type | N | Field name has changed. |
| Changed | limits-approve.csv | LimitValues -> Limit Values | N | Field name has changed. |
| Changed | limits-approve.csv | AbsoluteValueIndicator -> Absolute Value Indicator | N | Field name has changed. |
| Changed | limits-approve.csv | WarningThreshold -> Warning Threshold | N | Field name has changed. |
| Changed | limits-approve.csv | MeasureName -> Measure Name | N | Field name has changed. |
| Changed | limits-approve.csv | LimitStatus -> Limit Status | N | Field name has changed. |
| Changed | limits-approve.csv | ChangeWorkflow -> Limit Changes Workflow | N | Field name has changed. |
| Changed | limits-approve.csv | ChangeWorkflowParameters -> Limit Changes Workflow Parameters | N | Field name has changed. |
| Changed | limits-approve.csv | ExceptionWorkflow -> Exception Workflow | N | Field name has changed. |
| Changed | limits-approve.csv | userID -> User ID | N | Field name has changed. |
| Changed | limits-approve.csv | CubeName -> Cube Name | N | Field name has changed. |
| Changed | limits-approve.csv | ServerName -> Server Name | N | Field name has changed. |
Configuration files
Files Modified
limits.properties
New properties:
| Property Name | Comment | Value |
|---|---|---|
| enhanced.drillthrough.base.dir.path | Path to the folder in which the files will be generated for the extractions | ./src/main/resources/extractionOutput |
| enhanced.drillthrough.http.base.url | URL mount point to access the folder as a Web File Server for the extractions | http://localhost:3090 |
| scope.isUsingExplicitScopeMatching | Enables/disables Explicit Scope Matching. | True |
| sample-rate-cron | Intraday limit evalution frequency with the cron expression. | 0 */5 * * * * |
Updated properties:
| Property Name | Comment |
|---|---|
| ap.url.map | Renamed from acc.url.map to reflect that the Limits Module can work with any AP instance. |
| ap.configuration.kpi.path.map | Renamed from acc.configuration.kpi.path.map |
| ap.asOfDate.dim.map | Renamed from acc.asOfDate.dim.map |
| scope.isUsingExplicitScopeMatching | Changed default value from False to True |
| scope.autofill-unambiguous-level-paths | Changed default value from False to True |
| sample-rate-minutes | Replaced with sample-rate-cron. Changed default value from * to 0 */5 * * * * |
With the default values for Scope properties changed, defining any scope properties in your limits.properties is not recommended. These properties include:
- scope.force-unambiguous-level-paths
- scope.autofill-unambiguous-level-paths
- scope.isUsingExplicitScopeMatching
application.yml
Deleted properties:
| Property Name | Comment |
|---|---|
| Deletion | Not in use. The deletion is part of the creation workflow. |
| export.polling-period-in-milliseconds | Not in use. |
| export.initial-delay-in-milliseconds | Not in use. |
| export.scheduler-pool-size | Not in use. |
| sample-rate-minutes | Replaced with sample-rate-cron. |
| sample-rate-seconds | Replaced with sample-rate-cron. |
| Property Name | Comment | Value |
|---|---|---|
| servlet.session.cookie: name | The cookie name | LIM_JSESSIONID |
| max-age | The maximum expiration time. Must match the value defined in qfs.expiration | PT12H |
Datastores
Modified stores
| Modification | Store | Field | Type | Description |
|---|---|---|---|---|
| Added | LimitsDefinition | Exception Workflow | string | Type of workflow to use for handling breaches and warnings. |
| Deleted | LimitsDefinition | WarningWorkflow | ||
| Deleted | LimitsDefinition | WarningWorkflowParameters | ||
| Deleted | LimitsDefinition | BreachWorkflow | ||
| Deleted | LimitsDefinition | BreachWorkflowParameters | ||
| Deleted | LimitsDefinition | CCY | string | Currency value |
| Renamed | LimitsDefinition | From -> Start Date | string | |
| Renamed | LimitsDefinition | To -> End Date | string | |
| Renamed | LimitsDefinition | key -> limitKey | integer | |
| Added | EvaluationTimestamp | Evaluation Date | Local Date | Date when the limit was evaluated. |
Cube schema
Added
| Cube | Dimension | Hierarchy | Levels | Datastore fields | Details |
|---|---|---|---|---|---|
| Limits | ExceptionWorkflow | ExceptionWorkflow | ExceptionWorkflow | ExceptionWorkflow | Type of workflow to use for handling breaches and warnings. |
| Limits | EvaluationDate | EvaluationDate | EvaluationDate | EvaluationDate | Date when the limit was evaluated, represented as a LocalDate. |
Modified
| Cube | Dimension | Hierarchy | Levels | Datastore fields | Details |
|---|---|---|---|---|---|
| Limits | limitKey | limitKey | limitKey | limitKey | Renamed from “key” to “limitKey”. |
Removed
| Cube | Dimension | Hierarchy | Levels | Datastore fields | Details |
|---|---|---|---|---|---|
| Limits | WarningWorkflow | WarningWorkflow | WarningWorkflow | WarningWorkflow | |
| Limits | WarningWorkflowParameters | WarningWorkflowParameters | WarningWorkflowParameters | WarningWorkflowParameters | |
| Limits | BreachWorkflow | BreachWorkflow | BreachWorkflow | BreachWorkflow | |
| Limits | BreachWorkflowParameters | BreachWorkflowParameters | BreachWorkflowParameters | BreachWorkflowParameters | |
| Limits | CCY | CCY | CCY | CCY | See Specifying the currency for details on how to specify a limit’s currency. |
Measures
No changes.
Context values
No changes.
Other changes
No changes.