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 ページレコードのクライアントスクリプトブロックに以下を追加します。<report sys_id>をレポートの実際のsys_idに置き換えます。
var div = $j("#report_stuff");
embedReportById(div, <"report sys_id">);または、HTML/XML ブロックの 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 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 要素。 |
| parms | レポートを定義する 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 ページレコードのクライアントスクリプトブロックに以下を追加します。<report sys_id>をレポートの実際のsys_idに置き換えます。
var div = $j("#report_stuff");
embedReportById(div, <"report sys_id">);または、HTML / XML ブロックの 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" />
<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 | 指定された表からデータをグループ化するためのフィールド。時系列レポート、縦棒レポート、棒グラフレポート、円グラフレポート、ドーナツグラフレポート、じょうごグラフレポート、ピラミッドレポート、ボックスレポート、トレンドレポート、トレンドボックスレポートに必要です。リストレポートの場合はオプションです。 | |
| sysparm_query | レポートを生成する前にデータに適用するフィルター。この値にクエリ文字列を指定します。 特定のフィールドでクエリ結果をソートするには、 ^ORDERBY<field_name> または ^ORDERBYDES<field_name> をクエリ文字列の最後に追加します。ORDERBY は、クエリを昇順で並べ替えます。ORDERBYDES は、クエリを降順でソートします。 |
|
| sysparm_aggregate | 集計タイプ。 可能な値:AVG、COUNT、SUM、および COUNT_DISTINCT |
総数 |
| sysparm_sumfield | データを集計するフィールド。このパラメータは、総数集計タイプを使用する場合は適用されません。 | |
| 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 パラメーターで指定されたカタログアイテムに属している必要があります。 |
MetricBase パラメータ
埋め込みレポートで MetricBase を使用するには、sysparm_source_type パラメータを「metricbase」に設定する必要があります。
MetricBase には次の構文を持つ 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_...はプレースホルダー名です
group-by を除くすべての属性が必要です。グラフ固有のパラメータ
特定のパラメータは特定のレポート タイプに対してのみ使用できます。
| パラメータ | 説明 | デフォルト値 |
|---|---|---|
| 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パラメーターの size オプションを使用する代わりに、このパラメーターを有効にして、カスタムグラフの高さと幅の値を指定します。 | false |
| sysparm_custom_chart_height | レポート内のグラフの高さ (ピクセル単位)。 | |
| sysparm_custom_chart_width | レポート内のチャートの幅（ピクセル単位）。 |
グラフ タイトル パラメータ
特定のパラメータは、タイトルを表示するレポートに対してのみ使用できます。これらのレポート タイプには、時系列、棒、縦棒、円、ドーナツ、ダイヤル、トレンド、ボックス、トレンドボックス、ヒストグラム、ピラミッド、ヒートマップ、じょうご、およびコントロールのレポートが含まれます。
| パラメータ | 説明 | デフォルト値 |
|---|---|---|
| sysparm_report_title_size | タイトルのフォント サイズを定義する数値。 | 16 |
| sysparm_report_title_color | タイトル テキストの色。この値は、色定義 [sys_report_color] レコードの sys_id である必要があります。 | 黒 |
| ysparm_title_horizontal_alignment | タイトルはレポートに対して水平に配置されます。この値は、sysparm_custom_report_title_position が false の場合にのみ使用されます。 可能な値は、left、center、および right です。 |
中心 |
| sysparm_title_vertical_alignment | タイトルはレポートに対して垂直に配置されます。この値は、sysparm_custom_report_title_position が false の場合にのみ使用されます。 可能な値:上、中央、下。 |
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 | 凡例は、レポートに対して垂直に配置されます。 可能な値:上、中央、下。 |
下 |
| 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 軸に表示される最高値を定義する数値。 |