1. Homepage
  2. SAP S/4HANA OData Connector (2.9)

  3. SAP S/4HANA OData Connector リファレンス

All Connectors

SAP S/4HANA OData Connector 2.9 リファレンス

ソフトウェアの要件および互換性に関する情報は、「SAP S/4HANA OData Connector リリースノート」を参照してください。

デフォルト設定

名前 型 説明 デフォルト値 必須

Name (名前)

String (文字列)

この設定の名前。コネクタはこの名前の設定を参照します。

x

Connection (接続)

この設定に指定する接続型。

x

Time Zone (タイムゾーン)

String (文字列)

S/4HANA から返される日付オブジェクトを変換するタイムゾーン。

UTC

Batch Buffer Size (バッチバッファサイズ)

Number (数値)

バッチ要求をメモリ内に保持するためにコネクタで使用する最大メモリを定義します。指定された最大メモリ以上の量がコンシュームされると、コネクタによってディスクへのコンテンツのバッファが開始されます。

512

Buffer Unit (バッファ単位)

Enumeration (列挙)。次のいずれかになります。

  • BYTE (バイト)

  • KB

  • MB

  • GB

batchBufferSize サイズを表す単位。

KB

Response timeout (応答タイムアウト)

Number (数値)

要求の応答タイムアウト。

30

Response Timeout Unit (応答タイムアウト単位)

Enumeration (列挙)。次のいずれかになります。

  • NANOSECONDS

  • MICROSECONDS

  • MILLISECONDS

  • SECONDS

  • MINUTES

  • HOURS

  • DAYS

要求の応答タイムアウト単位。

SECONDS

Encoding (エンコード)

String (文字列)

Name (名前)

String (文字列)

他のコンポーネントでもこの要素を参照するために使用されるこの要素の識別子。

x

Expiration Policy (有効期限ポリシー)

Expiration Policy (有効期限ポリシー)

動的設定インスタンスがアイドル状態を続けられる最小時間を設定します。この時間が経過すると、Mule Runtime で期限切れに相当するとみなされます。インスタンスが期限切れとみなされた瞬間にインスタンスが期限切れになるという意味ではありません。必要に応じて、インスタンスがパージされます。

接続種別

基本認証

基本認証は、Cookie、セッション識別子、ログインページが不要なため、アクセス制御を適用するための最も簡単な方法です。代わりに、HTTP ヘッダーの標準項目を使用するため、ハンドシェイクは必要ありません。このメカニズムでは、転送されるログイン情報の機密性保護が提供されません。ログイン情報は送信時に Base64 を使用してエンコードされますが、他の何らかの方法で暗号化されたりハッシュ化されたりすることはありません。

パラメーター

名前 型 説明 デフォルト値 必須

Service base URL (サービスベース URL)

String (文字列)

コネクタからアクセスし、その他のすべてのエンドポイントの派生元となる SAP S/4HANA インスタンスのベース URL。

x

Cache Entry TTL (キャッシュエントリ TTL)

Number (数値)

存続期間。キャッシュエントリが除去されるまでにキャッシュ内に保持される時間。値を 0 にするとキャッシュが無効になります。

0

Cache Entry TTL Time Unit (キャッシュエントリ TTL の時間単位)

Enumeration (列挙)。次のいずれかになります。

  • NANOSECONDS

  • MICROSECONDS

  • MILLISECONDS

  • SECONDS

  • MINUTES

  • HOURS

  • DAYS

[Cache Entry TTL (キャッシュエントリ TTL)]​ 項目の時間単位。

MINUTES

EDM Expiration Interval (EDM 有効期限間隔)

Number (数値)

ObjectStore 内で有効期限が切れた EDM オブジェクトを確認する間隔。

30

EDM Expiration Interval Time Unit (EDM 有効期限間隔の時間単位)

Enumeration (列挙)。次のいずれかになります。

  • NANOSECONDS

  • MICROSECONDS

  • MILLISECONDS

  • SECONDS

  • MINUTES

  • HOURS

  • DAYS

[EDM Expiration Interval (EDM 有効期限間隔)]​ 項目の時間単位。

MINUTES

Username (ユーザー名)

String (文字列)

SAP S/4HANA にログインするためのアカウントユーザー名。

x

Password (パスワード)

String (文字列)

SAP S/4HANA にログインするためのアカウントパスワード。

x

Discovery Service Enabled (検出サービス有効化)

Boolean (ブール)

自動サービス検出の機能の切り替え。

true

Service discovery relative path (サービス検出相対パス)

String (文字列)

自動サービス検出に使用するエンドポイントへのベース URL からの相対パス。

sap/opu/odata/IWFND/CATALOGSERVICE;v=0002/ServiceCollection

s

OData v4 service discovery relative path (OData v4 サービス検出相対パス)

String (文字列)

自動 OData v4 サービス検出に使用するエンドポイントへのベース URL からの相対パス。

sap/opu/odata4/iwfnd/config/default/iwfnd/catalog/0002/ServiceGroups

Scoped service discovery relative path (スコープ設定されたサービス検出相対パス)

String (文字列)

(カスタム名前空間を使用した) クラウドインスタンスの自動サービス検出に使用するエンドポイントへのベース URL からの相対パス。

sap/opu/odata/IWFND/CATALOGSERVICE;v=0002/ScopedServiceCollection

Unlisted services directory (リストされていないサービスのディレクトリ)

String (文字列)

リストされていないサービスおよび ​[Service Attribute (サービス属性)]​ で宣言されたサービスの共通 HTTP ディレクトリ (サービス URL が指定されていない場合)。この項目を使用すると、ユーザーはサービス URL ではなくサービス名を [unlisted services (リストされていないサービス)] リストに指定したり、サービス URL を ​[Services Attribute (サービス属性)]​ に指定しないようにしたりできます。また、コネクタで ​{base URL parameter}/{this parameter}/{item from unlisted services list or service name from ​Service Attribute​}​ の形式を使用してサービス URL を作成することもできます。

Unlisted services (リストされていないサービス)

Array of String (文字列の配列)

検出されたサービスのリストに追加するサービスのリスト。このリストの各項目は有効なサービス URL である必要があります。また、​{base url parameter}/{service directory parameter}/{item from this list}​ の形式で有効なサービス URL を作成できる必要があります。

Services attributes (サービス属性)

サービス属性​ の配列

検出されたサービスのリストに追加するサービスのリスト。​[Service attributes (サービス属性)]​ を使用すると、新しいサービスを追加したり、既存のサービスを上書きしたりできます。

Default headers (デフォルトヘッダー)

Default Header (デフォルトヘッダー)​ の配列

メッセージに含めるデフォルト HTTP ヘッダー。

Default query parameters (デフォルトクエリパラメーター)

Default Query Param (デフォルトクエリパラメーター)​ の配列

要求に含めるデフォルトクエリパラメーター。

Proxy configuration (プロキシ設定)

Proxy Configuration (プロキシ設定)

コネクタのプロキシ設定。

Connection timeout (接続タイムアウト)

Number (数値)

要求の接続タイムアウト。

30

Connection Timeout Unit (接続タイムアウト単位)

Enumeration (列挙)。次のいずれかになります。

  • NANOSECONDS

  • MICROSECONDS

  • MILLISECONDS

  • SECONDS

  • MINUTES

  • HOURS

  • DAYS

要求の接続タイムアウト単位。

SECONDS

Client timeout (クライアントタイムアウト)

Number (数値)

要求のクライアントタイムアウト。

30

Client Timeout Unit (クライアントタイムアウト単位)

Enumeration (列挙)。次のいずれかになります。

  • NANOSECONDS

  • MICROSECONDS

  • MILLISECONDS

  • SECONDS

  • MINUTES

  • HOURS

  • DAYS

要求のクライアントタイムアウト単位。

SECONDS

Retrieve Csrf Token (Csrf トークンの取得)

Boolean (ブール)

リソース変更要求 (POST 要求など) の前の X-CSRF-Token の自動取得を有効または無効にします。

true

TLS configuration (TLS 設定)

TLS

Mule アプリケーションの通信を保護するためにクライアント側とサーバー側の両方から使用できる TLS の設定を定義します。HTTPS プロトコルを使用すると、HTTP 通信が TLS または SSL を使用して保護されます。プロトコルとして HTTPS が設定されている場合、ユーザーは ​listener-config​ の ​tls:context​ 子要素で少なくともキーストアを設定する必要があります。

HTTP

Reconnection (再接続)

Reconnection (再接続)

アプリケーションがデプロイされると、すべてのコネクタで接続テストが実行されます。​true​ に設定されている場合、関連する再接続戦略をすべて実行した後にテストに合格しないと、デプロイメントが失敗します。

OAuth 2.0 クライアントログイン情報認証

OAuth 2.0 を使用して、ユーザーアカウントをホストするサービスにユーザー認証を委任します。詳細は、​「コネクタの OAuth 2.0 の設定」​または​「CloudHub でのコネクタの OAuth 2.0 の設定」​を参照してください。

パラメーター

名前 型 説明 デフォルト値 必須

Service base URL (サービスベース URL)

String (文字列)

コネクタからアクセスし、その他のすべてのエンドポイントの派生元となる SAP S/4HANA インスタンスのベース URL。

x

Cache Entry TTL (キャッシュエントリ TTL)

Number (数値)

存続期間。キャッシュエントリが除去されるまでにキャッシュ内に保持される時間。値を 0 にするとキャッシュが無効になります。

0

Cache Entry TTL Time Unit (キャッシュエントリ TTL の時間単位)

Enumeration (列挙)。次のいずれかになります。

  • NANOSECONDS

  • MICROSECONDS

  • MILLISECONDS

  • SECONDS

  • MINUTES

  • HOURS

  • DAYS

[Cache Entry TTL (キャッシュエントリ TTL)]​ 項目の時間単位。

MINUTES

EDM Expiration Interval (EDM 有効期限間隔)

Number (数値)

ObjectStore 内で有効期限が切れた EDM オブジェクトを確認する間隔。

30

EDM Expiration Interval Time Unit (EDM 有効期限間隔の時間単位)

Enumeration (列挙)。次のいずれかになります。

  • NANOSECONDS

  • MICROSECONDS

  • MILLISECONDS

  • SECONDS

  • MINUTES

  • HOURS

  • DAYS

[EDM Expiration Interval (EDM 有効期限間隔)]​ 項目の時間単位。

MINUTES

Discovery Service Enabled (検出サービス有効化)

Boolean (ブール)

自動サービス検出の機能の切り替え。

true

Service discovery relative path (サービス検出相対パス)

String (文字列)

自動サービス検出に使用するエンドポイントへのベース URL からの相対パス。

sap/opu/odata/IWFND/CATALOGSERVICE;v=0002/ServiceCollection

OData v4 service discovery relative path (OData v4 サービス検出相対パス)

String (文字列)

自動 OData v4 サービス検出に使用するエンドポイントへのベース URL からの相対パス。

sap/opu/odata4/iwfnd/config/default/iwfnd/catalog/0002/ServiceGroups

Scoped service discovery relative path (スコープ設定されたサービス検出相対パス)

String (文字列)

(カスタム名前空間を使用した) クラウドインスタンスの自動サービス検出に使用するエンドポイントへのベース URL からの相対パス。

sap/opu/odata/IWFND/CATALOGSERVICE;v=0002/ScopedServiceCollection

Unlisted services directory (リストされていないサービスのディレクトリ)

String (文字列)

リストされていないサービスおよび ​[Service Attribute (サービス属性)]​ で宣言されたサービスの共通 HTTP ディレクトリ (サービス URL が指定されていない場合)。この項目を使用すると、ユーザーはサービス URL ではなくサービス名を [unlisted services (リストされていないサービス)] リストに指定したり、サービス URL を ​[Services Attribute (サービス属性)]​ に指定しないようにしたりできます。また、コネクタで ​{base URL parameter}/{this parameter}/{item from unlisted services list or service name from ​Service Attribute​}​ の形式を使用してサービス URL を作成することもできます。

Unlisted services (リストされていないサービス)

Array of String (文字列の配列)

検出されたサービスのリストに追加するサービスのリスト。このリストの各項目は有効なサービス URL である必要があります。また、​{base url parameter}/{service directory parameter}/{item from this list}​ の形式で有効なサービス URL を作成できる必要があります。

Services attributes (サービス属性)

サービス属性​ の配列

検出されたサービスのリストに追加するサービスのリスト。​[Service attributes (サービス属性)]​ を使用すると、新しいサービスを追加したり、既存のサービスを上書きしたりできます。

Default headers (デフォルトヘッダー)

Default Header (デフォルトヘッダー)​ の配列

メッセージに含めるデフォルト HTTP ヘッダー。

Default query parameters (デフォルトクエリパラメーター)

Default Query Param (デフォルトクエリパラメーター)​ の配列

要求に含めるデフォルトクエリパラメーター。

Proxy configuration (プロキシ設定)

Proxy Configuration (プロキシ設定)

コネクタのプロキシ設定。

Connection timeout (接続タイムアウト)

Number (数値)

要求の接続タイムアウト。

30

Connection Timeout Unit (接続タイムアウト単位)

Enumeration (列挙)。次のいずれかになります。

  • NANOSECONDS

  • MICROSECONDS

  • MILLISECONDS

  • SECONDS

  • MINUTES

  • HOURS

  • DAYS

要求の接続タイムアウト単位。

SECONDS

Client timeout (クライアントタイムアウト)

Number (数値)

要求のクライアントタイムアウト。

30

Client Timeout Unit (クライアントタイムアウト単位)

Enumeration (列挙)。次のいずれかになります。

  • NANOSECONDS

  • MICROSECONDS

  • MILLISECONDS

  • SECONDS

  • MINUTES

  • HOURS

  • DAYS

要求のクライアントタイムアウト単位。

SECONDS

Retrieve Csrf Token (Csrf トークンの取得)

Boolean (ブール)

リソース変更要求 (POST 要求など) の前の X-CSRF-Token の自動取得を有効または無効にします。

true

TLS configuration (TLS 設定)

TLS

Mule アプリケーションの通信を保護するためにクライアント側とサーバー側の両方から使用できる TLS の設定を定義します。HTTPS プロトコルを使用すると、HTTP 通信が TLS または SSL を使用して保護されます。プロトコルとして HTTPS が設定されている場合、ユーザーは ​listener-config​ の ​tls:context​ 子要素で少なくともキーストアを設定する必要があります。

HTTP

Reconnection (再接続)

Reconnection (再接続)

アプリケーションがデプロイされると、すべてのコネクタで接続テストが実行されます。​true​ に設定されている場合、関連する再接続戦略をすべて実行した後にテストに合格しないと、デプロイメントが失敗します。

Client Id (クライアント ID)

String (文字列)

サービスプロバイダーに登録されている OAuth クライアント ID。

x

Client Secret (クライアントシークレット)

String (文字列)

サービスプロバイダーに登録されている OAuth クライアントシークレット。

x

Token Url (トークン URL)

String (文字列)

サービスプロバイダーのトークンエンドポイント URL。

https://{host-name}/{oauth-service}/{generate-token-resource}

Scopes (スコープ)

String (文字列)

OAuth ダンス時に要求する OAuth スコープ。指定しない場合、デフォルトのアノテーションの範囲になります。

Object Store (オブジェクトストア)

String (文字列)

各リソースオーナー ID のデータの保存に使用するオブジェクトストアへの参照。指定されていない場合、Mule が自動的にデフォルトのオブジェクトストアをプロビジョニングします。

サポートされている操作

Batch Create Entity

<s4hana:batch-create-entity>

この操作では、エンティティの作成要求をバッチに追加します。これは動的な操作であり、OData 仕様でこの操作によって返されると記されている内容を返します。この要求がサーバーによって正常に処理されなかった場合、この操作の結果は空の JSON になります。この結果は、​Execute batch​ 操作の実行後にのみ使用できるようになります。​Execute batch​ 操作を実行する前に結果にアクセスすると、エラーになります。

パラメーター

名前 型 説明 デフォルト値 必須

Configuration (設定)

String (文字列)

使用する設定の名前。

x

Config Ref (設定参照)

ConfigurationProvider

このコンポーネントを実行するために使用する設定の名前。

x

Streaming Strategy (ストリーミング戦略)

ストリーミング戦略を使用して、Mule によるストリームの処理方法を設定します。反復可能ストリームは、デフォルトの動作です。

Batch ID (バッチ ID)

String (文字列)

バッチ識別子。

x

Change set ID (変更セット ID)

String (文字列)

変更セット識別子。

x

Service (サービス)

String (文字列)

サービスの種別。これは、SAP S/4HANA インスタンスで使用可能なサービスから定義されます。

x

Entity type (エンティティ種別)

String (文字列)

操作を実行するエンティティの種別。これは、選択したサービスで使用可能なエンティティの種別から定義されます。

x

Entity (エンティティ)

Object (オブジェクト)

影響を受ける SAP S/4HANA インスタンスのエンティティ。このエンティティは ​Entity type (エンティティ種別)​ パラメーターで定義される種別である必要があります。

#[payload]

Custom headers (カスタムヘッダー)

Object (オブジェクト)

要求に含めるカスタムヘッダー。ここで指定したカスタムヘッダーにより、設定で指定したデフォルトヘッダーが上書きされます。

Custom query parameters (カスタムクエリパラメーター)

Object (オブジェクト)

要求に含めるカスタムクエリパラメーター。ここで指定したカスタムクエリパラメーターにより、設定で指定したデフォルトクエリパラメーターが上書きされます。

Response timeout (応答タイムアウト)

Number (数値)

要求の応答タイムアウト。ここで指定されたタイムアウトにより、設定で指定したデフォルトのタイムアウトが上書きされます。

Response Timeout Unit (応答タイムアウト単位)

Enumeration (列挙)。次のいずれかになります。

  • NANOSECONDS

  • MICROSECONDS

  • MILLISECONDS

  • SECONDS

  • MINUTES

  • HOURS

  • DAYS

要求の応答タイムアウト単位。ここで指定したタイムアウト単位により、設定で指定したデフォルト単位が上書きされます。

Target Variable (対象変数)

String (文字列)

操作の出力を保存する変数の名前。

Target Value (対象値)

String (文字列)

操作の出力に対して評価される式。この式の結果が対象変数に保存されます。

#[payload]

Reconnection Strategy (再接続戦略)

接続エラーが発生した場合の再試行戦略。

出力

Type (型)

Any (任意)

次の設定の場合

スロー

  • S4HANA:CONNECTIVITY

  • S4HANA:NO_SUCH_BATCH_ID

  • S4HANA:NO_SUCH_CHANGE_SET_ID

  • S4HANA:NO_SUCH_ENTITY_TYPE

  • S4HANA:NO_SUCH_SERVICE

  • S4HANA:RETRY_EXHAUSTED

Batch Delete Entity

<s4hana:batch-delete-entity>

エンティティの削除要求をバッチに追加します。

パラメーター

名前 型 説明 デフォルト値 必須

Configuration (設定)

String (文字列)

使用する設定の名前。

x

Config Ref (設定参照)

ConfigurationProvider

このコンポーネントを実行するために使用する設定の名前。

x

Batch ID (バッチ ID)

String (文字列)

バッチ識別子。

x

Change set ID (変更セット ID)

String (文字列)

変更セット識別子。

x

Service (サービス)

String (文字列)

サービスの種別。これは、SAP S/4HANA インスタンスで使用可能なサービスから定義されます。

x

Entity type (エンティティ種別)

String (文字列)

操作を実行するエンティティの種別。これは、選択したサービスで使用可能なエンティティの種別から定義されます。

x

Entity key (エンティティキー)

Object (オブジェクト)

検索するエンティティ (それ自体がオブジェクトである可能性もあります) を識別するオブジェクト。これは、選択されたエンティティの種別によって定義されます。

#[payload]

Custom headers (カスタムヘッダー)

Object (オブジェクト)

要求に含めるカスタムヘッダー。ここで指定したカスタムヘッダーにより、設定で指定したデフォルトヘッダーが上書きされます。

Custom query parameters (カスタムクエリパラメーター)

Object (オブジェクト)

要求に含めるカスタムクエリパラメーター。ここで指定したカスタムクエリパラメーターにより、設定で指定したデフォルトクエリパラメーターが上書きされます。

Response timeout (応答タイムアウト)

Number (数値)

要求の応答タイムアウト。ここで指定されたタイムアウトにより、設定で指定したデフォルトのタイムアウトが上書きされます。

Response Timeout Unit (応答タイムアウト単位)

Enumeration (列挙)。次のいずれかになります。

  • NANOSECONDS

  • MICROSECONDS

  • MILLISECONDS

  • SECONDS

  • MINUTES

  • HOURS

  • DAYS

要求の応答タイムアウト単位。ここで指定したタイムアウト単位により、設定で指定したデフォルト単位が上書きされます。

Reconnection Strategy (再接続戦略)

接続エラーが発生した場合の再試行戦略。

次の設定の場合

スロー

  • S4HANA:CONNECTIVITY

  • S4HANA:INVALID_KEY

  • S4HANA:NO_SUCH_BATCH_ID

  • S4HANA:NO_SUCH_CHANGE_SET_ID

  • S4HANA:NO_SUCH_ENTITY_TYPE

  • S4HANA:NO_SUCH_SERVICE

  • S4HANA:RETRY_EXHAUSTED

Batch Execute Function

<s4hana:batch-execute-function>

この操作では、関数の実行要求 (呼び出し要求) をバッチに追加します。この要求がサーバーによって正常に処理されなかった場合、この操作の結果は空の JSON になります。この結果は、​Execute batch​ 操作の実行後にのみ使用できるようになります。​Execute batch​ 操作を実行する前に結果にアクセスすると、エラーが発生します。

[Change set ID (変更セット ID)]​ パラメーターの変更セット識別子を指定する必要があるのは、POST HTTP メソッドを使用して ​Execute Batch Function​ を実行する場合のみです。それ以外の場合、変更セット識別子は指定しません。

次のような場合は、コネクタで例外がスローされます。

  • 変更セット識別子が指定されていないにもかかわらず POST HTTP メソッドが使用された場合。

  • 変更セット識別子が指定されているにもかかわらず ​Execute Batch Function​ で GET HTTP メソッドが使用された場合。

パラメーター

名前 型 説明 デフォルト値 必須

Configuration (設定)

String (文字列)

使用する設定の名前。

x

Config Ref (設定参照)

ConfigurationProvider

このコンポーネントを実行するために使用する設定の名前。

x

Streaming Strategy (ストリーミング戦略)

ストリーミング戦略を使用して、Mule によるストリームの処理方法を設定します。反復可能ストリームは、デフォルトの動作です。

Batch ID (バッチ ID)

String (文字列)

バッチ識別子。

x

Change set ID (変更セット ID)

String (文字列)

変更セット識別子。

Service (サービス)

String (文字列)

サービスの種別。これは、SAP S/4HANA インスタンスで使用可能なサービスから定義されます。

x

Function Name (関数名)

String (文字列)

実行する関数の名前。

x

Input parameters (入力パラメーター)

Object (オブジェクト)

1 つのオブジェクトにラップされる関数のパラメーター。

Custom headers (カスタムヘッダー)

Object (オブジェクト)

要求に含めるカスタムヘッダー。ここで指定したカスタムヘッダーにより、設定で指定したデフォルトヘッダーが上書きされます。

Custom query parameters (カスタムクエリパラメーター)

Object (オブジェクト)

要求に含めるカスタムクエリパラメーター。ここで指定したカスタムクエリパラメーターにより、設定で指定したデフォルトクエリパラメーターが上書きされます。

Response timeout (応答タイムアウト)

Number (数値)

要求の応答タイムアウト。ここで指定されたタイムアウトにより、設定で指定したデフォルトのタイムアウトが上書きされます。

Response Timeout Unit (応答タイムアウト単位)

Enumeration (列挙)。次のいずれかになります。

  • NANOSECONDS

  • MICROSECONDS

  • MILLISECONDS

  • SECONDS

  • MINUTES

  • HOURS

  • DAYS

要求の応答タイムアウト単位。ここで指定したタイムアウト単位により、設定で指定したデフォルト単位が上書きされます。

Target Variable (対象変数)

String (文字列)

操作の出力を保存する変数の名前。

Target Value (対象値)

String (文字列)

操作の出力に対して評価される式。この式の結果が対象変数に保存されます。

#[payload]

Reconnection Strategy (再接続戦略)

接続エラーが発生した場合の再試行戦略。

出力

Type (型)

Any (任意)

次の設定の場合

スロー

  • S4HANA:BATCH_PROCESSING_ERROR

  • S4HANA:CONNECTIVITY

  • S4HANA:INVALID_ENTITY

  • S4HANA:INVALID_FUNCTION_PARAMETER

  • S4HANA:NO_SUCH_BATCH_ID

  • S4HANA:NO_SUCH_CHANGE_SET_ID

  • S4HANA:NO_SUCH_FUNCTION

  • S4HANA:NO_SUCH_SERVICE

  • S4HANA:RETRY_EXHAUSTED

Batch Get Entity

<s4hana:batch-get-entity>

定義済みのキーを使用したクエリ操作要求をバッチに追加します。これは動的な操作であり、OData 仕様でこの操作によって返されると記されている内容を返します。この要求がサーバーによって正常に処理されなかった場合、この操作の結果は空の JSON になります。この結果は、Execute batch 操作の実行後にのみ使用できるようになります。Execute batch 操作を実行する前に結果にアクセスすると、エラーが発生します。

パラメーター

名前 型 説明 デフォルト値 必須

Configuration (設定)

String (文字列)

使用する設定の名前。

x

Config Ref (設定参照)

ConfigurationProvider

このコンポーネントを実行するために使用する設定の名前。

x

Streaming Strategy (ストリーミング戦略)

ストリーミング戦略を使用して、Mule によるストリームの処理方法を設定します。反復可能ストリームは、デフォルトの動作です。

Batch ID (バッチ ID)

String (文字列)

バッチ識別子。

x

Service (サービス)

String (文字列)

サービスの種別。これは、SAP S/4HANA インスタンスで使用可能なサービスから定義されます。

x

Entity type (エンティティ種別)

String (文字列)

操作を実行するエンティティの種別。これは、選択したサービスで使用可能なエンティティの種別から定義されます。

x

Returned Fields (返される項目)

String (文字列)

選択句のカンマ区切りリスト。各選択句は、プロパティ名、ナビゲーションプロパティ名、または「*」文字にすることができます。「*」構文を使用すると、関連付けをトラバースすることなく、エントリのすべてのプロパティが含まれます。スラッシュ「/」を使用すると、拡張ナビゲーションプロパティの項目が選択されます。項目を選択しない場合、すべての項目が返されます。

Expanded properties (拡張プロパティ)

String (文字列)

ナビゲーションプロパティのカンマ区切りリスト。また、各ナビゲーションプロパティの後にスラッシュと別のナビゲーションプロパティを続けて、複数レベルのリレーションを識別できます。拡張ナビゲーションプロパティのプロパティは、選択されない限り、ペイロードには含まれません。

Entity key (エンティティキー)

Object (オブジェクト)

検索するエンティティ (それ自体がオブジェクトである可能性もあります) を識別するオブジェクト。これは、選択されたエンティティの種別によって定義されます。

#[payload]

Custom headers (カスタムヘッダー)

Object (オブジェクト)

要求に含めるカスタムヘッダー。ここで指定したカスタムヘッダーにより、設定で指定したデフォルトヘッダーが上書きされます。

Custom query parameters (カスタムクエリパラメーター)

Object (オブジェクト)

要求に含めるカスタムクエリパラメーター。ここで指定したカスタムクエリパラメーターにより、設定で指定したデフォルトクエリパラメーターが上書きされます。

Response timeout (応答タイムアウト)

Number (数値)

要求の応答タイムアウト。ここで指定されたタイムアウトにより、設定で指定したデフォルトのタイムアウトが上書きされます。

Response Timeout Unit (応答タイムアウト単位)

Enumeration (列挙)。次のいずれかになります。

  • NANOSECONDS

  • MICROSECONDS

  • MILLISECONDS

  • SECONDS

  • MINUTES

  • HOURS

  • DAYS

要求の応答タイムアウト単位。ここで指定したタイムアウト単位により、設定で指定したデフォルト単位が上書きされます。

Target Variable (対象変数)

String (文字列)

操作の出力を保存する変数の名前。

Target Value (対象値)

String (文字列)

操作の出力に対して評価される式。この式の結果が対象変数に保存されます。

#[payload]

Reconnection Strategy (再接続戦略)

接続エラーが発生した場合の再試行戦略。

出力

Type (型)

Any (任意)

次の設定の場合

スロー

  • S4HANA:CONNECTIVITY

  • S4HANA:INVALID_KEY

  • S4HANA:NO_SUCH_BATCH_ID

  • S4HANA:NO_SUCH_ENTITY_TYPE

  • S4HANA:NO_SUCH_SERVICE

  • S4HANA:RETRY_EXHAUSTED

Batch Query Entity

<s4hana:batch-query>

クエリ操作要求をバッチに追加し、定義されたパラメーターで結果を絞り込みます。検索条件を追加しない場合は、すべての結果がリストされます。この要求がサーバーによって正常に処理されなかった場合、この操作の結果は空の JSON になります。この結果は、Execute batch 操作の実行後にのみ使用できるようになります。Execute batch 操作を実行する前に結果にアクセスすると、エラーが発生します。

パラメーター

名前 型 説明 デフォルト値 必須

Configuration (設定)

String (文字列)

使用する設定の名前。

x

Config Ref (設定参照)

ConfigurationProvider

このコンポーネントを実行するために使用する設定の名前。

x

Streaming Strategy (ストリーミング戦略)

ストリーミング戦略を使用して、Mule によるストリームの処理方法を設定します。反復可能ストリームは、デフォルトの動作です。

Batch ID (バッチ ID)

String (文字列)

バッチ識別子。

x

Service (サービス)

String (文字列)

サービスの種別。これは、SAP S/4HANA インスタンスで使用可能なサービスから定義されます。

x

Entity type (エンティティ種別)

String (文字列)

操作を実行するエンティティの種別。これは、選択したサービスで使用可能なエンティティの種別から定義されます。

x

Returned Fields (返される項目)

String (文字列)

選択句のカンマ区切りリスト。各選択句は、プロパティ名、ナビゲーションプロパティ名、または「*」文字にすることができます。「*」構文を使用すると、関連付けをトラバースすることなく、エントリのすべてのプロパティが含まれます。スラッシュ「/」を使用すると、拡張ナビゲーションプロパティの項目が選択されます。項目を選択しない場合、すべての項目が返されます。

Expanded properties (拡張プロパティ)

String (文字列)

ナビゲーションプロパティのカンマ区切りリスト。また、各ナビゲーションプロパティの後にスラッシュと別のナビゲーションプロパティを続けて、複数レベルのリレーションを識別できます。拡張ナビゲーションプロパティのプロパティは、選択されない限り、ペイロードには含まれません。

Filter (検索条件)

String (文字列)

エンティティの結果のリストを絞り込む条件。

Order by (並び替え基準)

String (文字列)

asc​ または ​desc​ サフィックスを使用して昇順または降順で要求された情報を並び替えることができます。​asc​ または ​desc​ を指定しない場合、リソースは昇順で並び替えられます。

asc

Maximum returned elements (返される最大要素数)

Number (数値)

このクエリによって取得されるレコードの数を制限します。

Skipped record amount (スキップされるレコードの数)

Number (数値)

結果を返す前にスキップするレコードの数。

0

Custom headers (カスタムヘッダー)

Object (オブジェクト)

要求に含めるカスタムヘッダー。ここで指定したカスタムヘッダーにより、設定で指定したデフォルトヘッダーが上書きされます。

Custom query parameters (カスタムクエリパラメーター)

Object (オブジェクト)

要求に含まれるカスタムクエリパラメーター。ここで指定されたヘッダーは、設定で指定されたデフォルトヘッダーを上書きします。

Response timeout (応答タイムアウト)

Number (数値)

要求の応答タイムアウト。ここで指定されたタイムアウトにより、設定で指定したデフォルトのタイムアウトが上書きされます。

Response Timeout Unit (応答タイムアウト単位)

Enumeration (列挙)。次のいずれかになります。

  • NANOSECONDS

  • MICROSECONDS

  • MILLISECONDS

  • SECONDS

  • MINUTES

  • HOURS

  • DAYS

要求の応答タイムアウト単位。ここで指定したタイムアウト単位により、設定で指定したデフォルト単位が上書きされます。

Target Variable (対象変数)

String (文字列)

操作の出力を保存する変数の名前。

Target Value (対象値)

String (文字列)

操作の出力に対して評価される式。この式の結果が対象変数に保存されます。

#[payload]

Reconnection Strategy (再接続戦略)

接続エラーが発生した場合の再試行戦略。

出力

Type (型)

Any (任意)

次の設定の場合

スロー

  • S4HANA:CONNECTIVITY

  • S4HANA:NO_SUCH_BATCH_ID

  • S4HANA:RETRY_EXHAUSTED

Batch Update Entity

<s4hana:batch-update-entity>

エンティティの更新要求をバッチに追加します。この操作は、PATCH 要求を介して機能します。つまり、欠落している項目が更新されることはありません。

ユーザーは、カスタムビジネスオブジェクトのカスタム名前空間を指定できません。

パラメーター

名前 型 説明 デフォルト値 必須

Configuration (設定)

String (文字列)

使用する設定の名前。

x

Config Ref (設定参照)

ConfigurationProvider

このコンポーネントを実行するために使用する設定の名前。

x

Batch ID (バッチ ID)

String (文字列)

バッチ識別子。

x

Change set ID (変更セット ID)

String (文字列)

変更セット識別子。

x

Service (サービス)

String (文字列)

サービスの種別。これは、SAP S/4HANA インスタンスで使用可能なサービスから定義されます。

x

Entity type (エンティティ種別)

String (文字列)

操作を実行するエンティティの種別。これは、選択したサービスで使用可能なエンティティの種別から定義されます。

x

Entity (エンティティ)

Object (オブジェクト)

SAP S/4HANA インスタンスで影響を受けるエンティティ。このエンティティは type パラメーターで定義される種別である必要があります。

#[payload]

Custom headers (カスタムヘッダー)

Object (オブジェクト)

要求に含めるカスタムヘッダー。ここで指定したカスタムヘッダーにより、設定で指定したデフォルトヘッダーが上書きされます。

Custom query parameters (カスタムクエリパラメーター)

Object (オブジェクト)

要求に含まれるカスタムクエリパラメーター。ここで指定されたヘッダーは、設定で指定されたデフォルトヘッダーを上書きします。

Response timeout (応答タイムアウト)

Number (数値)

要求の応答タイムアウト。ここで指定されたタイムアウトにより、設定で指定したデフォルトのタイムアウトが上書きされます。

Response Timeout Unit (応答タイムアウト単位)

Enumeration (列挙)。次のいずれかになります。

  • NANOSECONDS

  • MICROSECONDS

  • MILLISECONDS

  • SECONDS

  • MINUTES

  • HOURS

  • DAYS

要求の応答タイムアウト単位。ここで指定したタイムアウト単位により、設定で指定したデフォルト単位が上書きされます。

Reconnection Strategy (再接続戦略)

接続エラーが発生した場合の再試行戦略。

次の設定の場合

スロー

  • S4HANA:CONNECTIVITY

  • S4HANA:INVALID_KEY

  • S4HANA:NO_SUCH_BATCH_ID

  • S4HANA:NO_SUCH_CHANGE_SET_ID

  • S4HANA:NO_SUCH_ENTITY_TYPE

  • S4HANA:NO_SUCH_SERVICE

  • S4HANA:RESOURCE_NOT_FOUND

  • S4HANA:RETRY_EXHAUSTED

Batch Upsert Custom Business Object

<s4hana:batch-upsert-custom-business-object>

この操作では、カスタムビジネスオブジェクトの更新/挿入がサポートされています。

ユーザーは、カスタムビジネスオブジェクトのカスタム名前空間を指定できません。

パラメーター

名前 型 説明 デフォルト値 必須

Configuration (設定)

String (文字列)

使用する設定の名前。

x

Config Ref (設定参照)

ConfigurationProvider

このコンポーネントを実行するために使用する設定の名前。

x

Streaming Strategy (ストリーミング戦略)

Mule によるストリームの処理方法を設定します。デフォルトでは、反復可能ストリームが使用されます。

Batch ID (バッチ ID)

String (文字列)

バッチ識別子。

x

Change set ID (変更セット ID)

String (文字列)

変更セット識別子。

x

Service (サービス)

String (文字列)

サービス種別。これは、SAP S/4HANA インスタンスで使用可能なサービスから定義されます。

x

Entity type (エンティティ種別)

String (文字列)

実行するエンティティ種別の名前。

x

Entity (エンティティ)

Object (オブジェクト)

1 つのオブジェクトにラップされるエンティティ種別のカスタムビジネスオブジェクトエンティティ。

#[payload]

Custom headers (カスタムヘッダー)

Object (オブジェクト)

要求に含まれるカスタムヘッダー。ここで指定したカスタムヘッダーにより、設定で指定したデフォルトヘッダーが上書きされます。

Custom query parameters (カスタムクエリパラメーター)

Object (オブジェクト)

要求に含まれるカスタムクエリパラメーター。ここで指定したカスタムクエリパラメーターにより、設定で指定したデフォルトクエリパラメーターが上書きされます。

Response timeout (応答タイムアウト)

Number (数値)

Mule が応答の完了を待機する時間。この時間が経過すると、要求がタイムアウトします。

Response Timeout Unit (応答タイムアウト単位)

Enumeration (列挙)。次のいずれかになります。

  • NANOSECONDS

  • MICROSECONDS

  • MILLISECONDS

  • SECONDS

  • MINUTES

  • HOURS

  • DAYS

[Response Timeout (応答タイムアウト)]​ 項目の時間単位。

Target Variable (対象変数)

String (文字列)

操作の出力を保存する変数の名前。

Target Value (対象値)

String (文字列)

操作の出力を評価する式。式の結果は ​[Target Variable (対象変数)]​ 項目に保存されます。

#[payload]

Reconnection Strategy (再接続戦略)

接続エラーが発生した場合の再試行戦略。

出力

Type (型)

Any (任意)

次の設定の場合

スロー

  • S4HANA:CONNECTIVITY

  • S4HANA:NO_SUCH_BATCH_ID

  • S4HANA:NO_SUCH_CHANGE_SET_ID

  • S4HANA:NO_SUCH_SERVICE

  • S4HANA:RESOURCE_NOT_FOUND

  • S4HANA:RETRY_EXHAUSTED

Create Change Set

<s4hana:create-change-set>

バッチで新しい変更セットを作成し、その識別子を返します。

パラメーター

名前 型 説明 デフォルト値 必須

Configuration (設定)

String (文字列)

使用する設定の名前。

x

Config Ref (設定参照)

ConfigurationProvider

このコンポーネントを実行するために使用する設定の名前。

x

Batch ID (バッチ ID)

String (文字列)

バッチ識別子。

x

Target Variable (対象変数)

String (文字列)

操作の出力を保存する変数の名前。

Target Value (対象値)

String (文字列)

操作の出力に対して評価される式。この式の結果が対象変数に保存されます。

#[payload]

Reconnection Strategy (再接続戦略)

接続エラーが発生した場合の再試行戦略。

出力

Type (型)

String (文字列)

次の設定の場合

スロー

  • S4HANA:CONNECTIVITY

  • S4HANA:NO_SUCH_BATCH_ID

  • S4HANA:RETRY_EXHAUSTED

Create Entity

<s4hana:create-entity>

接続された SAP S/4HANA インスタンス内で create 操作を実行します。これは動的な操作であり、OData 仕様でこの操作によって返されると記されている内容を返します。

パラメーター

名前 型 説明 デフォルト値 必須

Configuration (設定)

String (文字列)

使用する設定の名前。

x

Config Ref (設定参照)

ConfigurationProvider

このコンポーネントを実行するために使用する設定の名前。

x

Service (サービス)

String (文字列)

サービスの種別。これは、SAP S/4HANA インスタンスで使用可能なサービスから定義されます。

x

Entity type (エンティティ種別)

String (文字列)

操作を実行するエンティティの種別。これは、選択したサービスで使用可能なエンティティの種別から定義されます。

x

Entity (エンティティ)

Object (オブジェクト)

SAP S/4HANA インスタンスで影響を受けるエンティティ。このエンティティは type パラメーターで定義される種別である必要があります。

#[payload]

Custom headers (カスタムヘッダー)

Object (オブジェクト)

要求に含めるカスタムヘッダー。ここで指定したカスタムヘッダーにより、設定で指定したデフォルトヘッダーが上書きされます。

Custom query parameters (カスタムクエリパラメーター)

Object (オブジェクト)

要求に含まれるカスタムクエリパラメーター。ここで指定されたヘッダーは、設定で指定されたデフォルトヘッダーを上書きします。

Response timeout (応答タイムアウト)

Number (数値)

要求の応答タイムアウト。ここで指定されたタイムアウトにより、設定で指定したデフォルトのタイムアウトが上書きされます。

Response Timeout Unit (応答タイムアウト単位)

Enumeration (列挙)。次のいずれかになります。

  • NANOSECONDS

  • MICROSECONDS

  • MILLISECONDS

  • SECONDS

  • MINUTES

  • HOURS

  • DAYS

要求の応答タイムアウト単位。ここで指定したタイムアウト単位により、設定で指定したデフォルト単位が上書きされます。

Target Variable (対象変数)

String (文字列)

操作の出力を保存する変数の名前。

Target Value (対象値)

String (文字列)

操作の出力に対して評価される式。この式の結果が対象変数に保存されます。

#[payload]

Reconnection Strategy (再接続戦略)

接続エラーが発生した場合の再試行戦略。

出力

Type (型)

Object (オブジェクト)

Attributes Type (属性型)

応答属性

次の設定の場合

スロー

  • S4HANA:CONNECTIVITY

  • S4HANA:INVALID_ENTITY

  • S4HANA:INVALID_KEY

  • S4HANA:NO_SUCH_ENTITY_KEY

  • S4HANA:NO_SUCH_ENTITY_TYPE

  • S4HANA:NO_SUCH_SERVICE

  • S4HANA:RETRY_EXHAUSTED

  • S4HANA:SERVER_ERROR

  • S4HANA:TIMEOUT

  • S4HANA:UNAUTHORIZED

Delete Entity

<s4hana:delete-entity>

接続された SAP S/4HANA インスタンス内で delete 操作を実行します。

パラメーター

名前 型 説明 デフォルト値 必須

Configuration (設定)

String (文字列)

使用する設定の名前。

x

Config Ref (設定参照)

ConfigurationProvider

このコンポーネントを実行するために使用する設定の名前。

x

Service (サービス)

String (文字列)

サービスの種別。これは、SAP S/4HANA インスタンスで使用可能なサービスから定義されます。

x

Entity type (エンティティ種別)

String (文字列)

操作を実行するエンティティの種別。これは、選択したサービスで使用可能なエンティティの種別から定義されます。

x

Entity key (エンティティキー)

Object (オブジェクト)

検索するエンティティ (それ自体がオブジェクトである可能性もあります) を識別するオブジェクト。これは、選択されたエンティティの種別によって定義されます。

#[payload]

Custom headers (カスタムヘッダー)

Object (オブジェクト)

要求に含めるカスタムヘッダー。ここで指定したカスタムヘッダーにより、設定で指定したデフォルトヘッダーが上書きされます。

Custom query parameters (カスタムクエリパラメーター)

Object (オブジェクト)

要求に含まれるカスタムクエリパラメーター。ここで指定されたヘッダーは、設定で指定されたデフォルトヘッダーを上書きします。

Response timeout (応答タイムアウト)

Number (数値)

要求の応答タイムアウト。ここで指定されたタイムアウトにより、設定で指定したデフォルトのタイムアウトが上書きされます。

Response Timeout Unit (応答タイムアウト単位)

Enumeration (列挙)。次のいずれかになります。

  • NANOSECONDS

  • MICROSECONDS

  • MILLISECONDS

  • SECONDS

  • MINUTES

  • HOURS

  • DAYS

要求の応答タイムアウト単位。ここで指定したタイムアウト単位により、設定で指定したデフォルト単位が上書きされます。

Reconnection Strategy (再接続戦略)

接続エラーが発生した場合の再試行戦略。

次の設定の場合

スロー

  • S4HANA:CONNECTIVITY

  • S4HANA:INVALID_ENTITY

  • S4HANA:INVALID_KEY

  • S4HANA:NO_SUCH_ENTITY_KEY

  • S4HANA:NO_SUCH_ENTITY_TYPE

  • S4HANA:NO_SUCH_SERVICE

  • S4HANA:RETRY_EXHAUSTED

  • S4HANA:SERVER_ERROR

  • S4HANA:TIMEOUT

  • S4HANA:UNAUTHORIZED

Execute Batch

<s4hana:execute-batch>

バッチを実行し、バッチのすべての要求の結果が含まれるサマリーを返します。この操作を正常に実行した後で、このバッチに含まれていた各バッチ操作の詳細な結果を確認できるようになります。

パラメーター

名前 型 説明 デフォルト値 必須

Configuration (設定)

String (文字列)

使用する設定の名前。

x

Service (サービス)

String (文字列)

SAP S/4HANA のサービス。

x

Config Ref (設定参照)

ConfigurationProvider

このコンポーネントを実行するために使用する設定の名前。

x

Batch ID (バッチ ID)

String (文字列)

バッチ識別子。

x

Custom headers (カスタムヘッダー)

Object (オブジェクト)

要求に含めるカスタムヘッダー。ここで指定したカスタムヘッダーにより、設定で指定したデフォルトヘッダーが上書きされます。

Custom query parameters (カスタムクエリパラメーター)

Object (オブジェクト)

要求に含まれるカスタムクエリパラメーター。ここで指定されたヘッダーは、設定で指定されたデフォルトヘッダーを上書きします。

Response timeout (応答タイムアウト)

Number (数値)

要求の応答タイムアウト。ここで指定されたタイムアウトにより、設定で指定したデフォルトのタイムアウトが上書きされます。

Response Timeout Unit (応答タイムアウト単位)

Enumeration (列挙)。次のいずれかになります。

  • NANOSECONDS

  • MICROSECONDS

  • MILLISECONDS

  • SECONDS

  • MINUTES

  • HOURS

  • DAYS

要求の応答タイムアウト単位。ここで指定したタイムアウト単位により、設定で指定したデフォルト単位が上書きされます。

Target Variable (対象変数)

String (文字列)

操作の出力を保存する変数の名前。

Target Value (対象値)

String (文字列)

操作の出力に対して評価される式。この式の結果が対象変数に保存されます。

#[payload]

Reconnection Strategy (再接続戦略)

接続エラーが発生した場合の再試行戦略。

出力

Type (型)

Bulk Operation Result (一括操作結果)

次の設定の場合

スロー

  • S4HANA:BATCH_PROCESSING_ERROR

  • S4HANA:CONNECTIVITY

  • S4HANA:NO_SUCH_BATCH_ID

  • S4HANA:NO_SUCH_SERVICE

  • S4HANA:RETRY_EXHAUSTED

Execute Function

<s4hana:execute-function>

SAP S/4HANA インスタンスで OData の定義済みの関数を実行します。

パラメーター

名前 型 説明 デフォルト値 必須

Configuration (設定)

String (文字列)

使用する設定の名前。

x

Config Ref (設定参照)

ConfigurationProvider

このコンポーネントを実行するために使用する設定の名前。

x

Service (サービス)

String (文字列)

サービスの種別。これは、SAP S/4HANA インスタンスで使用可能なサービスから定義されます。

x

Function Name (関数名)

String (文字列)

実行する関数の名前。

x

Input parameters (入力パラメーター)

Object (オブジェクト)

1 つのオブジェクトにラップされる関数のパラメーター。

Custom headers (カスタムヘッダー)

Object (オブジェクト)

要求に含めるカスタムヘッダー。ここで指定したカスタムヘッダーにより、設定で指定したデフォルトヘッダーが上書きされます。

Custom query parameters (カスタムクエリパラメーター)

Object (オブジェクト)

要求に含まれるカスタムクエリパラメーター。ここで指定されたヘッダーは、設定で指定されたデフォルトヘッダーを上書きします。

Response timeout (応答タイムアウト)

Number (数値)

要求の応答タイムアウト。ここで指定されたタイムアウトにより、設定で指定したデフォルトのタイムアウトが上書きされます。

Response Timeout Unit (応答タイムアウト単位)

Enumeration (列挙)。次のいずれかになります。

  • NANOSECONDS

  • MICROSECONDS

  • MILLISECONDS

  • SECONDS

  • MINUTES

  • HOURS

  • DAYS

要求の応答タイムアウト単位。ここで指定したタイムアウト単位により、設定で指定したデフォルト単位が上書きされます。

Target Variable (対象変数)

String (文字列)

操作の出力を保存する変数の名前。

Target Value (対象値)

String (文字列)

操作の出力に対して評価される式。この式の結果が対象変数に保存されます。

#[payload]

Reconnection Strategy (再接続戦略)

接続エラーが発生した場合の再試行戦略。

出力

Type (型)

Any (任意)

Attributes Type (属性型)

応答属性

次の設定の場合

スロー

  • S4HANA:CONNECTIVITY

  • S4HANA:INVALID_FUNCTION_PARAMETER

  • S4HANA:NO_SUCH_FUNCTION

  • S4HANA:NO_SUCH_SERVICE

  • S4HANA:RETRY_EXHAUSTED

  • S4HANA:SERVER_ERROR

  • S4HANA:TIMEOUT

  • S4HANA:UNAUTHORIZED

Get Entity by Key

<s4hana:get-entity>

結果をキーで絞り込む SAP S/4HANA インスタンスで retrieve 操作を実行します。要素が見つからないと、エラーがスローされます。

パラメーター

名前 型 説明 デフォルト値 必須

Configuration (設定)

String (文字列)

使用する設定の名前。

x

Config Ref (設定参照)

ConfigurationProvider

このコンポーネントを実行するために使用する設定の名前。

x

Service (サービス)

String (文字列)

サービスの種別。これは、SAP S/4HANA インスタンスで使用可能なサービスから定義されます。

x

Entity type (エンティティ種別)

String (文字列)

操作を実行するエンティティの種別。これは、選択したサービスで使用可能なエンティティの種別から定義されます。

x

Returned Fields (返される項目)

String (文字列)

選択句のカンマ区切りリスト。各選択句は、プロパティ名、ナビゲーションプロパティ名、または「*」文字にすることができます。「*」構文を使用すると、関連付けをトラバースすることなく、エントリのすべてのプロパティが含まれます。スラッシュ「/」を使用すると、拡張ナビゲーションプロパティの項目が選択されます。項目を選択しない場合、すべての項目が返されます。

Expanded properties (拡張プロパティ)

String (文字列)

ナビゲーションプロパティのカンマ区切りリスト。また、各ナビゲーションプロパティの後にスラッシュと別のナビゲーションプロパティを続けて、複数レベルのリレーションを識別できます。拡張ナビゲーションプロパティのプロパティは、選択されない限り、ペイロードには含まれません。

Entity key (エンティティキー)

Object (オブジェクト)

検索するエンティティ (それ自体がオブジェクトである可能性もあります) を識別するオブジェクト。これは、選択されたエンティティの種別によって定義されます。

#[payload]

Custom headers (カスタムヘッダー)

Object (オブジェクト)

要求に含めるカスタムヘッダー。ここで指定したカスタムヘッダーにより、設定で指定したデフォルトヘッダーが上書きされます。

Custom query parameters (カスタムクエリパラメーター)

Object (オブジェクト)

要求に含まれるカスタムクエリパラメーター。ここで指定されたヘッダーは、設定で指定されたデフォルトヘッダーを上書きします。

Response timeout (応答タイムアウト)

Number (数値)

要求の応答タイムアウト。ここで指定されたタイムアウトにより、設定で指定したデフォルトのタイムアウトが上書きされます。

Response Timeout Unit (応答タイムアウト単位)

Enumeration (列挙)。次のいずれかになります。

  • NANOSECONDS

  • MICROSECONDS

  • MILLISECONDS

  • SECONDS

  • MINUTES

  • HOURS

  • DAYS

要求の応答タイムアウト単位。ここで指定したタイムアウト単位により、設定で指定したデフォルト単位が上書きされます。

Target Variable (対象変数)

String (文字列)

操作の出力を保存する変数の名前。

Target Value (対象値)

String (文字列)

操作の出力に対して評価される式。この式の結果が対象変数に保存されます。

#[payload]

Reconnection Strategy (再接続戦略)

接続エラーが発生した場合の再試行戦略。

出力

Type (型)

Object (オブジェクト)

Attributes Type (属性型)

応答属性

次の設定の場合

スロー

  • S4HANA:CONNECTIVITY

  • S4HANA:INVALID_ENTITY

  • S4HANA:INVALID_KEY

  • S4HANA:NO_SUCH_ENTITY_FIELD

  • S4HANA:NO_SUCH_ENTITY_KEY

  • S4HANA:NO_SUCH_ENTITY_TYPE

  • S4HANA:NO_SUCH_NAVIGATION_PROPERTY

  • S4HANA:NO_SUCH_SERVICE

  • S4HANA:RETRY_EXHAUSTED

  • S4HANA:SERVER_ERROR

  • S4HANA:TIMEOUT

  • S4HANA:UNAUTHORIZED

Initiate Batch

<s4hana:initiate-batch>

バッチでバッチを作成し、その識別子を返します。

パラメーター

名前 型 説明 デフォルト値 必須

Configuration (設定)

String (文字列)

使用する設定の名前。

x

Config Ref (設定参照)

ConfigurationProvider

このコンポーネントを実行するために使用する設定の名前。

x

Target Variable (対象変数)

String (文字列)

操作の出力を保存する変数の名前。

Target Value (対象値)

String (文字列)

操作の出力に対して評価される式。この式の結果が対象変数に保存されます。

#[payload]

Reconnection Strategy (再接続戦略)

接続エラーが発生した場合の再試行戦略。

出力

Type (型)

String (文字列)

次の設定の場合

スロー

  • S4HANA:CONNECTIVITY

  • S4HANA:RETRY_EXHAUSTED

Query

<s4hana:query>

SAP S/4HANA インスタンスで retrieve 操作を実行し、定義されたパラメーターで結果を絞りみます。検索条件を追加しない場合は、すべての結果がリストされます。これはページ分割操作です。

この操作を使用するには、SAP S/4HANA インスタンスでページネーションサポートを有効にする必要があります。

パラメーター

名前 型 説明 デフォルト値 必須

Configuration (設定)

String (文字列)

使用する設定の名前。

x

Config Ref (設定参照)

ConfigurationProvider

このコンポーネントを実行するために使用する設定の名前。

x

Streaming Strategy (ストリーミング戦略)

ストリーミング戦略を使用して、Mule によるストリームの処理方法を設定します。反復可能ストリームは、デフォルトの動作です。

Service (サービス)

String (文字列)

サービスの種別。これは、SAP S/4HANA インスタンスで使用可能なサービスから定義されます。

x

Entity type (エンティティ種別)

String (文字列)

操作を実行するエンティティの種別。これは、選択したサービスで使用可能なエンティティの種別から定義されます。

x

Returned Fields (返される項目)

String (文字列)

選択句のカンマ区切りリスト。各選択句は、プロパティ名、ナビゲーションプロパティ名、または「*」文字にすることができます。「*」構文を使用すると、関連付けをトラバースすることなく、エントリのすべてのプロパティが含まれます。スラッシュ「/」を使用すると、拡張ナビゲーションプロパティの項目が選択されます。項目を選択しない場合、すべての項目が返されます。

Expanded properties (拡張プロパティ)

String (文字列)

ナビゲーションプロパティのカンマ区切りリスト。また、各ナビゲーションプロパティの後にスラッシュと別のナビゲーションプロパティを続けて、複数レベルのリレーションを識別できます。拡張ナビゲーションプロパティのプロパティは、選択されない限り、ペイロードには含まれません。

Filter (検索条件)

String (文字列)

エンティティの結果のリストを絞り込む条件。

Order by (並び替え基準)

String (文字列)

?asc? または ?desc? サフィックスを使用して昇順または降順で要求情報を並び替えることができます。asc または desc を指定しない場合、リソースは昇順で並び替えられます。

Maximum returned elements (返される最大要素数)

Number (数値)

このクエリによって取得されるレコードの数を制限します。

Skipped record amount (スキップされるレコードの数)

Number (数値)

結果を返す前にスキップするレコードの数。

0

Page size (ページサイズ)

Number (数値)

クエリによって取得されるページのサイズ。

100

Legacy Pagination (従来のページネーション)

Boolean (ブール)

ユーザーがバージョン 2.6.2 以前の従来のページネーションを使用できるようにします。

false

Custom headers (カスタムヘッダー)

Object (オブジェクト)

要求に含めるカスタムヘッダー。ここで指定したカスタムヘッダーにより、設定で指定したデフォルトヘッダーが上書きされます。

Custom query parameters (カスタムクエリパラメーター)

Object (オブジェクト)

要求に含まれるカスタムクエリパラメーター。ここで指定されたヘッダーは、設定で指定されたデフォルトヘッダーを上書きします。

Response timeout (応答タイムアウト)

Number (数値)

要求の応答タイムアウト。ここで指定されたタイムアウトにより、設定で指定したデフォルトのタイムアウトが上書きされます。

Response Timeout Unit (応答タイムアウト単位)

Enumeration (列挙)。次のいずれかになります。

  • NANOSECONDS

  • MICROSECONDS

  • MILLISECONDS

  • SECONDS

  • MINUTES

  • HOURS

  • DAYS

要求の応答タイムアウト単位。ここで指定したタイムアウト単位により、設定で指定したデフォルト単位が上書きされます。

Target Variable (対象変数)

String (文字列)

操作の出力を保存する変数の名前。

Target Value (対象値)

String (文字列)

操作の出力に対して評価される式。この式の結果が対象変数に保存されます。

#[payload]

Reconnection Strategy (再接続戦略)

接続エラーが発生した場合の再試行戦略。

出力

Type (型)

Array of Object (オブジェクトの配列)

次の設定の場合

スロー

  • S4HANA:INVALID_ENTITY

  • S4HANA:INVALID_FILTER

  • S4HANA:INVALID_KEY

  • S4HANA:INVALID_PAGE_SIZE

  • S4HANA:INVALID_SKIP_SIZE

  • S4HANA:INVALID_TOP_SIZE

  • S4HANA:NO_SUCH_ENTITY_FIELD

  • S4HANA:NO_SUCH_ENTITY_KEY

  • S4HANA:NO_SUCH_ENTITY_TYPE

  • S4HANA:NO_SUCH_NAVIGATION_PROPERTY

  • S4HANA:NO_SUCH_SERVICE

  • S4HANA:NO_SUCH_SORTING_FIELD

  • S4HANA:SERVER_ERROR

  • S4HANA:TIMEOUT

  • S4HANA:UNAUTHORIZED

Unauthorize

<s4hana:unauthorize>

特定のリソースオーナー ID のアクセストークン情報をすべて削除して、認証ダンスが繰り返されない限り、そのユーザー向けの操作を実行できないようにします。

パラメーター

名前 型 説明 デフォルト値 必須

Configuration (設定)

String (文字列)

使用する設定の名前。

x

Config Ref (設定参照)

ConfigurationProvider

このコンポーネントを実行するために使用する設定の名前。

x

次の設定の場合

Update Entity

<s4hana:update-entity>

接続された SAP S/4HANA インスタンス内で update 操作を実行します。この操作は、PATCH 要求を介して機能します。つまり、欠落している項目が更新されることはありません。

パラメーター

名前 型 説明 デフォルト値 必須

Configuration (設定)

String (文字列)

使用する設定の名前。

x

Config Ref (設定参照)

ConfigurationProvider

このコンポーネントを実行するために使用する設定の名前。

x

Service (サービス)

String (文字列)

サービスの種別。これは、SAP S/4HANA インスタンスで使用可能なサービスから定義されます。

x

Entity type (エンティティ種別)

String (文字列)

操作を実行するエンティティの種別。これは、選択したサービスで使用可能なエンティティの種別から定義されます。

x

Entity (エンティティ)

Object (オブジェクト)

影響を受ける SAP S/4HANA インスタンスのエンティティ。このエンティティは type パラメーターで定義される種別である必要があります。

#[payload]

Custom headers (カスタムヘッダー)

Object (オブジェクト)

要求に含めるカスタムヘッダー。ここで指定したカスタムヘッダーにより、設定で指定したデフォルトヘッダーが上書きされます。

Custom query parameters (カスタムクエリパラメーター)

Object (オブジェクト)

要求に含めるカスタムクエリパラメーター。ここで指定したカスタムクエリパラメーターにより、設定で指定したデフォルトクエリパラメーターが上書きされます。

Response timeout (応答タイムアウト)

Number (数値)

要求の応答タイムアウト。ここで指定されたタイムアウトにより、設定で指定したデフォルトのタイムアウトが上書きされます。

Response Timeout Unit (応答タイムアウト単位)

Enumeration (列挙)。次のいずれかになります。

  • NANOSECONDS

  • MICROSECONDS

  • MILLISECONDS

  • SECONDS

  • MINUTES

  • HOURS

  • DAYS

要求の応答タイムアウト単位。ここで指定したタイムアウト単位により、設定で指定したデフォルト単位が上書きされます。

Reconnection Strategy (再接続戦略)

接続エラーが発生した場合の再試行戦略。

次の設定の場合

スロー

  • S4HANA:CONNECTIVITY

  • S4HANA:INVALID_ENTITY

  • S4HANA:INVALID_KEY

  • S4HANA:NO_SUCH_ENTITY_KEY

  • S4HANA:NO_SUCH_ENTITY_TYPE

  • S4HANA:NO_SUCH_SERVICE

  • S4HANA:RETRY_EXHAUSTED

  • S4HANA:SERVER_ERROR

  • S4HANA:TIMEOUT

  • S4HANA:UNAUTHORIZED

型

サービス属性

サービスに関する詳細を指定します (名前空間は個別の設定)。

項目 型 説明 デフォルト値 必須

Service Name (サービス名)

String (文字列)

サービス名。通常はサービスカタログのタイトルです。URL にバージョンサフィックスが含まれている場合、サービス名は URL の最後の ​/​ の後に含まれます。たとえば、URL が ​{base URL parameter}/sap/opu/odata/sap/SERVICE_NAME;v=0002​ の場合、サービス名は ​SERVICE_NAME;v=0002​ です。OData API v4 のサービス名は異なります。

x

Service Url (サービス URL)

String (文字列)

サービスへの URL。

Namespace (名前空間)

String (文字列)

サービスのカスタム名前空間 (該当する場合)。

Default Header (デフォルトヘッダー)

項目 型 説明 デフォルト値 必須

Key (キー)

String (文字列)

キー。

x

Value (値)

String (文字列)

値。

x

Default Query Param (デフォルトクエリパラメーター)

項目 型 説明 デフォルト値 必須

Key (キー)

String (文字列)

キー。

x

Value (値)

String (文字列)

値。

x

Proxy Configuration (プロキシ設定)

項目 型 説明 デフォルト値 必須

Host (ホスト)

String (文字列)

プロキシ要求が送信されるホスト。

x

Port (ポート)

Number (数値)

プロキシ要求が送信されるポート。

x

Username (ユーザー名)

String (文字列)

プロキシに対して認証するユーザー名。

Password (パスワード)

String (文字列)

プロキシに対して認証するパスワード。

Non Proxy Hosts (非プロキシホスト)

Array of String (文字列の配列)

プロキシを使用してはならないホストのリスト。

Ntlm Domain (NTLM ドメイン)

String (文字列)

プロキシに対して認証するドメイン。

TLS

Mule アプリケーションの通信を保護するためにクライアント側とサーバー側の両方から使用できる TLS の設定を定義します。HTTPS プロトコルを使用すると、HTTP 通信が TLS または SSL を使用して保護されます。プロトコルとして HTTPS が設定されている場合、ユーザーは ​listener-config​ の ​tls:context​ 子要素で少なくともキーストアを設定する必要があります。

項目 型 説明 デフォルト値 必須

Enabled Protocols (有効化されたプロトコル)

String (文字列)

このコンテキストで有効化されたプロトコルのカンマ区切りリスト。

Enabled Cipher Suites (有効化された暗号化スイート)

String (文字列)

このコンテキストで有効化された暗号化スイートのカンマ区切りリスト。

Trust Store (トラストストア)

Truststore (トラストストア)

Key Store (キーストア)

Keystore (キーストア)

Revocation Check (取り消し確認)

Truststore (トラストストア)

項目 型 説明 デフォルト値 必須

Path (パス)

String (文字列)

トラストストアの場所 (可能な場合、現在のクラスパスとファイルシステムを基準として解決されます)。

Password (パスワード)

String (文字列)

トラストストアを保護するために使用するパスワード。

Type (型)

String (文字列)

使用するストアの型。

Algorithm (アルゴリズム)

String (文字列)

トラストストアで使用するアルゴリズム。

Insecure (安全ではない)

Boolean (ブール)

true​ の場合、証明書の検証が実行されず、攻撃に対して接続が脆弱になります。各自の責任で使用してください。

Keystore (キーストア)

項目 型 説明 デフォルト値 必須

Path (パス)

String (文字列)

キーストアの場所 (可能な場合、現在のクラスパスとファイルシステムを基準として解決されます)。

Type (型)

String (文字列)

使用するストアの型。

Alias (別名)

String (文字列)

キーストアに多数の非公開鍵がある場合、この属性は、使用するキーの別名を示します。定義しない場合、デフォルトでファイル内の最初の鍵が使用されます。

Key Password (キーパスワード)

String (文字列)

非公開キーを保護するために使用するパスワード。

Password (パスワード)

String (文字列)

キーストアを保護するために使用するパスワード。

Algorithm (アルゴリズム)

String (文字列)

キーストアで使用するアルゴリズム。

Standard Revocation Check (標準の取り消し確認)

項目 型 説明 デフォルト値 必須

Only End Entities (最後のエンティティのみ)

Boolean (ブール)

証明書チェーンの最後の要素のみを確認します。

Prefer Crls (CRL を優先)

Boolean (ブール)

最初に OCSP ではなく CRL を試みます。

No Fallback (代替なし)

Boolean (ブール)

第 2 の確認方法 (以前に選択されていない方法) を使用しません。

Soft Fail (ソフトフェール)

Boolean (ブール)

取り消しサーバーに到達できない場合や取り消しサーバーが混雑している場合に検証エラーを回避します。

Custom OCSP Responder (カスタム OCSP レスポンダー)

項目 型 説明 デフォルト値 必須

Url

String (文字列)

OCSP レスポンダーの URL。

Cert Alias (証明書の別名)

String (文字列)

(トラストストアに含まれている) OCSP 応答の署名証明書の別名 (存在する場合)。

CRL File (CRL ファイル)

項目 型 説明 デフォルト値 必須

Path (パス)

String (文字列)

CRL ファイルへのパス。

Reconnection (再接続)

項目 型 説明 デフォルト値 必須

Fails Deployment (デプロイメントに失敗)

Boolean (ブール)

アプリケーションがデプロイされると、すべてのコネクタで接続テストが実行されます。true に設定されている場合、関連する再接続戦略をすべて実行した後にテストに合格しないと、デプロイメントが失敗します。

Reconnection Strategy (再接続戦略)

使用する再接続戦略。

Reconnect (再接続)

項目 型 説明 デフォルト値 必須

Frequency (頻度)

Number (数値)

再接続する頻度 (ミリ秒)。

Blocking

Boolean (ブール)

false​ の場合、再接続戦略が個別の非ブロックスレッドで実行されます。

Count (数)

Number (数値)

再接続の試行回数。

Reconnect Forever (繰り返し再接続)

項目 型 説明 デフォルト値 必須

Frequency (頻度)

Number (数値)

再接続する頻度 (ミリ秒)。

Blocking

Boolean (ブール)

false​ の場合、再接続戦略が個別の非ブロックスレッドで実行されます。

Expiration Policy (有効期限ポリシー)

項目 型 説明 デフォルト値 必須

Max Idle Time (最大アイドル時間)

Number (数値)

有効期限の対象とみなされるまで、動的設定インスタンスがアイドル状態を維持できる最大時間のスカラー時間値。

Time Unit (時間単位)

Enumeration (列挙)。次のいずれかになります。

  • NANOSECONDS

  • MICROSECONDS

  • MILLISECONDS

  • SECONDS

  • MINUTES

  • HOURS

  • DAYS

maxIdleTime 属性の時間単位

Repeatable In Memory Stream (反復可能なメモリ内ストリーム)

このモードでストリーミングする場合、Mule はコンテンツのバッファにディスクを使用しません。バッファサイズを超えた場合、メッセージは失敗します。

項目 型 説明 デフォルト値 必須

Initial Buffer Size (初期バッファサイズ)

Number (数値)

ストリームをコンシュームし、ストリームへのランダムアクセスを提供する目的で割り当てられるメモリの容量。ストリームに含まれているデータがこのバッファに適合できる量を超えている場合、bufferSizeIncrement 属性に従ってバッファが拡張され、上限は maxInMemorySize となります。

Buffer Size Increment (バッファサイズ増分)

Number (数値)

バッファサイズが初期サイズを超えた場合にバッファサイズをどれだけ拡張するかを指定します。値を 0 以下に設定すると、バッファが拡張されません。つまり、バッファがフルになると、​STREAM_MAXIMUM_SIZE_EXCEEDED​ エラーが発生します。

Max Buffer Size (最大バッファサイズ)

Number (数値)

使用するメモリの最大量。これを超えると、​STREAM_MAXIMUM_SIZE_EXCEEDED​ エラーが発生します。0 以下の値は無制限を意味します。

Buffer Unit (バッファ単位)

Enumeration (列挙)。次のいずれかになります。

  • BYTE (バイト)

  • KB

  • MB

  • GB

これらのすべての属性の単位

Repeatable File Store Stream (反復可能なファイルストアストリーム)

ファイルストアの反復可能なストリームにはバッファが必要であり、さまざまなバッファ戦略があります。Mule はコンテンツの一部をメモリに保持します。ストリームのコンテンツが、設定されたバッファサイズよりも大きい場合、Mule はバッファのコンテンツをディスクにバックアップしてからメモリをクリアします。

項目 型 説明 デフォルト値 必須

In Memory Size (メモリ内サイズ)

Number (数値)

データをメモリ内に保持するためにストリームで使用する最大メモリを定義します。これを超えると、ディスクへのコンテンツのバッファが開始されます。

Buffer Unit (バッファ単位)

Enumeration (列挙)。次のいずれかになります。

  • BYTE (バイト)

  • KB

  • MB

  • GB

maxInMemorySize で表される単位

反復不可能ストリーム

反復可能ストリーム機能を無効にして反復不可能ストリームを使用できます。これにより、パフォーマンスオーバーヘッド、メモリ使用量、およびコストが軽減される可能性があります。

項目 型 説明 デフォルト値 必須

Transactional Action (トランザクションアクション)

Enumeration (列挙)。次のいずれかになります。

  • ALWAYS_JOIN​

  • JOIN_IF_POSSIBLE​

  • NOT_SUPPORTED

トランザクションに関する操作で実行できる結合アクションの種別。

JOIN_IF_POSSIBLE

応答属性

項目 型 説明 デフォルト値 必須

Headers (ヘッダー)

Object (オブジェクト)

Status Code (状況コード)

Number (数値)

Bulk Operation Result (一括操作結果)

項目 型 説明 デフォルト値 必須

Id

Any (任意)

Items (項目)

Bulk Item (一括項目)​ の配列

Successful (成功)

Boolean (ブール)

Bulk Item (一括項目)

項目 型 説明 デフォルト値 必須

例外

Any (任意)

Id

Any (任意)

Message (メッセージ)

String (文字列)

Payload (ペイロード)

Any (任意)

Status Code (状況コード)

String (文字列)

Successful (成功)

Boolean (ブール)

Repeatable In Memory Iterable (反復可能なメモリ内イテラブル)

項目 型 説明 デフォルト値 必須

Initial Buffer Size (初期バッファサイズ)

Number (数値)

ストリームをコンシュームし、ランダムアクセスを提供するために初期状態でメモリ内に保持が許容されるインスタンスの量。ストリームのデータ量がこのバッファサイズを超える場合は、bufferSizeIncrement 属性に従って、maxInMemorySize を上限としてバッファが拡張されます。

100 件のインスタンス

Buffer Size Increment (バッファサイズ増分)

Number (数値)

バッファサイズが初期サイズを超えた場合に、どれだけ拡張するか。値を 0 以下に設定すると、バッファが拡張されません。つまり、バッファがフルになると、​STREAM_MAXIMUM_SIZE_EXCEEDED​ エラーが発生します。

100 件のインスタンス

Max Buffer Size (最大バッファサイズ)

Number (数値)

使用するメモリの最大量。これを超えると、​STREAM_MAXIMUM_SIZE_EXCEEDED​ エラーが発生します。0 以下の値は無制限を意味します。

Repeatable File Store Iterable (反復可能なファイルストアイテラブル)

項目 型 説明 デフォルト値 必須

In Memory Objects (メモリ内オブジェクト)

Number (数値)

メモリ内に保持されるインスタンスの最大量。これ以上の量が必要な場合、コンテンツはディスク上にバッファされます。

Buffer Unit (バッファ単位)

Enumeration (列挙)。次のいずれかになります。

  • BYTE (バイト)

  • KB

  • MB

  • GB

maxInMemorySize で表される単位

関連情報

MuleSoft ヘルプセンター