idoc文档管理系统API开发手册
IDOC实例详解(阵全)
IDOC实例详解IDOC是用于在不同的SAP系统之间或SAP系统与外部系统之间传输信息的一种文档表示形式。
本实例讲述从SAP客户端：SAPDEV 200传送自定义表中的内容至SAPPROD 700。
其中SAPPROD 700的在200中逻辑系统名称为：DEVCLNT700200的在200中逻辑系统名称为：DEVCLNT200SAPDEV传送的表结构如下：此表在DEV200和PRD700中均存在。
本实例中在讲述DEV200和PRD700之间的通讯设置中，如有不明白之处，还请参考本人的另一个文档“ALE配置及操作详解(阵全)”。
本实例讲述的是不通过消息控制的，处于不同物理地址的SAP系统间的数据传输。
一、使用TCODE：WE31创建一个段，该段须在DEV200和PRD700同时存在。
该段中只包含一个字段。
二、使用TCODE：WE30创建一个IDOC基本类型，该类型须在DEV200和PRD700同时存在。
三、使用TCODE：WE81创建一个逻辑消息类型。
只需在DEV200中创建。
四、TCODE：WE82在DEV200中指定逻辑消息类型和IDOC基本类型的对应关系。
五、使用TCODE：BD64在DEV200中添加消息类型ZMSGDEPARTMENT，并产生合作伙伴文件及分配，详细操作请见“ALE配置及操作详解(阵全)”。
如下图：BD64界面。
在DEV200中产生的对应于PRD700的RFC端口。
通过TCODE：WE21查看。
在DEV200中产生的对应于PRD700的合作伙伴参数，消息类型为ZMSGDEPARTMENT，可使用TCODE：WE20查看。
六、TCODE：SE38在DEV200中写该IDOC的出站处理程序。
代码如下：*& Report ZCREATEMATARIALIDOC*&*&---------------------------------------------------------------------* REPORT ZCREATEDEPARTMENTIDOC.DATA: G_IDOC_CTL LIKE EDIDC,ZSEGDEPARTMENT LIKE ZSEGDEPARTMENT.DATA: GI_RET_CTL LIKE EDIDC OCCURS 0,GI_IDOC_DATA LIKE EDIDD OCCURS 0 WITH HEADERLINE.PERFORM BUILD_IDOC_CTL.PERFORM BUILD_IDOC_SEG.PERFORM CREATE_IDOC.*&---------------------------------------------------------------------* *& Form CREATE_IDOC*&---------------------------------------------------------------------* * textFORM CREATE_IDOC.CALL FUNCTION 'MASTER_IDOC_DISTRIBUTE'EXPORTINGMASTER_IDOC_CONTROL = G_IDOC_CTLTABLESCOMMUNICATION_IDOC_CONTROL = GI_RET_CTLMASTER_IDOC_DATA = GI_IDOC_DATAEXCEPTIONSERROR_IN_IDOC_CONTROL = 1ERROR_WRITING_IDOC_STATUS = 2ERROR_IN_IDOC_DATA = 3SENDING_LOGICAL_SYSTEM_UNKNOWN = 4OTHERS = 5 .IF SY-SUBRC <> 0.MESSAGE ID SY-MSGID TYPE SY-MSGTY NUMBER SY-MSGNOWITH SY-MSGV1 SY-MSGV2 SY-MSGV3 SY-MSGV4.ELSE.COMMIT WORK.ENDIF.ENDFORM. " CREATE_IDOC*& Form BUILD_IDOC_CTL*&---------------------------------------------------------------------* * text*----------------------------------------------------------------------* * --> p1 text* <-- p2 text*----------------------------------------------------------------------* FORM BUILD_IDOC_CTL.* TYPEG_IDOC_CTL-IDOCTP = 'ZTYPDEPARTMENT'. "IDOC TYPEG_IDOC_CTL-MESTYP = 'ZMSGDEPARTMENT'. "MESSAGE TYPE* RECEIVERG_IDOC_CTL-RCVPRT = 'LS'. "PARTNER TYPEG_IDOC_CTL-RCVPRN = 'DEVCLNT700'. "PARTNER NOG_IDOC_CTL-RCVPOR = 'A000000017'. "PORT* SENDERG_IDOC_CTL-SNDPRT = 'LS'. "PARTNER TYPEG_IDOC_CTL-SNDPRN = 'DEVCLNT200'. "PARTNER NO* G_IDOC_CTL-SNDPOR = 'A000000017'. "PORTENDFORM. " BUILD_IDOC_CTL*&---------------------------------------------------------------------* *& Form BUILD_IDOC_SEG*&---------------------------------------------------------------------* FORM BUILD_IDOC_SEG.* HEAD DATAGI_IDOC_DATA-SEGNAM = 'ZSEGDEPARTMENT'. "SEGMENT NAMEGI_IDOC_DATA-SEGNUM = 1. "SEGMENT NOZSEGDEPARTMENT-DEPT_NAME = '资讯部'. "部门名称MOVE ZSEGDEPARTMENT TO GI_IDOC_DATA-SDATA.APPEND GI_IDOC_DATA.ENDFORM. " BUILD_IDOC_SEG七、PRD700中，使用BD64查看在本文档中第五步产生的分配模型。
SAPIDOC配置步骤
CHAPTER
集成其他模块实现业务协同
SAP ERP集成
通过SAP ERP系统与其他SAP模块（如SAP HR、SAP FI/CO等）进行集成，实现业务流程的自动化和协同工作。
SAP S/4HANA集成
将SAPIDOC与SAP S/4HANA系统进行集成，利用S/4HANA的先进功能和性能，提升业务处理效率和数据准确性。
SAPIDOC配置步骤
目录
SAPIDOC简介与前期准备 基础设置与参数配置 文档管理功能使用指南 报表生成与数据分析功能介绍 集成其他模块实现业务协同 系统维护与故障排除方法
01
CHAPTER
SAPIDOC简介与前期准备
1
2
3
SAPIDOC能够自动生成SAP系统的技术文档，包括数据字典、程序文档等，方便开发人员和系统管理员查看和维护。
SAP Cloud Platform集成
通过SAP Cloud Platform将SAPIDOC与其他SAP云应用进行集成，实现云上云下业务的无缝连接和高效协同。
与SAP其他模块集成方案讨论
数据同步策略制定
制定合理的数据同步策略，确保不同系统间的数据实时性和一致性。
数据安全保障
在数据传输和同步过程中，采用加密、身份验证等安全措施，确保数据的安全性和完整性。
操作演示
提供数据备份和恢复的详细操作步骤和演示，让用户能够熟练掌握操作方法。
数据备份恢复操作演示
用户培训
针对系统的功能和操作进行培训，让用户能够充分了解系统的使用方法和注意事项。
技术支持服务
提供全天候的技术支持服务，解答用户在使用过程中遇到的问题，确保系统的稳定运行。
服务介绍
详细介绍用户培训和技术支持服务的内容和方式，让用户能够了解并享受到完善的服务保障。
Idoc学习笔记
2024/1/24
编写处理程序
为实现自定义逻辑，可以编写ABAP 程序来处理Idoc的生成、发送和接收 过程中的特定任务。
测试与验证
在自定义开发完成后，进行全面的测 试和验证以确保自定义Idoc结构和内 容的正确性和可用性。
10
03
Idoc接收与处理
2024/1/24
11
接收Idoc流程
监听端口
Idoc处理系统需要监听指定的端 口，以便接收来自SAP系统的 Idoc文件。
2024/1/24
接收Idoc
一旦有Idoc文件发送到监听端口， Idoc处理系统就会接收该文件。
验证Idoc
接收到的Idoc文件需要进行验证， 以确保文件的完整性和准确性。验 证过程可能包括检查文件格式、内 容结构、数据有效性等。
12
解析Idoc内容
解析文件
数据存储
经过验证的Idoc文件需要被解析，以 便提取出其中的数据。解析过程通常 基于Idoc的文件格式和结构进行。
转换后的数据可以被存储到数据库、 数据仓库或其他数据存储系统中，以 便后续处理和分析。
数据映射
解析出的数据需要根据预定义的数据 映射规则进行转换，以适应目标系统 的数据格式和要求。
通过IDoc实现采购订单数据的自动传输和 更新，确保采购数据的及时性和准确性。
库存管理
财务管理
利用IDoc进行库存数据的实时传输和更新 ，帮助企业实现库存的精准管理和控制。
通过IDoc实现财务数据的自动传输和处理 ，提高财务处理的效率和准确性。
2024/1/24
18
05
Idoc性能优化与监控
2024/1/24
定义Idoc类型
在SAP系统中，通过IMG（ Implementation Guide） 配置自定义的Idoc类型，包 括定义基本结构和所需字段 。
IDOC培训教程
IDOC培训教程一、概述二、IDOC功能介绍1.文档创建：IDOC支持在线创建多种类型的文档，如Word、Excel、PPT等。
用户只需在系统中选择相应的模板，即可快速文档。
2.文档编辑：IDOC提供丰富的文本编辑功能，包括字体、字号、颜色、对齐方式等，用户可以方便地对文档进行排版和美化。
3.文档审核：IDOC内置智能审核功能，可自动检测文档中的错误和问题，并提出修改建议。
用户可以根据建议进行修改，确保文档质量。
4.文档管理：IDOC提供便捷的文档管理功能，包括文档分类、标签、搜索、分享等。
用户可以轻松地组织和管理自己的文档。
5.团队协作：IDOC支持多人在线协作，团队成员可以实时查看和编辑同一文档，提高工作效率。
6.版本控制：IDOC自动保存文档的每个版本，用户可以随时查看历史版本，并进行比较和恢复。
7.数据分析：IDOC可以对文档中的数据进行智能分析，图表和报告，帮助用户更好地理解和利用数据。
8.智能搜索：IDOC提供强大的搜索功能，用户可以通过关键词、标签、作者等条件快速找到所需文档。
三、IDOC操作流程1.注册和登录：访问IDOC官网，注册账号并登录。
2.创建文档：在IDOC首页选择“新建文档”，选择相应的模板，填写文档内容。
3.文档编辑：在编辑页面，用户可以对文档进行排版、美化等操作。
4.文档审核：“审核”按钮，系统会自动检测文档中的错误和问题，并提出修改建议。
5.文档管理：在“我的文档”页面，用户可以对文档进行分类、标签、搜索等操作。
6.团队协作：在“团队”页面，用户可以邀请团队成员加入，共同编辑和审核文档。
7.版本控制：在“历史版本”页面，用户可以查看和恢复文档的历史版本。
8.数据分析：在“数据分析”页面，用户可以查看文档中的数据图表和报告。
9.智能搜索：在搜索框输入关键词，“搜索”按钮，系统会展示相关文档。
四、IDOC使用技巧1.快捷键：熟练使用IDOC的快捷键，可以提高工作效率。
IDOC基本步骤
可扩展性
IDOC支持自定义字 段和扩展属性，以满 足特定业务需求。
可靠性
IDOC传输过程中采 用确认机制和错误处 理机制，确保数据的 完整性和准确性。
高效性
IDOC支持批量处理 和异步传输，提高了 数据传输的效率。
IDOC在SAP系统中的应用
跨系统数据交换
业务流程自动化
通过IDOC，SAP系统可以与其他非SAP系统 进行数据交换，实现信息的共享和集成。
发送IDOC至目标系统
01
02
03
组装IDOC数据
按照目标系统的要求，将 业务数据组装成IDOC格 式。
调用发送接口
通过编程方式调用发送接 口，将组装好的IDOC数 据发送给目标系统。
监控发送状态实时监控IDOC的发送状 态来自确保数据成功传输至 目标系统。
04
接收IDOC
接收IDOC数据
通过SAP系统提供的接口，如RFC、 Web Services等，接收来自外部系统 的IDOC数据。
06
总结与展望
回顾本次项目成果
完成了项目目标
成功实现了IDOC的基本功 能，包括数据提取、转换 和加载等。
提高了数据质量
通过IDOC的处理，数据准 确性和一致性得到了显著 提高。
提升了业务效率
IDOC的自动化处理大大减 少了人工干预，提高了业 务处理效率。
展望未来发展趋势
智能化发展
随着人工智能技术的不断发展， IDOC有望实现更加智能化的数据
错误验证
在修复错误后，需要对修复结果进行 验证，确保错误已被正确解决且不会 影响系统其他部分。
05
04
错误修复
根据错误类型和定位结果，采取相应 措施修复错误，如修复代码、调整配 置、清理数据等。
IDOC配置手册
IDOC配置手册1.自建IDOC类型 (1)2.扩展标准IDOC (8)3.创建接口端口和逻辑系统 (13)4. 配置分布模型和伙伴参数 (17)5.激活指针 (21)6.设置筛选器 (22)7.异常处理 (27)1.自建IDOC类型1.1首先创建用来记录增量发送时间戮的自建表ZIDOC_LOG，结构如下图：通过自建表来记录IDOC发送的时间戳，有一定的漏单危险，推荐每次取值设置的时间为当前时间往前一段时间来避免因为多次IDOC发送过程中遗漏的记录。
假如想统计或查询已发记录，可以通过自建表来保存已发送信息。
1.2WE31定义自定义段ZMKAL（用于自定义IDOC类型发布生产版本），开发完成后可设置批rrrrrrrrrrrrrrrrrrrrrrrrrrrrrrrrrrrrrrrrrrrrrrrrrrrrrrrrrr1.3WE30定义基本类型ZMKAL_IDOC，将刚才定义的段ZMKAL挂在此类型下，开发完成后可设置版本，表示开发完成，如需修改则需要取消发布。
1.4 WE81定义消息类型MKAL_IDOC。
1.5WE82 把基本类型MKAL_IDOC分配给消息类型MKAL_IDOC。
1.6定义自定义IDOC类型所需的结构ZMKAL_LINE。
表结构,ZMKAL_TYP,对应行类型结构为ZMKAL_LINE1.7创建发送生产版本IDOC用的函数：ZMKAL_IDOC_SEND,源代码如下,参数、异常定义见函数开头说明FUNCTION zmkal_idoc_send .*"----------------------------------------------------------------------*"*"Local interface:*" TABLES*" ZMKAL TYPE ZMKAL_TYP*" EXCEPTIONS*" NO_IDOC*" NO_MODEL*"----------------------------------------------------------------------*variables of general interestDATA:*control record for the IDocidoc_control LIKE edidc,*data records for the IDoct_idoc_data LIKE edidd OCCURS0WITH HEADER LINE,*table for the IDocs created by MASTER_IDOC_CONTROLt_comm_control LIKE edidc OCCURS0WITH HEADER LINE,*partner type for logical systemc_partner_type_logical_system LIKE edidc-rcvprt,*help variable for the check if an IDoc has to be createdh_create_idoc.* variables specific for this exampleDATA:* field strings with IDoc segment structuree1xmkal TYPE zmkal_line,* data to be put to the control recordc_message_type LIKE edidc-mestyp VALUE'ZMKAL_IDOC',c_base_idoc_type LIKE edidc-idoctp VALUE'ZMKAL_IDOC',* segment types to be put to the data record tablec_header_segtyp LIKE edidd-segnam VALUE'ZMKAL'.* check if an IDoc has to be created, read the distribution model CALL FUNCTION'ALE_MODEL_DETERMINE_IF_TO_SEND'EXPORTINGmessage_type = c_message_type* SENDING_SYSTEM = ' '* RECEIVING_SYSTEM = ' '* VALIDDATE = SY-DATUMIMPORTINGidoc_must_be_sent = h_create_idoc.* exceptions* own_system_not_defined = 1* others = 2.IF h_create_idoc IS INITIAL.raise no_model.* no message flow maintained in the model, nothing to do EXIT.ENDIF.* put the application header record to the IDocLOOP AT zmkal.MOVE-CORRESPONDING zmkal TO e1xmkal.* append record to IDoc data tablet_idoc_data-segnam = c_header_segtyp.t_idoc_data-sdata = e1xmkal.APPEND t_idoc_data.ENDLOOP.idoc_control-mestyp = c_message_type.idoc_control-idoctp = c_base_idoc_type.CALL FUNCTION'MASTER_IDOC_DISTRIBUTE'* in update task "if application document is posted in update taskEXPORTINGmaster_idoc_control = idoc_controlTABLEScommunication_idoc_control = t_comm_controlmaster_idoc_data = t_idoc_dataEXCEPTIONSerror_in_idoc_control = 1error_writing_idoc_status = 2error_in_idoc_data = 3sending_logical_system_unknown = 4OTHERS = 5.* A commit work has to be done. It could also be done in the calling * application.COMMIT WORK.READ TABLE t_comm_control INDEX1.IF sy-subrc <> 0.raise no_idoc.* no IDoc was created, you can react here, if neccessary ENDIF.ENDFUNCTION.1.8程序中通过自建时间戳表来抓取增量数据，并调用函数zmkal_idoc_send。
2024年度IDoc易学教程
IDoc处理错误，可能原因包括数据格式错误、处理逻辑错 误等，解决方案包括检查数据格式、修复处理逻辑错误等 。
问题三
自定义字段无法识别，可能原因包括字段定义错误、增强 代码错误等，解决方案包括检查字段定义、修复增强代码 错误等。
12
PART 03
IDoc接收与处理
REPORTING
2024/3/23
IDoc易学教程
REPORTING
2024/3/23
1
2024/3/23
• IDoc基本概念与原理 • IDoc创建与配置 • IDoc接收与处理 • IDoc高级功能应用 • 总结回顾与展望未来
目录
PART 01
IDoc基本概念与原理
REPORTING
2024/3/23
3
IDoc定义及作用
在学习过程中，我遇到了很多问题，但通过思考和请教老师，我逐 渐提高了解决问题的能力。
25
行业发展趋势预测
2024/3/23
IDoc在数字化转型中的作用
随着企业数字化转型的加速推进，IDoc作为实现系统间数据传输的重要工具，将在企业 信息化建设中发挥越来越重要的作用。
IDoc与云计算的结合
云计算技术的发展为IDoc的应用提供了新的可能性，未来IDoc有望与云计算技术相结合 ，实现更高效、更灵活的数据传输和处理。
REPORTING
2024/3/23
23
关键知识点总结回顾
IDoc基本概念和原理
介绍了IDoc的定义、作用、传输原理等基本 概念。
IDoc创建与配置
讲解了如何在SAP系统中创建和配置IDoc， 包括基本设置、参数配置等。
2024/3/23
IDOC讲议
状态记录(Status Record) 状态记录
IDoc概述 概述
控制记录(Control 控制记录 Record)
每个IDoc的Control Record可以认为是 文件头,它包含发送及接收端, IDoc ID, 发送日期等信息,当Idoc被触发时,SAP 会首先检查这些信息是否正确.
IDoc概述 概述
数据记录(Data Record) 数据记录 多个数据段(Segment)组成的一个层 次结构,装载传输的数据,每个数据段 不能超过1000个字符
当发送或接收这些IDoc时,数 据将会被解析到这些特定层 级关系的数据段中,SAP将会 将中FM的逻辑中对此数据加 以操作.
IDoc概述 概述
状态记录(Status Record) 状态记录 用来记录IDOC从发送方到接受 方的历史状态信息.
T-CODE:WE81 定义消息类型
T-CODE:WE82 IDoc 类型分配给消息类型,Release代表不同的版本
IDoc概述 概述
IDoc示例 示例
演示２个示例帮助理解 具体工作模式和设计: 演示２个示例帮助理解IDoc具体工作模式和设计 具体工作模式和设计 1,配置一个跨 配置一个跨Client传输主数据的示例 传输主数据的示例. 配置一个跨 传输主数据的示例 通常在实际应用中,为了简化系统过多的人为操作或更好的实现自动化,有时我们 需要在同一集团内跨公司交易时传输相关的数据, 例如: 1).SAP系统中同一集团A和B两个公司,A向B开PO传出IDoc自动创建B公司的SO. 2).在主数据中,可以方便的通过Idoc传输物料主档/BOM/Work Center/Routing/Vendor/Customer等资料. 3).SAP也可轻易地做到跨Client交换数据.
- 1、下载文档前请自行甄别文档内容的完整性，平台不提供额外的编辑、内容补充、找答案等附加服务。
- 2、"仅部分预览"的文档,不可在线预览部分如存在完整性等问题,可反馈申请退款(可完整预览的文档不适用该条件!)。
- 3、如文档侵犯您的权益，请联系客服反馈,我们会尽快为您处理(人工客服工作时间：9:00-18:30)。
第二章 API 函数接口
2.1 设置服务器信息
int SetServerInfo( string ServerHost, int ServerPort );
功能说明： 设置服务器 IP 地址和端口。
参数： ServerHost：[in]服务器 IP 地址； ServerPort：[in]服务器端口；
64。
返回值： 1： 新建成功； 14：没有登录或者登录信息错误，不能进行操作； 20：参数无效； 21：父目录不存在； 22：目录名包含非法字符或者太长； 23：没有相应权限； 25：服务器端存在该目录名。
2.4 删除目录
int FolderDel( int OwnerId, long FolderId );
返回值： 1： 设置成功； 10：IP 地址或者端口格式错误。 11：连接服务器失败，请检查网络连接情况以及服务器地址和端口是否设置正确；
2.2 登录服务器
int Login( string UserName, string Password );
功能说明： 登录多可文档管理系统。
参数： UserName：[in]用户名； Password：[in]密码；
idoc 文档管理系统 API 开发手册
版权所有 北京联高软件开发有限公司
目录
idoc 文档管理系统 API 开发手册 ..................................................................................................1 第一章 概述.......................................................................................................................3 1.1 目录及文件说明...................................................................................................3 1.2 控件注册...............................................................................................................3 1.3 接口调用的环境........................................................................................................3 第二章 API 函数接口 .......................................................................................................4 2.1 设置服务器信息........................................................................................................4 2.2 登录服务器................................................................................................................4 2.3 新建目录....................................................................................................................5 2.4 删除目录....................................................................................................................5 2.5 目录重命名................................................................................................................6 2.6 上传文件....................................................................................................................6 2.7 文件下载....................................................................................................................7 2.8 文件删除....................................................................................................................7 2.9 文件重命名................................................................................................................8 2.10 提取文件正文..........................................................................................................9 2.11 修改摘要..................................................................................................................9 2.12 得到文件信息........................................................................................................10 2.13 得到系统的组织结构............................................................................................11 2.14 得到组目录结构....................................................................................................12 2.15 得到目录文件........................................................................................................13 2.16 目录授权................................................................................................................14 2.17 文件授权................................................................................................................15 2.18 搜索........................................................................................................................16 2.19 注册用户................................................................................................................17 2.20 修改密码................................................................................................................18 2.21 得到登录的 URL...................................................................................................18 2.12 得到用户密码的 MD5 ...............................................................19
1.2 控件注册
idocAPI.ocx 需要注册，注册过程如下： win“开始”-> 点击“运行”-> 输入命令“cmd”，出现窗口，运行命令 regsvr32 c:\idoc\binn\idocAPI.ocx 即可（c:\idoc\binn\为文件所在目录）。
1.3 接口调用的环境
首先需要启动 idoc 多可系统，您可用通过 idocAPI.ocx 连接 idoc 多可服务器，通过 TCP/HTTP 实现接口调用。
2.5 目录重命名
int FolderRename( int OwnerId, long FolderId, string NewFolderName );
功能说明： 修改目录名字。
参数： OwnerId：[in]所要修改的目录所在的工作组 ID，如果是个人文档，则为个人 ID； FolderId：[in]所要修改的目录的 ID； NewFolderName：[in]：新的目录名字，不能包含下列符号：” / \ : * ? < > |，长度小于