Intégration de rapports dans Jelly
Vous pouvez intégrer des rapports dans n’importe quel élément basé sur Jelly, tel qu’une page d’interface utilisateur.
Activation de l’incorporation
Pour activer l’intégration des rapports dans Jelly, ajoutez l’élément suivant à votre code Jelly.
<g :inline template="reporting_includes.xml » />
Après avoir ajouté ce code, vous pouvez incorporer un rapport existant ou générer un rapport dans le code Jelly.
Intégrer un rapport existant
Vous pouvez incorporer un rapport existant en appelant la fonction embedReportById(targetSpan, reportId).
<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>| Paramètre | Description |
|---|---|
| targetSpan (en anglais seulement) | Élément jQuery dans lequel intégrer le graphique. Le graphique utilise la taille de cet élément. |
| reportId | La sys_id du rapport que vous souhaitez incorporer. |
Générer et incorporer un rapport
Vous pouvez incorporer un rapport dans l’interface utilisateur en appelant la fonction embedReportByParams(targetSpan, parms). Lors de l’incorporation d’un rapport de cette manière, vous pouvez générer un nouveau rapport à l’aide de paramètres ou spécifier une sys_id de rapport pour afficher ce rapport.
<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>
| Paramètre | Description |
|---|---|
| targetSpan (en anglais seulement) | Élément jQuery dans lequel intégrer le graphique. |
| Parms | Objet JSON définissant le rapport. Les paramètres disponibles dépendent du type de rapport. |
Génération et incorporation d’un rapport de liste
Lorsque vous incorporez un rapport de liste existant ou que vous générez un rapport de liste et que vous l’incorporez, vous devez entrer une ligne de code supplémentaire.
<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>| Paramètre | Description |
|---|---|
| targetSpan (en anglais seulement) | Élément jQuery dans lequel intégrer le graphique. Le graphique utilise la taille de cet élément. |
| reportId | La sys_id du rapport que vous souhaitez incorporer. |
Paramètres de rapport incorporés
Lors de l’incorporation d’un rapport dans un élément Jelly, vous pouvez définir un rapport à tout moment en passant des paramètres.
Paramètres communs
Certains paramètres sont utilisés par plusieurs types de rapports.
| Paramètre | Description | Valeur par défaut |
|---|---|---|
| jvar_report_id | sys_id d’un enregistrement de rapport. Si vous transmettez ce paramètre, ne spécifiez aucun autre paramètre. Toutes les valeurs sont extraites de l’enregistrement de rapport. | |
| sysparm_report_id | Utilisez ce paramètre au lieu de jvar_report_id lorsque vous souhaitez remplacer l’un des autres paramètres sysparm qui existent dans le rapport. | |
| sysparm_title | Le titre du rapport. | |
| sysparm_table | Table sur laquelle établir un rapport. Spécifiez cette valeur ou cette sysparm_report_source_id, mais pas les deux. | |
| sysparm_report_source_id | sys_id d’une source de rapport. Spécifiez cette valeur ou sysparm_table, mais pas les deux. Cette valeur est utilisée au lieu de sysparm_table si vous transmettez les deux. | |
| sysparm_type | Type de rapport à créer. Valeurs possibles : liste, ligne, line_bar, zone, spline, barre, horizontal_bar, diagramme, hist, camembert, anneau, semi_donut, indicateur de vitesse, cadran, pivot, pivot_v2, entonnoir, calendrier, pyramide, boîte, tendance, contrôle, boîte de tendance et carte thermique. |
ligne |
| sysparm_field | Champ de la table spécifiée sur laquelle regrouper les données. Requis pour les rapports de séries chronologiques, de colonnes, de barres, de secteurs, d’anneaux, d’entonnoirs, de pyramides, de boîtes, de tendances et de boîtes de tendances. Facultatif pour les rapports de liste. | |
| sysparm_query | Filtre à appliquer aux données avant de générer le rapport. Spécifiez une chaîne de requête pour cette valeur. Pour trier les résultats de votre requête par un champ spécifique, ajoutez ^ORDERBY <field_name> ou ^ORDERBYDES <field_name> à la fin de la chaîne de requête. ORDERBY trie la requête par ordre croissant. ORDERBYDES trie la requête par ordre décroissant. |
|
| sysparm_aggregate | Type d’agrégation. Valeurs possibles : AVG, COUNT, SUM et COUNT_DISTINCT |
NOMBRE |
| sysparm_sumfield | Champ sur lequel regrouper les données. Ce paramètre ne s’applique pas lors de l’utilisation d’un type d’agrégation COUNT. | |
| sysparm_display_grid | Une valeur vrai/faux qui contrôle si le rapport affiche une grille de données. | faux |
| sysparm_show_other | Valeur vrai/faux qui contrôle si le groupe Autre apparaît sur le rapport. Ce groupe s’affiche uniquement si le nombre de groupes dépasse le nombre spécifié dans le paramètre sysparm_others. Ce paramètre s’applique aux rapports à barres, à secteurs, en entonnoir, pyramidaux, croisés dynamiques et de carte thermique. | VRAI |
| sysparm_others | Nombre maximal de groupes de données individuels à afficher. Tous les groupes de données supplémentaires sont combinés dans le groupe Autre. Ce paramètre s’applique aux rapports à barres, à secteurs, en entonnoir, pyramidaux, croisés dynamiques et de carte thermique. | |
| sysparm_source_type | Source du rapport incorporé. Facultatif. Valeurs possibles : table, metricbase, source, import |
Table |
| sysparm_set_color | Le paramètre de couleur pour le rapport. Valeurs possibles : one_color, color_palette several_colors |
color_palette |
| sysparm_color_palette | Palette de couleurs utilisée par le rapport. Ce paramètre est utilisé lorsque sysparm_set_color="color_palette ». Valeur possible : sys_id d’une palette de couleurs |
UI14 par défaut |
| sysparm_color | La couleur utilisée par le rapport. Ce paramètre est utilisé lorsque sysparm_set_color="one_color ». Valeur possible : la sys_id d’une couleur |
|
| sysparm_chart_colors | Ensemble de couleurs de graphique que le rapport utilise. Ce paramètre est utilisé lorsque sysparm_set_color="several_colors ». Valeur possible : une liste de codes couleur hexadécimaux séparés par des virgules |
|
| sysparm_show_marker | Un marqueur est la valeur représentée par un point dans une ligne ou un autre élément graphique dans un graphique. Il s’agit d’une valeur vrai/faux qui détermine si le marqueur s’affiche. | VRAI |
| sysparm_show_empty | Valeur vrai/faux qui contrôle si des enregistrements avec des valeurs de regroupement ou de tendance vides apparaissent dans le rapport. | faux |
| sysparm_stack_field | Champ utilisé pour contrôler l’empilement sur les rapports à barres et à colonnes. | |
| sysparm_bar_unstack | Valeur vrai/faux qui contrôle si les données empilées sont présentées sous forme d’une barre ou d’une colonne unique, ou sous forme de barres multiples. | faux |
| sysparm_box_field | Champ numérique utilisé pour mesurer les données. Ce paramètre est requis pour les rapports à boîtes et d’histogramme. | |
| sysparm_trend_field | Champ de date/heure utilisé pour organiser les données de tendance. Ce paramètre est requis pour les rapports de séries chronologiques, de tendances et à surfaces. | |
| sysparm_trend_interval | Intervalle par lequel mesurer les valeurs de tendance. Valeurs possibles : année, trimestre, mois, semaine, jour de la semaine, heure et date. |
année |
| sysparm_compute_percent | Valeur à utiliser lors de l’affichage des pourcentages de rapport. Vous pouvez afficher les pourcentages en fonction du nombre total d’enregistrements ou de l’agrégat spécifié. Valeurs possibles : agréger et compter |
compter |
| sysparm_funnel_neck_percent | Un nombre compris entre 1 et 100 qui définit le pourcentage d’un rapport d’entonnoir qui constitue le cou de l’entonnoir. | 30 |
| sysparm_show_chart_data_label | Une valeur vrai/faux qui contrôle si les étiquettes de données apparaissent sur le rapport. | faux |
| sysparm_show_zero | Valeur vrai/faux qui contrôle si des zéros apparaissent dans les rapports de tableau croisé dynamique et de carte thermique à plusieurs niveaux. | |
| sysparm_ct_row | Champ utilisé pour définir les lignes dans les rapports de carte thermique et à bulles. | |
| sysparm_ct_column | Champ utilisé pour définir les colonnes dans les rapports de carte thermique et à bulles. | |
| sysparm_y_axis_category_fields | Champ utilisé pour définir les lignes dans les rapports sous forme de tableau croisé dynamique à plusieurs niveaux. Spécifiez jusqu’à cinq noms de champs séparés par des virgules. | |
| sysparm_x_axis_category_fields | Champ utilisé pour définir les colonnes dans les rapports sous forme de tableau croisé dynamique à plusieurs niveaux. Spécifiez jusqu’à trois noms de champs séparés par des virgules. | |
| sysparm_list_ui_view | sys_id d’une vue de liste à utiliser lorsqu’un utilisateur explore le rapport. | |
| sysparm_show_marker | Valeur vrai/faux qui contrôle si des marqueurs apparaissent à chaque point tracé sur un rapport. | VRAI |
| sysparm_apply_alias | Valeur vrai/faux qui contrôle si les alias configurés apparaissent dans les rapports incorporés. |
Paramètres de Service Catalog
| Paramètre | Description |
|---|---|
| sysparm_sc_groupby_item_id | sys_id d’un élément de catalogue. Utilisez ce paramètre avec le sysparm_sc_groupby_variable_id paramètre pour regrouper un rapport de catalogue de services basé sur une valeur de variable de catalogue. Ces paramètres remplacent le sysparm_field paramètre lors du regroupement sur des variables de catalogue de services. |
| sysparm_sc_groupby_variable_id | sys_id de la variable d’élément de catalogue utilisée pour déterminer comment les données sont regroupées dans le rapport. Cette variable doit appartenir à l’élément de catalogue spécifié dans le sysparm_sc_groupby_item_id paramètre. |
| sysparm_sc_stackby_item_id | sys_id d’un élément de catalogue. Utilisez ce paramètre avec le sysparm_sc_stackby_variable_id paramètre pour empiler un rapport de catalogue de services en fonction d’une valeur de variable de catalogue. Ces paramètres remplacent le sysparm_stack_field paramètre lors du regroupement sur des variables de catalogue de services. Seuls les rapports prenant en charge l’empilement, tels que les rapports à barres, prennent en charge ces paramètres. |
| sysparm_sc_stackby_variable_id | sys_id de la variable d’élément de catalogue utilisée pour déterminer comment les données sont regroupées dans le rapport. Cette variable doit appartenir à l’élément de catalogue spécifié dans le sysparm_sc_stackby_item_id paramètre. |
Paramètres MetricBase
Pour utiliser MetricBase dans un rapport incorporé, le paramètre sysparm_source_type doit être défini sur « metricbase ».
MetricBase nécessite également le paramètre sysparm_custom_configuration, dont la syntaxe est la suivante :
sysparm_custom_config: "{query_condition:\"\",transforms:[{transform:{transform:\"Reference\",name:\"chart-subjects\"},metric:\"mb_metricname\"}], group_by:\"\", table:\"mb_tablename\"}";
- Une
transformationest une chaîne de fonctions de transformation imbriquées. La dernière transformation de chaque chaîne doit toujours être la transformation de référence :{transform:\"Reference\",name:\"chart-subjects\"} - Une
mesureest un champ de mesure d’une table de mesures. - Le champ
Grouper parest le champ de la table de mesures sélectionnée selon laquelle les séries chronologiques sont regroupées. La tablefait référence à la table de mesuresMb_...sont des noms d’espace réservé
de Grouper par.Paramètres spécifiques au graphique
Certains paramètres ne sont disponibles que pour des types de rapports spécifiques.
| Paramètre | Description | Valeur par défaut |
|---|---|---|
| sysparm_show_chart_total | Valeur vrai/faux qui contrôle si le score total de l’anneau groupé apparaît au centre du rapport. | faux |
| sysparm_donut_width_percent | Un nombre compris entre 1 et 100 qui contrôle l’épaisseur du rapport en anneau. | 50 |
| Paramètre | Description | Valeur par défaut |
|---|---|---|
| sysparm_use_color_heatmap | Une valeur vrai/faux qui contrôle si la carte thermique utilise un dégradé pour colorer le rapport. Si la valeur est vrai, les valeurs sysparm_axis_max_color et sysparm_axis_min_color sont utilisées. | VRAI |
| sysparm_axis_max_color | Couleur utilisée dans le dégradé de la carte thermique pour indiquer une valeur élevée. Cette valeur doit être l’sys_id d’un enregistrement Définition des couleurs [sys_report_color]. | UI14 bleu |
| sysparm_axis_min_color | Couleur utilisée dans le dégradé de la carte thermique pour indiquer une valeur faible. Cette valeur doit être l’sys_id d’un enregistrement Définition des couleurs [sys_report_color]. | Blanc |
| Paramètre | Description | Valeur par défaut |
|---|---|---|
| sysparm_gauge_autoscale | Une valeur vrai/faux qui contrôle si le cadran calcule automatiquement l’échelle minimale et maximale sur le rapport. Si vous définissez cette valeur sur false, vous devez spécifier un sysparm_from et une valeur sysparm_to. | VRAI |
| sysparm_from | Nombre qui définit la valeur minimale de l’échelle de l’axe. | |
| sysparm_to | Nombre qui définit la valeur maximale de l’échelle de l’axe. | |
| sysparm_upper_limit | Nombre qui définit le seuil supérieur du cadran. Si vous ne spécifiez pas de valeur, le cadran n’a pas de seuil supérieur. | |
| sysparm_lower_limit | Nombre qui définit le seuil inférieur du cadran. Si vous ne spécifiez pas de valeur, le cadran n’a pas de seuil inférieur. | |
| sysparm_direction | Une valeur qui contrôle les valeurs qui sont considérées comme positives sur le rapport, les valeurs inférieures ou les valeurs supérieures. Valeurs possibles : minimiser et maximiser. |
Minimiser |
Paramètres de taille du graphique
| Paramètre | Description | Valeur par défaut |
|---|---|---|
| sysparm_chart_size | La taille du graphique dans le rapport. Les valeurs valides sont small, medium et large. | grand |
| sysparm_custom_chart_size | Activez ce paramètre pour spécifier des valeurs personnalisées de hauteur et de largeur du graphique au lieu d’utiliser une option de taille du sysparm_chart_size paramètre. | faux |
| sysparm_custom_chart_height | Hauteur du graphique dans le rapport, en pixels. | |
| sysparm_custom_chart_width | La largeur du graphique dans le rapport, en pixels. |
Paramètres du titre du graphique
| Paramètre | Description | Valeur par défaut |
|---|---|---|
| sysparm_report_title_size | Nombre qui définit la taille de la police du titre. | 16 |
| sysparm_report_title_color | La couleur du texte du titre. Cette valeur doit être l’sys_id d’un enregistrement Définition des couleurs [sys_report_color]. | noir |
| sysparm_title_horizontal_alignment | Où le titre est placé horizontalement par rapport au rapport. Cette valeur n’est utilisée que si sysparm_custom_report_title_position est faux. Les valeurs possibles sont : gauche, centre et droite. |
Centre |
| sysparm_title_vertical_alignment | Où le titre est placé verticalement par rapport au rapport. Cette valeur n’est utilisée que si sysparm_custom_report_title_position est faux. Valeurs possibles : haut, milieu et bas. |
top |
| sysparm_custom_report_title_position | Une valeur vrai/faux qui détermine si les coordonnées x et y définissent la position du titre du rapport au lieu de l’alignement relatif. | faux |
| sysparm_report_title_x_position | Nombre qui définit la position x du titre sur le rapport. Cette valeur n’est utilisée que si sysparm_custom_report_title_position est vrai. | 0 |
| sysparm_report_title_y_position | Nombre qui définit la position y du titre sur le rapport. Cette valeur n’est utilisée que si sysparm_custom_report_title_position est vrai. | 0 |
Paramètres de bordure du graphique
| Paramètre | Description | Valeur par défaut |
|---|---|---|
| sysparm_show_report_border | Une valeur vrai/faux qui contrôle si le rapport affiche une bordure. | faux |
| sysparm_report_border_width | Nombre qui définit la largeur de la bordure, en pixels. | 1 |
| sysparm_report_border_radius | Nombre qui définit la taille du rayon des angles de la bordure, en pixels. | 0 |
Paramètres de la légende
| Paramètre | Description | Valeur par défaut |
|---|---|---|
| sysparm_show_legend | Valeur vrai/faux qui détermine si le rapport affiche une légende. | VRAI |
| sysparm_legend_horizontal_alignment | Où la légende est placée horizontalement par rapport au rapport. Valeurs possibles : gauche, centre et droite. |
Centre |
| sysparm_legend_vertical_alignment | Endroit où la légende est placée verticalement par rapport au rapport. Valeurs possibles : haut, milieu et bas. |
bas |
| sysparm_show_legend_border | Une valeur vrai/faux qui contrôle si la légende affiche une bordure. | VRAI |
| sysparm_legend_border_width | Nombre qui définit la largeur de la bordure de la légende, en pixels. | 1 |
| sysparm_legend_border_radius | Nombre qui définit la taille du rayon des angles de la bordure de la légende, en pixels. | 0 |
Paramètres de l’axe X
| Paramètre | Description | Valeur par défaut |
|---|---|---|
| sysparm_x_axis_title | Nom à afficher sur l’axe X. | |
| sysparm_x_axis_title_size | Nombre qui définit la taille de police du titre sur l’axe des X. | |
| sysparm_x_axis_title_bold | Valeur vrai/faux qui détermine si le texte du titre de l’axe des X est en gras. | VRAI |
| sysparm_x_axis_opposite | Valeur vrai/faux qui contrôle si l’axe x apparaît en haut du rapport. | faux |
| sysparm_x_axis_display_grid | Valeur vrai/faux qui contrôle si des lignes de grille verticales apparaissent à partir de l’axe X. | faux |
| sysparm_x_axis_grid_dotted | Valeur vrai/faux qui détermine si les lignes verticales du quadrillage sont en pointillés. | faux |
| sysparm_x_axis_label_size | Nombre qui définit la taille de police pour les étiquettes d’incrémentation sur l’axe X. | 11 |
| sysparm_x_axis_label_bold | Valeur vrai/faux qui contrôle si les étiquettes d’incrément de l’axe X sont en gras. | faux |
Paramètres de l’axe Y
| Paramètre | Description | Valeur par défaut |
|---|---|---|
| sysparm_y_axis_title | Nom à afficher sur l’axe Y. | Description générée automatiquement de l’agrégation de rapports |
| sysparm_y_axis_title_size | Nombre qui définit la taille de la police du titre sur l’axe des y. | |
| sysparm_y_axis_title_bold | Valeur vrai/faux qui détermine si le texte du titre de l’axe des Y est en gras. | VRAI |
| sysparm_y_axis_opposite | Valeur vrai/faux qui contrôle si l’axe y apparaît à gauche du rapport. | faux |
| sysparm_y_axis_display_grid | Valeur vrai/faux qui contrôle si des lignes de grille horizontales apparaissent à partir de l’axe y. | VRAI |
| sysparm_y_axis_grid_dotted | Valeur vrai/faux qui détermine si les lignes horizontales du quadrillage sont en pointillés. | faux |
| sysparm_y_axis_label_size | Nombre qui définit la taille de police pour les étiquettes d’incrémentation sur l’axe Y. | 12 |
| sysparm_y_axis_label_bold | Valeur vrai/faux qui contrôle si les étiquettes d’incrément de l’axe des Y sont en gras. | faux |
| sysparm_y_axis_from | Nombre définissant la valeur la plus basse affichée sur l’axe Y. | |
| sysparm_y_axis_to | Nombre définissant la valeur la plus élevée affichée sur l’axe Y. |