Business Object Designer Express での SAPODA の使用

このセクションでは、Business Object Designer Express で SAPODA を使用して、ビジネス・オブジェクト定義を生成する方法について説明します。Business Object Designer Express の起動については、「IBM WebSphere Business Integration Server Express ビジネス・オブジェクト開発ガイド」を参照してください。

ODA の起動後、Business Object Designer Express を起動させ、ODA を構成し、実行します。Business Object Designer Express で ODA を使用してビジネス・オブジェクト定義を生成する手順は、6 つのステップから構成されます。Business Object Designer Express は、これらのステップを順にガイドしていくウィザードを提供します。

ODA の起動後、このウィザードを起動するには、次の手順を実行します。

  1. Business Object Designer Express を開きます。
  2. 「ファイル」メニューから、「ODA を使用して新規作成...」サブメニューを選択します。

    Business Object Designer Express に、ウィザードの最初のウィンドウ (「エージェントの選択」という名前) が表示されます。 図 34 に、このウィンドウを示します。

ODA を選択、構成、および実行するには、以下のステップを実行してください。

  1. "ODA の選択".
  2. "初期化プロパティーの構成".
  3. "ノードの展開およびオブジェクトの選択".
  4. オブジェクト選択の確認.
  5. "定義の生成"(任意で 追加情報の指定)
  6. 定義の保管.

ODA の選択

図 34 に、Business Object Designer Express の 6 ステップのウィザードの最初のダイアログ・ボックスを示します。このウィンドウで、実行する ODA を選択します。

図 34. ODA の選択


ODA を選択するには、以下の手順を行います。

  1. 「エージェントの検索」ボタンをクリックすることにより、登録済みまたは現在実行中の ODA のすべてを「検索されたエージェント」フィールドに表示します。
    注:
    Business Object Designer Express で目的の ODA が見つからない場合は、対応するフィールドにホストとポートを入力してください。
  2. 表示リストから、目的の ODA を選択します。

初期化プロパティーの構成

Business Object Designer Express は、SAPODA と初めて通信する際に、図 35 に示すように、一連の初期化プロパティーの入力を要求します。これらのプロパティーは、SAPODA を使用するたびに入力せずに済むように、名前を付けたプロファイルに保存できます。ODA プロファイルの指定の詳細については、「IBM WebSphere ビジネス・オブジェクト開発ガイド」を参照してください。

図 35. エージェント・プロパティーの構成


SAPODA プロパティーの構成を表 51 に示します。

表 51. SAPODA のプロパティー
行番号 プロパティー名 プロパティー・タイプ 説明
1 UserName String SAP ログオン・ユーザー名 (抽出した IDoc 定義ファイルのみから定義を生成する場合は不要)
2 Password String SAP ログオン・パスワード (抽出した IDoc 定義ファイルのみから定義を生成する場合は不要)
3 Client String SAP ログオン・クライアント番号 (抽出した IDoc 定義ファイルのみから定義を生成する場合は不要)
4 Language String SAP ログオン言語 (抽出した IDoc 定義ファイルのみから定義を生成する場合は不要)
5 SystemNumber String SAP システム番号 (抽出した IDoc 定義ファイルのみから定義を生成する場合は不要)
6 ASHostName String SAP アプリケーション・サーバーのホスト名 (抽出した IDoc 定義ファイルのみから定義を生成する場合は不要)
7 RFCTrace 単一カード、複数値 SAP システムの RFC トレース
8 DefaultBOPrefix String ビジネス・オブジェクトの名前を固有にするために、名前の前に付加するテキスト

Business Object Designer Express からビジネス・オブジェクト固有のプロパティーの指定を求めるプロンプトが出されたときに、必要に応じて後からこの値を変更できます。

9 MaximumHits String ノード検索時に戻されるオブジェクトの最大数。詳細については、ノードの展開およびオブジェクトの選択を参照してください。

デフォルトは 100 です。

10 TraceFileName String トレース・ファイルの名前。ファイルが存在しない場合、SAPODA はファイルを ¥ODA¥SAP ディレクトリーに作成します。ファイルが既に存在している場合、SAPODA はトレース情報をファイルの後に追加します。

SAPODA は次の命名規則に従ってファイルに名前を付けます。例えば、エージェントの名前が SAPODA の場合、SAPODAtrace.txt という名前のトレース・ファイルを生成します。

このプロパティーを使用して、このファイルとは異なる名前を指定します。

11 TraceLevel Integer SAPODA に対して有効なトレースのレベル

トレースの詳細については、エラーおよびト レース・メッセージ・ファイルでの作業を参照してください。

12 MessageFile String エラー/メッセージ・ファイルの名前。

SAPODA は次の命名規則に従ってファイルに名前を付けます。例えば、エージェントの名前が SAPODA の場合、メッセージ・ファイルに SAPODAAgent.txt という名前を付けます。詳細については、エラーおよびト レース・メッセージ・ファイルでの作業を参照してください。

重要: エラーおよびメッセージ・ファイルは ¥ODA¥messages ディレクトリーに配置する必要があります。

このプロパティーを使用して、既存のファイルの確認や指定をします。

13 File destination Directory ODA が生成したファイルが格納されるディレクトリー。

デフォルトは、Windows システム上のデフォルト・ディレクトリーです。デフォルト設定を ¥connectors¥SAP¥utilities¥generatedfiles ディレクトリーに変更することを推奨します。

重要:
Business Object Designer Express で表示されているデフォルト値が存在しないファイルを指している場合には、メッセージ・ファイルの名前を訂正します。このダイアログ・ボックスから移動したときに、名前が不正確であった場合に、Business Object Designer Express は、ODA の起動元となったウィンドウにエラー・メッセージを表示します。このメッセージは、Business Object Designer Express ではポップアップしません。有効なメッセージ・ファイルの指定に失敗すると、ODA はメッセージなしに稼働します。詳細については、エラーおよびト レース・メッセージ・ファイルでの作業を参照してください。

ノードの展開およびオブジェクトの選択

SAPODA のすべてのプロパティーの構成が完了すると、Business Object Designer Express には以下を最初のノードとするツリーが表示されます。

名前の前に正符号 (+) が付いたノードは、展開可能です。これらのノードをクリックすると、さらにノードまたはリーフが表示されます。SAPODA では、ビジネス・オブジェクト定義は、リーフのみから生成されます。

図 36 に、このダイアログ・ボックスの最初の状態と、いくつかのノードを展開した状態を示します。

図 36. ノードを展開したツリー


リーフの名前が太字で表示された場合は、そのリーフをビジネス・オブジェクトを生成するための基礎として選択できます。複数のリーフを選択するには、Windows の標準の手順を使用します。つまり、Ctrl キーを押したまま、マウスを使用して複数のリーフを選択します。

重要:
Windows システムの場合、Business Object Designer Express が必要なライブラリー・ファイルを Path 環境変数内で見付けることができないか、またはファイルがシステム上に存在しないときには、空の「エージェント通知 (Agent notification)」ウィンドウが表示されます。これらのファイルの詳細については、SAPODA を実行する前にを参照してください。

SAPODA では、フラットなファイルをノードと関連付けることができる、ポリモアフィック・ノード・タイプが使用されます。最初に、リーフのないノードが表示されます。ファイル・システムをブラウズして、そのノードに追加するファイルを選択できます。ノードは、1 つ以上のファイルに関連付けられると性質がリーフから枝に変化するため、ポリモアフィックと呼ばれます。

図 37 に、Business Object Designer Express が戻すリーフの数を制限するための、次の 2 つの方法を示します。

オブジェクトを生成するために必要なすべてのリーフを選択したら、「次へ」ボタンをクリックします。戻されるオブジェクトをフィルター操作する方法については、「ビジネス・オブジェクト開発ガイド」を参照してください。

オブジェクト選択の確認

生成したビジネス・オブジェクト定義に関連付けるすべてのオブジェクトを識別すると、Business Object Designer Express には、選択したリーフとそれらのノード・パスのみを表示したダイアログ・ボックスが表示されます。図 38 にこのダイアログ・ボックスを示します。

図 38. ノードとリーフの選択の確認


このウィンドウには、以下のオプションが表示されます。

定義の生成

選択したオブジェクトを確認すると、Business Object Designer Express が定義を生成中であることを知らせるダイアログ・ボックスが表示されます。

図 39 にこのダイアログ・ボックスを示します。

図 39. 定義の生成


追加情報の指定

SAPODA から、追加情報の入力が要求されます。トップレベル・ノードのタイプ (IDoc タイプ、BOR、RFC、または動的定義) によって、以下のことが決定されます。

IDoc タイプ: 追加情報の指定

SAPODA で表示される「BO プロパティー」ウィンドウで、IDoc タイプに基づいてビジネス・オブジェクトに必要な情報を指定することができます。このウィンドウに表示されるプロパティーは、IDoc のソース (抽出されたファイルであるか、または SAP システム内の定義であるか)、および定義が ABAP Extension Module に定義されているかどうかによって異なります。このセクションでは、以下のトピックについて説明します。

「BO プロパティー」ウィンドウ -- 共通プロパティー

SAPODA がビジネス・オブジェクト定義を IDoc ファイルから生成するか、SAP システムに定義された IDoc から生成するかにかかわらず、IDoc タイプの「BO プロパティー」ウィンドウを使用すると以下の情報を指定または変更できます。

「BO プロパティー」ウィンドウ -- SAP システムに定義された IDoc のプロパティー

prefix プロパティーと module プロパティー以外にも、SAP システムに定義された IDoc を表す「BO プロパティー」ウィンドウには Release プロパティーが表示されます。このプロパティーを使用して、IDoc タイプの以前のバージョンを識別できます。

重要:
以前のバージョンの IDoc タイプに含まれるセグメントが現行バージョンよりも少ない場合は、SAPODA によって欠落しているセグメントが作成される場合があります。あるいは、ビジネス・オブジェクト定義の生成が失敗したことを示すエラーが表示されます。このような不整合が発生するのは、SAP のバージョンごとに必要な API 呼び出しが異なるためです。

図 40 に、2 つのバージョンの「BO プロパティー」ウィンドウを示します。一方は抽出した IDoc タイプ定義ファイル、他方は SAP システムに定義された IDoc の「BO プロパティー」ウィンドウです。

図 40. IDoc タイプ・ビジネス・オブジェクトの追加情報の指定


「BO プロパティー」ウィンドウ -- ABAP Handler に対する機能モジュールの指定

モジュール・タイプとして Extension を選択した場合は、デフォルトの動詞のいずれかに対して機能モジュール名を入力するかどうかを尋ねるプロンプトが SAPODA によって表示されます。

デフォルトでは、ABAP Extension Module の定義を生成すると、SAPODA によって以下のテキストがトップレベル・ビジネス・オブジェクトのビジネス・オブジェクト・レベルの動詞のアプリケーション固有情報に指定されます。

:/CWLD/IDOC_HANDLER

ABAP Handler に渡す機能モジュール名が既にわかっている場合は、このプロンプトで「はい」を選択してください。SAPODA により、図 41 に示す画面が表示されます。

図 41. ABAP Handler に対する機能モジュールの指定


図 41 は、2 つの機能モジュールが指定された「BO プロパティー」ウィンドウを示しています。

注:
多数の IDoc タイプがファイル内に定義されている場合には、ファイル内の各 IDoc タイプに対して「機能モジュール BO プロパティー (Function module BO Properties)」ウィンドウが表示されます。「汎用 IDoc タイプ BO プロパティー (General IDoc type BO properties)」ウィンドウは 1 回のみ表示されます。

ビジネス・オブジェクト定義を保管した後は、トップレベル・ビジネス・オブジェクトのビジネス・オブジェクト・レベルの必要なアプリケーション固有情報が Business Object Designer Express の「一般」タブに表示されます。図 42 に、2 つの機能モジュールが指定されたこのウィンドウを示します。

図 42. Business Object Designer での ABAP Handler の指定


ABAP Handler の詳細については、ABAP Handler へのビジネス・オブジェクト発送を参照してください。ABAP Extension Module が必要とするアプリケーション固有の情報については、SAPODA を使用したビジネス・オブジェクト定義の開発を参照してください。

BOR または RFC: 追加情報の指定

BOR または RFC タイプには、2 つの「BO プロパティー」ウィンドウがあります。最初のウィンドウに表示されるプロパティーでは、以下の項目を指定または変更できます。

「OK」をクリックして、最初の「BO プロパティー」ウィンドウから次に進むと、SAPODA によって生成される定義のサイズを減らすことのできるダイアログ・ボックスが表示されます。定義から、オプションのパラメーターを表すいずれかの属性を削除するかどうかを選択するように要求されます。このプロンプトは、削除できるオプショナル・パラメーターが存在する場合にのみ表示されます。定義のサイズを減らすと、後にコネクターがビジネス・オブジェクトのインスタンスを処理する際に、パフォーマンスが向上する可能性があります。

図 43 に、BOR または RFC タイプのオブジェクトに対して表示されるプロパティーと、「OK」をクリックした後に表示されるプロンプトを示します。

図 43. BOR または RFC ビジネス・オブジェクトの追加情報の指定


上に示したプロンプトで「はい」をクリックすると、2 番目の「BO プロパティー」ウィンドウが表示されます。BAPI/RFC インターフェースの各オプショナル・パラメーターを削除するように指定するには、その「値」を Yes (対応する属性を生成される定義に組み込む) から No (属性を組み込まない) に変更します。

上に示したプロンプトで「いいえ」をクリックすると、最終ウィザードが表示されます。詳細については、定義の保管を参照してください。

図 44 に、2 番目の「BO プロパティー」ウィンドウを示します。

図 44. 定義から削除する属性の指定


重要:
Bapi」で始まる RFC 対応機能のビジネス・オブジェクト定義には、戻り構造体またはテーブルに対応するビジネス・オブジェクトを表す属性が含まれている必要があります。この属性が定義に含まれていない場合は、対応する生成コードがコンパイルされるときにエラーが発生します。このコンパイル・エラーが発生したら、BAPI を検査して、SAP が異なる戻り構造体を使用していなかったかどうかを判別してください。そうであった場合には、生成された Java コードを、正しいパラメーターを指すように変更します。

SAPODA での指定のほかに、RFC Server Module の定義を作成する場合にも、ビジネス・オブジェクト定義を保管した後にアプリケーション固有の情報を変更することもできます。詳細については、RFC Server Module のビジネス・オブジェクトの開発を参照してください。

HDR タイプ: 追加情報の指定

HDR 表ベースのオブジェクトには、2 つの「BO プロパティー」ウィンドウがあります。最初のウィンドウに表示されるプロパティーを使用して、ビジネス・オブジェクトのプレフィックスを指定または変更できます。「エージェントの構成」ウィンドウ (図 35) で DefaultBOPrefix プロパティーに対して入力した値が適切であれば、ここでこの値を変更する必要はありません。

図 45 にこのウィンドウを示します。

図 45. HDR ビジネス・オブジェクトの追加情報の指定


さらに、テーブルからの情報のうち 512 バイトのみを戻すことができます。テーブルが 512 バイトを超えるデータを戻す場合は、図 46 に示すダイアログが表示されます。「いいえ」で応答すると、テーブルの先頭から最大 512 バイトに達するまで属性 (列の記述) が戻されます。

図 46. 512 バイトの警告

「はい」で応答すると、図 47 に示す 2 番目の「BO プロパティー」ウィンドウが表示されます。各属性のバイト長はウィンドウの記述で示されます。ビジネス・オブジェクトの属性を含めるか除外するかを指定するには、値を「はい」または「いいえ」に切り替えます。

図 47. HDR ビジネス・オブジェクトに対する BO プロパティーのサイズおよびタイプ


定義の保管

「BO プロパティー」ダイアログ・ボックスで必要なすべての情報を指定し、「OK」をクリックすると、Business Object Designer Express にウィザードの最終ダイアログ・ボックスが表示されます。このダイアログ・ボックスでは、定義をサーバーまたはファイルに保管したり、定義を Business Object Designer Express で開いて編集することができます。詳細について、または追加の修正を行うには、「ビジネス・オブジェクト開発ガイド」を参照してください。

図 48 にこのダイアログ・ボックスを示します。

図 48. ビジネス・オブジェクト定義の保管


Copyright IBM Corp. 2004