搜索
支持控制台（Console）开发人员开始试用联系人

289.6. IDoc 的消息正文

download PDF

IDoc 消息类型

当使用 IDoc Camel SAP 端点时，消息正文类型取决于您使用的特定端点。

对于 sap-idoc-destination 端点或 sap-qidoc-destination 端点，消息正文为 Document 类型： 

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

对于 sap-idoclist-destination 端点、sap-qidoclist-destination 端点或 sap-idoclist-server 端点，消息正文为 DocumentList 类型： 

org.fusesource.camel.component.sap.model.idoc.DocumentList

IDoc 文档模型

对于 Camel SAP 组件，使用 Eclipse 建模框架(EMF)对 IDoc 文档进行建模，该文档围绕底层 SAP IDoc API 提供打包程序 API。这个模型中最重要的类型有： 

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

文档 类型表示 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();
}

以下一种方法是 Document 接口公开：

访问控制记录的方法
大多数方法是访问或修改 IDoc 控制记录的字段值。这些方法的格式为 AttributeName,AttributeName，其中 AttributeName 是字段值的名称（请参阅 表 289.2 “IDoc 文档属性”）。
访问文档内容的方法

getRoot Segment 方法提供对文档内容(IDoc 数据记录)的访问，以分段对象返回内容。每个分段对象可以包含任意数量的子片段，片段可以嵌套在任意程度上。

但请注意，片段层次结构的精确布局由文档的特定 IDoc 类型定义。在创建（或读取）片段层次结构时，您必须确保遵循 IDoc 类型定义的确切结构。

分段类型用于访问 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);
}

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);
}

因此，要创建 E1SCU_CRE 类型的数据记录，您可以使用类似如下的 Java 代码： 

Segment rootSegment = document.getRootSegment();

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

IDoc 如何与文档对象相关

根据 SAP 文档，IDoc 文档由以下主要部分组成：

控制记录
控制记录（包含 IDoc 文档的 meta-data）由 Document 对象所有流量属性代表，详情请参阅 表 289.2 “IDoc 文档属性”。
数据记录
数据记录由 Segment 对象表示，该对象由嵌套的片段层次结构组成。您可以通过 Document.getRootSegment 方法访问根段。
状态记录
在 Camel SAP 组件中，状态记录 不由 文档模型表示。但是，您可以通过控制记录的 status 属性访问最新的状态值。

创建文档实例示例

例如： 例 289.1 “在 Java 中创建 IDoc 文档” 演示了如何使用 IDoc 类型 FLCUSTOMER_CREATEFROMDATA01 在 Java 中创建 IDoc 模型 API。

例 289.1. 在 Java 中创建 IDoc 文档

// Java
import org.fusesource.camel.component.sap.model.idoc.Document;
import org.fusesource.camel.component.sap.model.idoc.Segment;
import org.fusesource.camel.component.sap.util.IDocUtil;

import org.fusesource.camel.component.sap.model.idoc.Document;
import org.fusesource.camel.component.sap.model.idoc.DocumentList;
import org.fusesource.camel.component.sap.model.idoc.IdocFactory;
import org.fusesource.camel.component.sap.model.idoc.IdocPackage;
import org.fusesource.camel.component.sap.model.idoc.Segment;
import org.fusesource.camel.component.sap.model.idoc.SegmentChildren;
...
//
// Create a new IDoc instance using the modelling classes
//

// Get the SAP Endpoint bean from the Camel context.
// In this example, it's a 'sap-idoc-destination' endpoint.
SapTransactionalIDocDestinationEndpoint endpoint =
    exchange.getContext().getEndpoint(
        "bean:SapEndpointBeanID",
        SapTransactionalIDocDestinationEndpoint.class
    );

// The endpoint automatically populates some required control record attributes
Document document = endpoint.createDocument()

// Initialize additional control record attributes
document.setMessageType("FLCUSTOMER_CREATEFROMDATA");
document.setRecipientPartnerNumber("QUICKCLNT");
document.setRecipientPartnerType("LS");
document.setSenderPartnerNumber("QUICKSTART");
document.setSenderPartnerType("LS");

Segment rootSegment = document.getRootSegment();

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

Segment E1BPSCUNEW_Segment = E1SCU_CRE_Segment.getChildren("E1BPSCUNEW").add();
E1BPSCUNEW_Segment.put("CUSTNAME", "Fred Flintstone");
E1BPSCUNEW_Segment.put("FORM", "Mr.");
E1BPSCUNEW_Segment.put("STREET", "123 Rubble Lane");
E1BPSCUNEW_Segment.put("POSTCODE", "01234");
E1BPSCUNEW_Segment.put("CITY", "Bedrock");
E1BPSCUNEW_Segment.put("COUNTR", "US");
E1BPSCUNEW_Segment.put("PHONE", "800-555-1212");
E1BPSCUNEW_Segment.put("EMAIL", "fred@bedrock.com");
E1BPSCUNEW_Segment.put("CUSTTYPE", "P");
E1BPSCUNEW_Segment.put("DISCOUNT", "005");
E1BPSCUNEW_Segment.put("LANGU", "E");

文档属性

表 289.2 “IDoc 文档属性” 显示您可以在 Document 对象上设置的控制记录属性。

表 289.2. IDoc 文档属性
属性长度SAP 字段描述

archiveKey

70

ARCKEY

EDI 归档密钥

client

3

MANDT

客户端

creationDate

8

CREDAT

创建日期 IDoc

creationTime

6

CRETIM

创建时间 IDoc

方向

1

直接

方向

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 number

iDocSAPRelease

4

DOCREL

SAP Release of IDoc

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

sender 的合作伙伴功能

senderPartnerNumber

10

SNDPRN

合作伙伴发件人数量

senderPartnerType

2

SNDPRT

合作伙伴的发件人类型

senderPort

10

SNDPOR

发件人端口(SAP 系统、EDI 子系统)

序列化

20

SERIAL

EDI/ALE: Serialization 字段

status

2

状态

IDoc 的状态

testFlag

1

测试

test 标记

在 Java 中设置文档属性

在 Java 中设置控制记录属性时（来自 表 289.2 “IDoc 文档属性”）时，会遵循 Java bean 属性的常规约定。也就是说，可以通过 getName 和 setName 方法来访问 name 属性，以获取和设置属性值。例如，iDocType、iDocTypeExtension 和 messageType 属性可按照 文档 对象设置如下： 

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

在 XML 中设置文档属性

在 XML 中设置控制记录属性时，必须在 idoc:Document 元素上设置属性。例如，iDocType、iDocTypeExtension 和 messageType 属性可以设置如下： 

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

学习

尝试、购买和销售

社区

关于红帽文档

通过我们的产品和服务，以及可以信赖的内容，帮助红帽用户创新并实现他们的目标。

让开源更具包容性

红帽致力于替换我们的代码、文档和 Web 属性中存在问题的语言。欲了解更多详情，请参阅红帽博客.

關於紅帽

我们提供强化的解决方案，使企业能够更轻松地跨平台和环境（从核心数据中心到网络边缘）工作。

© 2024 Red Hat, Inc.