Enabling the Reporting Services

In Mashup Builder > Application, you can enable reporting for your Mashup Builder applications and for the Mashup API. In both cases, reporting relies on reporters which can be configured in the Administration Console > Reporting menu.

Note: To configure the reporters available in Mashup Builder, see Analyzing User Queries with Reporters in the Exalead CloudView Configuration Guide.

This task shows you how to:

Enable reporting on your Mashup Builder applications

The edm-mashup-ui-reporting reporter collects data relative to task execution and to CPU activity on the Mashup UI. For example, when a user queries a page, the reporter retrieves data such as the execution and CPU time of pages, widgets and triggers.

Once configured in the Administration Console, this reporter must be enabled in the Mashup Builder > Application > Application Properties menu.

As for all reporters, the information collected by the edm-mashup-ui-reporting reporter can be exported to CSV, JDBC and SQLite repositories, to make reports with external tools. It can also be sent to a Push API publisher if you want to index this data and use it like other indexed Exalead CloudView data.

The difference with the other reporters, is that you can directly display collected information into a timeline chart, accessible when the debug mode is enabled.

Before you begin: Once reporting is enabled for a given application, the debug mode displays a timeline tab, allowing you to get a graphical view of collected data.
  1. In Mashup Builder, select Application from the top left menu bar.
  2. Select General > API Properties.
  3. In the Reporting section:
    1. Select the Enable reporting checkbox.
    2. Click in the Reporter field and select the edm-mashup-ui-reporting reporter.
  4. Go to Developer area and select the Mashup UI debug mode.
  5. Open your Mashup Builder application.

    The Debug bar displays at the bottom of your search application pages.

  6. Click the Timeline tab.

    A window displaying a timeline chart opens (see the following screenshot example).



Enable reporting for the Mashup API

The edm-mashup-api-reporting reporter collects data relative to feeds, subfeeds and triggers execution. This reporter allows you to understand explicitly the feed execution process, with subfeeds and triggers and to identify possible problematic issues.

Once configured in the Administration Console, this reporter must be enabled in the Mashup Builder > Application > API Properties menu.

As for all reporters, the information collected by the edm-mashup-api-reporting reporter can be exported to CSV, JDBC and SQLites repositories, to make reports with external tools. It can also be sent to a Push API publisher if you want to index this data and use it like other indexed Exalead CloudView data.

The difference with the other reporters, is that you can directly display collected information into a timeline chart, accessible when the debug mode is enabled.

Note: To get the count of unique users in your edm-mashup-api-reporting (this is displayed in the Business Console > Query Reporting graph), you must select the Enable Security option on your feeds. Otherwise, the count will return 0. For more information, see Enable security on a Exalead CloudView Search feed.

  1. In Mashup Builder, select Application from the top left menu bar.
  2. Select General > API Properties.
  3. In the Reporting section:
    1. Select the Enable reporting checkbox.
    2. Click in the Reporter field and select the edm-mashup-api-reporting reporter.
  4. Go to Developer area and select the Mashup UI debug mode.
  5. Open your Mashup Builder application.

    The Debug bar displays at the bottom of your search application pages.

  6. Click the Timeline tab.

    A window displaying a timeline chart opens (see the following screenshot example). In the Type column, the edm-mashup-api-reporting information can be seen for the Feed and Feed triggers entries.