• 製品
  • 関連ドキュメント
  • リソース

「隠し変数」コントロールをセットアップする

「隠し変数」コントロールを使用すると、ダッシュボードで直接アクセスできないフィルター値を設定できます。

「隠し変数」コントロールのセットアップには、主に次の 2 つの手順が必要です。

  1. ダッシュボードに「隠し変数」コントロールを作成します。

  2. 「隠し変数」コントロールをチャートに接続します。

「隠し変数」コントロールを作成する

「隠し変数」コントロールをダッシュボードに追加する方法は次のとおりです。

  1. 「隠し変数」コントロールを追加するダッシュボードを開きます。

  2. ダッシュボードのサイドバーから [Add control] > [Hidden variable] を選択します。コントロールを設定するためのポップアップが表示されます。

  3. 必要に応じてコントロールの設定を編集します。「隠し変数」設定の詳細に関しては、次のセクションをご覧ください。

  4. 追加 を選択します 。


「隠し変数」コントロールの設定

「隠し変数」では次の設定を編集できます。

名前

コントロールの名前

データ タイプ

コントロールのデータ型は次のとおりです。

  • 日付範囲

  • 日付

  • テキスト

  • 数値

Default start and end dates (既定の開始日と終了日)

[データ タイプ] が [日付範囲] の場合にのみ使用可能

固定の日付を使用するか、動的なフィルタリングの場合は相対日付変数日付と時刻の関数を組み合わせて使用します。

複数の値

[データ タイプ] が [数値] または [テキスト] の場合のみ使用可能

コントロールが数値または文字列のリストかどうかを指定します。このオプションを選択すると、複数の既定値を追加できます。

デフォルト値

ダッシュボードを開くときに選択する既定値を設定します。リストされた値をカンマ区切りのリストに変換します。テキスト リストの値は引用符で囲まれていますが、数値リストの値は引用符で囲まれません。


「隠し変数」コントロールをチャートに接続する

「隠し変数」コントロールを作成したら、フィルターに使い始める前に、そのコントロールをチャートに接続する必要があります。クエリで対応するダッシュボード変数を使用することで、チャートに接続します。

ビジュアル モード クエリの場合

ビジュアル モード クエリを使用して「隠し変数」コントロールをチャートに接続する方法は次のとおりです。

  1. 新しいチャートを作成するか、ダッシュボードの既存チャートを編集して、チャート エディターを開きます。

  2. ビジュアル モード クエリの [Filters] セクションで以下を実行します。

    1. コントロールでフィルタリングする列を追加します。「隠し変数」コントロールと同じデータ型でなければなりません。

    2. 適切なフィルター演算子を選択します。

    3. コントロールのダッシュボード変数を指定します。

  3. [Run query] を選択します。結果テーブルは、データに新しいフィルターが適用された状態で更新されます。

  4. チャートを保存するには、[Save to dashboard] を選択します。

「隠し変数」コントロールを使用して、ビジュアル モード クエリで特定の課題番号をフィルタリングします。

SQL モード クエリの場合

SQL モード クエリで「隠し変数」コントロールを接続する構文は、コントロールの設定で選択したデータ型によって異なります。

  • 日付または日付範囲

  • 単一値

  • 複数選択

日付または日付範囲の「隠し変数」

「カレンダー」コントロールや「日付スライダー」コントロールと同じように、次の構文を使用してコントロールの開始日と終了日のプロパティを参照できます。

  • コントロールの [Data type] が [Date] の場合は、{HIDDEN_VARIABLE_NAME} を使用します。

  • コントロールの [Data type] が [Data range] の場合、開始日と終了日のそれぞれに {HIDDEN_VARIABLE_NAME.START}{HIDDEN_VARIABLE_NAME.END} を使用します。

  • HIDDEN_VARIABLE_NAME をコントロールの名前に置き換えます。

これは「隠し変数」コントロールの選択した日付範囲の間に作成された Jira 課題の総数を取得する方法の例です。

1 2 3 SELECT COUNT(DISTINCT "Jira Issue"."issue_id") AS "Count of distinct Issue Id" FROM "jira_issue" AS "Jira Issue" WHERE "Jira Issue"."created_at" BETWEEN {HIDDEN_VARIABLE_NAME.START} AND {HIDDEN_VARIABLE_NAME.END};

単一値の「隠し変数」

[Multi-value] が選択解除されている場合、構文はシンプルで、{HIDDEN_VARIABLE_NAME} になります。HIDDEN_VARIABLE_NAME を自分のコントロールの名前に置き換えます。

データ型がテキストの「隠し変数」コントロールの場合は、値をクエリに渡すときに値を一重引用符で囲みます。一重引用符を削除するには、コントロール名の後に .RAW を追加して {HIDDEN_VARIABLE_NAME.RAW} とします。

これは、選択した「隠し変数」の値とプロジェクト タイプが等しい場合の Jira 課題の総数を取得する方法の例です。

1 2 3 4 5 SELECT COUNT(DISTINCT "Jira Issue"."issue_id") AS "Count of distinct Issue Id" FROM "jira_issue" AS "Jira Issue" INNER JOIN "jira_project" AS "Jira Project" ON "Jira Project"."project_id" = "Jira Issue"."project_id" WHERE "Jira Project"."project_type" = {HIDDEN_VARIABLE_NAME}

複数選択の「隠し変数」

[Multi-value] を選択した場合は、次の構文を使用します。

  • 選択した「隠し変数」の値を持つデータを含める場合: {HIDDEN_VARIABLE_NAME.IN('"table_name"."column_name"')}

  • 選択した「隠し変数」の値を持つデータを除外する場合: {HIDDEN_VARIABLE_NAME.NOT_IN('"table_name"."column_name"')}

HIDDEN_VARIABLE_NAME を自分のコントロールの名前に置き換え、テーブル列の参照は一重引用符で囲む必要があります。

これは、「隠し変数」コントロールで選択されたすべてのプロジェクト タイプの Jira 課題の総数を取得する方法の例です。

1 2 3 SELECT COUNT(DISTINCT "Jira Issue"."issue_id") AS "Count of distinct Issue Id" FROM "jira_issue" AS "Jira Issue" WHERE "Jira Issue"."created_at" BETWEEN {HIDDEN_VARIABLE_NAME.START} AND {HIDDEN_VARIABLE_NAME.END};

これは反対に、「隠し変数」コントロールで選択されていないすべてのプロジェクト タイプの Jira 課題の総数を取得する方法の例です。

1 2 3 4 5 SELECT COUNT(DISTINCT "Jira Issue"."issue_id") AS "Count of distinct Issue Id" FROM "jira_issue" AS "Jira Issue" INNER JOIN "jira_project" AS "Jira Project" ON "Jira Project"."project_id" = "Jira Issue"."project_id" WHERE "Jira Project"."project_type" = {HIDDEN_VARIABLE_NAME}

チャートがコントロールに接続されていることを確認する

チャートがコントロールに正しく接続されていることを確認するには、コントロールの値を更新し、接続されているチャートがその値に応じてフィルタリングされるかどうかを見ることで、接続が適切かを確認できます。

または、次の手順に沿ってコントロールに接続されているすべてのチャートを確認できます。

  1. ダッシュボードのサイドバーで [設定] を選択します。

  2. [Controls (コントロール)] タブに移動します。

  3. [Highlight connections (接続をハイライト)] を選択します。

これによって、その特定のコントロールに接続されているダッシュボード上のすべての要素が強調表示されます。

その他のヘルプ