Using CardioLog Analytics’ Software Development Kit (SDK), you can create your own customized reports. CardioLog Analytics already has many reports, but if you want to produce any other report you can create them with the SDK. You can tap into the CardioLog database and integrate with any other data source for richer reports (note that the creation of a custom report using the SDK requires T-SQL programming skills).

 If you combine extended tracking, you can then use custom reports to produce reports based upon banner clicks, form fields, custom events and more.

In order to create a custom report, the following steps are required:

Register the report in the CardioLog Analytics UI

In the CardioLog Analytics UI, reports can be added to dashboards in both the Report Center and Analysis Center. This is done by clicking any blank grid area of the report where a plus sign appears as you hover your cursor over the central area, or clicking Add at the top of the Central Area Toolbar.

To make a new report available for selection in the UI, the following is required:

  • Create a new widget category (menu)
  • Create a new widget (sub-menu)
  • Create a new widget type (meter, chart or table)

How to add a new widget category (menu)

  1. In the Navigation pane, under Administration, click on Custom Widgets


    Custom Widgets Tool

  2. Click Add Widget, then select the Menu option 


    Custom Widgets > Add Widget

  3. Enter the Title and Location fields, then click Save (by default the widget category location is set to Root - "~")


    Add Widget > Menu

  4. You should now be able to see your newly created widget category when adding a widget to a dashboard in the Report Center and Analysis Center.


    Add Widget Dialog

How to create a new widget (sub-menu)

  1. In Administration under Custom Widgets, click Add Widget, then select the Menu option 


    Custom Widgets > Add Widget

  2. Enter the Title and Location fields. Click Browse to select the widget location (widget category), then click Save


    Widget Location Dialog

  3. You should now be able to see your newly created widget under the selected widget category, when adding a widget to a dashboard in the Report Center and Analysis Center.


    Add Widget Dialog

How to create a new widget type (meter, chart or table)

  1. In Administration under Custom Widgets, click Add Widget, then select the  desired widget type (meter, chart or table) 


    Custom Widgets > Add Widget

  2. Enter the Title, Description and Location fields. Click Browse to select the widget type location (sub-menu).


    New Meter Dialog

    When selecting the Chart type, enter the Title and Value for the chart series.


    New Chart Dialog

    When selecting the Table type, enter the table columns - Title, Type, Description and Width (%)
    The following column types are available:
    String - text
    Numeric - number
    SPPage - tree item (includes drill down support)
    User - user account name (includes drill down support)


    New Table Dialog

  3. You should now be able to see your newly created widget type under the selected widget and widget category, when adding a widget to a dashboard in the Report Center and Analysis Center.


    Add Widget Dialog

Create a SQL stored procedure to populate the report

The stored procedure is created in the CardioLog database and contains a list of required parameters by default.
The stored procedure can display results from the CardioLog database tables and/or from external databases.
Note that direct queries against the CardioLog Analytics production database are not supported.

  1. When creating a new widget of type meter, chart or table, enter the stored procedure code in the Procedure Body field


    New Widget > Data

  2. Return values:
    • Meter widget stored procedure should return a single value
    • Chart widget stored procedure should return a series of values
    • Table widget stored procedure should return a table with columns as defined in the table widget properties

Common Database Tables

tab_event_log - usage events table

tab_sharepoint_tree - SharePoint tree structure

tab_users - user details

  • No labels