Create a Report Dashboard

V10.3.1 and later

A report in Analytics, enables the user to view the data from a SQL table or view in a grid format, making it easy for the user to sort, filter and save the data.

Prerequisites

Before you create a report, you need to:

• Create a dashboard suite.
• Add the relevant Lookup table to your data model.

Create a new report dashboard

1. In the Administration>Analytics>Dashboard Suites, add a new dashboard or edit the dashboard suite to which you want to add a report dashboard.
   By default, the newly created dashboard includes a tile with a bar chart. 
2. Delete the default tile with a bar chart.
3. In the Toolbox, click Reports>Report.
   
4. To edit the report, click Edit Details.
5. On the Properties tab:
   1. Name: Enter a significant name for the report.
   2. Title: Enter the name to display on top of the report when viewed in the portal.
   3. Description: Add a short description of the data displayed by the report. This text displays as a tooltip when the report is viewed in the portal.
6. Click Next.
7. On the Data tab:
   1. Select Choose Query as <New Query>.
      
   2. Click Add>Lookup Table, to add a new Lookup table query as the data source for the report.
      In the Lookup Table Properties, select table, and then click Add.
      Report dashboard works with Lookup table data source only.
   3. To define cache settings for the selected query, click Advanced Options. For more information on defining cache settings, see this article.
8. On the Format tab, configure the report columns.
   For example and details, see the Configure report columns section below.
9. Click Finish.

Configure report columns

You can configure the report columns per your need while configuring the report tile in the dashboard. Edit the report tile, and in the Format tab add the column settings.

Example 1

For configuring the date format, use the sample below:

{
  "columns": [
    {
      "field": "actCreationDate",
      "definitions": {
        "width": 100,
        "title": "Act Creation Date",
        "template": "<span>#=kendo.toString(data.actCreationDate,'G')#</span>"
      }
    }
  ] 
}

More date format options, see this link.

Example 2

To change the Case ID field you need to change the fldId field value, as shown in sample below:

{
  "columns": [
    {
      "field": "fldId",
      "definitions": {
        "width": 100,
        "title": "ID",
        "template": "<a href=javascript:$ft('\\##=data.elementId#').AnalyticsDataGrid('instance').openItem('/_layouts/runtime.aspx?workflowInstanceId=#=data.fldId#','#=data.fldId#','Case ID #=data.fldId#')>#=data.fldId#</a>"
      }
    }
  ] 
}

If no columns are specified, then the default for ‘fldId’ (field must exist) is following:

<a href=javascript:$ft('\\##=data.elementId#').AnalyticsDataGrid('instance').openItem('/_layouts/runtime.aspx?workflowInstanceId=#=data.fldId#','#=data.fldId#','Case ID #=data.fldId#');>#:data.fldId#</a>

Dashboard filter appearance and canvas width

You can add default settings for the appearance of the dashboard in the portal in runtime. The canvas width for report dashboard is 100% by default, and can't be changed.

1. Click the ellipsis next to the dashboard name drop down, and the click Options.
   
2. In the Dashboard options pop-up window:
   1. Select Filter Appearance in Runtime:
      • Collapsed on entry: To display the report in collapsed form by default in runtime. You can then expand the report to view.
      • Expanded on entry: To display the report in expanded form by default.
      • Hidden: To hide the report by default in runtime.
3. Click OK.

Create a report to view from an external link (V10.4 onwards)

The external link report in Analytics enables the user to view reports from any external link in a tab in the portal.

1. In the Administration>Analytics>Dashboard Suites, add a new dashboard or edit the dashboard suite to which you want to add a report dashboard.
   By default, the newly created dashboard includes a tile with a bar chart. 
2. Delete the default tile with a bar chart or any tile already in the dashboard.
3. In the Toolbox, click Reports>External Link.
   
4. To edit the report, click Edit Details.
5. On the Properties tab, add the following:
   1. Name: Enter a significant name for the report.
   2. Title: Enter the name to display on top of the report when viewed in the portal.
   3. Description: Add a short description of the data displayed by the report. This text displays as a tooltip when the report is viewed in the portal.
6. Click Next.
7. On the Content tab, add the JSON code with the external link and other report configurations.
   
8. Click Finish.

Add icon to dashboards (V10.5 onwards)

Starting from V10.5, you can add icons to your reports and dashboards. With added icons you can easily identify your reports and dashboards even with similar names.

1. Click the ellipsis next to the dashboard name drop down, and the click Options.
   
2. Click Select Icon, in the Dashboard options pop-up window, and choose from the list the icon you want to set.
   
3. Click OK.

The icon appears next to the report name on the Analytics page in the portal.