Migration notes 0.3.0

This page explains the changes required to migrate to the stated version of the Limits Module.

Migrate to 0.3.0

Upgrading from version 0.2.0 See Limits 0.3.0 Release Notes.

The Accelerator is using ActivePivot 5.10.7 and ActiveUI 5.0.7.

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

  • activiti dependency : Please add the activiti repository in your repository list:
<repositories>
	<repository>
  	<id>activiti-releases</id>
  	<url>https://artifacts.alfresco.com/nexus/content/repositories/activiti-releases</url>
	</repository>
</repositories>

Input file formats

Added

File Details
as_of_date.csv Sets AsOfDate for limits accelerator - this date is used in AlertTasks for creating MDX for which to evaluate KPI status
alert.csv Alert file generated by AlertTasks which populates AlertsDefinition store via listening topic

Modified

Modification File Field Optional Description
Replaced limits_approve.csv Limit_Card ->
Group
N Renamed
Replaced as above Source ID ->
ID
N Renamed
Replaced as above Limit Caption ->
Name
N Renamed
Replaced as above Limit Commentary ->
Comment
Y Renamed
Replaced as above Observation Frequency/Relevancy ->
Polling Frequency
N Renamed
Replaced as above Limit Ccy ->
Ccy
N Renamed
Deleted as above AsOfDate N Moved to AsOfDateStore
Added as above KPIType N String describing whether limit is “Greater Than” “Less Than” “Between” and “Not Between” (i.e. Between means breach when between limit value)
Added as above AbsoluteValueIndicator N Boolean value indicating absolute value of measure should be used when making comparisons to limit value(s)
Added as above WarningThreshold Y Double value representing % threshold from breach where warning rather than breach should be recorded (KPI indicator shows amber in Status)
Replaced as above Limit_Value ->
LimitValues
N Limits Value now accepts a double array for “Between” and “Not Between” support first limit value should always be lower-bound and second should be upper-bound
Deleted as above NewLimitsApprovalWorkflow Y Workflows have been overhauled
Deleted as above NewLimitsApprovalWorkflowParameters Y Workflows have been overhauled
Added as above WarningWorkflow Y Workflows have been overhauled
Added as above WarningWorkflowParameters Y Workflows have been overhauled
Added as above BreachWorkflow Y Workflows have been overhauled
Added as above BreachWorkflowParameters Y Workflows have been overhauled
Added as above ChangeWorkflow Y Workflows have been overhauled
Added as above ChangeWorkflowParameters Y Workflows have been overhauled
Added as above Breach or Warning N Indicator for whether alert is breach (red-status) or a warning (amber-status)
Deleted as above Frequency Type N Removed

Removed

None.

Configuration files

Files Added

application.yml

Added application.yml to allow the springboot application property file to be used during the startup including the port number, and database connections.

Files Modified

Updated properties:

Property Name Comment New Value Old Value
acc.asOfDate.dim.map Level description is now in format of Level@Hierarchy@Dimension Level@Hierarchy@Dimension Dimension@Hierarchy@Level

Deleted properties:

Property Name Comment
cube.rest.path The cube REST path is now included in the acc.url.map property value. Your acc.url.map URLS should look something like http://localhost:8080/frtb-starter/pivot/rest/v5/cube

Files Deleted

None.

Datastores

No changes.

Cube schema

Added

Cube Dimension Hierarchy Levels Datastore fields Details
Limits LimitChangeWorkflowType LimitChangeWorkflowType LimitChangeWorkflowType LimitChangeWorkflowType When a limit is created or updated workflow type, such as simple eye or 4eye workflow.
Limits LimitChangeWorkflowParameter LimitChangeWorkflowParameter LimitChangeWorkflowParameter LimitChangeWorkflowParameter Specify the user role to approve the breach.
Limits BreachWorkflowType BreachWorkflowType BreachWorkflowType BreachWorkflowType Breach workflow type, such as simple eye or 4eye workflow.
Limits BreachWorkflowParameter BreachWorkflowParameter BreachWorkflowParameter BreachWorkflowParameter Specify the user role to approve the breach.
Limits WarningWorkflowType WarningWorkflowType WarningWorkflowType WarningWorkflowType Warning workflow type, such as simple eye or 4eye workflow.
Limits WarningWorkflowParameter WarningWorkflowParameter WarningWorkflowParameter WarningWorkflowParameter Specify the user role to approve the breach.

Modified

Type for timestamp field in LimitDefinitionDTO changed from Timestamp to LocalDateTime.

Removed

None.

Measures

No changes.

Context values

No changes.

Other changes

To integrate Limits Module to any ActivePivot instance is now simplier.

  1. Add the limits module to the dependency pom.
   <dependency>
        <groupId>com.activeviam.limits</groupId>
        <artifactId>limits-core</artifactId>
        <version>{LIMIT MODULE VERSION}</version>
    </dependency>
  1. To register the LookupPostProcessor, anywhere in your ActivePivot configuration to add the measure: LookupPostProcessor.addMeasureToRegistry();