JIRA「オブジェクトの検索」アクティビティーの使用

「オブジェクトの検索」アクティビティーを使用して、JIRA から Issue、User、UsersOverMultiProject、AssignableUser、および UsersWithPermissions を対象に検索ストリングと一致するレコードをフェッチします。Issue の「検索」アクティビティーでは、カスタム・フィールド・データが取得されます。

このタスクについて

照会パラメーターを設定して、JIRA インスタンスでオブジェクトを検索するには、このタスクを使用します。このアクティビティーの呼び出しは、同期呼び出しです。同期呼び出しでは、入力データが処理のためにアクティビティーに送信され、オーケストレーションに応答が返信されます。

手順

  1. アクティブなオーケストレーションで、「アクティビティー」タブを開いて JIRA フォルダーのコンテンツを展開します。
  2. オブジェクト内の検索」アクティビティー・アイコンをオーケストレーション上にドラッグします。アクティビティーを選択します。 JIRA オブジェクトの検索「チェックリスト」が表示されます。
  3. 「チェックリスト」で「要約」をクリックします。
  4. アクティビティー名」フィールドの内容を確認して、必要な変更を行います。
  5. 「チェックリスト」で「エンドポイントの選出」をクリックします。
  6. 「参照」をクリックし、「プロジェクト・エクスプローラー」ダイアログ・ボックスを使用して、関連する JIRA エンドポイントを選択します。
  7. オプション: 「新規作成」をクリックして必要な接続の詳細を指定することで、エンドポイントを作成することができます。この構成のエンドポイントを保存して使用するには、「OK」をクリックします。
  8. 選択したエンドポイントの構成に対して必要な変更を行うには、「編集」をクリックして、別のウィンドウでオプションにアクセスします。 変更を行うと、アクティブなオーケストレーションにおけるエンドポイントのすべての使用に、グローバルに影響します。
  9. 「チェックリスト」で「構成」をクリックします。
  10. 参照」をクリックして、オブジェクト・タイプを選択します。 「JIRA の参照 (Browse JIRA)」ウィンドウが表示されます。
  11. 「JIRA の参照 (Browse JIRA)」では、オブジェクト・タイプ・リストからオブジェクト・タイプを選択できます。「OK」をクリックします。
  12. 「チェックリスト」で「再試行」をクリックします。 デフォルト設定を確認して、必要な変更を行います。
    注: 詳しくは、『JIRA REST API アクティビティーの再試行オプションの指定』を参照してください。
  13. チェックリスト」から「入力のマップ」を選択します。 「オブジェクトの取得」アクティビティーの選択したオブジェクトから生成された XML スキーマが、「アクティビティーへ」パネルの request 入力パラメーターの下にノードとして表示されます。
  14. オーケストレーション変数とアクティビティーの入力パラメーターとの間のマップを作成します。
    注: 入力構造の必須エレメントの値は、実行時に指定されている必要があります。 この値は、エレメントのデフォルト値を指定するか、エレメントを入力ノードにリンクすることによって指定できます。 実行時に必須エレメントの値が指定されていないと、アクティビティーは Web 管理コンソールから報告された例外をスローします。 実行時にオプションの入力パラメーターの値が指定されていなくても、実行時に例外はスローされません。
  15. チェックリスト」から「出力のマップ」を選択します。 アクティビティーの応答保持のために生成された XML スキーマが、「アクティビティーから」パネルの response 出力パラメーターの下にノードとして表示されます。
  16. 出力パラメーターとオーケストレーション変数との間のマップを作成します。 照会パラメーター

    「オブジェクトの検索」の照会パラメーターを以下に示します。

    表 1. すべての「オブジェクトの検索」の一般的な照会パラメーター
    フィールド名 説明
    startAt 返す最初のレコードの索引 (0 ベース)
    maxResults 返すユーザーの最大数 (デフォルトは 50)。最大許容値は 1000 です。この数より大きい値を指定した場合、検索結果は切り捨てられます。
    表 2. Issue オブジェクト用の照会パラメーター
    フィールド名 説明
    validateQuery このパラメーターは、JQL 照会を妥当性検査するために使用されます。
    responseFields Issue ごとに返すフィールドのリスト。デフォルトでは、すべてのナビゲート可能なフィールドが返されます。
    criteria 基準には、field、operator、value、および logicalOperator が定義されます。 criteria ノードのオカレンスを展開することで、複数の基準を指定できます。
    field 基準に使用される標準のフィールド名を指定します。
    operator 適用する演算子。(例えば、有効な演算子には、=、!=、<、>、<=、>=、~、!~、IN、NOT IN、IS、IS NOT などがあります)
    value 検索で使用されるフィールドの値。
    logicalOperator 適用する論理演算子 (例えば、有効な論理演算子には、AND、OR、NOT、ORDER BY などがあります)。
    orderBy orderBy には、field と order が定義されます。orderBy ノードのオカレンスを展開することで、複数の orderby を指定できます。
    field フィールドを順番に表示するために使用される標準のフィールド名。
    order 順序は、ASC または DESC です。
    表 3. User オブジェクトの一般的な照会パラメーター
    フィールド名 説明
    includeActive このパラメーターは、アクティブ・ユーザーを組み込む場合に使用されます。
    includeInActive このパラメーターは、非アクティブ・ユーザーを組み込む場合に使用されます。
    表 4. UserWithPermission オブジェクトの一般的な照会パラメーター
    フィールド名 説明
    permissions 返されるプロジェクトまたは課題に対してユーザーが保持している必要がある許可のコンマ区切りリスト。
    注: 列挙はコネクターでサポートされないため、ユーザーは照会パラメーターにデータを入力する必要があります。

タスクの結果

JIRA「オブジェクトの検索」アクティビティーを構成しました。