{"revision":"c10276e953456835cdbb1f3a60d58ae1980be353","document":{"id":36186,"path":"now-intelligence/reporting/c_EmbeddingReportsInJelly.md","title":"Embedding reports in Jelly","bundle":null,"doc_type":null,"release":"australia","body":"\n# Embedding reports in Jelly\n\nYou can embed reports in any Jelly-based element, such as a UI page.\n\n## Enabling Embedding\n\nTo enable embedding reports in Jelly, add the following element to your Jelly code.\n\n``\n\nAfter adding this code, you can embed an existing report, or generate a report within the Jelly code.\n\n## Embedding an existing report\n\nYou can embed an existing report by calling the `embedReportById(targetSpan, reportId)` function.\n\nFor example, add the following to the HTML/XML block in the UI page record:\n\n```\n\n \n \n
\n \n\n```\n\nAnd add the following to the Client script block in the UI page record. Replace <report sys\\_id> with the report's actual sys\\_id:\n\n```\nvar div = $j(\"#report_stuff\");\nembedReportById(div, <\"report sys_id\">);\n```\n\nAlternatively, 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:\n\n```\n\n \n \n
\n \n \n```\n\n|Parameter|Description|\n|---------|-----------|\n|targetSpan|The jQuery element to embed the chart in. The chart uses the size of this element.|\n|reportId|The sys\\_id of the report you want to embed.|\n\n## Generate and embed a report\n\nYou 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.\n\nFor example, add the following to the HTML/XML block in the UI page record:\n\n```\n\n \n \n
\n \n\n```\n\nAnd add the following to the Client script block in the UI page record:\n\n```\nvar params = {sysparm_title: \"Average for all ratings\", sysparm_field: \"category\", sysparm_type: \"bar\", sysparm_table: \"asmt_category_result\", sysparm_aggregate: \"AVG\", sysparm_sumfield: \"rating\"}; \nvar div = $j(\"#report_stuff\");\nembedReportByParams(div, params);\n```\n\nAlternatively, you can embed the JavaScript inside the jelly code. Add the code from the client script block between <script> tags:\n\n```\n\n \n \n
\n \n \n\n```\n\n|Parameter|Description|\n|---------|-----------|\n|targetSpan|The jQuery element to embed the chart in.|\n|parms|A JSON object defining the report. Available parameters depend on the report type.|\n\n## Generating and embedding a list report\n\nWhen you embed an existing list report or generate a list report and embed it, you must enter one more line of code.\n\nAdd the following to the HTML/XML block in the UI page record:\n\n```\n\n \n \n \n
\n \n\n```\n\nAdd the following to the Client script block in the UI page record. Replace <report sys\\_id> with the report's actual sys\\_id:\n\n```\nvar div = $j(\"#report_stuff\");\nembedReportById(div, <\"report sys_id\">);\n```\n\nOr embed the JavaScript in the jelly code entirely in the HTML/XML block. Add the code from the client script block between <script> tags:\n\n```\n\n \n \n \n
\n \n \n```\n\n|Parameter|Description|\n|---------|-----------|\n|targetSpan|The jQuery element to embed the chart in. The chart uses the size of this element.|\n|reportId|The sys\\_id of the report you want to embed.|\n\n**Parent Topic:**[Advanced Core UI reporting topics](https://raw.githubusercontent.com/ServiceNow/ServiceNowDocs/australia/markdown/australia/now-intelligence/reporting/c_AdvancedReporting.md)\n\n## Embedded report parameters\n\nWhen embedding a report in a Jelly element, you can define a report at any time by passing parameters.\n\n### Common parameters\n\nCertain parameters are used by multiple report types.\n\n\n
\n\nParameter\n\n\n\nDescription\n\n\n\nDefault value\n\n
\n\njvar\\_report\\_id\n\n\n\nThe sys\\_id of a report record. If you pass this parameter, do not specify any other parameters. All values are taken from the report record.\n\n\n\n \n\n
\n\nsysparm\\_report\\_id\n\n\n\nUse this parameter instead of jvar\\_report\\_id when you want to override any of the other sysparm parameters that exist in the report.\n\n\n\n \n\n
\n\nsysparm\\_title\n\n\n\nThe title of the report.\n\n\n\n \n\n
\n\nsysparm\\_table\n\n\n\nThe table to report on. Specify this value or sysparm\\_report\\_source\\_id, but not both.\n\n\n\n \n\n
\n\nsysparm\\_report\\_source\\_id\n\n\n\nThe sys\\_id of a report source. Specify this value or sysparm\\_table, but not both. This value is used instead of sysparm\\_table if you pass both.\n\n\n\n \n\n
\n\nsysparm\\_type\n\n\n\nThe type of report to create. Possible values: list, line, line\\_bar, area, spline, bar, horizontal\\_bar, pareto, hist, pie, donut, semi\\_donut, speedometer, dial, pivot, pivot\\_v2, funnel, calendar, pyramid, box, trend, control, trendbox, and heat map.\n\n\n\nline\n\n
\n\nsysparm\\_field\n\n\n\nThe field from the specified table to group data by. Required for time series, column, bar, pie, donut, funnel, pyramid, box, trend, and trendbox reports. Optional for list reports.\n\n\n\n \n\n
\n\nsysparm\\_query\n\n\n\nThe filter to apply to the data before generating the report. Specify a query string for this value. To sort your query results by a specific field, add `^ORDERBY` or `^ORDERBYDES` to the end of the query string. ORDERBY sorts the query by ascending order. ORDERBYDES sorts the query by descending order.\n\n\n\n \n\n
\n\nsysparm\\_aggregate\n\n\n\nThe aggregation type.Possible values: AVG, COUNT, SUM, and COUNT\\_DISTINCT\n\n\n\nCOUNT\n\n
\n\nsysparm\\_sumfield\n\n\n\nThe field to aggregate data on. This parameter does not apply when using a COUNT aggregation type.\n\n\n\n \n\n
\n\nsysparm\\_display\\_grid\n\n\n\nA true/false value that controls whether the report displays a data grid.\n\n\n\nfalse\n\n
\n\nsysparm\\_show\\_other\n\n\n\nA true/false value that controls whether the Other group appears on the report. This group appears only if the number of groups exceeds the number specified in the sysparm\\_others parameter. This parameter applies to bar, pie, funnel, pyramid, pivot, and heat map reports.\n\n\n\ntrue\n\n
\n\nsysparm\\_others\n\n\n\nThe maximum number of individual groups of data to display. Any additional data groups are combined into the Other group. This parameter applies to bar, pie, funnel, pyramid, pivot, and heat map reports.\n\n\n\n \n\n
\n\nsysparm\\_source\\_type\n\n\n\nThe source of the embedded report. Optional.Possible values: table, metricbase, source, import\n\n\n\ntable\n\n
\n\nsysparm\\_set\\_color\n\n\n\nThe color setting for the report.Possible values: one\\_color, color\\_palette, several\\_colors\n\n\n\ncolor\\_palette\n\n
\n\nsysparm\\_color\\_palette\n\n\n\nThe color palette that the report uses. This parameter is used when sysparm\\_set\\_color=\"color\\_palette\".Possible value: The sys\\_id of a color palette\n\n\n\nDefault UI14\n\n
\n\nsysparm\\_color\n\n\n\nThe color that the report uses. This parameter is used when sysparm\\_set\\_color=\"one\\_color\".Possible value: The sys\\_id of a color\n\n\n\n \n\n
\n\nsysparm\\_chart\\_colors\n\n\n\nThe set of chart colors that the report uses. This parameter is used when sysparm\\_set\\_color=\"several\\_colors\".Possible value: A comma-separated list of color hex codes\n\n\n\n \n\n
\n\nsysparm\\_show\\_marker\n\n\n\nA marker is the value represented by a dot in a line or another graphic element in a chart. This parameter is a true/false value that controls whether the marker appears.\n\n\n\ntrue\n\n
\n\nsysparm\\_show\\_empty\n\n\n\nA true/false value that controls if records with empty grouping or trend values appear on the report.\n\n\n\nfalse\n\n
\n\nsysparm\\_stack\\_field\n\n\n\nThe field used to control stacking on bar and column reports.\n\n\n\n \n\n
\n\nsysparm\\_bar\\_unstack\n\n\n\nA true/false value that controls if stacked data is presented as a single bar or column, or as multiple bars.\n\n\n\nfalse\n\n
\n\nsysparm\\_box\\_field\n\n\n\nThe numeric field used to measure the data. This parameter is required for box and histogram reports.\n\n\n\n \n\n
\n\nsysparm\\_trend\\_field\n\n\n\nThe date-time field used to organize trend data. This parameter is required for time series, trend, and box reports.\n\n\n\n \n\n
\n\nsysparm\\_trend\\_interval\n\n\n\nThe interval to measure trend values by. Possible values: year, quarter, month, week, dayofweek, hour, and date.\n\n\n\nyear\n\n
\n\nsysparm\\_compute\\_percent\n\n\n\nThe value to use when displaying report percentages. You can display percentages based on the total record count, or by the specified aggregate.Possible values: aggregate and count\n\n\n\ncount\n\n
\n\nsysparm\\_funnel\\_neck\\_percent\n\n\n\nA number 1–100 that defines the percentage of a funnel report that is the neck of the funnel.\n\n\n\n30\n\n
\n\nsysparm\\_show\\_chart\\_data\\_label\n\n\n\nA true/false value that controls if data labels appear on the report.\n\n\n\nfalse\n\n
\n\nsysparm\\_show\\_zero\n\n\n\nA true/false value that controls if zeroes appear on multilevel pivot and heat map reports.\n\n\n\n \n\n
\n\nsysparm\\_ct\\_row\n\n\n\nThe field used to define the rows in heat map and bubble reports.\n\n\n\n \n\n
\n\nsysparm\\_ct\\_column\n\n\n\nThe field used to define the columns in heat map and bubble reports.\n\n\n\n \n\n
\n\nsysparm\\_y\\_axis\\_category\\_fields\n\n\n\nThe field used to define the rows in multilevel pivot reports. Specify up to five comma-separated field names.\n\n\n\n \n\n
\n\nsysparm\\_x\\_axis\\_category\\_fields\n\n\n\nThe field used to define the columns in multilevel pivot reports. Specify up to three comma-separated field names.\n\n\n\n \n\n
\n\nsysparm\\_list\\_ui\\_view\n\n\n\nThe sys\\_id of a list view to use when a user drills into the report.\n\n\n\n \n\n
\n\nsysparm\\_show\\_marker\n\n\n\nA true/false value that controls if markers appear at every plotted point on a report.\n\n\n\ntrue\n\n
\n\nsysparm\\_apply\\_alias\n\n\n\nA true/false value that controls if configured aliases appear in embedded reports.\n\n\n\n \n\n
### Service catalog parameters\n\nCertain 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.\n\n|Parameter|Description|\n|---------|-----------|\n|sysparm\\_sc\\_groupby\\_item\\_id|The sys\\_id of a catalog item. Use this parameter with the **sysparm\\_sc\\_groupby\\_variable\\_id** parameter to group a service catalog report based on a catalog variable value. These parameters replace the**sysparm\\_field** parameter when grouping on service catalog variables.|\n|sysparm\\_sc\\_groupby\\_variable\\_id|The sys\\_id of the catalog item variable used to determine how data is grouped on the report. This variable must belong to the catalog item specified in the **sysparm\\_sc\\_groupby\\_item\\_id**parameter.|\n|sysparm\\_sc\\_stackby\\_item\\_id|The sys\\_id of a catalog item. Use this parameter with the**sysparm\\_sc\\_stackby\\_variable\\_id** parameter to stack a service catalog report based on a catalog variable value. These parameters replace the **sysparm\\_stack\\_field** parameter when grouping on service catalog variables. Only reports that support stacking, such as bar reports, support these parameters.|\n|sysparm\\_sc\\_stackby\\_variable\\_id|The sys\\_id of the catalog item variable used to determine how data is grouped on the report. This variable must belong to the catalog item specified in the **sysparm\\_sc\\_stackby\\_item\\_id**parameter.|\n\n### MetricBase parameters\n\nTo use MetricBase in an embedded report, the sysparm\\_source\\_type parameter must be set to \"metricbase\".\n\nMetricBase also requires the sysparm\\_custom\\_configuration parameter, which has the following syntax:\n\n```\nsysparm_custom_config: \"{query_condition:\\\"\\\",transforms:[{transform:{transform:\\\"Reference\\\",name:\\\"chart-subjects\\\"},metric:\\\"mb_metricname\\\"}], group_by:\\\"\\\", table:\\\"mb_tablename\\\"}\"; \n```\n\nIn this syntax:\n\n- A `transform` is a chain of nested transform functions. The last transform of every chain must always be the Reference transform:\n\n ```\n {transform:\\\"Reference\\\",name:\\\"chart-subjects\\\"}\n ```\n\n- A `metric` is a metric field of a metric table.\n- The `group-by` field is the field on the selected metric table by which the time series is grouped.\n- `table` refers to the metric table\n- `mb_...` are placeholder names\n\nAll attributes are required except for `group-by`.\n\n### Chart-specific parameters\n\nCertain parameters are available only for specific report types.\n\n|Parameter|Description|Default value|\n|---------|-----------|-------------|\n|sysparm\\_show\\_chart\\_total|A true/false value that controls if the total score of the grouped donut appears in the center of the report.|false|\n|sysparm\\_donut\\_width\\_percent|A number 1–100 that controls the thickness of the donut report.|50|\n\n|Parameter|Description|Default value|\n|---------|-----------|-------------|\n|sysparm\\_use\\_color\\_heatmap|A true/false value that controls if the heatmap uses a gradient to color the report. When true, the sysparm\\_axis\\_max\\_color and sysparm\\_axis\\_min\\_color values are used.|true|\n|sysparm\\_axis\\_max\\_color|The color used in the heatmap gradient to indicate a high value. This value must be the sys\\_id of a Color Definition \\[sys\\_report\\_color\\] record.|UI14 blue|\n|sysparm\\_axis\\_min\\_color|The color used in the heatmap gradient to indicate a low value. This value must be the sys\\_id of a Color Definition \\[sys\\_report\\_color\\] record.|white|\n\n\n
\n\nParameter\n\n\n\nDescription\n\n\n\nDefault value\n\n
\n\nsysparm\\_gauge\\_autoscale\n\n\n\nA true/false value that controls if the dial automatically calculates the minimum and maximum scale on the report. If you set this value to false, you must specify a sysparm\\_from and sysparm\\_to value.\n\n\n\ntrue\n\n
\n\nsysparm\\_from\n\n\n\nA number that defines the minimum value for the axis scale.\n\n\n\n \n\n
\n\nsysparm\\_to\n\n\n\nA number that defines the maximum value for the axis scale.\n\n\n\n \n\n
\n\nsysparm\\_upper\\_limit\n\n\n\nA number that defines the upper threshold for the dial. If you do not specify a value, the dial has no upper threshold.\n\n\n\n \n\n
\n\nsysparm\\_lower\\_limit\n\n\n\nA number that defines the lower threshold for the dial. If you do not specify a value, the dial has no lower threshold.\n\n\n\n \n\n
\n\nsysparm\\_direction\n\n\n\nA value that controls which values are considered positive on the report, lower values or higher values. Possible values: minimize and maximize.\n\n\n\nminimize\n\n
### Chart size parameters\n\nCertain parameters control the width and height of the report.\n\n|Parameter|Description|Default value|\n|---------|-----------|-------------|\n|sysparm\\_chart\\_size|The size of the chart in the report. Valid values are small, medium, and large.|large|\n|sysparm\\_custom\\_chart\\_size|Enable this parameter to specify custom chart height and width values instead of using a size option from the **sysparm\\_chart\\_size** parameter.|false|\n|sysparm\\_custom\\_chart\\_height|The height of the chart in the report, in pixels.| |\n|sysparm\\_custom\\_chart\\_width|The width of the chart in the report, in pixels.| |\n\n### Chart title parameters\n\nCertain 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.\n\n\n
\n\nParameter\n\n\n\nDescription\n\n\n\nDefault value\n\n
\n\nsysparm\\_report\\_title\\_size\n\n\n\nA number that defines the font size of the title.\n\n\n\n16\n\n
\n\nsysparm\\_report\\_title\\_color\n\n\n\nThe title text color. This value must be the sys\\_id of a Color Definition \\[sys\\_report\\_color\\] record.\n\n\n\nblack\n\n
\n\nsysparm\\_title\\_horizontal\\_alignment\n\n\n\nWhere the title is placed horizontally relative to the report. This value is used only if sysparm\\_custom\\_report\\_title\\_position is false.Possible values are: left, center, and right.\n\n\n\ncenter\n\n
\n\nsysparm\\_title\\_vertical\\_alignment\n\n\n\nWhere the title is placed vertically relative to the report. This value is used only if sysparm\\_custom\\_report\\_title\\_position is false.Possible values: top, middle, and bottom.\n\n\n\ntop\n\n
\n\nsysparm\\_custom\\_report\\_title\\_position\n\n\n\nA true/false value that controls whether the x and y coordinates define the report title position instead of relative alignment.\n\n\n\nfalse\n\n
\n\nsysparm\\_report\\_title\\_x\\_position\n\n\n\nA number that defines the x position of the title on the report. This value is used only if sysparm\\_custom\\_report\\_title\\_position is true.\n\n\n\n0\n\n
\n\nsysparm\\_report\\_title\\_y\\_position\n\n\n\nA number that defines the y position of the title on the report. This value is used only if sysparm\\_custom\\_report\\_title\\_position is true.\n\n\n\n0\n\n
### Chart border parameters\n\nCertain 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.\n\n|Parameter|Description|Default value|\n|---------|-----------|-------------|\n|sysparm\\_show\\_report\\_border|A true/false value that controls whether the report displays a border.|false|\n|sysparm\\_report\\_border\\_width|A number that defines the width of the border, in pixels.|1|\n|sysparm\\_report\\_border\\_radius|A number that defines the radius size of the corners of the border, in pixels.|0|\n\n### Legend parameters\n\nCertain 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.\n\n\n
\n\nParameter\n\n\n\nDescription\n\n\n\nDefault value\n\n
\n\nsysparm\\_show\\_legend\n\n\n\nA true/false value that controls whether the report displays a legend.\n\n\n\ntrue\n\n
\n\nsysparm\\_legend\\_horizontal\\_alignment\n\n\n\nWhere the legend is placed horizontally relative to the report.Possible values: left, center, and right.\n\n\n\ncenter\n\n
\n\nsysparm\\_legend\\_vertical\\_alignment\n\n\n\nWhere the legend is placed vertically relative to the report.Possible values: top, middle, and bottom.\n\n\n\nbottom\n\n
\n\nsysparm\\_show\\_legend\\_border\n\n\n\nA true/false value that controls whether the legend displays a border.\n\n\n\ntrue\n\n
\n\nsysparm\\_legend\\_border\\_width\n\n\n\nA number that defines the width of the legend border, in pixels.\n\n\n\n1\n\n
\n\nsysparm\\_legend\\_border\\_radius\n\n\n\nA number that defines the radius size of the corners of the legend border, in pixels.\n\n\n\n0\n\n
### X-axis parameters\n\nCertain 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.\n\n|Parameter|Description|Default value|\n|---------|-----------|-------------|\n|sysparm\\_x\\_axis\\_title|The name to display on the x axis.| |\n|sysparm\\_x\\_axis\\_title\\_size|A number that defines the font size of the x-axis title.| |\n|sysparm\\_x\\_axis\\_title\\_bold|A true/false value that controls whether the x-axis title text is bold.|true|\n|sysparm\\_x\\_axis\\_opposite|A true/false value that controls if the x axis appears at the top of the report.|false|\n|sysparm\\_x\\_axis\\_display\\_grid|A true/false value that controls if vertical grid lines appear from the x axis.|false|\n|sysparm\\_x\\_axis\\_grid\\_dotted|A true/false value that controls whether the vertical grid lines are dotted.|false|\n|sysparm\\_x\\_axis\\_label\\_size|A number that defines the font size for increment labels on the x axis.|11|\n|sysparm\\_x\\_axis\\_label\\_bold|A true/false value that controls whether the x-axis increment labels are bold.|false|\n\n### Y-axis parameters\n\nCertain 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.\n\n|Parameter|Description|Default value|\n|---------|-----------|-------------|\n|sysparm\\_y\\_axis\\_title|The name to display on the y axis.|An automatically generated description of the report aggregation|\n|sysparm\\_y\\_axis\\_title\\_size|A number that defines the font size of the y-axis title.| |\n|sysparm\\_y\\_axis\\_title\\_bold|A true/false value that controls whether the y-axis title text is bold.|true|\n|sysparm\\_y\\_axis\\_opposite|A true/false value that controls if the y axis appears on the left of the report.|false|\n|sysparm\\_y\\_axis\\_display\\_grid|A true/false value that controls if horizontal grid lines appear from the y axis.|true|\n|sysparm\\_y\\_axis\\_grid\\_dotted|A true/false value that controls whether the horizontal grid lines are dotted.|false|\n|sysparm\\_y\\_axis\\_label\\_size|A number that defines the font size for increment labels on the y axis.|12|\n|sysparm\\_y\\_axis\\_label\\_bold|A true/false value that controls whether the y-axis increment labels are bold.|false|\n|sysparm\\_y\\_axis\\_from|A number defining the lowest value displayed on the y axis.| |\n|sysparm\\_y\\_axis\\_to|A number defining the highest value displayed on the y axis.| |\n\n"}}