Set Payload (<set-payload/>)

logo cloud IDE Cloud IDE

logo desktop IDE Desktop IDE

メッセージのペイロードを設定または更新します。

ペイロードは、文字列リテラルまたは DataWeave 式です。​set-payload​ コンポーネントは、シンプルな式または変換にのみ使用してください。 複雑なシナリオの場合は、​Transform Message コンポーネント​を使用します。

コンポーネント XML

このコンポーネントは、次の XML 構造をサポートします。

<set-payload
  value=""
  doc:name="Set payload"
  doc:id="vnjpqo" />

Set Payload (​<set-payload/>​) 属性は UI および XML で設定できます。

属性名 属性 XML 説明

Set payload (ペイロードを設定)​ (デフォルト)

doc:name

キャンバスに表示されるコンポーネントの編集可能な名前。

なし

doc:id

コンポーネントの自動生成された識別子。

Value (値)

value

リテラル文字列またはペイロードの設定方法を定義した DataWeave 式。例: "some string"​ または ​#[now()]​。この属性は必須です。

なし

resource

DataWeave 変換スクリプトが格納された ​.dwl​ ファイル。これらの値は (動的ではなく) 静的に解決されます。たとえば、​<ee:set-payload resource="myscript-$site.dwl"/>​ を使用するとエラーが発生します。詳細は、​dwl ファイル​を参照してください。

Encoding (エンコード)

encoding

このコンポーネントで出力されるペイロードのエンコード。

Mime type (MIME タイプ)

mimeType

このコンポーネントで出力されるペイロードの MIME タイプ。詳細は、​「リーダーとライターのプロパティの使用」​を参照してください。

パラメーター

なし

リーダープロパティのキーと値のペアを ​outputMimeType​ 属性の値に追加します。複数のキーと値のペアが許可されます。リーダープロパティは MIME タイプに固有です。例として、​application/json​ の​「JSON リーダープロパティ」​を参照してください。他のリーダープロパティを見つけるには、​DataWeave 形式のドキュメント​の「サポートされる形式」に移動し、​「リーダーとライターのプロパティの使用」​を参照してください。

mimeType​ 属性と ​encoding​ 属性は、​value​ に指定された DataWeave 式には影響しません。これらの属性は、​出力​される Mule メッセージにのみ影響します。変換が必要な場合には、DataWeave 式に明示的な​出力​ディレクティブを指定する必要があります。

次の例は、静的な値または DataWeave 式を使用してペイロードを設定する方法を示しています。

例: 静的値を使用したペイロードの設定

次の例では、静的値でペイロードを設定しています。

<set-payload value="{ 'name' : 'Ana', 'office' : 'BA' }" mimeType="application/json" encoding="UTF-8"/>

例: DataWeave 式を使用したペイロードの設定

次の例では、メッセージのペイロードを​「Hello, World」​という文字列リテラルと、​#['Hello World!' ++ ' Today is ' ++ now()]​ という DataWeave 式を使用した今日の日付に設定しています。

<set-payload value="#['Hello World!' ++ ' Today is ' ++ now()]"/>