Atoti Java
Compatible versions
This table lists the versions of Atoti Server compatible with each Atoti Limits version. If you are using a solution, please check the underlying version of Atoti Server to see if your version of the solution is compatible.
Atoti Limits version | Atoti Server version |
---|---|
4.0-ALPHA | 5.11.x, 6.0.x, 6.0.x-sb3, 6.1.x |
3.3 | 5.11.x, 6.0.x, 6.0.x-sb3 |
3.2 | 5.9.x, 5.10.x, 5.11.x, 6.0.x, 6.0.x-sb3 |
3.1 | 5.9.x, 5.10.x, 5.11.x, 6.0.x |
3.0 | 5.9.x, 5.10.x, 5.11.x, 6.0.x |
2.0 | 5.9.x, 5.10.x, 5.11.x, 6.0.x |
1.1 | 5.9.x, 5.10.x, 5.11.x |
1.0 | 5.9.x, 5.10.x, 5.11.x |
Overview
Atoti Limits utilizes Spring Auto-configuration to connect to an Atoti Server. We shall refer to this as the Connected Server.
note
Atoti Limits does not require the connected server to be an ActiveVam Business Solution, it can be any instance of Atoti Server.
The autoconfiguration resides in the limits-auto-config-*
modules. These modules are responsible
for bootstrapping the Connected Server with any services required by Atoti Limits and for
sending a connection request to Atoti Limits with required information.
How it works
From a high-level view, the connection process works as follows:
-
Once Atoti Limits starts, it sits idle until it receives a connection request from the Connected Server.
-
When the Connected Server starts, it pings Atoti Limits to check if it is available to receive a connection request.
-
After both Atoti Limits and the Connected Server are started, the Connected Server will start some services and gather information to send a connection request to Atoti Limits.
note
the order in which the servers are started is irrelevant.
-
The connection request contains information about the Connected Server that Atoti Limits requires to connect.
-
Atoti Limits connects to the Connected Server and is now ready to manage limits.
-
During the lifetime of the application, Atoti Limits will manage all of the Connected Servers that it is connected to.
Steps
Follow these steps to integrate your Connected Server with Atoti Limits:
1. Import the Auto-configuration dependency
Import the limits-auto-config-*
maven dependency into your project depending on which version of Atoti Server you are using:
<dependency>
<groupId>com.activeviam.solutions.limits</groupId>
<artifactId>limits-auto-config-{VERSION}</artifactId>
<version>{ATOTI-LIMITS-MODULE-VERSION}</version>
</dependency>
The dependencies are as follows:
Atoti Server version | Auto-config artifact | Compatible Java versions |
---|---|---|
5.11.X | limits-auto-config-511 | 11 |
6.0.X | limits-auto-config-60 | 11, 17 |
6.0.X-sb3 | limits-auto-config-60-sb3 | 17 |
6.1.X | limits-auto-config-61 | 21 |
2. Configure the Auto-configuration properties
Configure the required auto-configuration properties in your application.yml
file on your Connected
Server. You do not need to configure any properties in Atoti Limits.
The full properties are available in the Auto-configuration properties section.
note
Not all properties are required, but they are all listed in the event that your Connected Server is unable to derive the properties automatically.
3. Start your servers
The order of these steps does not matter.
Start the Limits server
Start the Limits server using the installation instructions. Limits will wait for a connection from the Atoti Server.
Start the Connected Server
Start the Connected Server as normal. This should trigger a connection request.
If your connection is unsuccessful you may enable debug
logging for further investigation.
note
Ensure that within the ActivePivotConfig of your connected solution, the contextValueManager method is not setting the ActivePivotContentService to null.
If the ActivePivotContentService is null, KPIs will not appear in the UI, even if they are present in the content server.
Sometimes this can be fixed by setting the property contentServer.context-values.ignore
to false
.