XML パーサーステップ

  • リリースバージョン: Xanadu
  • 更新日 2024年08月01日
  • 所要時間：4分

    • 構造化されたデータを XML ペイロードからスクリプト記述不要で識別します。受信 XML 要素を、他のステップまたはアクションで使用できる複合オブジェクト出力にマッピングします。実行時に、XML ペイロードの値が複合オブジェクト出力に入力されます。

    複合オブジェクトの詳細については、「複合データ」を参照してください。

    注:
    このステップには 統合ハブ のサブスクリプションが必要です。詳細については、「 法務スケジュール - 統合ハブの概要」を参照してください。 必要なプラグインを有効化した後、ステップは [統合] の下に表示されます。

    ロールと可用性

    ワークフロースタジオ アクションステップとして利用可能です。action_designer ロールを持つユーザーは、1 つ以上のアクションステップを使用してカスタムアクションを作成できます。

    ペイロードサイズ制限

    実行時に、XML パーサーステップ は最大 10 MB のペイロードをサポートします。ペイロードが大きい場合は、データストリーム アクションを作成します。詳細については、「データストリームアクションおよびページネーション」を参照してください。

    設計時、XML パーサーステップ は最大 64,000 文字のサンプルペイロードをサポートしています。

    フィールド

    フィールド 説明
    ソース [ソースデータ] フィールドで、ソース XML データを含むデータピルを選択またはドラッグします。たとえば、REST ステップの 応答本文 データピルなどです。実行時に、データソースの値が複合オブジェクト出力に設定されます。

    [ソースデータ] のスクリプトウィンドウで、サンプルペイロードを入力して複合オブジェクトを生成します。たとえば、ユーザーのリストを返す REST API ステップからの応答を解析する場合は、1 人のユーザーに期待される XML を入力します。このフィールドは、次の制限付きの XML を受け入れます。

    • XML 名前空間は複合オブジェクトには適用されません。XML ファイル内の複数の名前空間はサポートされていないため、エラーメッセージが生成されます。
    • 多次元アレイはサポートされていません。
    • ハイフンやピリオドなど、一部の特殊文字はサポートされていません。二重コロン (::) は属性値ではサポートされていません。
    • 2 MB を超えるペイロードは保存できず、エラーメッセージが生成されます。ただし、大きなサンプルで作業する場合は、ステップを保存する前に複合オブジェクトを生成し、サンプルペイロードを削除することができます。
    構造化ペイロードビュー サンプルペイロードのビューを選択します。
    • Raw (編集モード)：編集可能な XML を表示します。
    • 構造化：XML をツリービューで表示します。ツリー内の要素をクリックして、要素 XPath をコピーします。[ターゲット] フィールドに複雑なデータを手動で作成する場合は、XPath をターゲットの XPath フィールドに貼り付けることができます。
    ターゲットを生成 サンプルペイロードからステップの出力構造を作成するには、[ターゲットを生成] を選択します。出力データ構造が [ターゲット] フィールドに表示されます。各オブジェクトの子要素は、String タイプとして自動的に生成されます。または、[ターゲット] フィールドで要素を追加して、ターゲット複合オブジェクトを手動で作成することもできます。
    ターゲット

    XML ペイロードの出力構造を表示または編集します。[ターゲットを生成] をクリックして構造化出力を作成するか、手動で要素を追加します。

    各要素には、[オブジェクトの編集] ビューに次の情報が含まれています。

    • [ラベル]：データピルラベル。デフォルトでは、XML 要素の名前が使用されます。
    • [名前]：出力要素の内部名。
      注:
      感嘆符、二重コロン、@ 記号、または数字のみは、要素名の有効な値ではありません。
    • [タイプ]：データタイプ。String、Object、Array.String、または Array.Object である必要があります。最上位の要素は Object である必要があります。
    • [必須]：要素を必須にするために切り替えます。これは String タイプの要素にのみ適用されます。
    • [子アイテムを追加]：[子アイテムを追加] アイコン ([子アイテムを追加] アイコン) を選択して、ネストされた子要素を追加します。

    オブジェクトタイプの要素には、オブジェクトの構造を複合オブジェクトテンプレートとして保存できる [テンプレートとして保存] 詳細オプションが含まれています。このテンプレートを使用して、アクションの Object 出力のスキーマを定義できます。

    文字列タイプの要素の場合、最大長、ヒント、およびデフォルト値を詳細オプションとして追加することもできます。

    出力の構造を変更したら、[ターゲット] ヘッダーで [編集モードの終了] を選択します。[詳細入力の切り替え] アイコン ([詳細入力の切り替え] アイコン) を選択すると、[XPath] オプションを表示できます。

    XPath は要素へのパスです。XPath を変更して、ソースデータ要素を複雑なデータ変数にマップする方法を変更します。複雑なデータ変数を手動で追加する場合は、[ペイロードビュー] フィールドから XPath をコピーし、それを複雑なデータ変数の [XPath] フィールドに貼り付けて、正しい階層を確保することができます。条件付き XPath 式はサポートされていません。