269.6. IDoc のメッセージ本文

IDoc 文書モデル
リンクのコピー

Camel SAP コンポーネントの場合、IDoc ドキュメントは、基礎となる SAP IDoc API のラッパー API を提供する Eclipse Modeling Framework (EMF) を使用してモデル化されます。このモデルで最も重要なタイプは次のとおりです。

org.fusesource.camel.component.sap.model.idoc.Document
org.fusesource.camel.component.sap.model.idoc.Segment

org.fusesource.camel.component.sap.model.idoc.Document
org.fusesource.camel.component.sap.model.idoc.Segment

Copy to Clipboard

Toggle word wrap

Document タイプは、IDoc ドキュメントインスタンスを表します。概説すると、Document インターフェイスは次のメソッドを公開します。

// Java
package org.fusesource.camel.component.sap.model.idoc;
...
public interface Document extends EObject {
    // Access the field values from the IDoc control record
    String getArchiveKey();
    void setArchiveKey(String value);
    String getClient();
    void setClient(String value);
    ...

    // Access the IDoc document contents
    Segment getRootSegment();
}

// Java
package org.fusesource.camel.component.sap.model.idoc;
...
public interface Document extends EObject {
    // Access the field values from the IDoc control record
    String getArchiveKey();
    void setArchiveKey(String value);
    String getClient();
    void setClient(String value);
    ...

    // Access the IDoc document contents
    Segment getRootSegment();
}

Copy to Clipboard

Toggle word wrap

次の種類のメソッドが Document インターフェイスによって公開されます。

制御レコードにアクセスする方法

ほとんどのメソッドは、IDoc 制御レコードのフィールド値にアクセスまたは変更するためのものです。これらのメソッドは、AttributeName、AttributeName の形式です。ここで、AttributeName はフィールド値の名前です (を参照してください)。表269.2「IDoc ドキュメントの属性」)。

ドキュメントコンテンツへのアクセス方法

getRootSegment メソッドは、ドキュメントコンテンツ (IDoc データレコード) へのアクセスを提供し、コンテンツを Segment オブジェクトとして返します。各 Segment オブジェクトには任意の数の子セグメントを含めることができ、セグメントは任意の程度にネストできます。

ただし、セグメント階層の正確なレイアウトは、文書の特定の IDoc タイプ によって定義されることに注意してください。したがって、セグメント階層を作成 (または読み取り) するときは、IDoc タイプによって定義された正確な構造に従う必要があります。

Segment タイプは、IDoc ドキュメントのデータレコードにアクセスするために使用されます。セグメントは、ドキュメントの IDoc タイプによって定義された構造に従って配置されます。概説すると、Segment インターフェイスは次のメソッドを公開します。

// Java
package org.fusesource.camel.component.sap.model.idoc;
...
public interface Segment extends EObject, java.util.Map<String, Object> {
    // Returns the value of the '<em><b>Parent</b></em>' reference.
    Segment getParent();

    // Return a immutable list of all child segments
    <S extends Segment> EList<S> getChildren();

    // Returns a list of child segments of the specified segment type.
    <S extends Segment> SegmentList<S> getChildren(String segmentType);

    EList<String> getTypes();

    Document getDocument();

    String getDescription();

    String getType();

    String getDefinition();

    int getHierarchyLevel();

    String getIdocType();

    String getIdocTypeExtension();

    String getSystemRelease();

    String getApplicationRelease();

    int getNumFields();

    long getMaxOccurrence();

    long getMinOccurrence();

    boolean isMandatory();

    boolean isQualified();

    int getRecordLength();

    <T> T get(Object key, Class<T> type);
}

// Java
package org.fusesource.camel.component.sap.model.idoc;
...
public interface Segment extends EObject, java.util.Map<String, Object> {
    // Returns the value of the '<em><b>Parent</b></em>' reference.
    Segment getParent();

    // Return a immutable list of all child segments
    <S extends Segment> EList<S> getChildren();

    // Returns a list of child segments of the specified segment type.
    <S extends Segment> SegmentList<S> getChildren(String segmentType);

    EList<String> getTypes();

    Document getDocument();

    String getDescription();

    String getType();

    String getDefinition();

    int getHierarchyLevel();

    String getIdocType();

    String getIdocTypeExtension();

    String getSystemRelease();

    String getApplicationRelease();

    int getNumFields();

    long getMaxOccurrence();

    long getMinOccurrence();

    boolean isMandatory();

    boolean isQualified();

    int getRecordLength();

    <T> T get(Object key, Class<T> type);
}

Copy to Clipboard

Toggle word wrap

getChildren (String segmentType) メソッドは、新しい (ネストされた) 子をセグメントに追加する場合に特に便利です。次のように定義されているタイプ SegmentList のオブジェクトを返します。

// Java
package org.fusesource.camel.component.sap.model.idoc;
...
public interface SegmentList<S extends Segment> extends EObject, EList<S> {
    S add();

    S add(int index);
}

// Java
package org.fusesource.camel.component.sap.model.idoc;
...
public interface SegmentList<S extends Segment> extends EObject, EList<S> {
    S add();

    S add(int index);
}

Copy to Clipboard

Toggle word wrap

したがって、E1SCU_CRE タイプのデータレコードを作成するには、次のような Java コードを使用できます。

Segment rootSegment = document.getRootSegment();

Segment E1SCU_CRE_Segment = rootSegment.getChildren("E1SCU_CRE").add();

Segment rootSegment = document.getRootSegment();

Segment E1SCU_CRE_Segment = rootSegment.getChildren("E1SCU_CRE").add();

Copy to Clipboard

Toggle word wrap

IDoc と Document オブジェクトの関係
リンクのコピー

SAP ドキュメントによると、IDoc ドキュメントは次の主要部分で設定されています。

制御記録: コントロールレコード (IDoc ドキュメントのメタデータを含む) は、Document オブジェクトの属性によって表されます。詳細については、表269.2「IDoc ドキュメントの属性」を参照してください。
データ記録: データレコードは、セグメントのネストされた階層として構築される Segment オブジェクトによって表されます。Document.getRootSegment メソッドを介してルートセグメントにアクセスできます。
状況記録: Camel SAP コンポーネントでは、ステータスレコードはドキュメントモデルによって表され ません。ただし、制御レコードの status 属性を介して最新のステータス値にアクセスできます。

ドキュメント属性
リンクのコピー

表269.2「IDoc ドキュメントの属性」 Document オブジェクトに設定できる制御レコード属性を示します。

Expand

表269.2 IDoc ドキュメントの属性
属性	長さ	SAP フィールド	説明
`archiveKey`	70	`ARCKEY`	EDI アーカイブキー
`クライアント`	3	`MANDT`	クライアント
`creationDate`	8	`CREDAT`	IDoc が作成された日付
`creationTime`	6	`CRETIM`	IDoc が作成された時間
`direction`	1	`DIRECT`	方向
`eDIMessage`	14	`REFMES`	メッセージ参照
`eDIMessageGroup`	14	`REFGRP`	メッセージグループへの参照
`eDIMessageType`	6	`STDMES`	EDI メッセージタイプ
`eDIStandardFlag`	1	`STD`	EDI 規格
`eDIStandardVersion`	6	`STDVRS`	EDI 規格のバージョン
`eDITransmissionFile`	14	`REFINT`	エクスチェンジファイルへの参照
`iDocCompoundType`	8	`DOCTYP`	IDoc タイプ
`iDocNumber`	16	`DOCNUM`	IDoc 番号
`iDocSAPRelease`	4	`DOCREL`	IDoc の SAP リリース
`iDocType`	30	`IDOCTP`	基本 IDoc タイプの名前
`iDocTypeExtension`	30	`CIMTYP`	拡張タイプの名前
`messageCode`	3	`MESCOD`	論理メッセージコード
`messageFunction`	3	`MESFCT`	論理メッセージ機能
`messageType`	30	`MESTYP`	論理メッセージタイプ
`outputMode`	1	`OUTMOD`	出力モード
`recipientAddress`	10	`RCVSAD`	受信者アドレス (SADR)
`recipientLogicalAddress`	70	`RCVLAD`	受信者の論理アドレス
`recipientPartnerFunction`	2	`RCVPFC`	受信者のパートナー機能
`recipientPartnerNumber`	10	`RCVPRN`	受信機のパートナー番号
`recipientPartnerType`	2	`RCVPRT`	受信者のパートナータイプ
`recipientPort`	10	`RCVPOR`	受信側ポート (SAP システム、EDI サブシステム)
`senderAddress`		`SNDSAD`	送信者アドレス (SADR)
`senderLogicalAddress`	70	`SNDLAD`	送信者の論理アドレス
`senderPartnerFunction`	2	`SNDPFC`	差出人のパートナー機能
`senderPartnerNumber`	10	`SNDPRN`	送信者のパートナー番号
`senderPartnerType`	2	`SNDPRT`	送信者のパートナータイプ
`senderPort`	10	`SNDPOR`	送信側ポート (SAP システム、EDI サブシステム)
`serialization`	20	`SERIAL`	EDI/ALE: シリアル化フィールド
`status`	2	`STATUS`	IDoc のステータス
`testFlag`	1	`テスト`	テストフラグ

Java で制御レコード属性を設定する場合 (から表269.2「IDoc ドキュメントの属性」)、Java Bean プロパティーの通常の規則に従います。つまり、属性値を取得および設定するために、getName および setName メソッドを介して name 属性にアクセスできます。たとえば、iDocType、iDocTypeExtension、および messageType 属性は、Document オブジェクトで次のように設定できます。

// Java
document.setIDocType("FLCUSTOMER_CREATEFROMDATA01");
document.setIDocTypeExtension("");
document.setMessageType("FLCUSTOMER_CREATEFROMDATA");

// Java
document.setIDocType("FLCUSTOMER_CREATEFROMDATA01");
document.setIDocTypeExtension("");
document.setMessageType("FLCUSTOMER_CREATEFROMDATA");

Copy to Clipboard

Toggle word wrap

XML でドキュメント属性を設定する
リンクのコピー

XML で制御レコード属性を設定する場合、idoc:Document 要素に属性を設定する必要があります。たとえば、iDocType、iDocTypeExtension および messageType 属性は次のように設定できます。

<?xml version="1.0" encoding="ASCII"?>
<idoc:Document ...
               iDocType="FLCUSTOMER_CREATEFROMDATA01"
               iDocTypeExtension=""
               messageType="FLCUSTOMER_CREATEFROMDATA" ... >
    ...
</idoc:Document>

<?xml version="1.0" encoding="ASCII"?>
<idoc:Document ...
               iDocType="FLCUSTOMER_CREATEFROMDATA01"
               iDocTypeExtension=""
               messageType="FLCUSTOMER_CREATEFROMDATA" ... >
    ...
</idoc:Document>

Copy to Clipboard

Toggle word wrap

トップに戻る

269.6. IDoc のメッセージ本文

IDoc メッセージタイプ
リンクのコピー

IDoc 文書モデル
リンクのコピー

IDoc と Document オブジェクトの関係
リンクのコピー

Document インスタンスの作成例
リンクのコピー

ドキュメント属性
リンクのコピー

Java でドキュメント属性を設定する
リンクのコピー

XML でドキュメント属性を設定する
リンクのコピー

詳細情報

試用、購入および販売

コミュニティー

Red Hat ドキュメントについて

多様性を受け入れるオープンソースの強化

会社概要

Theme

Red Hat legal and privacy links

Red Hat legal and privacy links

269.6. IDoc のメッセージ本文

IDoc メッセージタイプリンクのコピーリンクがクリップボードにコピーされました!

IDoc 文書モデルリンクのコピーリンクがクリップボードにコピーされました!

IDoc と Document オブジェクトの関係リンクのコピーリンクがクリップボードにコピーされました!

Document インスタンスの作成例リンクのコピーリンクがクリップボードにコピーされました!

ドキュメント属性リンクのコピーリンクがクリップボードにコピーされました!

Java でドキュメント属性を設定するリンクのコピーリンクがクリップボードにコピーされました!

XML でドキュメント属性を設定するリンクのコピーリンクがクリップボードにコピーされました!

詳細情報

試用、購入および販売

コミュニティー

Red Hat ドキュメントについて

多様性を受け入れるオープンソースの強化

会社概要

Theme

Red Hat legal and privacy links

Red Hat legal and privacy links

IDoc メッセージタイプ
リンクのコピー

IDoc 文書モデル
リンクのコピー

IDoc と Document オブジェクトの関係
リンクのコピー

Document インスタンスの作成例
リンクのコピー

ドキュメント属性
リンクのコピー

Java でドキュメント属性を設定する
リンクのコピー

XML でドキュメント属性を設定する
リンクのコピー