解析ルールを作成する

  • リリースバージョン: Washingtondc
  • 更新日 2024年02月01日
  • 読む8読むのに数分

    • カスタムアクティビティで定義された出力変数に、外部ホストまたはエンドポイントでの入力テストから返されたペイロード データを取り込みます。

    始める前に

    必要なロール：activity_admin、activity_creator

    このタスクについて

    手順

    1. 移動先 すべて > Workflow > ワークフローエディター.
    2. パレットの [カスタム] タブから、カスタムアクティビティを開きます。
    3. [アクティビティデザイナー] フォームで、[出力] ステージに進みます。
    4. データ構造ビルダーから [解析ルール] ビルダーの [変数名] フィールドに出力変数をドラッグします。
      図 : 1. 解析ルールへの変数のマッピング
      解析ルールへの変数のマッピング

      選択した変数について、[解析ルール] フォームが表示されます。デフォルトでは、解析タイプは [直接] に設定されています。これにより、変数には、選択したペイロードからのすべてのデータが、内容を解析することなく取り込まれます。各テンプレートには、特定のデフォルトの解析ソースがあります。

    5. テーブル内のフィールド使用して、フォームに値を入力します。
      この例では、解析タイプとして [XML] が選択されています。これにより、ペイロードから特定のパラメーターを選択して解析することができます。
      [解析ルール] フォーム
      表 : 1. 解析ルールのフィールド
      フィールド 説明
      ソースを解析中 ターゲット ホストまたはエンドポイントから返されたデータのソース。各テンプレートは、特定のデフォルト ペイロードに対して開きます。選択可能な項目は、アクティビティに対して選択した実行テンプレートによって異なります。ローカル変数に対してすでに解析ルールが定義されている場合は、そのローカル変数を解析ソースとして使用することもできます。各テンプレートの使用可能なペイロードのリストについては、「アクティビティデザイナーの解析ソース」を参照してください。
      式 選択した解析ソースから特定のデータを抽出するために使用される式。この式は、サンプル ペイロードのクリック可能なデータから作成され、[タイプを解析中] フィールドで選択されたフォーマットで表示されます。テスト時に、式は複数の結果を返す可能性があります。式を選択する前に、信頼できるまたは予測可能な結果が得られる式を見極めてください。
      注:
      システムは、サンプル データからクリック可能な正規表現の式を生成することはできません。すべての正規表現は、手動で記述する必要があります。
      変数名 最終的な出力式で使用される更新済みの変数名。システムによって、指定した変数に activityOutput または activityLocal プリフィックスが追加されます。
      タイプを解析中 ターゲット ホストのペイロードのクエリに使用する言語。選択肢は次のとおりです。
      • 直接：解析することなく、[ソースを解析中] フィールドで選択したペイロードの内容全体にマップします。これがデフォルトの解析タイプです。
      • XML：XML ペイロードからノードを選択するために使用される XPath クエリ。
      • JSON：JSON ペイロードの一部を選択するための JSONPath クエリ。
      • 正規表現：正規表現を使用してペイロードからデータを抽出する解析メソッド。RegEx 解析タイプでは、複数行解析がサポートされておらず、大文字と小文字は区別されません。
      簡単な説明 この解析ルールの簡単な説明。
      サンプル ペイロード データ 要求されたデータを含むソースからのサンプル データ。このフィールドは、[直接] 解析タイプには使用できません。[サンプル データを解析] をクリックした後は、このフィールド内のデータを編集できませんが、式を作成する目的ではクリック可能になります。フィールドを再度編集可能にするには、[サンプル データを編集] をクリックします。
      解析結果 選択した式によりソースから返されたデータが表示されます。このフィールドは、[直接] 解析タイプには使用できません。
    6. 入力を再テストするには、[テストからサンプル ペイロードを取得] をクリックします。
      このアクションにより、テスト フォームが再度開き、さまざまなテスト値を置き換えて別のペイロードを作成することができます。
    7. [保存] をクリックすると、解析ルールにより作成したペイロードで前のペイロードが上書きされます。
    8. 解析ルールの式を作成するには、サンプル ペイロードに表示する特定のパラメーターをクリックします。
      そのパラメーターの値は、[解析結果] フィールドに表示されます。システムによって、[式] フィールドに適切な式が作成されます。
    9. [送信] をクリックして、その変数の解析ルールを保存します。

    アクティビティデザイナーの解析ソース

    次の表に、各実行テンプレートで使用可能な解析ソースを示します。

    表 : 2. ソースを解析中
    テンプレート ソース
    SOAP Web サービス
    • executionResult.body (デフォルト)
    • executionResult.status_code
    • executionResult.header
    • executionResult.error
    JDBC
    • executionResult.output (デフォルト)
    • executionResult.errorMessages
    • executionResult.probeCompletedEccId
    • executionResult.totalRows
    JavaScript プローブ
    • executionResult.payload (デフォルト)
    • executionResult.output
    • executionResult.eccSysId
    • executionResult.errorMessages
    PowerShell
    • executionResult.output (デフォルト)
    • executionResult.tags
    • executionResult.hresult
    • executionResult.eccSysId
    • executionResult.errorMessages
    REST Web サービス
    • executionResult.body (デフォルト)
    • executionResult.status_code
    • executionResult.header
    • executionResult.error
    SFTP
    • executionResult.output (デフォルト)
    • executionResult.eccSysId
    • executionResult.errorMessages
    • executionResult.tags
    プローブ
    • executionResult.output (デフォルト)
    • executionResult.payload
    • executionResult.eccSysId
    SSH
    • executionResult.output (デフォルト)
    • executionResult.eccSysId
    • executionResult.errorMessages
    • executionResult.tags
    JMS
    • executionResult.status
    • executionResult.standardHeaders
    • executionResult.customHeaders
    • executionResult.messagePayload
    • executionResult.eccSysId
    • executionResult.errorMessages

    アクティビティデザイナーの解析ルールの例

    この例では、解析ルールは、PowerShell を使用して、activityOutput.ipv4 変数にドメイン サーバーからの IP アドレスの値が入力されるように構成されています。

    始める前に

    必要なロール：activity_creator、activity_admin

    このタスクについて

    このサンプル データを生成するには、管理者は実際にホスト上でコマンドを実行し、返されたデータを [サンプル ペイロード データ] フィールドに入力する必要があります。その後、管理者は、そのサンプルから IP アドレスを返す式を、2 つの形式 (ipv4 および ipv6) で作成することができます。この例では、解析ルールに使用する式が 2 つ生成されます。

    手順

    1. 移動先 すべて > Workflow > ワークフローエディター をクリックし、ホスト上で実行されるアクティビティを開きます。
    2. [入力] タブをクリックし、[コマンド] をメモします。
      図 : 2. 解析ルール PowerShell 入力コマンド
      解析ルール PowerShell 入力コマンド
    3. PowerShell コンソールで、ホスト上で [コマンド] を実行して、必要な値を含む XML サンプルを抽出します。
    4. 返されたデータをクリップボードにコピーします。
    5. アクティビティデザイナーで、[出力] タブをクリックし、返されたデータを [サンプル ペイロード データ] フィールドに貼り付けます。

      この例では、データには 2 つの異なる形式の IP アドレスとドメイン名が含まれています。

    6. ソースの解析タイプを選択します。
      次の例では、[XML] を選択します。
      解析ルールの生ペイロードデータ
    7. [サンプル データを解析] をクリックします。

      システムによって XML が適切な形式で表示され、クリック可能になります。このビューで、システムはサンプルからクリックされたデータを式に変換することができます。

      解析ルールの解析されたペイロードデータ
    8. 式を作成するには、変数にマップするデータ サンプルの要素をクリックします。

      クリックしたサンプル データに基づいて、2 つの式が作成されます。

      解析ルールの式の作成
    9. リストから式を選択します。

      目的の結果は、[タイプ] 属性が ipv4 の IP アドレスです。システムによって、[式] フィールドにこの選択項目が入力されます。

      解析ルール式の選択
    10. [式をテスト] をクリックします。

      システムによって、選択した式を使用してペイロードが解析され、要求したデータが [解析結果] フィールド内に返されます。

      解析ルール式のテスト
    11. [送信] をクリックします。

      ビューがアクティビティデザイナーの [出力] タブに戻ります。新しい解析ルールがリストされ、別のルールに対して空の行が使用可能になります。

      完了した解析ルールのリスト