Berichte in Jelly einbetten
Sie können Berichte in jedes Jelly-basierte Element einbetten, z. B. in eine UI-Seite.
Einbettung aktivieren
Um das Einbetten von Berichten in Jelly zu ermöglichen, fügen Sie Ihrem Jelly-Code das folgende Element hinzu.
<g:inline template="reporting_includes.xml" />
Nach dem Hinzufügen dieses Codes können Sie einen vorhandenen Bericht einbetten oder einen Bericht innerhalb des Jelly-Codes generieren.
Vorhandene Berichte einbetten
Sie können einen vorhandenen Bericht einbetten, indem Sie die Funktion embedReportById(targetSpan, reportId) aufrufen.
<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>
var div = $j("#report_stuff");
embedReportById(div, <"report sys_id">);<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>| Parameter | Beschreibung |
|---|---|
| targetSpan | Das jQuery-Element, in das das Diagramm eingebettet werden soll. Das Diagramm verwendet die Größe dieses Elements. |
| reportId | Die sys_id des Berichts, den Sie einbetten möchten. |
Berichte generieren und einbetten
Sie können einen Bericht in die Benutzeroberfläche einbetten, indem Sie die Funktion embedReportByParams(targetSpan, parms) aufrufen. Wenn Sie einen Bericht auf diese Weise einbetten, können Sie einen neuen Bericht mithilfe von Parametern generieren oder eine Berichts-sys_id angeben, um diesen Bericht anzuzeigen.
<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>
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);<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>
| Parameter | Beschreibung |
|---|---|
| targetSpan | Das jQuery-Element, in das das Diagramm eingebettet werden soll. |
| parms | Ein JSON-Objekt, das den Bericht definiert. Die verfügbaren Parameter hängen von dem Berichtstyp ab. |
Listenbericht wird generiert und eingebettet
Wenn Sie einen vorhandenen Listenbericht einbetten oder einen Listenbericht generieren und einbetten, müssen Sie eine weitere Codezeile eingeben.
<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>
var div = $j("#report_stuff");
embedReportById(div, <"report sys_id">);<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>| Parameter | Beschreibung |
|---|---|
| targetSpan | Das jQuery-Element, in das das Diagramm eingebettet werden soll. Das Diagramm verwendet die Größe dieses Elements. |
| reportId | Die sys_id des Berichts, den Sie einbetten möchten. |
Eingebettete Berichtsparameter
Wenn Sie einen Bericht in ein Jelly-Element einbetten, können Sie jederzeit einen Bericht definieren, indem Sie Parameter übergeben.
Häufige Parameter
Bestimmte Parameter werden von mehreren Berichtstypen verwendet.
| Parameter | Beschreibung | Standardwert |
|---|---|---|
| jvar_report_id | Die sys_id eines Berichtsdatensatzes. Wenn Sie diesen Parameter übergeben, geben Sie keine anderen Parameter an. Alle Werte werden dem Berichtsdatensatz entnommen. | |
| sysparm_report_id | Verwenden Sie diesen Parameter anstelle von „jvar_report_id“, wenn Sie einen der anderen im Bericht vorhandenen Sysparm-Parameter überschreiben möchten. | |
| sysparm_title | Der Name des Berichts | |
| sysparm_table | Die Tabelle, über die berichtet werden soll. Geben Sie diesen Wert oder sysparm_report_source_id, aber nicht beide an. | |
| sysparm_report_source_id | Die sys_id einer Berichtsquelle. Geben Sie diesen Wert oder sysparm_table an, aber nicht beide. Dieser Wert wird anstelle von sysparm_table verwendet, wenn Sie beide übergeben. | |
| sysparm_type | Der Typ des zu erstellenden Berichts. Mögliche Werte: Liste, Linie, Linie_Leiste, Bereich, Spline, Balken, horizontale_Leiste, Pareto, hist, Kreis, Ring, Halbring, Tachometer, Skala, Pivot, Pivot_v2, Trichter, Kalender, Pyramide, Box, Trend, Steuerung, Trendbox und Heatmap. |
Zeile |
| sysparm_field | Das Feld aus der angegebenen Tabelle, um Daten zu gruppieren. Erforderlich für Zeitreihen-, Spalten-, Balken-, Kreis-, Ring-, Trichter-, Pyramiden-, Feld-, Trend- und Trendbox-Berichte. Optional für Listenberichte. | |
| sysparm_query | Der Filter, der vor dem Erstellen des Berichts auf die Daten angewendet wird. Geben Sie eine Abfragezeichenfolge für diesen Wert an. Um Ihre Abfrageergebnisse nach einem bestimmten Feld zu sortieren, fügen Sie ^ORDERBY<field_name> oder ^ORDERBYDES<field_name> am Ende der Abfragezeichenfolge hinzu. ORDERBY sortiert die Abfrage in aufsteigender Reihenfolge. ORDERBYDES sortiert die Abfrage in absteigender Reihenfolge. |
|
| sysparm_aggregate | Der Zusammenfassungstyp. Mögliche Werte: AVG, COUNT, SUM und COUNT_DISTINCT |
ANZAHL |
| sysparm_sumfield | Das Feld, anhand dessen Daten zusammengefasst werden. Dieser Parameter gilt nicht, wenn Sie den Zusammenfassungstyp COUNT verwenden. | |
| sysparm_display_grid | Ein Wahr/Falsch-Wert, der steuert, ob im Bericht ein Datenraster angezeigt wird. | falsch |
| sysparm_show_other | Ein Wahr/Falsch-Wert, der steuert, ob die Gruppe „Andere“ im Bericht angezeigt wird. Diese Gruppe wird nur angezeigt, wenn die Anzahl der Gruppen die im Parameter sysparm_others angegebene Anzahl überschreitet. Dieser Parameter gilt für Balken-, Kreis-, Funnel-, Pyramiden-, Pivot- und Heatmap-Berichte. | true |
| sysparm_others | Die maximale Anzahl der einzelnen anzuzeigenden Datengruppen. Alle weiteren Datengruppen werden zur Gruppe „Andere“ zusammengefasst. Dieser Parameter gilt für Balken-, Kreis-, Funnel-, Pyramiden-, Pivot- und Heatmap-Berichte. | |
| sysparm_source_type | Die Quelle des eingebetteten Berichts. Optional. Mögliche Werte: table, metricbase, source, import |
Tabelle |
| sysparm_set_color | Die Farbeinstellung für den Bericht. Mögliche Werte: „one_color“, „color_palette“, „mehrere_farben“. |
color_palette |
| sysparm_color_palette | Die Farbpalette, die der Bericht verwendet. Dieser Parameter wird verwendet, wenn sysparm_set_color="color_palette". Möglicher Wert: die sys_id einer Farbpalette |
Default UI14 |
| sysparm_color | Die Farbe, die der Bericht verwendet. Dieser Parameter wird verwendet, wenn sysparm_set_color="one_color". Möglicher Wert: die sys_id einer Farbe |
|
| sysparm_chart_colors | Die Menge der Diagrammfarben, die der Bericht verwendet. Dieser Parameter wird verwendet, wenn sysparm_set_color="multiple_colors". Möglicher Wert: eine durch Kommas getrennte Liste von farbigen Hex-Codes |
|
| sysparm_show_marker | Eine Markierung ist der Wert, der durch einen Punkt in einer Linie oder ein anderes grafisches Element in einem Diagramm dargestellt wird. Dieser Parameter ist ein Wahr/Falsch-Wert, der steuert, ob die Markierung angezeigt wird. | wahr |
| sysparm_show_empty | Ein Wahr/Falsch-Wert, der steuert, ob Datensätze mit leeren Gruppierungs- oder Trendwerten im Bericht angezeigt werden. | falsch |
| sysparm_stack_field | Das Feld, das zum Steuern der Stapelung von Balken- und Spaltenberichten verwendet wird | |
| sysparm_bar_unstack | Ein Wahr/Falsch-Wert, der steuert, ob gestapelte Daten als einzelner Balken oder Spalte oder als mehrere Balken dargestellt werden. | falsch |
| sysparm_box_field | Das numerische Feld, das zum Messen der Daten verwendet wird. Dieser Parameter ist für Box- und Histogrammberichte erforderlich. | |
| sysparm_trend_field | Das Datum/Uhrzeit-Feld, das zum Organisieren von Trenddaten verwendet wird. Dieser Parameter ist für Zeitreihen-, Trend- und Box-Berichte erforderlich. | |
| sysparm_trend_interval | Das Intervall, nach dem Trendwerte gemessen werden. Mögliche Werte: Jahr, Quartal, Monat, Woche, Wochentag, Stunde und Datum. |
Jahr |
| sysparm_compute_percent | Der Wert, der beim Anzeigen von Berichtsprozenten verwendet werden soll. Sie können Prozentsätze basierend auf der Gesamtzahl der Datensätze oder nach der angegebenen Zusammenfassung anzeigen. Mögliche Werte: „aggregat“ und „count“. |
count |
| sysparm_funnel_neck_percent | Eine Zahl zwischen 1 und 100, die den Prozentsatz eines Funnelberichts definiert, der den Hals des Funnels bildet | 30 |
| sysparm_show_chart_data_label | Ein Wahr/Falsch-Wert, der steuert, ob Datenbezeichnungen im Bericht angezeigt werden. | falsch |
| sysparm_show_zero | Ein Wahr/Falsch-Wert, der steuert, ob Nullen in Pivot- und Heatmap-Berichten mit mehreren Ebenen angezeigt werden. | |
| sysparm_ct_row | Das Feld zum Definieren der Zeilen in Heatmap- und Bubble-Berichten | |
| sysparm_ct_column | Das Feld zum Definieren der Spalten in Heatmap- und Bubble-Berichten | |
| sysparm_y_axis_category_fields | Das Feld, das zum Definieren der Zeilen in Pivot-Berichten mit mehreren Ebenen verwendet wird. Geben Sie bis zu fünf durch Kommas getrennte Feldnamen an. | |
| sysparm_x_axis_category_fields | Das Feld, das zum Definieren der Spalten in Pivot-Berichten mit mehreren Ebenen verwendet wird. Geben Sie bis zu drei durch Kommas getrennte Feldnamen an. | |
| sysparm_list_ui_view | Die sys_id einer Listenansicht, die verwendet wird, wenn ein Benutzer den Bericht einleitet | |
| sysparm_show_marker | Ein Wahr/Falsch-Wert, der steuert, ob an jedem aufgezeichneten Punkt in einem Bericht Markierungen angezeigt werden. | wahr |
| sysparm_apply_alias | Ein Wahr/Falsch-Wert, der steuert, ob konfigurierte Aliasse in eingebetteten Berichten angezeigt werden. |
Servicekatalog-Parameter
| Parameter | Beschreibung |
|---|---|
| sysparm_sc_groupby_item_id | Die sys_id eines Katalogelements. Verwenden Sie diesen Parameter mit dem Parameter sysparm_sc_groupby_variable_id, wenn Sie einen Katalogvariablenwert als Grundlage zur Gruppierung eines Servicekatalogberichts verwenden möchten. Diese Parameter ersetzen bei der Gruppierung auf Servicekatalogvariablen den Parameter sysparm_field. |
| sysparm_sc_groupby_variable_id | Die sys_id der Katalogelementvariablen, die verwendet wird, um zu bestimmen, wie Daten im Bericht gruppiert werden. Diese Variable muss zu dem Katalogartikel gehören, der im Parameter sysparm_sc_groupby_item_id angegeben ist. |
| sysparm_sc_stackby_item_id | Die sys_id eines Katalogelements. Verwenden Sie diesen Parameter mit dem Parameter sysparm_sc_stackby_variable_id, wenn Sie einen Katalogvariablenwert als Grundlage zur Stapelung eines Servicekatalogberichts verwenden möchten. Diese Parameter ersetzen bei der Gruppierung auf Servicekatalogvariablen den Parameter sysparm_stack_field. Nur Berichte, die Stapelung unterstützen, z. B. Balkenberichte, unterstützen diese Parameter. |
| sysparm_sc_stackby_variable_id | Die sys_id der Katalogelementvariablen, die verwendet wird, um zu bestimmen, wie Daten im Bericht gruppiert werden. Diese Variable muss zu dem Katalogartikel gehören, der im Parameter sysparm_sc_stackby_item_id angegeben ist. |
MetricBase-Parameter
Um MetricBase in einem eingebetteten Bericht zu verwenden, muss der Parameter sysparm_source_type auf „metricbase“ festgelegt werden.
MetricBase erfordert außerdem den Parameter sysparm_custom_configuration, der folgende Syntax aufweist:
sysparm_custom_config: "{query_condition:\"\",transforms:[{transform:{transform:\"Reference\",name:\"chart-subjects\"},metric:\"mb_metricname\"}], group_by:\"\", table:\"mb_tablename\"}";
- Eine
Transformationist eine Kette von verschachtelten Transformationsfunktionen. Die letzte Transformation jeder Kette muss immer die Referenztransformation sein:{transform:\"Reference\",name:\"chart-subjects\"} - Eine
Metrikist ein metrisches Feld einer Metrik-Tabelle. - Das Feld
Gruppierungist das Feld in der ausgewählten Metrik-Tabelle, nach der die Zeitreihe gruppiert ist. Tabellebezieht sich auf die Metrik-Tabelle.mb_...sind Platzhalternamen.
group-bysind erforderlich.Diagrammspezifische Parameter
Bestimmte Parameter sind nur für bestimmte Berichtstypen verfügbar.
| Parameter | Beschreibung | Standardwert |
|---|---|---|
| sysparm_show_chart_total | Ein Wahr/Falsch-Wert, der steuert, ob die Gesamtpunktzahl des gruppierten Rings in der Mitte des Berichts angezeigt wird. | falsch |
| sysparm_donut_width_percent | Eine Zahl zwischen 1 und 100, die die Dicke des Donut-Berichts steuert | 50 |
| Parameter | Beschreibung | Standardwert |
|---|---|---|
| sysparm_use_color_heatmap | Ein Wahr/Falsch-Wert, der steuert, ob die Heatmap einen Farbverlauf verwendet, um den Bericht zu färben. Wenn der Wert „true“ ist, werden die Werte sysparm_axis_max_color und sysparm_axis_min_color verwendet. | true |
| sysparm_axis_max_color | Die im Heatmap-Gradient verwendete Farbe zur Anzeige eines hohen Wertes. Dieser Wert muss die sys_id eines Farbdefinitionssatzes [sys_report_color] sein. | UI14 blue |
| sysparm_axis_min_color | Die im Heatmap-Gradient verwendete Farbe zur Anzeige eines niedrigen Wertes. Dieser Wert muss die sys_id eines Farbdefinitionssatzes [sys_report_color] sein. | white |
| Parameter | Beschreibung | Standardwert |
|---|---|---|
| sysparm_gauge_autoscale | Ein Wahr/Falsch-Wert, der steuert, ob die Skala die minimale und maximale Skala im Bericht automatisch berechnet. Wenn Sie diesen Wert auf „false“ festlegen, müssen Sie einen sysparm_from- und sysparm_to-Wert angeben. | true |
| sysparm_from | Eine Zahl, die den Mindestwert für die Achsenskala definiert | |
| sysparm_to | Eine Zahl, die den Maximalwert für die Achsenskala definiert | |
| sysparm_upper_limit | Eine Zahl, die den oberen Schwellenwert für die Wählscheibe definiert. Wenn Sie keinen Wert angeben, hat die Wählscheibe keinen oberen Schwellenwert. | |
| sysparm_lower_limit | Eine Zahl, die den unteren Schwellenwert für die Wählscheibe definiert. Wenn Sie keinen Wert angeben, hat die Wählscheibe keinen unteren Schwellenwert. | |
| sysparm_direction | Ein Wert, der steuert, welche Werte für den Bericht als positive, niedrigere oder höhere Werte gelten. Mögliche Werte: minimieren und maximieren. |
minimize |
Diagrammgrößenparameter
| Parameter | Beschreibung | Standardwert |
|---|---|---|
| sysparm_chart_size | Die Größe des Diagramms in dem Bericht. Gültige Werte sind small, medium und large. | large |
| sysparm_custom_chart_size | Aktivieren Sie diesen Parameter, um anwenderdefinierte Werte für die Höhe und Breite des Diagramms anzugeben, anstatt eine Größenoption aus dem Parameter sysparm_chart_size zu verwenden. | falsch |
| sysparm_custom_chart_height | Die Höhe des Diagramms im Bericht in Pixel | |
| sysparm_custom_chart_width | Die Breite des Diagramms im Bericht in Pixel |
Diagrammtitelparameter
| Parameter | Beschreibung | Standardwert |
|---|---|---|
| sysparm_report_title_size | Eine Zahl, die die Schriftgröße des Titels definiert | 16 |
| sysparm_report_title_color | Die Textfarbe des Titels. Dieser Wert muss die sys_id eines Farbdefinitionssatzes [sys_report_color] sein. | black |
| sysparm_title_horizontal_alignment | Wenn der Titel horizontal zum Bericht platziert wird. Dieser Wert wird nur verwendet, wenn sysparm_custom_report_title_position den Wert „false“ hat. Mögliche Werte sind: left, center und right. |
center |
| sysparm_title_vertical_alignment | Wenn der Titel vertikal zum Bericht platziert wird. Dieser Wert wird nur verwendet, wenn sysparm_custom_report_title_position den Wert „false“ hat. Mögliche Werte: oben, Mitte und unten. |
top |
| sysparm_custom_report_title_position | Ein wahr/falsch-Wert, der steuert, ob die x- und y-Koordinaten die Position des Berichtstitels anstelle der relativen Ausrichtung definieren. | falsch |
| sysparm_report_title_x_position | Eine Zahl, die die x-Position des Titels im Bericht definiert. Dieser Wert wird nur verwendet, wenn sysparm_custom_report_title_position den Wert „true“ hat. | 0 |
| sysparm_report_title_y_position | Eine Zahl, die die y-Position des Titels im Bericht definiert. Dieser Wert wird nur verwendet, wenn sysparm_custom_report_title_position den Wert „true“ hat. | 0 |
Diagrammrahmenparameter
| Parameter | Beschreibung | Standardwert |
|---|---|---|
| sysparm_show_report_border | Ein Wahr/Falsch-Wert, der steuert, ob im Bericht ein Rahmen angezeigt wird. | falsch |
| sysparm_report_border_width | Eine Zahl, die die Breite des Rahmens in Pixel definiert | 1 |
| sysparm_report_border_radius | Eine Zahl, die die Radiusgröße der Ecken des Rahmens in Pixel definiert | 0 |
Legendenparameter
| Parameter | Beschreibung | Standardwert |
|---|---|---|
| sysparm_show_legend | Ein wahr/falsch-Wert, der steuert, ob der Bericht eine Legende anzeigt. | wahr |
| sysparm_legend_horizontal_alignment | Wenn die Legende horizontal zum Bericht platziert wird. Mögliche Werte: links, Mitte und rechts. |
center |
| sysparm_legend_vertical_alignment | Wenn die Legende vertikal zum Bericht platziert wird. Mögliche Werte: oben, Mitte und unten. |
bottom |
| sysparm_show_legend_border | Ein wahr/falsch-Wert, der steuert, ob die Legende einen Rahmen anzeigt. | wahr |
| sysparm_legend_border_width | Eine Zahl, die die Breite der Legendenbegrenzung in Pixel definiert | 1 |
| sysparm_legend_border_radius | Eine Zahl, die die Radiusgröße der Ecken der Legendenbegrenzung in Pixel definiert | 0 |
X-Achsen-Parameter
| Parameter | Beschreibung | Standardwert |
|---|---|---|
| sysparm_x_axis_title | Der Name, der auf der X-Achse angezeigt werden soll | |
| sysparm_x_axis_title_size | Eine Zahl, die die Schriftgröße des X-Achsentitels definiert | |
| sysparm_x_axis_title_bold | Ein Wahr/Falsch-Wert, der steuert, ob der Titeltext der x-Achse fett dargestellt wird. | wahr |
| sysparm_x_axis_opposite | Ein Wahr/Falsch-Wert, der steuert, ob die x-Achse oben im Bericht angezeigt wird. | falsch |
| sysparm_x_axis_display_grid | Ein wahr/falsch-Wert, der steuert, ob vertikale Rasterlinien von der x-Achse angezeigt werden. | falsch |
| sysparm_x_axis_grid_dotted | Ein wahr/falsch-Wert, der steuert, ob die vertikalen Rasterlinien gepunktet sind. | falsch |
| sysparm_x_axis_label_size | Eine Zahl, die die Schriftgröße für Inkremente auf der X-Achse definiert | 11 |
| sysparm_x_axis_label_bold | Ein wahr/falsch-Wert, der steuert, ob die Inkrementbezeichnungen der x-Achse fett sind. | falsch |
Y-Achsenparameter
| Parameter | Beschreibung | Standardwert |
|---|---|---|
| sysparm_y_axis_title | Der Name, der auf der Y-Achse angezeigt werden soll | Eine automatisch generierte Beschreibung der Berichtszusammenfassung |
| sysparm_y_axis_title_size | Eine Zahl, die die Schriftgröße des Y-Achsentitels definiert | |
| sysparm_y_axis_title_bold | Ein Wahr/Falsch-Wert, der steuert, ob der Titeltext der Y-Achse fett dargestellt wird. | wahr |
| sysparm_y_axis_opposite | Ein Wahr/Falsch-Wert, der steuert, ob die Y-Achse links im Bericht angezeigt wird. | falsch |
| sysparm_y_axis_display_grid | Ein wahr/falsch-Wert, der steuert, ob horizontale Rasterlinien von der y-Achse angezeigt werden. | wahr |
| sysparm_y_axis_grid_dotted | Ein wahr/falsch-Wert, der steuert, ob die horizontalen Rasterlinien gepunktet sind. | falsch |
| sysparm_y_axis_label_size | Eine Zahl, die die Schriftgröße für Inkremente auf der Y-Achse definiert | 12 |
| sysparm_y_axis_label_bold | Ein wahr/falsch-Wert, der steuert, ob die Inkrementbezeichnungen der y-Achse fett sind. | falsch |
| sysparm_y_axis_from | Eine Zahl, die den niedrigsten auf der Y-Achse angezeigten Wert definiert | |
| sysparm_y_axis_to | Eine Zahl, die den höchsten auf der Y-Achse angezeigten Wert definiert |