Overview

    When embedding Analytics into web applications, the architecture is slightly more complex than with native apps, as two components are always involved:

    • Analytics Client SDK: a set of JavaScript libraries that needs to be integrated into the web application. The frameworks supported today are: jQuery, Angular and React.

    • Analytics Server SDK: the server-side component to be integrated into the server application, current libraries require JAVA SDK 11+ and are distributed as a set of Maven modules.

    In the following diagram you visualize the architecture for a web application embedding Analytics Web SDK:

    Analytics Web Architecture diagram

    As shown above, the SDK works pretty much the same way as with native apps. The difference is that some of the callbacks are invoked in the client side (like the event sent when a data point is clicked) and others are invoked server side (like the callback to load the dashboard or to provide in-memory data).

    Hosting the Client-side and Server-Side Parts on Different Servers

    You can host the client-side and the server-side parts separately i.e. on different urls.

    To achieve this, set a property on the window object, as shown below:

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

    Please note that the format used is: http://[server]:[port]/[application]/reveal-api. The inclusion of /reveal-api is required in order to set the property successfully.

    Set this property prior to the instantiation of the $.ig.AnalyticsView.