Embedding reports in Jelly

You can embed reports in any Jelly-based element, such as a UI page.

Enabling Embedding

To enable embedding reports in Jelly, add the following element to your Jelly code.

<g:inline template="reporting_includes.xml" />

After adding this code, you can embed an existing report, or generate a report within the Jelly code.

Embedding an existing report

You can embed an existing report by calling the embedReportById(targetSpan, reportId) function.

For example, add the following to the HTML/XML block in the UI page record:

<xml version="1.0" encoding="utf-8">
     <j:jelly trim="false" xmlns:j="jelly:core" xmlns:g="glide" xmlns:j2="null" xmlns:g2="null">
     <g:inline template="reporting_includes.xml" />
     <div id="report_stuff" />
     </j:jelly>

And add the following to the Client script block in the UI page record. Replace <report sys_id> with the report's actual sys_id:

var div = $j("#report_stuff");
embedReportById(div, <"report sys_id">);

Alternatively, you can embed the JavaScript in the jelly code entirely in the HTML/XML block. Add the code from the client script block between <script> tags:

<xml version="1.0" encoding="utf-8">
     <j:jelly trim="false" xmlns:j="jelly:core" xmlns:g="glide" xmlns:j2="null" xmlns:g2="null">
     <g:inline template="reporting_includes.xml" />
     <div id="report_stuff" />     
     <script>
          var div = $j("#report_stuff");
          embedReportById(div, <"report sys_id">);
     </script>
     </j:jelly>

Generate and embed a report

You can embed a report within the UI by calling the embedReportByParams(targetSpan, parms) function. When embedding a report in this way, you can generate a new report using parameters, or specify a report sys_id to display that report.

For example, add the following to the HTML/XML block in the UI page record:

<xml version="1.0" encoding="utf-8">
     <j:jelly trim="false" xmlns:j="jelly:core" xmlns:g="glide" xmlns:j2="null" xmlns:g2="null">
     <g:inline template="reporting_includes.xml" />
     <div id="report_stuff" />
     </j:jelly>

And add the following to the Client script block in the UI page record:

var params = {sysparm_title: "Average for all ratings", sysparm_field: "category", sysparm_type: "bar", sysparm_table: "asmt_category_result", sysparm_aggregate: "AVG", sysparm_sumfield: "rating"}; 
var div = $j("#report_stuff");
embedReportByParams(div, params);

Alternatively, you can embed the JavaScript inside the jelly code. Add the code from the client script block between <script> tags:

<xml version="1.0" encoding="utf-8">
     <j:jelly trim="false" xmlns:j="jelly:core" xmlns:g="glide" xmlns:j2="null" xmlns:g2="null">
     <g:inline template="reporting_includes.xml" />
     <div id="report_stuff" />
     <script>
          var params = {sysparm_title: "Average for all ratings", sysparm_field: "category", sysparm_type: "bar", sysparm_table: "asmt_category_result", sysparm_aggregate: "AVG", sysparm_sumfield: "rating"};
          var div = $j("#report_stuff");
          embedReportByParams(div, params);
     </script>
     </j:jelly>

Generating and embedding a list report

When you embed an existing list report or generate a list report and embed it, you must enter one more line of code.

Add the following to the HTML/XML block in the UI page record:

<xml version="1.0" encoding="utf-8">
     <j:jelly trim="false" xmlns:j="jelly:core" xmlns:g="glide" xmlns:j2="null" xmlns:g2="null">
     <g:inline template="reporting_includes.xml" />
     <g:inline template="list2_js_includes.xml" />  
     <div id="report_stuff" />
     </j:jelly>

Add the following to the Client script block in the UI page record. Replace <report sys_id> with the report's actual sys_id:

var div = $j("#report_stuff");
embedReportById(div, <"report sys_id">);

Or embed the JavaScript in the jelly code entirely in the HTML/XML block. Add the code from the client script block between <script> tags:

<xml version="1.0" encoding="utf-8">
     <j:jelly trim="false" xmlns:j="jelly:core" xmlns:g="glide" xmlns:j2="null" xmlns:g2="null">
     <g:inline template="reporting_includes.xml" />
     <g:inline template="list2_js_includes.xml" />
     <div id="report_stuff" />     
     <script>
          var div = $j("#report_stuff");
          embedReportById(div, <"report sys_id">);
     </script>
     </j:jelly>

Parent Topic:Advanced Core UI reporting topics

Embedded report parameters

When embedding a report in a Jelly element, you can define a report at any time by passing parameters.

Common parameters

Certain parameters are used by multiple report types.

Service catalog parameters

Certain parameters apply only to reports created on service catalog tables, such as the Requested Item [sc_req_item] table. These parameters are not available on list or calendar type reports.

MetricBase parameters

To use MetricBase in an embedded report, the sysparm_source_type parameter must be set to "metricbase".

MetricBase also requires the sysparm_custom_configuration parameter, which has the following syntax:

sysparm_custom_config: "{query_condition:\"\",transforms:[{transform:{transform:\"Reference\",name:\"chart-subjects\"},metric:\"mb_metricname\"}], group_by:\"\", table:\"mb_tablename\"}"; 

In this syntax:

• A transform is a chain of nested transform functions. The last transform of every chain must always be the Reference transform:

  {transform:\"Reference\",name:\"chart-subjects\"}
  

• A metric is a metric field of a metric table.

• The group-by field is the field on the selected metric table by which the time series is grouped.
• table refers to the metric table
• mb_... are placeholder names

All attributes are required except for group-by.

Chart-specific parameters

Certain parameters are available only for specific report types.

Chart size parameters

Certain parameters control the width and height of the report.

Chart title parameters

Certain parameters are available only for reports that display a title. These report types include time series, bar, column, pie, donut, dials, trend, box, trend box, histogram, pyramid, heat map, funnel, and control reports.

Chart border parameters

Certain parameters are available only for reports that display a border. These report types include: time series, bar, column, pies, donuts, dials, trend, box, trend box, histogram, pyramid, heat map, funnel, and control reports.

Legend parameters

Certain parameters are available only for reports that display a legend. These report types include pie, donut, stacked bar, stacked column, time series, trend, box, histogram, pyramid, control, and heat map reports.

X-axis parameters

Certain parameters are available only for reports that use an X axis. These report types include bar, horizontal bar, pareto, column, line area, spline, box, trendbox, control, and trend reports.

Y-axis parameters

Certain parameters are available only for reports that use a Y axis. These report types include bar, horizontal bar, Pareto, column, line area, spline, box, trendbox, control, and trend reports.