コンテンツフレーム起動

機能の文書化  コンテナ処理のためのマクロ命令 文書を SAP ライブラリストラクチャに組み込む

使用

これらのマクロ命令を使用可能なプログラムを、次に示します。

キ        オブジェクトタイプの導入プログラム

キ        イベント生成のための汎用モジュール

キ        ルール解決のための汎用モジュール

キ        ABAP クラス ( たとえばプログラマが終了させる場合)

コンテナインスタンスの処理には、以下の処理が含まれます。

キ        コンテナエレメントの値へのアクセス

キ        コンテナエレメントの値の入力

これには、列エレメント ID と値だけが関連します。

注記

コンテナに値を割り当てるときに、入力したエレメントとその値のデータ型が、コンテナ定義と一致しているかどうかの チェックは行われません。使用するエレメントID とデータ型が定義と一致していることを確認する必要があります。

コンテナエレメントID は、内部では常に大文字で処理されます。マクロ命令の呼出しには大文字小文字のどちらを使っても構いません。エレメント ID は、常にアクセス前に大文字に変換されるためです。

前提条件

インクルードファイル <CNTN01> は、汎用モジュールおよび導入プログラムでこれらのマクロを使用するため、プログラムにインクルードされる必要があります。これには、次の命令を使用します。

INCLUDE <CNTN01>.

注記

インクルードファイル <OBJECT> にはすでにインクルードファイル <CNTN01> が含まれるので、インクルードファイル <CNTN01> を再び、導入プログラムにインクルードすることはできません。

ABAP クラスでマクロを使用するには、インクルードファイル <CNTN02> と <CNTN03> をインクルードする必要があります。クラスビルダでは、インクルードファイル <CNTN02> はジャンプ → クラスローカルタイプ → マクロ を選択することによりインクルードします。インクルードファイル <CNTN03> は、ジャンプ → クラスローカルタイプ → ローカルクラス定義/ タイプ を選択することによりインクルードします。

コンテナは、次のマクロ命令により宣言、初期化する必要があります。

SWC_CONTAINER <Container>.         "Declaration
SWC_CREATE_CONTAINER <Container>.  "Initialization

追加情報については、コンテナのデータ構造の宣言と初期化を参照してください。

特徴

項目の内容をコンテナエレメントへ割り当てたり、コンテナの内容を項目に書き込むことができます。この内容は複数行、つまり内部テーブルの形式にすることができます。項目の内容は、基本データ型、構造、またはオブジェクト参照です。

オブジェクト参照は、ビジネスオブジェクトリポジトリで定義されたオブジェクトタイプのオブジェクトを参照します。そこには、オブジェクトの一意の ID に必要なキーが記述されています。キーは、1 つまたは複数のキー項目から構成されています。キー項目はたとえば、指図番号または会社コード、伝票番号、記帳年度などで、これらが組み合わせられてキーが構成されます。

例

発注を登録するトランザクションでは、この発注の登録が完了すると、イベントがトリガされます。

登録されたオブジェクトは、このイベントの潜在レシーバに通知されます。そのため、オブジェクトタイプ 発注のキー項目によって記述されるオブジェクトへの参照を、イベントコンテナに書き込みます。

例

品目マスタデータの特定の品目へのエントリは、ワークフローステップで更新されます。ロール 品目管理者は、このアクティビティの責任者です。

ルール解決は、アプリケーションにより提供された汎用モジュールによって品目の情報にもとづいて実行されます。ワークフローシステムは、タイプ 品目のオブジェクトへのオブジェクト参照を格納する汎用モジュールにコンテナを渡します。汎用モジュール内では、オブジェクト参照がコンテナから読み込まれて、担当者決定のための評価されます。

アクティビティ

読込と書込に必要なマクロとその呼出プロシージャは、コンテナエレメントの内容が異なります。コンテナエレメントを削除やコピーしても、変更ありません。

コンテナエレメントの削除

SWC_DELETE_ELEMENT <Container> <ContainerElement>.

注記

コンテナ内にコンテナエレメントが存在しない場合、 SY-SUBRC とともにエラーコード 1 が返されますが、存在する場合の Y-SUBRC の値は 0 となります。

コンテナエレメントのコピー

SWC_COPY_ELEMENT <SourceContainer> <SourceElement> <TargetContainer> <TargetElement>.

コンテナエレメントが、対象コンテナにコピーされます。コンテナに同じ名称のコンテナエレメントが存在する場合は上書きされ、存在しない場合は、新しいコンテナエレメントが登録されます。

基本タイプまたは構造

次のマクロを使用して、コンテナから構造や単一変数を読み込んだり、それらをコンテナに書き込みます。

項目値の書込

SWC_SET_ELEMENT <Container> <ContainerElement> <Value>.

追加情報については、コンテナへの項目値の書込を参照してください。

項目値の読込

SWC_GET_ELEMENT <Container> <ContainerElement> <FieldVariable>.

注記

コンテナ内にコンテナエレメントが存在しない場合、 SY-SUBRC とともにエラーコード 1 が返されますが、存在する場合の Y-SUBRC の値は 0 となります。

複数行基本タイプまたは複数行構造

次のマクロを使用して、コンテナから複数行構造や複数行変数を読み込んだり、それらをコンテナに書き込みます。

複数行項目値の書込

SWC_SET_TABLE <Container> <ContainerElement> <Value>.

追加情報については、コンテナへのテーブルの書込を参照してください。

複数行項目値の読込

SWC_GET_TABLE <Container> <ContainerElement> <TableVariable>.

注記

コンテナ内にコンテナエレメントが存在しない場合、 SY-SUBRC とともにエラーコード 1 が返されますが、存在する場合の Y-SUBRC の値は 0 となります。

コンテナエレメントとしてのオブジェクト参照

次のマクロを使用して、コンテナからオブジェクト参照を読み込んだり、それらをコンテナに書き込みます。オブジェクト参照がコンテナに書込まれる場合、次の作業が行われます。

キ        ビジネスオブジェクトリポジトリ で、関連するオブジェクトタイプが定義され、有効になっているかどうかをチェックします。

キ        エントリがオブジェクト参照であることを示すよう、コンテナ内で区分を設定します。

オブジェクト参照の登録

オブジェクト参照を宣言および登録し、それをコンテナに書き込みます。

DATA <Object> TYPE SWC_OBJECT.
SWC_CREATE_OBJECT <Object> <ObjectType> <ObjectKey>.
SWC_SET_ELEMENT <Container> <ContainerElement> <Object>.

追加情報については、コンテナへのオブジェクト参照の書込を参照してください。

オブジェクト参照の読込

オブジェクト参照を宣言してそれにコンテナから書き込んでから、オブジェクト参照から関連するオブジェクトタイプとキーを設定します。

DATA <Object> TYPE SWC_OBJECT.
SWC_GET_ELEMENT <Container> <ContainerElement> <Object>.
SWC_GET_OBJECT_KEY <Object> <ObjectKey>.
SWC_GET_OBJECT_TYPE <Object> <ObjectType>.

追加情報については、コンテナからのオブジェクト参照の読込を参照してください。

コンテナエレメントとしての複数行オブジェクト参照

マクロを使用して、コンテナから複数行オブジェクト参照を読み込んだり、それらをコンテナに書き込みます。オブジェクト参照がコンテナに書込まれる場合、次の作業が行われます。

キ        ビジネスオブジェクトリポジトリ で、関連するオブジェクトタイプが定義され、有効になっているかどうかをチェックします。

キ        エントリがオブジェクト参照であることを示すよう、コンテナ内で区分を設定します。

複数行オブジェクト参照の書込

複数行オブジェクト参照および単一オブジェクト参照を宣言します。次に、個別にテーブルに挿入される各オブジェクト参照を登録してテーブルに追加し、最後にコンテナにテーブルを書き込みます。

DATA <ObjectList> TYPE SWC_OBJECT OCCURS 0.
DATA <Object> TYPE SWC_OBJECT.
SWC_CREATE_OBJECT <Object> <ObjectType> <ObjectKey>.
APPEND <Object> TO <ObjectList>.
...
SWC_SET_TABLE <Container> <ContainerElement> <ObjectList>.

追加情報については、コンテナへの複数行オブジェクト参照の書込を参照してください。

複数行オブジェクト参照の読込

複数行オブジェクト参照を宣言し、それにコンテナから書き込みます。

DATA <ObjectList> TYPE SWC_OBJECT OCCURS 0.
SWC_GET_TABLE <Container> <ContainerElement> <ObjectList>.

追加情報については、コンテナからの複数行オブジェクト参照の読込を参照してください。

 

 

コンテンツフレーム終了