Spring Server Setup and Configuration

    Prerequisites (Maven)

    Analytics Java SDK is distributed as a set of Maven modules. To work with the SDK libraries, you need to add a reference to Analytics's Maven Repository and also a dependency in your Maven pom.xml file.

    Add the following repository:

    <repositories>
  <repository>
    <id>reveal.public</id>
    <url>http://revealpackages.eastus.cloudapp.azure.com/repository/public</url>
  </repository> 
</repositories>

    And the following dependency:

    <dependency>
  <groupId>com.infragistics.reveal.sdk</groupId>
  <artifactId>reveal-sdk</artifactId>
  <version>version_number</version>
</dependency>

    Replace version_number with a number similar to 0.9.6.

    If you are not familiar with Maven, please refer to the following link.

    Setup and Configuration

    To set up the Analytics with an existing Spring Boot application, you need to:

    1. Add a dependency to spring-starter-jersey implementation.
    2. Add a dependency to Analytics SDK.
    3. Initialize Analytics.
    4. Enable server-side export.

    Step 1 - Adding a dependency to spring-starter-jersey implementation

    Add a dependency to spring-starter-jersey, if not added yet:

    <dependency>
    <groupId>org.springframework.boot</groupId>
    <artifactId>spring-boot-starter-jersey</artifactId>
</dependency>

    Step 2 - Adding a dependency to Analytics SDK

    Add a dependency to reveal-sdk and specify your SDK version.

    <dependency>
    <groupId>com.infragistics.reveal.sdk</groupId>
    <artifactId>reveal-sdk</artifactId>
    <version>version_number</version>
</dependency>

    Replace version_number with a number similar to 1.0.1821.

    Step 3 - Initializing Analytics

    Add a JerseyConfig component that will initialize a Jakarta RESTful Web Services (JAX-RS) application with Analytics resources. To do this, you can copy the class AnalyticsJerseyConfig from upmedia-backend-spring source code, located inside the package com.pany.analytics.upmedia.reveal).

    The @ApplicationPath annotation configures the path where Analytics services will be available, if you modify it then you’ll also need to modify the client-side path too. For the React application this is configured in index.html:

    $.ig.AnalyticsSdkSettings.setBaseUrl("http://localhost:8080/upmedia-backend/reveal-api/");

    To initialize Analytics, you use AnalyticsEngineInitializer.initialize.

    It is possible to invoke the method without initial parameters:

    AnalyticsEngineInitializer.initialize();

    But most of the times, you will be using parameters as shown in the example below:

    AnalyticsEngineInitializer.initialize(
    new InitializeParameterBuilder()
        .setAuthProvider(new AnalyticsAuthenticationProvider())
        .setUserContextProvider(new AnalyticsUserContextProvider())
        .setDashboardProvider(new AnalyticsDashboardProvider())
        .setDataSourceProvider(new UpMediaDataSourceProvider())
        .setDataProvider(new UpMediaInMemoryDataProvider())
        .setMaxConcurrentImageRenderThreads(2)
        .setLicense("SERIAL_KEY_TO_BE_USED")
        .build());

    Those parameters, are the providers used to customize Analytics, you’ll need to create your own providers when integrating Analytics into your application.

    The available parameters passed to AnalyticsEngineInitializer.initialize are:

    • setAuthProvider. Here you should include a custom class that resolves authentication, implementing IRVAuthenticationProvider.
    • setUserContextProvider. Custom class that provides information about the user, implementing IRVUserContextProvider.
    • setDashboardProvider. Custom class that replaces or modifies a dashboard, implementing IRVDashboardProvider.
    • setDataSourceProvider. Custom class that replaces or modifies a data source, implementing IRVDataSourceProvider.
    • setDataProvider. Custom class that returns in-memory data for dashboards, implementing IRVDataProvider.
    • setLicense. Here you can configure the SDK license, by including the Serial Key.

    For further details about how implement your own Dashboards provider, please check our UpMedia samples in GitHub.

    Step 4 - Enabling server-side export

    The Java SDK uses some native components for exporting dashboards to different formats: Image, PDF, PPT and Excel.

    If you are interested in exporting server-side to one or more of those formats, please refer to Server-side Export Configuration