Atoti Limits Java integration

Overview

The Atoti Limits Java auto-configuration module connects an Atoti Server instance (the “Connected Server”) to a running Atoti Limits server. It uses Spring Auto-configuration to bootstrap the required services and send a connection request to Atoti Limits.

This module enables Atoti Limits to manage limits on data served by Atoti Server. Once connected, Atoti Limits can evaluate limits against the measures and hierarchies exposed by the Connected Server.

The auto-configuration 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.

Compatibility matrix

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.

Prerequisites

1. The Atoti server(s) you wish to connect to must contain a slicing date hierarchy. This hierarchy will be used by Atoti Limits when evaluating limits.
2. User and role configurations must be consistent between Atoti Limits and the connected Atoti server(s) in order to guarantee proper access control. We recommend placing your security configurations in a single module and referencing that module in both Atoti Limits and the Atoti server.

How does the connection process work?

From a high-level view, the connection process works as follows:

1. Once Atoti Limits starts, it sits idle until it receives a connection request from the Connected Server.

2. When the Connected Server starts, it pings Atoti Limits to check if it is available to receive a connection request.

3. 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.

4. The connection request contains information about the Connected Server that Atoti Limits requires to connect.

5. Atoti Limits connects to the Connected Server and is now ready to manage limits.

6. During the lifetime of the application, Atoti Limits will manage all of the Connected Servers that it is connected to.

How to integrate a Connected Server with Atoti Limits

Follow these steps to integrate a Connected Server with Atoti Limits.

Step 1: Import the auto-configuration dependency in the Connected Server

The limits-auto-config-* Maven dependency must be added to the Connected Server project. The correct artifact depends on the version of Atoti Server in use.

Add the following dependency to the project pom.xml file:

<dependency>
  <groupId>com.activeviam.solutions.limits</groupId>
  <artifactId>limits-auto-config-{VERSION}</artifactId>
  <version>{ATOTI-LIMITS-MODULE-VERSION}</version>
</dependency>

The following table lists each artifact and its compatible Java versions:

Step 2: Configure the auto-configuration properties in the Connected Server

The auto-configuration module requires a set of properties to establish the connection. Configure these properties in the application.yml file on the Connected Server.

The full list of properties is available in the Auto-configuration properties section.

Step 3: Configure the inter-server-event-service properties in Atoti Limits

The Atoti Limits server needs to know where to find the Connected Server. Set the following configuration properties in the application.yml file on the Atoti Limits server.

activeviam:
  apps:
    inter-server-event-service:
      issuer:
        target-servers:
          - name: <Connected Server>
            url: <Connected Server URL>

where:

• <Connected Server> is the name of the Connected Server and should be the same as the value (defined or auto-configured) of limits.autoconfiguration.server-name in the connected server.
• <Connected Server URL> is the URL of the Connected Server and should be the same as the value (defined or auto-configured) of limits.autoconfiguration.atoti-base-url in the connected server.

Step 4: Start the servers

The order in which the servers start 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.

Troubleshooting

If the connection is unsuccessful, enable debug logging for further investigation.