---
schema_version: "1"
id: f49ff5b06b51128d550dd855f57789720662b1aedf4fd4d7b74e167ac8d3d486
title: Scripting Module リファレンス
collection: mulesoft
version: current
locale: ja-jp
portal_url: https://docs.salesforce.com/mulesoft/current/ja-jp/scripting-module/latest/scripting-reference.md
canonical_url: https://docs.mulesoft.com/jp/scripting-module/latest/scripting-reference
source_site: docs.mulesoft.com
content_type: documentation
content_hash: 04e7c8c6ae60518019e00cd7e250cd1c1d5bab5720b95292f2b3317455837313
description: MuleSoft Documentation Site
release: "2.1"
latest: true
---
# Scripting Module リファレンス

Scripting Module v2.1

Scripting Module は、スクリプト言語で作成されたカスタムロジックを実行します。

## [](#設定)設定

* * *

### [](#Config)設定

デフォルト設定

#### [](#パラメーター)パラメーター

<table class="tableblock frame-all grid-all fit-content spread">
<colgroup>
<col>
<col>
<col>
<col>
<col>
</colgroup>
<thead>
<tr>
<th class="tableblock halign-left valign-top">名前</th>
<th class="tableblock halign-left valign-top">型</th>
<th class="tableblock halign-left valign-top">説明</th>
<th class="tableblock halign-left valign-top">デフォルト値</th>
<th class="tableblock halign-left valign-top">必須</th>
</tr>
</thead>
<tbody>
<tr>
<td class="tableblock halign-left valign-top"><p class="tableblock">Name (名前)</p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">String (文字列)</p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">この設定の名前。コネクタはこの名前の設定を参照します。</p></td>
<td class="tableblock halign-left valign-top"></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">x</p></td>
</tr>
</tbody>
</table>

## [](#操作)操作

### [](#Execute)Execute

`<scripting:execute>`

エンジンと渡されたパラメーターに従ってスクリプトのコードを実行します。スクリプトでは、多くのバインド変数を使用できます。

<table class="tableblock frame-all grid-all stretch">
<colgroup>
<col style="width: 16.6666%;">
<col style="width: 16.6666%;">
<col style="width: 66.6668%;">
</colgroup>
<thead>
<tr>
<th class="tableblock halign-left valign-middle">名前</th>
<th class="tableblock halign-left valign-middle">型</th>
<th class="tableblock halign-left valign-middle">説明</th>
</tr>
</thead>
<tbody>
<tr>
<td class="tableblock halign-left valign-middle"><p class="tableblock">payload (ペイロード)</p></td>
<td class="tableblock halign-left valign-middle"><p class="tableblock">Object (オブジェクト)</p></td>
<td class="tableblock halign-left valign-middle"><p class="tableblock">処理されたメッセージのペイロード。</p></td>
</tr>
<tr>
<td class="tableblock halign-left valign-middle"><p class="tableblock">dataType</p></td>
<td class="tableblock halign-left valign-middle"></td>
<td class="tableblock halign-left valign-middle"><p class="tableblock">メッセージペイロードのデータ型。</p></td>
</tr>
<tr>
<td class="tableblock halign-left valign-middle"><p class="tableblock">correlationId</p></td>
<td class="tableblock halign-left valign-middle"><p class="tableblock">String (文字列)</p></td>
<td class="tableblock halign-left valign-middle"><p class="tableblock">処理されたメッセージの correlationId。</p></td>
</tr>
<tr>
<td class="tableblock halign-left valign-middle"><p class="tableblock">属性</p></td>
<td class="tableblock halign-left valign-middle"><p class="tableblock">Map&lt;String, Object&gt;</p></td>
<td class="tableblock halign-left valign-middle"><p class="tableblock">処理された Mule メッセージの属性。</p></td>
</tr>
<tr>
<td class="tableblock halign-left valign-middle"><p class="tableblock">vars</p></td>
<td class="tableblock halign-left valign-middle"><p class="tableblock">Map&lt;String, Object&gt;</p></td>
<td class="tableblock halign-left valign-middle"><p class="tableblock">処理された現在の Mule イベントに設定されている変数。</p></td>
</tr>
<tr>
<td class="tableblock halign-left valign-middle"><p class="tableblock">メッセージ</p></td>
<td class="tableblock halign-left valign-middle"></td>
<td class="tableblock halign-left valign-middle"><p class="tableblock">処理されたメッセージ。</p></td>
</tr>
<tr>
<td class="tableblock halign-left valign-middle"><p class="tableblock">エラー</p></td>
<td class="tableblock halign-left valign-middle"></td>
<td class="tableblock halign-left valign-middle"><p class="tableblock">処理された Mule メッセージに関連付けられているエラー。</p></td>
</tr>
<tr>
<td class="tableblock halign-left valign-middle"><p class="tableblock">認証</p></td>
<td class="tableblock halign-left valign-middle"></td>
<td class="tableblock halign-left valign-middle"><p class="tableblock">認証に関する情報。</p></td>
</tr>
<tr>
<td class="tableblock halign-left valign-middle"><p class="tableblock">フロー</p></td>
<td class="tableblock halign-left valign-middle"><p class="tableblock">String (文字列)</p></td>
<td class="tableblock halign-left valign-middle"><p class="tableblock">現在のフローの名前。</p></td>
</tr>
<tr>
<td class="tableblock halign-left valign-middle"><p class="tableblock">log</p></td>
<td class="tableblock halign-left valign-middle"><p class="tableblock">ロガー</p></td>
<td class="tableblock halign-left valign-middle"><p class="tableblock">アプリケーションのログファイル ​<code>MULE_HOME/logs/&lt;app-name&gt;.log</code>​ に記録されるロガーオブジェクト。</p></td>
</tr>
<tr>
<td class="tableblock halign-left valign-middle"><p class="tableblock">結果</p></td>
<td class="tableblock halign-left valign-middle"><p class="tableblock">Object (オブジェクト)</p></td>
<td class="tableblock halign-left valign-middle"><p class="tableblock">スクリプトの実行結果を表す変数。</p></td>
</tr>
<tr>
<td class="tableblock halign-left valign-middle"><p class="tableblock">レジストリ</p></td>
<td class="tableblock halign-left valign-middle"><p class="tableblock">org.mule.runtime.api.artifact.Registry</p></td>
<td class="tableblock halign-left valign-middle"><p class="tableblock">レジストリオブジェクトを使用すると、Mule API 内の他のすべてのサービスにアクセスできます。</p></td>
</tr>
</tbody>
</table>

<table><tbody><tr><td class="icon"><i class="fa icon-note" title="Note"></i></td><td class="content">コードで暗黙的な結果が生成されない場合、実行結果で ​<code>result</code>​ 変数値を明示的に設定する必要があります。​<a href="https://docs.mulesoft.com/jp/scripting-module/latest/" class="xref page">「Scripting Module の概要」</a>​に記載されているように、​<a href="https://docs.mulesoft.com/mule-runtime/latest/target-variables" class="xref page">対象変数</a>​を設定していない限り、ペイロードはこの値を使用して設定されます。</td></tr></tbody></table>

#### [](#パラメーター-2)パラメーター

<table class="tableblock frame-all grid-all stretch">
<colgroup>
<col style="width: 20%;">
<col style="width: 20%;">
<col style="width: 35%;">
<col style="width: 20%;">
<col style="width: 5%;">
</colgroup>
<thead>
<tr>
<th class="tableblock halign-left valign-middle">名前</th>
<th class="tableblock halign-left valign-middle">型</th>
<th class="tableblock halign-left valign-middle">説明</th>
<th class="tableblock halign-left valign-middle">デフォルト値</th>
<th class="tableblock halign-center valign-middle">必須</th>
</tr>
</thead>
<tbody>
<tr>
<td class="tableblock halign-left valign-middle"><p class="tableblock">Code (コード)</p></td>
<td class="tableblock halign-left valign-middle"><div class="content"><div class="paragraph">
<p>String (文字列)</p>
</div></div></td>
<td class="tableblock halign-left valign-middle"><p class="tableblock">実行するスクリプトのソースコード。</p></td>
<td class="tableblock halign-left valign-middle"></td>
<td class="tableblock halign-center valign-middle"><p class="tableblock">x</p></td>
</tr>
<tr>
<td class="tableblock halign-left valign-middle"><p class="tableblock">Engine (エンジン)</p></td>
<td class="tableblock halign-left valign-middle"><div class="content"><div class="paragraph">
<p>String (文字列)</p>
</div></div></td>
<td class="tableblock halign-left valign-middle"><p class="tableblock">このスクリプトを実行するスクリプティングエンジンの名前。</p></td>
<td class="tableblock halign-left valign-middle"></td>
<td class="tableblock halign-center valign-middle"><p class="tableblock">x</p></td>
</tr>
<tr>
<td class="tableblock halign-left valign-middle"><p class="tableblock">パラメーター</p></td>
<td class="tableblock halign-left valign-middle"><div class="content"><div class="paragraph">
<p>Map&lt;String, Object&gt;</p>
</div></div></td>
<td class="tableblock halign-left valign-middle"><p class="tableblock">バインドとしてスクリプトに渡される変数。</p></td>
<td class="tableblock halign-left valign-middle"></td>
<td class="tableblock halign-center valign-middle"></td>
</tr>
<tr>
<td class="tableblock halign-left valign-middle"><p class="tableblock">Execution Mode (実行モード)</p></td>
<td class="tableblock halign-left valign-middle"><div class="content"><div class="paragraph">
<p>Enumeration (列挙)。次のいずれかになります。</p>
</div>
<div class="ulist">
<ul>
<li>
<p>AUTO</p>
</li>
<li>
<p>INTERPRETED</p>
</li>
</ul>
</div></div></td>
<td class="tableblock halign-left valign-middle"><p class="tableblock">スクリプトを自動的にコンパイルするか強制的に解釈するかを判断します。​<code>AUTO</code>​ に設定するか指定しないと、モジュールはコンテキストを分析して適切なモードを判断します。​<code>INTERPRETED</code>​ に設定すると、モジュールは強制的に解釈モードにします。</p></td>
<td class="tableblock halign-left valign-middle"><p class="tableblock">AUTO</p></td>
<td class="tableblock halign-center valign-middle"></td>
</tr>
<tr>
<td class="tableblock halign-left valign-middle"><p class="tableblock">Target Variable (対象変数)</p></td>
<td class="tableblock halign-left valign-middle"><div class="content"><div class="paragraph">
<p>String (文字列)</p>
</div></div></td>
<td class="tableblock halign-left valign-middle"><p class="tableblock">操作の出力を配置する変数の名前</p></td>
<td class="tableblock halign-left valign-middle"></td>
<td class="tableblock halign-center valign-middle"></td>
</tr>
<tr>
<td class="tableblock halign-left valign-middle"><p class="tableblock">Target Value (対象値)</p></td>
<td class="tableblock halign-left valign-middle"><div class="content"><div class="paragraph">
<p>String (文字列)</p>
</div></div></td>
<td class="tableblock halign-left valign-middle"><p class="tableblock">操作の出力に対して評価する式。この式の出力は対象変数に保存されます。</p></td>
<td class="tableblock halign-left valign-middle"><p class="tableblock">#[payload]</p></td>
<td class="tableblock halign-center valign-middle"></td>
</tr>
</tbody>
</table>

<table><tbody><tr><td class="icon"><i class="fa icon-important" title="Important"></i></td><td class="content">Scripting Module で使用するクラスをエクスポートする必要があります。そうしないと、​<code>SCRIPTING:COMPILATION</code>​ エラーで実行が失敗します。​<a href="https://docs.mulesoft.com/mule-runtime/latest/how-to-export-resources" class="xref page">「リソースのエクスポート方法」</a>​を参照してください。</td></tr></tbody></table>

#### [](#スロー)スロー

- SCRIPTING:COMPILATION
- SCRIPTING:UNKNOWN\_ENGINE
- SCRIPTING:EXECUTION

## [](#型)型

### [](#AggregationAttributes)集約属性

<table class="tableblock frame-all grid-all stretch">
<colgroup>
<col style="width: 20%;">
<col style="width: 25%;">
<col style="width: 30%;">
<col style="width: 15%;">
<col style="width: 10%;">
</colgroup>
<thead>
<tr>
<th class="tableblock halign-left valign-middle">項目</th>
<th class="tableblock halign-left valign-middle">型</th>
<th class="tableblock halign-left valign-middle">説明</th>
<th class="tableblock halign-left valign-middle">デフォルト値</th>
<th class="tableblock halign-left valign-middle">必須</th>
</tr>
</thead>
<tbody>
<tr>
<td class="tableblock halign-left valign-middle"><p class="tableblock">Aggregation Id (集約 ID)</p></td>
<td class="tableblock halign-left valign-middle"><div class="content"><div class="paragraph">
<p>String (文字列)</p>
</div></div></td>
<td class="tableblock halign-left valign-middle"><p class="tableblock">イベントのメッセージの correlationId から取得される集約 ID。
 アグリゲーターで correlationId 別に集約されない場合、この項目は、
現在の集約グループ。</p></td>
<td class="tableblock halign-left valign-middle"></td>
<td class="tableblock halign-left valign-middle"><p class="tableblock">x</p></td>
</tr>
<tr>
<td class="tableblock halign-left valign-middle"><p class="tableblock">First Item Arrival Time (最初の項目の到着時間)</p></td>
<td class="tableblock halign-left valign-middle"><div class="content"><div class="paragraph">
<p>Number (数値)</p>
</div></div></td>
<td class="tableblock halign-left valign-middle"><p class="tableblock">最初に集約された値が到着した時刻。</p></td>
<td class="tableblock halign-left valign-middle"></td>
<td class="tableblock halign-left valign-middle"><p class="tableblock">x</p></td>
</tr>
<tr>
<td class="tableblock halign-left valign-middle"><p class="tableblock">Last Item Arrival Time (最後の項目の到着時間)</p></td>
<td class="tableblock halign-left valign-middle"><div class="content"><div class="paragraph">
<p>Number (数値)</p>
</div></div></td>
<td class="tableblock halign-left valign-middle"><p class="tableblock">最後に集約された値が到着した時刻。</p></td>
<td class="tableblock halign-left valign-middle"></td>
<td class="tableblock halign-left valign-middle"><p class="tableblock">x</p></td>
</tr>
<tr>
<td class="tableblock halign-left valign-middle"><p class="tableblock">Is Aggregation Complete (集約完了)</p></td>
<td class="tableblock halign-left valign-middle"><div class="content"><div class="paragraph">
<p>Boolean (ブール)</p>
</div></div></td>
<td class="tableblock halign-left valign-middle"><p class="tableblock">集約の完了を示すブール値。</p></td>
<td class="tableblock halign-left valign-middle"><p class="tableblock">false</p></td>
<td class="tableblock halign-left valign-middle"></td>
</tr>
</tbody>
</table>

### [](#RedeliveryPolicy)Redelivery Policy (再配信ポリシー)

エラーを生成する要求を実行するための再配信ポリシーを設定します。再配信ポリシーは、フロー内のあらゆる提供元に追加できます。

<table class="tableblock frame-all grid-all stretch">
<colgroup>
<col style="width: 20%;">
<col style="width: 25%;">
<col style="width: 30%;">
<col style="width: 15%;">
<col style="width: 10%;">
</colgroup>
<thead>
<tr>
<th class="tableblock halign-left valign-middle">項目</th>
<th class="tableblock halign-left valign-middle">型</th>
<th class="tableblock halign-left valign-middle">説明</th>
<th class="tableblock halign-left valign-middle">デフォルト値</th>
<th class="tableblock halign-left valign-middle">必須</th>
</tr>
</thead>
<tbody>
<tr>
<td class="tableblock halign-left valign-middle"><p class="tableblock">Max Redelivery Count (最大再配信数)</p></td>
<td class="tableblock halign-left valign-middle"><div class="content"><div class="paragraph">
<p>Number (数値)</p>
</div></div></td>
<td class="tableblock halign-left valign-middle"><p class="tableblock">​REDELIVERY_EXHAUSTED​ エラーが返されるまでに、再配信された要求が処理に失敗できる最大回数。</p></td>
<td class="tableblock halign-left valign-middle"></td>
<td class="tableblock halign-left valign-middle"></td>
</tr>
<tr>
<td class="tableblock halign-left valign-middle"><p class="tableblock">Use Secure Hash (セキュアハッシュを使用)</p></td>
<td class="tableblock halign-left valign-middle"><div class="content"><div class="paragraph">
<p>Boolean (ブール)</p>
</div></div></td>
<td class="tableblock halign-left valign-middle"><p class="tableblock">​<code>true</code>​ の場合、再配信されたメッセージの識別にセキュアハッシュアルゴリズムが使用されます。</p></td>
<td class="tableblock halign-left valign-middle"></td>
<td class="tableblock halign-left valign-middle"></td>
</tr>
<tr>
<td class="tableblock halign-left valign-middle"><p class="tableblock">Message Digest Algorithm (メッセージダイジェストアルゴリズム)</p></td>
<td class="tableblock halign-left valign-middle"><div class="content"><div class="paragraph">
<p>String (文字列)</p>
</div></div></td>
<td class="tableblock halign-left valign-middle"><p class="tableblock">&lt;b&gt;[Use Secure Hash (セキュアハッシュを使用)]&lt;b/&gt; 項目が ​<code>true</code>​ の場合に使用するセキュアハッシュアルゴリズム。メッセージのペイロードが Java オブジェクトの場合、Mule ではこの値が無視され、ペイロードの ​<code>hashCode()</code>​ が返した値が返されます。</p></td>
<td class="tableblock halign-left valign-middle"></td>
<td class="tableblock halign-left valign-middle"></td>
</tr>
<tr>
<td class="tableblock halign-left valign-middle"><p class="tableblock">Id Expression (ID の式)</p></td>
<td class="tableblock halign-left valign-middle"><div class="content"><div class="paragraph">
<p>String (文字列)</p>
</div></div></td>
<td class="tableblock halign-left valign-middle"><p class="tableblock">メッセージがいつ再配信されたのかを判断する 1 つ以上の式。このプロパティは、&lt;b&gt;[Use Secure Hash (セキュアハッシュを使用)]&lt;/b&gt; 項目が ​<code>false</code>​ の場合にのみ設定できます。</p></td>
<td class="tableblock halign-left valign-middle"></td>
<td class="tableblock halign-left valign-middle"></td>
</tr>
<tr>
<td class="tableblock halign-left valign-middle"><p class="tableblock">Object Store (オブジェクトストア)</p></td>
<td class="tableblock halign-left valign-middle"><div class="content"><div class="paragraph">
<p>ObjectStore</p>
</div></div></td>
<td class="tableblock halign-left valign-middle"><p class="tableblock">各メッセージの再配信カウンターが保存されるオブジェクトストアを設定します。</p></td>
<td class="tableblock halign-left valign-middle"></td>
<td class="tableblock halign-left valign-middle"></td>
</tr>
</tbody>
</table>

## [](#関連情報)関連情報

- [Scripting Module リリースノート](https://docs.mulesoft.com/jp/release-notes/mule-runtime/module-scripting)
- [MuleSoft ヘルプセンター](https://help.mulesoft.com)