auroraidoc设计说明及开发指南大学论文

if"REFDocControlNumber"="Error!Referencesourcenotfound."""REFDocControlNumberPAGE26CompanyConfidential-ForinternaluseonlyHandEnterpriseSolutionsAURORA-IDOC设计说明及开发指南作者: Jinxiao.lin建档日期: 2011/7/10最近更新: 2013/5/23控制号: 版本: 1.3审批:ProjectManager 拷贝号 _____文档控制记录更改日期作者版本文档状态更改参考2013/5/23Jinxiao.lin1.32011/11/24Jinxiao.lin1.22011/11/1ru.lu1.12011/7/10Xiaopeng.zhu1.0Draft1.0创建Jinxiao.linXiaochen.shi（SAP）审阅人姓名职位分发拷贝号姓名职位文档目录TOC\o"1-4"\h\z11322文档控制 ii14057基本概念介绍 131399SAPIDoc介绍 18634IDoc主要功能 115497IDoc文件例子 118226IDoc的数据结构 213417IDoc文件 210720AuroraIDoc 29238AuroraIDoc事务流程 312238项目实施 416140部署 421976从公司cvs下载最新的aurora_idoc项目 428880修改配置文件 415106开放端口 58075前台配置 1011069配置JCO功能。 105168在系统中注册配置页面，效果如下： 1119823管理 1415579启动和关闭AuroraIDoc 1430408监控，查询数据 1425443数据库表 1430112起初配置表 14298运行时表 1530843SAPIDOC配置 1625259配置接收/发送IDOC系统（TCODE:SALE） 166624定义RFC目标系统(TCODE:SM59) 178293配置IDOC端口(TCODE:WE21) 188223创建段类型(TCODE:WE31) 1924579创建IDOC类型(TCODE:WE30) 1914414定义消息类(TCODE:WE81) 2010236把基本类型分配给消息类型(TCODE:WE82) 2128145分配模型视图(TCODE:BD64) 218450把消息类型加入伙伴参数文件的出站参数 2227955编写代码 2315337把idoc设置成后台自动发送（TCODE:sm36） 2419353察看IDOC发送情况(TCODE:WE02和sm59) 2410241SAP网关配置 2413202常见问题 289455附件 3029019配置页面文件 30基本概念介绍SAPIDoc介绍IDoc的全称是IntermediateDocument，是SAP用于传输业务数据的一种数据格式。IDoc主要功能IDoc主要用于系统间的数据同步，数据发起方是SAP,接受方是另一方系统。举例来说，在一个特定的SAP服务器配置了IDoc之后，当一个SAP用户创建一张采购订单，其信息会自动通过IDoc传输给另一方系统，此系统根据接受到的数据，在本系统中自动创建一张销售订单。IDoc文件例子<?xmlversion="1.0"?><MATMAS05> <IDOCBEGIN="1"> <EDI_DC40SEGMENT="1"> <TABNAM>EDI_DC40</TABNAM> <MANDT>800</MANDT> <DOCNUM>0000000000940780</DOCNUM> <DOCREL>701</DOCREL> <STATUS>30</STATUS> <DIRECT>1</DIRECT> <OUTMOD>2</OUTMOD> <IDOCTYP>MATMAS05</IDOCTYP> <MESTYP>MATMAS</MESTYP> <SNDPOR>SAPIDS</SNDPOR> <SNDPRT>LS</SNDPRT> <SNDPRN>IDSCLNT800</SNDPRN> <RCVPOR>A000000071</RCVPOR> <RCVPRT>LS</RCVPRT> <RCVPRN>HANDMAS</RCVPRN> <CREDAT>20110620</CREDAT> <CRETIM>142202</CRETIM> <SERIAL>20110620142200</SERIAL> </EDI_DC40> <E1MARAMSEGMENT="1"> <MSGFN>005</MSGFN> <MATNR>000000000000002203</MATNR> <ERSDA>20110312</ERSDA> <ERNAM>3047</ERNAM> <LAEDA>20110312</LAEDA> <AENAM>3047</AENAM> <PSTAT>K</PSTAT> <MTART>FERT</MTART> <MBRSH>M</MBRSH> <MEINS>EA</MEINS> <BLANZ>000</BLANZ> <BRGEW>0.000</BRGEW> <NTGEW>0.000</NTGEW> <VOLUM>0.000</VOLUM> <WESCH>0.000</WESCH> <LAENG>0.000</LAENG> <BREIT>0.000</BREIT> <HOEHE>0.000</HOEHE> <ERGEW>0.000</ERGEW> <ERVOL>0.000</ERVOL> <GEWTO>0.0</GEWTO> <VOLTO>0.0</VOLTO> <FUELG>0</FUELG> <STFAK>0</STFAK> <MHDRZ>0</MHDRZ> <MHDHB>0</MHDHB> <MHDLP>0</MHDLP> <VPSTA>K</VPSTA> <MSTDE>00000000</MSTDE> <MSTDV>00000000</MSTDV> <COMPL>00</COMPL> <MTPOS_MARA>NORM</MTPOS_MARA> <GEWTO_NEW>0.0</GEWTO_NEW> <VOLTO_NEW>0.0</VOLTO_NEW> <E1MARA1SEGMENT="1"> <MAXC>0.000</MAXC> <MAXC_TOL>0.0</MAXC_TOL> <MAXL>0.000</MAXL> <MAXB>0.000</MAXB> <MAXH>0.000</MAXH> <QQTIME>0</QQTIME> </E1MARA1> <E1MAKTMSEGMENT="1"> <MSGFN>005</MSGFN> <SPRAS>1</SPRAS> <MAKTX>111</MAKTX> <SPRAS_ISO>ZH</SPRAS_ISO> </E1MAKTM> <E1MARMMSEGMENT="1"> <MSGFN>005</MSGFN> <MEINH>EA</MEINH> <UMREZ>1</UMREZ> <UMREN>1</UMREN> <LAENG>0.000</LAENG> <BREIT>0.000</BREIT> <HOEHE>0.000</HOEHE> <VOLUM>0.000</VOLUM> <BRGEW>0.000</BRGEW> <NEST_FTR>0</NEST_FTR> <MAX_STACK>0</MAX_STACK> <CAPAUSE>0.000</CAPAUSE> </E1MARMM> </E1MARAM> </IDOC></MATMAS05>IDoc的数据结构IDoc的数据结构分三个层次：IDoc类型（idoctype）段（segment）字段（field）不同的IDoc类型用于处理不同类型的信息。比如IDoc格式ORDERS01可用于采购订单（PurchaseOrder）和订单确认（OrderConfirmation）。IDoc类型下可以定义一个或多个段。段类似于数据库中的表，段可以有层次结构，即段可以有父段，也可以有子段。段下定义一个或多个字段，类似于数据库中的表字段。IDoc文件一个IDoc文件包含两种数据：控制记录（ControlRecord）：包含IDoc类型、伙伴端口、SAPR/3的版本等信息。对应上面文件中IDOC节点的第一个子节点。数据记录（DataRecord）：包含段和字段的数据信息。对应上面文件中的IDOC节点下除第一个子节点外的其余节点。AuroraIDocAuroraIDoc是基于Aurora框架研发出来的一款产品。它独立部署，不依赖于任何Web容器，并且可以部署在windows、unix和linux等各种操作系统上。AuroraIDoc事务流程AuroraIDoc启动时会登录SAP，并向SAP注册一个ProgramID。当SAP系统有数据新增或更改时，向上述的ProgramID发送IDoc数据流。AuroraIDoc接收到IDoc数据流，并以XML文件的形式保存在指定的文件目录中。AuroraIDoc解析此XML文件，并根据预先配置的对应关系，数据插入临时表中。在插入临时表后，调用项自定义的客户化数据库package，把临时表中德数据插入到正式业务表中。在成功插入业务表后，再把解析的数据插入系统通用的接口表（FND_INTERFACE_HEADERS，FND_INTERFACE_LINES），作为数据备份。根据配置决定是否删除此xml文件。给sap方一个反馈信息，这个步骤可选。注：以上七个步骤都是全自动化的操作，项目实施时只需要做两件事：配置对应关系编写客户化数据库package项目实施部署从公司cvs下载最新的aurora_idoc项目部署目录结构：binStartup.bat和startup.shshutdown.bat和shutdwon.shMYSERVER.jcoServerBCE.jcoDperties(可选)WEB-INFuncertain.xmluncertain.local.xmlaurora.plugin.sap.sync.idocIdoc.configaurora.databasedatasource.configAurora.featureservice-logging.configlibaurora.jarclasses12.jar（JDBC驱动）其他jar包classesfeedback_proc_cfnd_idoc_feedbacks.bm这个结构跟tomcat的结构基本类似，仅稍有不同：bin目录是跟web-inf目录是同级的，并减少了很多其他目录和文件。用户只需把自定义的config文件放入web-inf下，把jar包放入lib下，并把其他资源（如果需要）放入bin目录下，在classes目录下放置反馈给sap的程序文件，部署即完成。修改配置文件datasource.config：数据库连接idoc.config：idoc配置文件uncertain.xml：日志文件路径MYSERVER.jcoServer参数含义例子gidsap注册的ProgramIDHAND1SAP的服务器名字IDSjco.server.gwhostIP8jco.server.gwserv端口号sapgw00jco.server.unicode编码1jco.server.repository_destination指向<文件名称>.jcoDestination这个文件BCE参数说明例子jco.client.lang语言ENjco.client.client环境800jco.client.user密码1332jco.client.passwd用户handsapjco.client.sysnr端口号00（加上sapgw就是MYSERVER.jcoServer中的jco.server.gwserv属性值）jco.client.ashostIP8BCE.jcoDestinat开放端口在service文件，它在windows和unix系统下路径分别是：Windows系统在C:\Windows\System32\drivers\etc\serviceunxi或linux在/etc/services注：unix/linux刷新服务的命令：refresh–sinetd。如果这个命令没效果，请重启系统试试。添加以下内容：sapdp003200/tcpsapdp013201/tcpsapdp023202/tcpsapdp033203/tcpsapdp043204/tcpsapdp053205/tcpsapdp063206/tcpsapdp073207/tcpsapdp083208/tcpsapdp093209/tcpsapdp103210/tcpsapdp113211/tcpsapdp123212/tcpsapdp133213/tcpsapdp143214/tcpsapdp153215/tcpsapdp163216/tcpsapdp173217/tcpsapdp183218/tcpsapdp193219/tcpsapdp203220/tcpsapdp213221/tcpsapdp223222/tcpsapdp233223/tcpsapdp243224/tcpsapdp253225/tcpsapdp263226/tcpsapdp273227/tcpsapdp283228/tcpsapdp293229/tcpsapdp303230/tcpsapdp313231/tcpsapdp323232/tcpsapdp333233/tcpsapdp343234/tcpsapdp353235/tcpsapdp363236/tcpsapdp373237/tcpsapdp383238/tcpsapdp393239/tcpsapdp403240/tcpsapdp413241/tcpsapdp423242/tcpsapdp433243/tcpsapdp443244/tcpsapdp453245/tcpsapdp463246/tcpsapdp473247/tcpsapdp483248/tcpsapdp493249/tcpsapdp503250/tcpsapdp513251/tcpsapdp523252/tcpsapdp533253/tcpsapdp543254/tcpsapdp553255/tcpsapdp563256/tcpsapdp573257/tcpsapdp583258/tcpsapdp593259/tcpsapdp603260/tcpsapdp613261/tcpsapdp623262/tcpsapdp633263/tcpsapdp643264/tcpsapdp653265/tcpsapdp663266/tcpsapdp673267/tcpsapdp683268/tcpsapdp693269/tcpsapdp703270/tcpsapdp713271/tcpsapdp723272/tcpsapdp733273/tcpsapdp743274/tcpsapdp753275/tcpsapdp763276/tcpsapdp773277/tcpsapdp783278/tcpsapdp793279/tcpsapdp803280/tcpsapdp813281/tcpsapdp823282/tcpsapdp833283/tcpsapdp843284/tcpsapdp853285/tcpsapdp863286/tcpsapdp873287/tcpsapdp883288/tcpsapdp893289/tcpsapdp903290/tcpsapdp913291/tcpsapdp923292/tcpsapdp933293/tcpsapdp943294/tcpsapdp953295/tcpsapdp963296/tcpsapdp973297/tcpsapdp983298/tcpsapdp993299/tcpsapgw003300/tcpsapgw013301/tcpsapgw023302/tcpsapgw033303/tcpsapgw043304/tcpsapgw053305/tcpsapgw063306/tcpsapgw073307/tcpsapgw083308/tcpsapgw093309/tcpsapgw103310/tcpsapgw113311/tcpsapgw123312/tcpsapgw133313/tcpsapgw143314/tcpsapgw153315/tcpsapgw163316/tcpsapgw173317/tcpsapgw183318/tcpsapgw193319/tcpsapgw203320/tcpsapgw213321/tcpsapgw223322/tcpsapgw233323/tcpsapgw243324/tcpsapgw253325/tcpsapgw263326/tcpsapgw273327/tcpsapgw283328/tcpsapgw293329/tcpsapgw303330/tcpsapgw313331/tcpsapgw323332/tcpsapgw333333/tcpsapgw343334/tcpsapgw353335/tcpsapgw363336/tcpsapgw373337/tcpsapgw383338/tcpsapgw393339/tcpsapgw403340/tcpsapgw413341/tcpsapgw423342/tcpsapgw433343/tcpsapgw443344/tcpsapgw453345/tcpsapgw463346/tcpsapgw473347/tcpsapgw483348/tcpsapgw493349/tcpsapgw503350/tcpsapgw513351/tcpsapgw523352/tcpsapgw533353/tcpsapgw543354/tcpsapgw553355/tcpsapgw563356/tcpsapgw573357/tcpsapgw583358/tcpsapgw593359/tcpsapgw603360/tcpsapgw613361/tcpsapgw623362/tcpsapgw633363/tcpsapgw643364/tcpsapgw653365/tcpsapgw663366/tcpsapgw673367/tcpsapgw683368/tcpsapgw693369/tcpsapgw703370/tcpsapgw713371/tcpsapgw723372/tcpsapgw733373/tcpsapgw743374/tcpsapgw753375/tcpsapgw763376/tcpsapgw773377/tcpsapgw783378/tcpsapgw793379/tcpsapgw803380/tcpsapgw813381/tcpsapgw823382/tcpsapgw833383/tcpsapgw843384/tcpsapgw853385/tcpsapgw863386/tcpsapgw873387/tcpsapgw883388/tcpsapgw893389/tcpsapgw903390/tcpsapgw913391/tcpsapgw923392/tcpsapgw933393/tcpsapgw943394/tcpsapgw953395/tcpsapgw963396/tcpsapgw973397/tcpsapgw983398/tcpsapgw993399/tcp前台配置前台配置需要：一个基于Web的Aurora项目。在做配置时，确保此项目连接的数据库和AuroraIDoc连接的数据是一致的。配置JCO功能。添加JCO相关文件在WEB-INF目录下创建目录aurora.plugin.sap，然后在这个目录下创建sap.config文件，将SAP服务器的连接配置到文件中，内容如下：<?xmlversion="1.0"encoding="UTF-8"?><jco:sap-configxmlns:jco="aurora.plugin.sap.jco3"> <instances> <jco:instance-config server_ip="1" sid="BP5" sap_client="300" userid="HAND.ZST" password="abc123" default_lang="ZH" max_conn="5" system_number="51"> </jco:instance-config> </instances> </jco:sap-config>属性名描述server_ipSAP服务器的ip地址sid为当前sap实例命名，方便引用sap_clientSAP中client的概念user_idSaprfc用户名password密码default_lang设定jco连接语言max_connJco连接池最大连接数system_numberSap中系统标识修改uncertain.xml文件，添加黄色底色部分<?xmlversion="1.0"encoding="UTF-8"?><uncertain-enginename="hec"> <packages> <package-pathclassPath="aurora_plugin_package/aurora.plugin.jms"/> <package-pathclassPath="aurora_plugin_package/aurora.plugin.memcached"/> <package-pathclassPath="aurora_plugin_package/aurora.plugin.dataimport"/> <package-pathclassPath="aurora_plugin_package/aurora.plugin.export"/> <package-pathclassPath="aurora_plugin_package/aurora.plugin.touch"/> <package-pathclassPath="aurora_plugin_package/aurora.plugin.ldap"/> <package-pathclassPath="aurora_plugin_package/aurora.plugin.sap"/> <package-pathclassPath="aurora_plugin_package/aurora.plugin.excelreport"/> <package-pathclassPath="aurora_plugin_package/aurora.plugin.export.task"/> </packages></uncertain-engine>在系统中注册配置页面，效果如下：同步IDOC结构打开“同步IDOC结构”功能，页面如下：这个页面form中的参数请sap人员协助配置，具体可参考下图的参数：点击段类型，查看段下的字段，效果如下：这个功能主要是从SAP方获取IDoc的结构。获取IDOC结构后，可以快速配置对应关系。配置对应关系打开“IDOC对应关系”功能，管理SAP段和数据库表的对应关系。建立对应关系后，AuroraIDoc在接收到IDoc数据时，能够根据对应关系，把段和字段的内容插入到数据库对应的表中。界面配置如下：点击“快速生成对应表和对应关系”按钮后，系统依据IDOC结构，用动态SQL自动生成名称相同的表和字段结构。这些自动被创建的表统称为临时表。配置IDOC类型对应的存储过程在数据根据对应关系插入到数据库的临时表中后，AuroraIDoc调用一个存储过程，把临时表中的数据插入到正式业务表中。这个存储过程，根据项目业务场景自行编写。如果需要在同步完程序后，给sap方一个反馈，请配置“反馈程序”，文件目录在classes下。配置页面如下：“有次序”这个属性表示，IDoc数据是否有严格的次序。如果某次同步IDOC数据发生异常后，下次再次接收到同一个IDoc类型的数据，是否处理？选中就是不处理，不选中，就是继续处理。管理和监控启动和关闭AuroraIDoc启动进入bin目录，运行startup.bat或startup.sh文件停止进入bin目录，运行shutdown.bat或shutdown.sh文件。查看日志查看uncertain.local.xml中定义的log目录。监控日志和数据查看aurora\web\bin\dev_jco_rfc.trc文件，可以获取与SAP交互出错信息。查看aurora\web\logs下，可以获取到AURORA抛出的信息查看fnd_idoc_files表可以获取到IDOC同步的步骤状态注意：SAP方更改IDocsegment或者field后，需要重新启动AuroraIDoc才能正确接收到更新后的结构文件。数据库表起初配置表表名说明fnd_idoc_segmentsIDOC段结构表fnd_idoc_fieldsIDoc字段结构表fnd_idoc_segment_mapsIDOC段和数据库表对应关系表fnd_idoc_field_mapsIDOC字段和数据库表字段对应关系表fnd_idoc_typesIDOC类型对应的存储过程表运行时表表名说明fnd_idoc_serversIDOC服务连接表fnd_idoc_files接收到的idoc文件表fnd_interface_headersAurora系统标准接口头表fnd_interface_linesAurora系统标准接口行表fnd_idoc_trx_sample仅测试用，假定是正式的业务表SAPIDOC配置配置接收/发送IDOC系统（TCODE:SALE）定义接收逻辑系统：输入一个逻辑系统名及其描述：定义RFC目标系统(TCODE:SM59)SM59里有很多不同的连接类型:ABAPConnections:连接远程SAP系统的,需要提供作为SAPCLIENT调用系统时的各种参数InternalConnections:连接外部HTTP服务,需要提供URL.TCP/IPconnections:通过TCP/IP层面调用外部服务.此处选用TCP/IP方式连接.由于接口是从SAP向外部系统抛送的方式,所以在配置RFC连接时需要RegisteredServerProgram方式来连接.因为外部程序不仅要向SAP发出RFC请求,还要允许SAP抛出IDOC,而这是通过JCOServer来连接,所以要告知外部系统一个PROGRAMID,而外部系统也配置与SAP相同的PROGRAMID来让SAP与外部系统连接.配置Unicode格式配置IDOC端口(TCODE:WE21)选择事务性RFC:ALE连接方式因为通过JCOServer连接,它会通过XML解析器,自动把IDOC文件转换成XML文件.只需要添加RFC端口,抛出的XML文件由外部系统来指定存在哪个位置.如果由SAP来指定文件夹则需要创建XML文件.其中目录根据操作系统的不同而指定的地址也不同UNIX:/usr/sap/QAS/SYS/global/WINDOWS:\\sapdevdb\sapmnt\QAS\SYS\global\其中黄色部分表示SAP环境功能模块名可制定输出文件的格式在出站：触发器中与RFC关联创建段类型(TCODE:WE31)系统的段类型以E1开头自定义段类型以Z1开头创建段类型后系统会自动创建E2或者Z2的段定义创建IDOC类型(TCODE:WE30)IDOC类型是IDOC文件的结构定义和说明,根据不同的传输格式来定义IDOC类型需要把刚才创建的段类型挂在IDOC类型下面最小数量:该段的最小条目数最大编号:该段得最大条目数创建IDOC类型后,需要设置版本来发布该类型发布后,该版本的IDOC结构无法更改,如要更改需取消发布,更改后再次设置版本定义消息类(TCODE:WE81)把基本类型分配给消息类型(TCODE:WE82)分配模型视图(TCODE:BD64)先创建模型视图然后添加消息类型因为是SAP->外部系统,所以发送方式。输入发送方为当前SAP系统，接收方为目标系统（逻辑系统名）点击菜单中的生成伙伴参数文件点击执行,生成伙伴参数把消息类型加入伙伴参数文件的出站参数因为这里是单向发送IDOC,所以只需要维护出站参数。选择立即转换IDocs。编写代码REPORT

ZTEST_IDOC.

TYPES:BEGIN

OF

TY_MATNR,

MATNR

TYPE

MAKT-MATNR,

END

OF

TY_MATNR.

DATA:IT_MATNR

TYPE

STANDARD

TABLE

OF

TY_MATNR,

WA_MATNR

LIKE

LINE

OF

IT_MATNR.

SELECT

MATNR

UP

TO

100

ROWS

INTO

CORRESPONDING

FIELDS

OF

TABLE

IT_MATNR

FROM

MAKT

WHERE

SPRAS

=

1.

***********************************************

***

发送IDOC

***

***********************************************

DATA:wamas_con

LIKE

edidc,

imas_data

LIKE

edidd

OCCURS

0

WITH

HEADER

LINE,

icom_con

LIKE

edidc

OCCURS

0

WITH

HEADER

LINE.

DATA:it_makt

LIKE

z1test."段类型

wamas_con-rcvprt

=

'LS'.

"接受方伙伴类型

wamas_con-rcvprn

=

'MASTEST001'.

"接受方伙伴编号

wamas_con-idoctp

=

'ZTEST'.

"基本类型

wamas_con-mestyp

=

'ZTEST'.

"消息类型

LOOP

AT

IT_MATNR

INTO

WA_MATNR.

IMAS_DATA-SEGNAM

=

'Z1TEST'.

IT_MAKT-MATNR

=

WA_MATNR-MATNR.

MOVE

IT_MAKT

TO

IMAS_DATA-SDATA.

APPEND

IMAS_DATA.

ENDLOOP.

CALL

FUNCTION

'MASTER_IDOC_DISTRIBUTE'

IN

UPDATE

TASK

EXPORTING

master_idoc_control

=

wamas_con

TABLES

communication_idoc_control

=

icom_con

master_idoc_data

=

imas_data.

COMMIT

WORK.把idoc设置成后台自动发送（TCODE:sm36）察看IDOC发送情况(TCODE:WE02和sm59)执行上面的代码生成了一个IDOC编号。状态是30，即黄色.解决方法TCODE:WE14这是因为刚才在创建出站参数的时候输出模式选择了收集IDOCs,这样发送的时候默认为待定,而需要手动发送来发送.只要选择立即转换IDOC,就会自动发送到端口去。状态02:解决方法：T-CODE：BD83SAP网关配置事务代码SMGW远程登录开发机su-devadmvi/usr/sap/DEV/DVEBMGS00/data/reginfo添加一行：PTP=SAPMASHOST=x3850CANCEL=x3850ACCESS=x3850说明：x3850在/etc/hosts中已维护重启网关服务如下先关闭在远程登录开发机，执行以下命令启动网关服务su-devadmstartsapr3常见问题java.