Setup and Configuration

Prerequisites (Maven)

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

Add the following repository:


And the following 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.


If you work with an Oracle Database you need to add the driver to your application.

Setup and Configuration (Generic Server)

To integrate Reveal with any existing application, you need to follow these generic steps:

  1. Add a dependency to the existing app implementation.
  2. Add a dependency to Reveal SDK.
  3. Initialize Reveal.
  4. Enable server-side export

If you are interested in configuring Tomcat or Spring, follow the links below:

Step 1 - Adding a dependency to the app implementation

Add a dependency to the existing application implementation, following the steps needed for the server of your preference.

Step 2 - Adding a dependency to Reveal SDK

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


Replace version_number with a number similar to 1.0.1821.

Step 3 - Initializing Reveal

To initialize Reveal, you use RevealEngineInitializer.initialize.

It is possible to invoke the method without initial parameters:


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

    new InitializeParameterBuilder()
        .setAuthProvider(new RevealAuthenticationProvider())
        .setUserContextProvider(new RevealUserContextProvider())
        .setDashboardProvider(new RevealDashboardProvider())
        .setDataSourceProvider(new UpMediaDataSourceProvider())
        .setDataProvider(new UpMediaInMemoryDataProvider())

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

The available parameters passed to RevealEngineInitializer.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 Dashboard providers, 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

Setup and Configuration (Client)

To set up the Reveal Web Client SDK you need to:

  1. Check Dependencies.

  2. Reference the Web Client SDK.

  3. Instantiate the Web Client SDK.

1. Checking Dependencies

The Reveal Web Client SDK has the following 3rd party references:

2. Referencing the Web Client SDK

Enabling $.ig.RevealView component in a web page requires several scripts to be included. These scripts will be provided as part of Reveal Web Client SDK.

<script src="~/Reveal/infragistics.reveal.js"></script>

You need to download the JavaScript files for your version of the Java SDK. Find below a table with download links for all Java SDK versions. Links to each version's release notes are also provided in the table.

Download JS files for Release notes
JAVA SDK 1.0.7 Version 1.0.7
JAVA SDK 1.0.6 Version 1.0.6
JAVA SDK 1.0.5 Version 1.0.5
JAVA SDK 1.0.4 Version 1.0.4
JAVA SDK 1.0.3 Version 1.0.3
JAVA SDK 1.0.0 Version 1.0.0

Referencing Reveal JS classes You could reference the JS classes through $.ig. or RevealApi.. Through out the docs we're using "$.ig." prefix to reference classes. You could use the RevealApi prefix instead of the "$.ig." one, if you want.

3. Instantiating the Web Client SDK

Reveal’s Dashboard presentation is handled natively through the Web Client SDK.

To get started follow these steps:

  1. Define a <div /> element with “id” and invoke the $.ig.RevealView constructor.


    Hosting Client-Side and Server-Side Parts Separately If you want to host client-side and server-side parts on different servers, please read here before you continue to next step.

  2. Call $.ig.RVDashboard.loadDashboard providing the dashboardId and success and error handlers.

  3. In the success handler instantiate the $.ig.RevealView component by passing a selector for the DOM element where the dashboard should be rendered into. Finally you should use the retrieved dashboard and set it to the dashboard property of the $.ig.RevealView

Sample Code

<!DOCTYPE html>
    <script type="text/javascript">
      var dashboardId = "dashboardId";

        function (dashboard) {
          var revealView = new $.ig.RevealView("#revealView");
          revealView.dashboard = dashboard;
        function (error) {
          //Process any error that might occur here
    <div id="revealView" style="height:500px;" />