第289章 SAP コンポーネント
SAP コンポーネントは、10 個の異なる SAP コンポーネントのスイートで設定されるパッケージです。sRFC、tRFC、および qRFC プロトコルをサポートするリモートファンクションコール (RFC) コンポーネントがあります。また、IDoc 形式のメッセージを使用して通信を容易にする IDoc コンポーネントがあります。このコンポーネントは、SAP Java Connector (SAP JCo) ライブラリーを使用して SAP との双方向通信を容易にし、SAP IDoc ライブラリーを使用して中間ドキュメント (IDoc) 形式でのドキュメントの送信を促進します。
289.1. 概要
依存関係
Maven ユーザーがこのコンポーネントを使用するには、pom.xml ファイルに次の依存関係を追加する必要があります。
<dependency>
<groupId>org.fusesource</groupId>
<artifactId>camel-sap</artifactId>
<version>x.x.x</version>
<dependency>SAP コンポーネントの追加のプラットフォーム制限
SAP コンポーネントはサードパーティーの JCo 3 および IDoc 3 ライブラリーに依存しているため、これらのライブラリーがサポートするプラットフォームにのみインストールできます。サポートされているライブラリーのバージョンとプラットフォームの制限の詳細については、Red Hat JBoss Fuse Supported Configurations を参照してください。
SAP JCo および SAP IDoc ライブラリー
SAP コンポーネントを使用するための前提条件は、SAP Java Connector (SAP JCo) ライブラリーと SAP IDoc ライブラリーが Java ランタイムの lib/ ディレクトリーにインストールされていることです。ターゲットオペレーティングシステムに適した SAP ライブラリーのセットを SAP Service Marketplace からダウンロードしていることを確認する必要があります。
ライブラリーファイルの名前は、ターゲットオペレーティングシステムによって異なります。表289.1「必要な SAP ライブラリー」
表289.1 必要な SAP ライブラリー
| SAP コンポーネント | Linux と UNIX | Windows |
|---|---|---|
| SAP JCo 3 |
|
|
| SAP IDoc |
|
|
Fuse OSGi コンテナーへのデプロイ
以下のように、SAP JCo ライブラリーと SAP IDoc ライブラリーを JBoss Fuse OSGi コンテナーにインストールできます。
SAP サービスマーケットプレイス (http://service.sap.com/public/connectors) から SAP JCo ライブラリーと SAP IDoc ライブラリーをダウンロードし、オペレーティングシステムに適したバージョンのライブラリーを選択してください。
注記これらのライブラリーをダウンロードして使用するには、SAP Service Marketplace アカウント が必要です。
-
sapjco3.jar、libsapjco3.so(または Windows ではsapjco3.dll)、およびsapidoc3.jarライブラリーファイルを Fuse インストールのlib/ディレクトリーにコピーします。 設定プロパティーファイル
etc/config.propertiesとカスタムプロパティーファイルetc/custom.propertiesの両方をテキストエディターで開きます。etc/config.propertiesファイルで、org.osgi.framework.system.packages.extraプロパティーを探し、完全なプロパティー設定をコピーします (この設定は、行の継続を示すために使用されるバックスラッシュ文字\を使用して、複数の行にまたがります。)。この設定をetc/custom.propertiesファイルに貼り付けます。SAP ライブラリーをサポートするために必要な追加パッケージを追加できるようになりました。
etc/custom.propertiesファイルで、次のように必要なパッケージをorg.osgi.framework.system.packages.extra設定に追加します。org.osgi.framework.system.packages.extra = \ ... , \ com.sap.conn.idoc, \ com.sap.conn.idoc.jco, \ com.sap.conn.jco, \ com.sap.conn.jco.ext, \ com.sap.conn.jco.monitor, \ com.sap.conn.jco.rt, \ com.sap.conn.jco.server
リストが適切に続くように、新しいエントリーの前の各行の終わりにコンマとバックスラッシュ、
\を含めることを忘れないでください。- これらの変更を有効にするには、コンテナーを再起動する必要があります。
コンテナーに
camel-sap機能をインストールする必要があります。Karaf コンソールで、次のコマンドを入力します。JBossFuse:karaf@root> features:install camel-sap
JBoss EAP コンテナーへのデプロイ
SAP コンポーネントを JBoss EAP コンテナーにデプロイするには、以下の手順を実行します。
SAP サービスマーケットプレイス (http://service.sap.com/public/connectors) から SAP JCo ライブラリーと SAP IDoc ライブラリーをダウンロードし、オペレーティングシステムに適したバージョンのライブラリーを選択してください。
注記これらのライブラリーをダウンロードして使用するには、SAP Service Marketplace アカウント が必要です。
JCo ライブラリーファイルと IDoc ライブラリーファイルを JBoss EAP インストールの適切なサブディレクトリーにコピーします。たとえば、ホストプラットフォームが 64 ビット Linux (
linux-x86_64) の場合、次のようにライブラリーファイルをインストールします。cp sapjco3.jar sapidoc3.jar $JBOSS_HOME/modules/system/layers/fuse/com/sap/conn/jco/main/ mkdir -p $JBOSS_HOME/modules/system/layers/fuse/com/sap/conn/jco/main/lib/linux-x86_64 cp libsapjco3.so $JBOSS_HOME/modules/system/layers/fuse/com/sap/conn/jco/main/lib/linux-x86_64/
重要ネイティブライブラリー (
libsapjco3.soなど) を JBoss EAP インストールにインストールする場合、ライブラリーサブディレクトリーの命名には標準化された規則があり、これに従う必要があります。64 ビット Linux の場合、サブディレクトリーはlinux-x86_64です。他のプラットフォームについては、https://docs.jboss.org/author/display/MODULES/Native+Libraries を参照してください。$JBOSS_HOME/modules/system/layers/fuse/org/wildfly/camel/extras/main/module.xmlという新しいファイルを作成し、次の内容を 追加 します。<?xml version="1.0" encoding="UTF-8"?> <module xmlns="urn:jboss:module:1.1" name="org.wildfly.camel.extras"> <dependencies> <module name="org.fusesource.camel.component.sap" export="true" services="export" /> </dependencies> </module>
URI 形式
SAP コンポーネントによって提供されるエンドポイントには、リモートファンクションコール (RFC) エンドポイントと中間ドキュメント (IDoc) エンドポイントの 2 種類があります。
RFC エンドポイントの URI 形式は次のとおりです。
sap-srfc-destination:destinationName:rfcName sap-trfc-destination:destinationName:rfcName sap-qrfc-destination:destinationName:queueName:rfcName sap-srfc-server:serverName:rfcName[?options] sap-trfc-server:serverName:rfcName[?options]
IDoc エンドポイントの URI 形式は次のとおりです。
sap-idoc-destination:destinationName:idocType[:idocTypeExtension[:systemRelease[:applicationRelease]]] sap-idoclist-destination:destinationName:idocType[:idocTypeExtension[:systemRelease[:applicationRelease]]] sap-qidoc-destination:destinationName:queueName:idocType[:idocTypeExtension[:systemRelease[:applicationRelease]]] sap-qidoclist-destination:destinationName:queueName:idocType[:idocTypeExtension[:systemRelease[:applicationRelease]]] sap-idoclist-server:serverName:idocType[:idocTypeExtension[:systemRelease[:applicationRelease]]][?options]
sap- endpointKind -destination で始まる URI 形式は、宛先エンドポイント (つまり、Camel プロデューサーエンドポイント) を定義するために使用され、destinationName は SAP インスタンスへの特定のアウトバウンド接続の名前です。で説明されているように、アウトバウンド接続はコンポーネントレベルで名前が付けられ、設定されます。「宛先設定」
sap- endpointKind -server で始まる URI 形式は、サーバーエンドポイント (つまり、Camel コンシューマーエンドポイント) を定義するために使用され、serverName は SAP インスタンスからの特定のインバウンド接続の名前です。インバウンド接続は、コンポーネントレベルで名前が付けられ、設定されます。「サーバー設定」
RFC エンドポイント URI のその他のコンポーネントは次のとおりです。
- rfcName
- (必須) 宛先エンドポイント URI では、接続された SAP インスタンスのエンドポイントによって呼び出される RFC の名前です。サーバーエンドポイント URI では、接続された SAP インスタンスから呼び出されたときにエンドポイントによって処理される RFC の名前です。
- queueName
- このエンドポイントが SAP リクエストを送信するキューを指定します。
IDoc エンドポイント URI のその他のコンポーネントは次のとおりです。
- idocType
- (必須) このエンドポイントによって生成される IDoc の基本 IDoc タイプを指定します。
- idocTypeExtension
- このエンドポイントによって生成された IDoc の IDoc タイプ拡張 (存在する場合) を指定します。
- systemRelease
- このエンドポイントによって生成された IDoc に関連付けられている SAP Basis Release がある場合は、それを指定します。
- applicationRelease
- このエンドポイントによって生成された IDoc の関連付けられたアプリケーションリリースがある場合は、それを指定します。
- queueName
- このエンドポイントが SAP リクエストを送信するキューを指定します。
RFC 宛先エンドポイントのオプション
RFC 宛先エンドポイント (sap-srfc-destination、sap-trfc-destination、および sap-qrfc-destination) は、次の URI オプションをサポートしています。
| 名前 | デフォルト | 説明 |
|---|---|---|
|
|
|
|
|
|
|
|
RFC サーバーエンドポイントのオプション
SAP RFC サーバーエンドポイント (sap-srfc-server および sap-trfc-server) は、次の URI オプションをサポートしています。
| 名前 | デフォルト | 説明 |
|---|---|---|
|
|
|
|
|
|
|
(sap-trfc-server エンドポイントのみ) |
IDoc List Server エンドポイントのオプション
SAP IDoc List Server エンドポイント (sap-idoclist-server) は、次の URI オプションをサポートしています。
| 名前 | デフォルト | 説明 |
|---|---|---|
|
|
|
|
|
|
|
|
RFC および IDoc エンドポイントの概要
SAP コンポーネントパッケージは、次の RFC および IDoc エンドポイントを提供します。
sap-srfc-destinationJBoss Fuse SAP Synchronous Remote Function Call Destination Camel コンポーネント。このエンドポイントは、Camel ルートが SAP システムへのリクエストと SAP システムからのレスポンスの同期配信を必要とする場合に使用する必要があります。
注記このコンポーネントで使用される sRFC プロトコルは、SAP システムとの間でリクエストとレスポンスを ベストエフォート で配信します。リクエストの送信中に通信エラーが発生した場合、受信側の SAP システムでのリモート関数呼び出しの完了ステータスは 不明 のままです。
sap-trfc-destinationJBoss Fuse SAP Transactional Remote Function Call Destination Camel コンポーネント。このエンドポイントは、リクエストを受信側の SAP システムに 最大 1 回 配信する必要がある場合に使用する必要があります。これを達成するために、コンポーネントはトランザクション ID
tidを生成します。この ID は、ルートのエクスチェンジでコンポーネントを介して送信されるすべてのリクエストに付随します。受信側の SAP システムは、リクエストを配信する前に、リクエストに付随するtidを記録します。SAP システムが同じtidのリクエストを再度受信した場合、リクエストは配信されません。したがって、このコンポーネントのエンドポイントを介してリクエストを送信するときにルートで通信エラーが発生した場合、ルートは同じリクエスト内でリクエストの送信を再試行できますが、配信と実行は 1 回だけです。注記このコンポーネントで使用される tRFC プロトコルは非同期であり、レスポンスを返しません。したがって、このコンポーネントのエンドポイントはレスポンスメッセージを返しません。
注記このコンポーネントは、エンドポイントを介した一連のリクエストの順序を保証しません。これらのリクエストの配信および実行順序は、通信エラーやリクエストの再送信により、受信側の SAP システムで異なる場合があります。配信順序の保証については、JBoss Fuse SAP Queued Remote Function Call Destination Camel コンポーネントを参照してください。
sap-qrfc-destinationJBoss Fuse SAP Queued Remote Function Call Destination Camel コンポーネント。このコンポーネントは、JBoss Fuse Transactional Remote Function Call Destination camel コンポーネントの機能を、そのエンドポイントを介したリクエストの配信に 順番に 配信保証を追加することで拡張します。このエンドポイントは、一連のリクエストが相互に依存しており、受信側の SAP システムに 最大 1 回、順番に 配信する必要がある場合に使用する必要があります。このコンポーネントは、JBoss Fuse SAP Transactional Remote Function Call Destination Camel コンポーネントと同じメカニズムを使用して、最大 1 回の 配信保証を実現します。順序の保証は、SAP システムが受信した順序でリクエストを 受信キュー にシリアル化することによって実現されます。受信キューは、SAP 内の QIN スケジューラー によって処理されます。インバウンドキューが アクティブ化される と、QIN スケジューラーはキューリクエストを順番に実行します。
注記このコンポーネントで使用される qRFC プロトコルは非同期であり、レスポンスを返しません。したがって、このコンポーネントのエンドポイントはレスポンスメッセージを返しません。
sap-srfc-server- JBoss Fuse SAP Synchronous Remote Function Call Server Camel コンポーネント。このコンポーネントとそのエンドポイントは、SAP システムからの要求と SAP システムへの応答を同期的に処理するために Camel ルートが必要な場合に使用する必要があります。
sap-trfc-server-
JBoss Fuse SAP Transactional Remote Function Call Server Camel コンポーネント。このエンドポイントは、送信側の SAP システムがリクエストを Camel ルートに 最大 1 回 配信する必要がある場合に使用する必要があります。これを実現するために、送信側の SAP システムは、コンポーネントのエンドポイントに送信するすべてのリクエストに付随するトランザクション ID
tidを生成します。送信側の SAP システムは、tidに関連付けられた一連のリクエストを送信する前に、コンポーネントが特定のtidを受信したかどうかを最初にチェックします。コンポーネントは、保持している受信tidのリストをチェックし、送信されたtidがそのリストにない場合は記録し、送信 SAP システムに応答して、tidがすでに記録されているかどうかを示します。送信側の SAP システムは、tidが以前に記録されていない場合にのみ、一連のリクエストを送信します。これにより、送信側の SAP システムは一連のリクエストを確実に camel ルートに 1 回送信できます。 sap-idoc-destination- JBoss Fuse SAP IDoc Destination Camel コンポーネント。このエンドポイントは、中間ドキュメント (IDoc) のリストを SAP システムに送信するために Camel ルートが必要な場合に使用する必要があります。
sap-idoclist-destination- JBoss Fuse SAP IDoc List Destination Camel コンポーネント。このエンドポイントは、中間ドキュメント (IDoc) リストのリストを SAP システムに送信するために Camel ルートが必要な場合に使用する必要があります。
sap-qidoc-destination- JBoss Fuse SAP Queued IDoc Destination Camel コンポーネント。このコンポーネントとそのエンドポイントは、中間ドキュメント (IDoc) のリストを順番に SAP システムに送信するために Camel ルートが必要な場合に使用する必要があります。
sap-qidoclist-destination- JBoss Fuse SAP Queued IDoc List Destination Camel コンポーネント。このコンポーネントとそのエンドポイントは、中間ドキュメント (IDoc) リストのリストを順番に SAP システムに送信するために camel ルートが必要な場合に使用する必要があります。
sap-idoclist-server-
JBoss Fuse SAP IDoc List Server Camel コンポーネント。このエンドポイントは、送信側の SAP システムが中間ドキュメントリストを Camel ルートに配信する必要がある場合に使用する必要があります。このコンポーネントは、
sap-trfc-server-standaloneクイックスタートで説明されているように、tRFC プロトコルを使用して SAP と通信します。
SAP RFC 宛先エンドポイント
RFC 宛先エンドポイントは、SAP へのアウトバウンド通信をサポートします。これにより、これらのエンドポイントは、SAP の ABAP 関数モジュールへの RFC 呼び出しを行うことができます。RFC 宛先エンドポイントは、SAP インスタンスへの特定の接続を介して特定の ABAP 関数への RFC 呼び出しを行うように設定されています。RFC 宛先は、アウトバウンド接続の論理的な指定であり、一意の名前を持っています。RFC 宛先は、宛先データ と呼ばれる一連の接続パラメーターによって指定されます。
RFC 宛先エンドポイントは、受信した IN-OUT エクスチェンジの入力メッセージから RFC リクエストを抽出し、そのリクエストを関数呼び出しで SAP にディスパッチします。関数呼び出しからのレスポンスは、エクスチェンジの出力メッセージで返されます。SAP RFC 宛先エンドポイントはアウトバウンド通信のみをサポートするため、RFC 宛先エンドポイントはプロデューサーの作成のみをサポートします。
SAP RFC サーバーエンドポイント
RFC サーバーエンドポイントは、SAP からのインバウンド通信をサポートします。これにより、SAP の ABAP アプリケーションがサーバーエンドポイントに対して RFC 呼び出しを行うことができます。ABAP アプリケーションは、リモート関数モジュールであるかのように RFC サーバーエンドポイントと対話します。RFC サーバーエンドポイントは、SAP インスタンスから特定の接続を介して特定の RFC 関数への RFC 呼び出しを受信するように設定されています。RFC サーバーは、インバウンド接続の論理的な指定であり、一意の名前を持っています。RFC サーバーは、サーバーデータ と呼ばれる一連の接続パラメーターによって指定されます。
RFC サーバーエンドポイントは、入力 RFC リクエストを処理し、それを IN-OUT エクスチェンジの入力メッセージとしてディスパッチします。エクスチェンジの出力メッセージは、RFC 呼び出しのレスポンスとして返されます。SAP RFC サーバーエンドポイントはインバウンド通信のみをサポートするため、RFC サーバーエンドポイントはコンシューマーの作成のみをサポートします。
SAP IDoc および IDoc リストの宛先エンドポイント
IDoc 宛先エンドポイントは、SAP へのアウトバウンド通信をサポートします。SAP は、IDoc メッセージに対してさらに処理を実行できます。IDoc ドキュメントはビジネストランザクションを表し、非 SAP システムと簡単にエクスチェンジできます。IDoc 宛先は、宛先データ と呼ばれる一連の接続パラメーターによって指定されます。
IDoc リスト宛先エンドポイントは、処理するメッセージが IDoc ドキュメントの リスト で設定されることを除いて、IDoc 宛先エンドポイントに似ています。
SAP IDoc リストサーバーエンドポイント
IDoc リストサーバーエンドポイントは、SAP からのインバウンド通信をサポートし、Camel ルートが SAP システムから IDoc ドキュメントのリストを受信できるようにします。IDoc リストサーバーは、サーバーデータ と呼ばれる一連の接続パラメーターによって指定されます。
メタデータリポジトリー
メタデータリポジトリーは、次の種類のメタデータを格納するために使用されます。
- 汎用モジュールのインタフェース説明
- このメタデータは、JCo および ABAP ランタイムによって使用され、RFC 呼び出しをチェックして、それらの呼び出しをディスパッチする前に、通信パートナー間でタイプセーフなデータ転送を保証します。リポジトリーには、リポジトリーデータが取り込まれます。リポジトリーデータは、名前付き関数テンプレートのマップです。関数テンプレートには、関数モジュールとの間で渡されるすべてのパラメーターとその入力情報を記述するメタデータが含まれており、関数テンプレートが説明する関数モジュールの一意の名前が付けられています。
- IDoc タイプの説明
- このメタデータは、IDoc ランタイムによって使用され、IDoc ドキュメントが通信パートナーに送信される前に正しくフォーマットされていることを確認します。基本的な IDoc タイプは、名前、許可されたセグメントのリスト、およびセグメント間の階層関係の説明で設定されます。いくつかの追加の制約をセグメントに課すことができます。セグメントは必須またはオプションにすることができます。また、各セグメントの最小/最大範囲を指定することができます (そのセグメントの許容反復回数を定義します)。
したがって、SAP 宛先およびサーバーエンドポイントは、RFC 呼び出しを送受信し、IDoc ドキュメントを送受信するために、リポジトリーへのアクセスを必要とします。RFC 呼び出しの場合、エンドポイントによって呼び出されて処理されるすべての機能モジュールのメタデータは、リポジトリー内に存在する必要があります。IDoc エンドポイントの場合、エンドポイントによって処理されるすべての IDoc タイプおよび IDoc タイプ拡張のメタデータは、リポジトリー内に存在する必要があります。宛先およびサーバーエンドポイントによって使用されるリポジトリーの場所は、それぞれの接続の宛先データおよびサーバーデータで指定されます。
SAP 宛先エンドポイントの場合、使用するリポジトリーは通常、SAP システムに存在し、接続先の SAP システムにデフォルト設定されます。このデフォルトでは、宛先データに明示的な設定は必要ありません。さらに、宛先エンドポイントが行うリモート関数呼び出しのメタデータは、それが呼び出す既存の関数モジュールのリポジトリーにすでに存在します。したがって、宛先エンドポイントによって行われる呼び出しのメタデータは、SAP コンポーネントで設定する必要はありません。
一方、サーバーエンドポイントによって処理される関数呼び出しのメタデータは、通常、SAP システムのリポジトリーには存在せず、代わりに SAP コンポーネントに存在するリポジトリーによって提供される必要があります。SAP コンポーネントは、名前付きメタデータリポジトリーのマップを維持します。リポジトリーの名前は、メタデータを提供するサーバーの名前に対応しています。
