アセット クエリ言語 (AQL) の使用方法

アセット クエリ言語 (AQL) は、Jira Service Management のアセットで使用される言語です。

アセットの最も強力で動的な機能の 1 つである AQL は、さまざまな方法で使用できます。

AQL による詳細検索を使用してオブジェクトを検索する

AQL を使用すると、非常に具体的な検索結果を返すことができます。ベーシック検索とは異なり、AQL による詳細検索では、AND や OR などの論理演算子、キーワード、ドット演算を使用できます。

特定のアセット クエリ言語 (AQL) ステートメントに一致するオブジェクトを単一のオブジェクト スキーマで検索するには、[AQL による詳細検索] を使用できます。

1. 上部のナビゲーション バーで [Assets] を選択します。

2. リストからオブジェクト スキーマを選択します。

3. オブジェクト タイプを選択します。

4. [オブジェクト] モードを選択します。

5. リスト ビューでアイコンを選択するか、詳細ビューで [フィルター] アイコンを選択します。

6. [AQL による詳細検索] タブを選択します。

7. AQL クエリを入力します。

8. [フィルターを更新] を選択します。クエリの結果は、現在選択されているオブジェクト タイプによって事前にフィルタリングされます。

参照属性に表示されるオブジェクトを絞り込む

AQL を使用して、参照属性に表示されるオブジェクトを絞り込むことができます。このフィールドに表示されるオブジェクトはすべて、現在選択されている参照のオブジェクト タイプによってすでにフィルタリングされています。

参照を作成するには、Jira 管理者としてログインするか、オブジェクト スキーマ マネージャ権限を持っている必要があります。

1. サービス プロジェクトから、[アセット] > [オブジェクト スキーマ] の順に移動します。

2. 関連するオブジェクト スキーマを選択します。

3. 関連するオブジェクト タイプを選択します。

4. [属性] を選択します。

5. 属性のリストで、[名前] と [説明] を入力します。

6. 属性のリストで、[タイプ] に「Object」と入力して [タイプ値] で参照するオブジェクト タイプを選択します。

7. 属性のリストの [追加値] で、この参照の [参照タイプ] を選択します。さまざまなタイプの参照を追加、編集、削除する方法をご確認ください。

8. [追加] を選択します。

アセット オブジェクトのカスタム フィールドに表示されるオブジェクトを絞り込む

AQL を使用すると、[フィルター スコープ] フィールドと [フィルター課題スコープ] フィールドで AQL ステートメントを使用して、アセット オブジェクトのカスタム フィールドに表示されるオブジェクトを絞り込むことができます。[フィルター スコープ] フィールドはアセットの属性に基づいて値をフィルタリングするために使用され、[フィルター課題スコープ] フィールドは課題に表示される他の Jira フィールドに基づいて値をフィルタリングするために使用されます。

アセット オブジェクトのフィールド設定を変更するには、Jira 管理者としてログインする必要があります。

1. ナビゲーション サイドバーの [カスタム フィールド] に移動します

2. [アセット オブジェクト] フィールドを見つけます ([タイプ] 列で アセット オブジェクトを検索するか、名前を検索します)。

3. その他のオプション > [コンテキストと既定値] の順に選択します。

4. [Edit Assets objects field configuration (アセット オブジェクトのフィールド設定を編集)] を選択します。

5. フィールドにアクセスするオブジェクト スキーマをドロップダウンから選択します ([オブジェクト スキーマ] の下)。

6. (オプション) [フィルター スコープ (AQL)] にアセット クエリ言語 (AQL) のクエリを入力して、表示するオブジェクトを定義します。このフィールドによって、アセットの属性に基づいてアセット オブジェクトをフィルタリングできます。AQL の詳細をご確認ください。

7. (オプション) [フィルター課題スコープ (AQL)] にアセット クエリ言語 (AQL) のクエリを入力して、表示するオブジェクトを定義します。このフィールドを使用すると、Jira Service Management 内の他のフィールドの値に基づいてアセット オブジェクトをフィルタリングできます。AQL の詳細をご確認ください。

8. (オプション) [フィルター課題スコープ (AQL)] フィールドがポータルに表示された際にそこに既定のオブジェクトが入力されている状態にする場合は、[このフィールドをカスタマー ポータルに表示する際に、既定のオブジェクトを表示] をクリックします。

9. [ユーザー相互作用] で、ユーザーが検索できて課題ビューに表示されるアセット属性を選択します。

10. [保存] を選択します。

Atlassian Automation を使用してオブジェクトを検索する

Atlassian Automation を使用する際、AQL を使用してオブジェクトを検索できます。設定した条件によって Lookup アクションをトリガーできます。

Lookup アクションは、アクションに指定された AQL 値に基づき、{{lookupObjects}} スマート値を使用して他のアクションで使用できるオブジェクトのリストを提供します。Lookup オブジェクトの詳細をご確認ください。

データのインポート時にアセットが属性を作成する方法を管理する

AQL を使用して、データをインポートするときにアセットが属性を作成する方法を管理できます。インポートの一部として属性タイプのマッピングを作成する場合、AQL ステートメント内のプレースホルダーを使用して、AQL フィールドを使用して生データから参照やステータスを作成できます。

たとえば、カテゴリ属性が参照であり、データ ソース フィールドの値に (名前の文字列値ではなく) 参照オブジェクトの名前とリンクを含める場合は、Name = ${Category} のような AQL ステートメントを使用してリンクを作成できます。

インポートを設定するには、Jira 管理者としてログインするか、オブジェクト スキーマ マネージャー権限を持っている必要があります。

1. サービス プロジェクトから、[アセット] > [オブジェクト スキーマ] の順に移動します。

2. オブジェクト スキーマを選択します。

3. [Configure (設定)]、[インポート] タブの順に選択します。

4. [インポート] タブで、インポート構造の [マッピングを編集] を選択してオブジェクト タイプ マッピングを表示します。

5. [属性マッピングを編集] を選択して、属性タイプ マッピングを表示します。

6. アセットにインポートされるすべてのオブジェクトには、少なくとも 1 つの情報が必要です。それは、データ ソース内のどこにオブジェクトがあるかをアセットに知らせる "データ ソース" フィールドです。"データ ソース" フィールドの詳細をご確認ください。

   1. データ ソース フィールドを選択します。データ ソース フィールドは、データ ファイル内のオブジェクトの場所を指定します。属性マッピングは、マッピングされた各属性にデータ ソース フィールドを指定するまで無効になります。

   2. データ ソース フィールドにマッピングする移動先属性を選択します。

   3. オプションで、この属性マッピングの初期設定を変更できます。

      1. AQL - データから参照を作成するには、ここに IQL ステートメントを入力します。

      2. 連結子 - ここに、この属性マッピングにのみ適用される代替連結子を入力します。

      3. 正規表現 - ここに、この属性マッピングにのみ適用される正規表現 (regex) を入力します。

      4. Base 64 - ここに代替の Base 64 値を入力します。

7. 識別子として属性の 1 つを選択します。識別子は各オブジェクトを一意に識別し、オブジェクトが作成されるときにそのオブジェクトの新しいラベルになります。インポートを実行するには、識別子を 1 つのみ含める必要があります。識別子は、データの更新時にも重要です。ターゲット スキーマに同じ識別子がある場合はオブジェクトが更新され、ターゲット スキーマに識別子が見つからない場合はオブジェクトが作成されます。

8. 右側の [追加] をクリックします。

データのインポート時にアセットが子オブジェクトを作成する方法を管理する

AQL を使用して、データをインポートするときにアセットが子オブジェクトを作成する方法を管理できます。1 つ以上の子オブジェクト タイプを持つ親オブジェクト タイプを作成し、その親オブジェクト タイプにデータをインポートする場合、[データ ソースを AQL で絞り込む] フィールドを使用して、入力される各オブジェクトを子オブジェクト タイプに割り当てることができます。

たとえば、ハードウェア アセットという親オブジェクト タイプに 3 つの子オブジェクト タイプ (電話、ノート パソコン、サーバー) があり、入力される各オブジェクトをソース データにある値に基づいて子オブジェクト タイプのいずれかに割り当てる場合は、[データ ソースを AQL で絞り込む] フィールドを使用して子オブジェクトを並べ替えることができます。

インポートを設定するには、Jira 管理者としてログインするか、オブジェクト スキーマ マネージャー権限を持っている必要があります。

1. サービス プロジェクトから、[アセット] > [オブジェクト スキーマ] の順に移動します。

2. オブジェクト スキーマを選択します。

3. [スキーマ設定] を選択して、次に [インポート] タブを選択します。

4. [インポート] タブで、インポート構造の [マッピングを編集] を選択して展開します。

5. 子マッピングを作成するオブジェクト タイプ マッピング > [属性マッピングを編集] の順に選択します。

6. 子マッピングを作成するボタンが属性マッピングの下に表示されます。これを選択して次の情報を入力します。

   1. オブジェクト タイプ - 子オブジェクト タイプは親オブジェクト タイプと同じになるため、このオプションは無効になります。

   2. IQL によるデータソースのフィルタリング - ソースからフェッチされたオブジェクトをクエリするためのオプションの IQL。データからオブジェクトをフィルタリングする場合は、ここで実行できます。

   3. 識別子の大小文字の区別 - このオプションは無効になります。

   4. 欠落しているオブジェクト - 以下から選択します。

      1. 削除 - インポートからのエントリのみ、アセット オブジェクトとして保持されます。アセットに手動で作成されたオブジェクトは削除されます。

      2. アップデート - インポートに存在しないすべてのアセットのオブジェクトで、属性が編集されます。

      3. 無視 - インポートにないアセットのオブジェクトは、削除や更新が行われません。

   5. 欠落しているアウトバウンド参照のオブジェクト - 次から選択します。

      1. 削除 - インポートからのアウトバウンド参照のみがアセット参照として保持されます。アセットで手動で作成されたアウトバウンド参照は削除されます。

      2. 無視 - インポートで見つからないアセットのアウトバウンド参照は、削除もアップデートもされません。

   6. 空の値 - オブジェクトが更新される際に、外部ソースからの空の値で既存の値を削除するかどうかを選択します。次の項目から選択します。

      1. デフォルトを使用 - 該当するオブジェクト タイプに対して [インポート構造を定義] 画面で指定された値を使用します。

      2. 削除 - 現在の値を削除します。属性がステータス、選択、または複数の値を持つ参照タイプ属性である場合、すべての値が削除されます。

      3. 無視 - 該当するオブジェクト タイプに対して現在の値を保持します。属性がステータス、選択、または複数の値を持つ参照タイプ属性である場合、すべての値が保持されます。

   7. 不明な値 - このオプションは無効になります。

7. [作成] を選択します。

アセット REST API を使用する

アセット REST API の呼び出しの一部として AQL を使用し、AQL ステートメントに基づいてオブジェクトを取得できます。

AQL を使用してオブジェクトのリストを取得する方法をご確認ください。