Jelly へのレポートの埋め込み
UI ページなどの Jelly ベースの要素にレポートを埋め込むことができます。
埋め込みの有効化
Jelly でレポートの埋め込みを有効にするには、次の要素を Jelly コードに追加します。
<g:inline template="reporting_includes.xml" />
このコードを追加した後、既存のレポートを埋め込んだり、Jelly コード内にレポートを生成したりできます。
既存のレポートの埋め込み
embedReportById(targetSpan, reportId) 関数を呼び出すことで、既存のレポートを埋め込むことができます。
たとえば、UI ページレコードの HTML/XML ブロックに次を追加します。
<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>
そして、UI ページレコードのクライアントスクリプトブロックに以下を追加します。<レポートsys_id>をレポートの実際のsys_idに置き換えます。
var div = $j("#report_stuff");
embedReportById(div, <"report sys_id">);または、JavaScript を jelly コードに埋め込む方法として、HTML/XML ブロック全体に埋め込むこともできます。次の間のクライアントスクリプトブロックからコードを追加します <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>| パラメーター | 説明 |
|---|---|
| targetSpan | グラフを埋め込む jQuery 要素。グラフでは、この要素のサイズが使用されます。 |
| reportId | 埋め込むレポートのsys_id。 |
レポートの生成と埋め込み
embedReportByParams(targetSpan, parms) 関数を呼び出すことで、UI 内にレポートを埋め込むことができます。この方法でレポートを埋め込む場合は、パラメーターを使用して新しいレポートを生成したり、そのレポートを表示するレポートsys_idを指定したりできます。
たとえば、UI ページレコードの HTML/XML ブロックに次を追加します。
<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>
そして、UI ページレコードのクライアントスクリプトブロックに次を追加します。
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);または、Jelly コード内に JavaScript を埋め込むこともできます。次の間のクライアントスクリプトブロックからコードを追加します <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>
| パラメーター | 説明 |
|---|---|
| targetSpan | グラフを埋め込む jQuery 要素。 |
| パラメーター | レポートを定義する JSON オブジェクト。使用可能なパラメーターは、レポートタイプによって異なります。 |
リストレポートの生成と埋め込み
既存のリストレポートを埋め込む場合、またはリストレポートを生成して埋め込む場合は、もう 1 行コードを入力する必要があります。
UI ページレコードの HTML/XML ブロックに以下を追加します。
<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>
UI ページレコードのクライアントスクリプトブロックに次を追加します。<レポートsys_id>をレポートの実際のsys_idに置き換えます。
var div = $j("#report_stuff");
embedReportById(div, <"report sys_id">);または、JavaScript を jelly コードに埋め込み、HTML/XML ブロック全体に埋め込みます。次の間のクライアントスクリプトブロックからコードを追加します <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>| パラメーター | 説明 |
|---|---|
| targetSpan | グラフを埋め込む jQuery 要素。グラフでは、この要素のサイズが使用されます。 |
| reportId | 埋め込むレポートのsys_id。 |
埋め込みレポートパラメーター
Jelly 要素にレポートを埋め込む場合は、パラメーターを渡すことでいつでもレポートを定義できます。
共通パラメーター
特定のパラメーターは複数のレポートタイプで使用されます。
| パラメーター | 説明 | デフォルト値 |
|---|---|---|
| jvar_report_id | レポートレコードのsys_id。このパラメーターを渡す場合は、他のパラメーターを指定しないでください。すべての値はレポートレコードから取得されます。 | |
| sysparm_report_id | レポートに存在する他の sysparm パラメーターを上書きする場合は、jvar_report_id の代わりにこのパラメーターを使用します。 | |
| sysparm_title | レポートのタイトル。 | |
| sysparm_table | レポートするテーブル。この値またはsysparm_report_source_idを指定しますが、両方を指定することはできません。 | |
| sysparm_report_source_id | レポートソースのsys_id。この値またはsysparm_tableを指定しますが、両方を指定することはできません。両方を渡すと、sysparm_tableの代わりにこの値が使用されます。 | |
| sysparm_type | 作成するレポートのタイプ。 可能な値:リスト、折れ線、line_bar、面、スプライン、棒、horizontal_bar、パレート図、履歴、円グラフ、ドーナツグラフ、semi_donut、スピードメーター、ダイヤル、ピボット、pivot_v2、じょうごグラフ、カレンダー、ピラミッド、ボックス、トレンド、コントロール、トレンドボックス、ヒートマップ。 |
線 |
| sysparm_field | データをグループ化する基準となる、指定されたテーブルのフィールド。時系列、縦棒グラフ、棒グラフ、円グラフ、ドーナツグラフ、じょうごグラフ、ピラミッドグラフ、ボックスグラフ、トレンドグラフ、および trendbox レポートに必要です。リストレポートのオプション。 | |
| sysparm_query | レポートを生成する前にデータに適用するフィルター。この値のクエリ文字列を指定します。 特定のフィールドでクエリ結果を並べ替えるには、クエリ文字列の末尾に ^ORDERBY <field_name> または ^ORDERBYDES <field_name> を追加します。ORDERBY は、昇順でクエリをソートします。ORDERBYDES は、クエリを降順でソートします。 |
|
| sysparm_aggregate | 集計タイプ。 可能な値:AVG、COUNT、SUM、および COUNT_DISTINCT |
総数 |
| sysparm_sumfield | データをアグリゲートするフィールド。COUNT 集計タイプを使用する場合、このパラメーターは適用されません。 | |
| sysparm_display_grid | レポートにデータグリッドを表示するかどうかを制御する true/false 値。 | false |
| sysparm_show_other | その他のグループをレポートに表示するかどうかを制御する true/false 値。このグループは、グループの数がsysparm_othersパラメーターで指定された数を超えている場合にのみ表示されます。このパラメーターは、棒グラフ、円グラフ、じょうごグラフ、ピラミッドグラフ、ピボット、およびヒートマップレポートに適用されます。 | true |
| sysparm_others | 表示する個々のデータのグループの最大数。追加のデータグループは、[その他のグループ] に結合されます。このパラメーターは、棒グラフ、円グラフ、じょうごグラフ、ピラミッドグラフ、ピボット、およびヒートマップレポートに適用されます。 | |
| sysparm_source_type | 埋め込みレポートのソース。オプション。 可能な値:table、metricbase、source、import |
テーブル |
| sysparm_set_color | レポートの色の設定。 可能な値:one_color、color_palette、several_colors |
color_palette |
| sysparm_color_palette | レポートで使用されるカラーパレット。このパラメーターは、sysparm_set_color="color_palette" の場合に使用されます。 可能な値:カラーパレットのsys_id |
デフォルト UI14 |
| sysparm_color | レポートで使用される色。このパラメーターは、sysparm_set_color="one_color" の場合に使用されます。 可能な値:色のsys_id |
|
| sysparm_chart_colors | レポートで使用するグラフの色のセット。このパラメーターは、sysparm_set_color="several_colors" の場合に使用されます。 可能な値:色の 16 進数コードのカンマ区切りリスト |
|
| sysparm_show_marker | マーカーは、グラフ内の線または別のグラフィック要素のドットで表される値です。このパラメーターは、マーカーを表示するかどうかを制御する true/false 値です。 | true |
| sysparm_show_empty | 空のグループ値または傾向値を持つレコードがレポートに表示されるかどうかを制御する true/false 値。 | false |
| sysparm_stack_field | 棒グラフレポートと縦棒グラフレポートの積み重ねを制御するために使用されるフィールド。 | |
| sysparm_bar_unstack | 積み重ねデータを単一の棒または列、または複数の棒として表示するかを制御する true/false 値。 | false |
| sysparm_box_field | データの測定に使用される数値フィールド。このパラメーターは、ボックスおよびヒストグラムレポートに必要です。 | |
| sysparm_trend_field | 傾向データの整理に使用する日時フィールド。このパラメーターは、時系列レポート、傾向レポート、およびボックスレポートに必要です。 | |
| sysparm_trend_interval | 傾向値を測定する間隔。 可能な値:年、四半期、月、週、曜日、時間、および日付。 |
年 |
| sysparm_compute_percent | レポートの割合を表示するときに使用する値。合計レコード数に基づいて、または指定されたアグリゲートに基づいて、パーセンテージを表示できます。 可能な値:aggregate と count |
カウント |
| sysparm_funnel_neck_percent | 1 〜 100 の数字で、じょうごグラフレポートの末尾部分を占める割合を定義します。 | 30 |
| sysparm_show_chart_data_label | データラベルがレポートに表示されるかどうかを制御する true/false 値。 | false |
| sysparm_show_zero | マルチレベルピボットおよびヒートマップレポートにゼロを表示するかどうかを制御する true/false 値。 | |
| sysparm_ct_row | ヒートマップレポートとバブルレポートの行を定義するために使用されるフィールド。 | |
| sysparm_ct_column | ヒートマップレポートとバブルレポートの列を定義するために使用されるフィールド。 | |
| sysparm_y_axis_category_fields | マルチレベルピボットレポートの行を定義するために使用されるフィールド。最大 5 つのカンマ区切りフィールド名を指定します。 | |
| sysparm_x_axis_category_fields | マルチレベルピボットレポートの列を定義するために使用されるフィールド。最大 3 つのカンマ区切りフィールド名を指定します。 | |
| sysparm_list_ui_view | ユーザーがレポートにドリルダウンするときに使用するリストビューのsys_id。 | |
| sysparm_show_marker | レポートのプロットされたすべてのポイントにマーカーを表示するかどうかを制御する true/false 値。 | true |
| sysparm_apply_alias | 構成されたエイリアスを埋め込みレポートに表示するかどうかを制御する true/false 値。 |
サービスカタログパラメーター
特定のパラメーターは、要求アイテム [sc_req_item] テーブルなどのサービスカタログテーブルで作成されたレポートにのみ適用されます。これらのパラメーターは、リストまたはカレンダータイプのレポートでは使用できません。
| パラメーター | 説明 |
|---|---|
| sysparm_sc_groupby_item_id | カタログアイテムのsys_id。カタログ変数値に基づいてサービスカタログレポートをグループ化するには、このパラメーターを sysparm_sc_groupby_variable_id パラメーターとともに使用します。これらのパラメーターは、サービスカタログ変数でグループ化するときに sysparm_field パラメーターに代わるものです。 |
| sysparm_sc_groupby_variable_id | レポートでデータをグループ化する方法を決定するために使用されるカタログアイテム変数のsys_id。この変数は、 sysparm_sc_groupby_item_id パラメーターで指定されたカタログアイテムに属している必要があります。 |
| sysparm_sc_stackby_item_id | カタログアイテムのsys_id。カタログ変数値に基づいてサービスカタログレポートを積み重ねるには、このパラメーターを sysparm_sc_stackby_variable_id パラメーターと併用します。これらのパラメーターは、サービスカタログ変数でグループ化するときにsysparm_stack_field パラメーターに代わるものです。これらのパラメーターをサポートするのは、棒グラフレポートなどの積み重ねをサポートするレポートのみです。 |
| sysparm_sc_stackby_variable_id | レポートでデータをグループ化する方法を決定するために使用されるカタログアイテム変数のsys_id。この変数は、 sysparm_sc_stackby_item_id パラメーターで指定されたカタログアイテムに属している必要があります。 |
メトリックベースパラメーター
埋め込みレポートでメトリックベースを使用するには、sysparm_source_typeパラメーターを「メトリックベース」に設定する必要があります。
メトリックベースには、次の構文を持つ sysparm_custom_configuration パラメーターも必要です。
sysparm_custom_config: "{query_condition:\"\",transforms:[{transform:{transform:\"Reference\",name:\"chart-subjects\"},metric:\"mb_metricname\"}], group_by:\"\", table:\"mb_tablename\"}"; この構文では、次のようになります。
変換は、ネストされた一連の変換関数です。すべてのチェーンの最後の変換は常に参照変換である必要があります。{transform:\"Reference\",name:\"chart-subjects\"}メトリクスは、メトリクステーブルのメトリクスフィールドです。グループ化フィールドは、時系列がグループ化される、選択したメトリクステーブルのフィールドです。テーブルはメトリクステーブルを参照しますmb_...はプレースホルダー名です
グループ化を除くすべての属性が必要です。チャート固有のパラメーター
特定のパラメーターは、特定のレポートタイプでのみ使用できます。
| パラメーター | 説明 | デフォルト値 |
|---|---|---|
| sysparm_show_chart_total | グループ化されたドーナツの合計スコアがレポートの中央に表示されるかどうかを制御する true/false 値。 | false |
| sysparm_donut_width_percent | ドーナツグラフレポートの太さを制御する 1 〜 100 の数字。 | 50 |
| パラメーター | 説明 | デフォルト値 |
|---|---|---|
| sysparm_use_color_heatmap | ヒートマップがグラデーションを使用してレポートに色付けするかどうかを制御する true/false 値。true の場合、sysparm_axis_max_color と sysparm_axis_min_color の値が使用されます。 | true |
| sysparm_axis_max_color | 高い値を示すためにヒートマップグラデーションで使用される色。この値は、色定義 [sys_report_color] レコードのsys_idである必要があります。 | UI14 青 |
| sysparm_axis_min_color | 低い値を示すためにヒートマップグラデーションで使用される色。この値は、色定義 [sys_report_color] レコードのsys_idである必要があります。 | 白 |
| パラメーター | 説明 | デフォルト値 |
|---|---|---|
| sysparm_gauge_autoscale | 目盛りがレポートの最小スケールと最大スケールを自動的に計算するかどうかを制御する true/false 値。この値を false に設定する場合は、sysparm_fromとsysparm_toの値を指定する必要があります。 | true |
| sysparm_from | 軸スケールの最小値を定義する数値。 | |
| sysparm_to | 軸スケールの最大値を定義する数値。 | |
| sysparm_upper_limit | 目盛りの上限しきい値を定義する数字。値を指定しない場合、ダイヤルには上限しきい値がありません。 | |
| sysparm_lower_limit | ダイヤルの下限しきい値を定義する数字。値を指定しない場合、ダイヤルには下限しきい値はありません。 | |
| sysparm_direction | レポートで正と見なされる値 (小さい値または大きい値) を制御する値。 可能な値:最小化と最大化。 |
最小化 |
チャートサイズパラメーター
特定のパラメーターは、レポートの幅と高さを制御します。
| パラメーター | 説明 | デフォルト値 |
|---|---|---|
| sysparm_chart_size | レポート内のグラフのサイズ。有効な値は、small、medium、large です。 | 大 |
| sysparm_custom_chart_size | このパラメーターを有効にすると、 sysparm_chart_size パラメーターのサイズオプションを使用する代わりに、カスタムチャートの高さと幅の値を指定します。 | false |
| sysparm_custom_chart_height | レポート内のグラフの高さ (ピクセル単位)。 | |
| sysparm_custom_chart_width | レポート内のグラフの幅 (ピクセル単位)。 |
チャートタイトルパラメーター
特定のパラメーターは、タイトルを表示するレポートでのみ使用できます。これらのレポートタイプには、時系列、棒、縦棒、円グラフ、ドーナツグラフ、目盛り、傾向レポート、ボックスレポート、トレンドボックスレポート、ヒストグラムレポート、ピラミッドレポート、ヒートマップレポート、じょうごグラフレポートなどがあります。
| パラメーター | 説明 | デフォルト値 |
|---|---|---|
| sysparm_report_title_size | タイトルのフォントサイズを定義する数字。 | 16 |
| sysparm_report_title_color | タイトルテキストの色。この値は、色定義 [sys_report_color] レコードのsys_idである必要があります。 | 黒 |
| sysparm_title_horizontal_alignment | タイトルがレポートに対して水平に配置される場所。この値は、sysparm_custom_report_title_positionが false の場合にのみ使用されます。 可能な値は、left、center、right です。 |
center |
| sysparm_title_vertical_alignment | レポートに対してタイトルが垂直に配置される場所。この値は、sysparm_custom_report_title_positionが false の場合にのみ使用されます。 可能な値:top、middle、および bottom。 |
top |
| sysparm_custom_report_title_position | 相対的な配置ではなく、x 座標と y 座標がレポートタイトルの位置を定義するかどうかを制御する true/false 値。 | false |
| sysparm_report_title_x_position | レポート上のタイトルの x 位置を定義する数値。この値は、sysparm_custom_report_title_positionが true の場合にのみ使用されます。 | 0 |
| sysparm_report_title_y_position | レポート上のタイトルの y 位置を定義する数値。この値は、sysparm_custom_report_title_positionが true の場合にのみ使用されます。 | 0 |
チャート境界パラメーター
特定のパラメーターは、境界線が表示されるレポートでのみ使用できます。これらのレポートタイプには、時系列、棒、縦棒、円グラフ、ドーナツグラフ、目盛り、トレンド、ボックス、トレンドボックス、ヒストグラム、ピラミッドグラフ、ヒートマップ、じょうごグラフ、コントロールレポートが含まれます。
| パラメーター | 説明 | デフォルト値 |
|---|---|---|
| sysparm_show_report_border | レポートに境界線を表示するかどうかを制御する true/false 値。 | false |
| sysparm_report_border_width | 境界線の幅を定義する数値 (ピクセル単位)。 | 1 |
| sysparm_report_border_radius | 境界線の角の半径サイズを定義する数値 (ピクセル単位)。 | 0 |
凡例パラメーター
特定のパラメーターは、凡例を表示するレポートでのみ使用できます。これらのレポートタイプには、円グラフ、ドーナツグラフ、積み上げ棒グラフ、積み上げ縦棒グラフ、時系列レポート、傾向レポート、ボックスグラフ、ヒストグラムレポート、ピラミッドグラフ、コントロールレポート、ヒートマップレポートが含まれます。
| パラメーター | 説明 | デフォルト値 |
|---|---|---|
| sysparm_show_legend | レポートに凡例を表示するかどうかを制御する true/false 値。 | true |
| sysparm_legend_horizontal_alignment | 凡例がレポートに対して水平に配置されている場所。 可能な値:left、center、right。 |
center |
| sysparm_legend_vertical_alignment | 凡例がレポートに対して垂直に配置される場所。 可能な値:top、middle、および bottom。 |
下 |
| sysparm_show_legend_border | 凡例に境界線を表示するかどうかを制御する true/false 値。 | true |
| sysparm_legend_border_width | 凡例の境界線の幅を定義する数値 (ピクセル単位)。 | 1 |
| sysparm_legend_border_radius | 凡例境界線の角の半径サイズを定義する数値 (ピクセル単位)。 | 0 |
X 軸パラメーター
特定のパラメーターは、X 軸を使用するレポートでのみ使用できます。これらのレポートタイプには、棒、水平棒、パレート図、縦棒、折れ線領域、スプライン、ボックス、トレンドボックス、コントロール、およびトレンドレポートが含まれます。
| パラメーター | 説明 | デフォルト値 |
|---|---|---|
| sysparm_x_axis_title | x 軸に表示する名前。 | |
| sysparm_x_axis_title_size | X 軸タイトルのフォントサイズを定義する数値。 | |
| sysparm_x_axis_title_bold | x 軸のタイトルテキストを太字にするかどうかを制御する true/false 値。 | true |
| sysparm_x_axis_opposite | x 軸がレポートの上部に表示されるかどうかを制御する true/false 値。 | false |
| sysparm_x_axis_display_grid | 垂直グリッド線が x 軸から表示されるかどうかを制御する true/false 値。 | false |
| sysparm_x_axis_grid_dotted | 垂直グリッド線を点線で囲むかどうかを制御する true/false 値。 | false |
| sysparm_x_axis_label_size | x 軸のインクリメントラベルのフォントサイズを定義する数値。 | 11 |
| sysparm_x_axis_label_bold | x 軸の増分ラベルを太字にするかどうかを制御する true/false 値。 | false |
Y 軸パラメーター
特定のパラメーターは、Y 軸を使用するレポートでのみ使用できます。これらのレポートタイプには、棒、水平棒、パレート図、縦棒、折れ線領域、スプライン、ボックス、トレンドボックス、コントロール、およびトレンドレポートが含まれます。
| パラメーター | 説明 | デフォルト値 |
|---|---|---|
| sysparm_y_axis_title | Y 軸に表示する名前。 | レポート集計の自動生成の説明 |
| sysparm_y_axis_title_size | Y 軸タイトルのフォントサイズを定義する数値。 | |
| sysparm_y_axis_title_bold | Y 軸のタイトルテキストを太字にするかどうかを制御する true/false 値。 | true |
| sysparm_y_axis_opposite | y 軸がレポートの左側に表示されるかどうかを制御する true/false 値。 | false |
| sysparm_y_axis_display_grid | 水平グリッド線が y 軸から表示されるかどうかを制御する true/false 値。 | true |
| sysparm_y_axis_grid_dotted | 水平グリッド線を点線で囲むかどうかをコントロールする true/false 値。 | false |
| sysparm_y_axis_label_size | y 軸のインクリメントラベルのフォントサイズを定義する数値。 | 12 |
| sysparm_y_axis_label_bold | y 軸の増分ラベルを太字にするかどうかを制御する true/false 値。 | false |
| sysparm_y_axis_from | Y 軸に表示される最小値を定義する数値。 | |
| sysparm_y_axis_to | Y 軸に表示される最大値を定義する数値。 |