SAP Application Interface Framework with Error and Conflict Handler

Transcription

1 SAP Applicatin Interface Framewrk with Errr and Cnflict Handler Applies t: SAP Applicatin Interface Framewrk 2.0 with cmpnent AIFX and SAP NetWeaver Summary This dcument describes the integratin scenaris between the SAP Applicatin Interface Framewrk and the Errr and Cnflict Handler. Tw different scenaris exist. The first scenari allws yu t display data f the ECH in Mnitring and Errr Handling. The secnd scenari enables yu t handle messages prcessed with the SAP Applicatin Interface Framewrk in ECH. Authr: Verena Wörner Cmpany: SAP AG Created n: 03 December 2012 Authr Bi Verena Wörner is a develper fr SAP Custm Develpment. She is a member f the develpment team fr the SAP Applicatin Interface Framewrk. scn.sap.cm 2012 SAP AG 1

2 SAP Applicatin Interface Framewrk with Errr and Cnflict Handler Table f Cntents Overview... 3 Preparatin... 3 Display Messages f ECH in Mnitring and Errr Handling... 3 Display Messages Prcessed with SAP Applicatin Interface Framewrk in ECH... 8 Related Cntent Cpyright scn.sap.cm 2012 SAP AG 2

3 SAP Applicatin Interface Framewrk with Errr and Cnflict Handler Overview SAP Applicatin Interface Framewrk prvides yu with mnitring and errr handling functinality. The Errr and Cnflict Handler (ECH) is an errr handling tl implementing the cncept f frward errr handling prvided by SAP NetWeaver. The integratin f the SAP Applicatin Interface Framewrk and ECH invlve tw different scenaris: Display messages f ECH in Mnitring and Errr Handling (/AIF/ERR). This scenari allws yu, t als display messages that yu wuld usually see in ECH in Mnitring and Errr Handling f SAP Applicatin Interface Framewrk. In rder t display this message in Mnitring and Errr Handling yu have t d sme custmizing in the SAP Applicatin Interface Framewrk. This guide will shw yu an example f an interface that will create a custmer fr the flight mdel. The example will then shw yu hw yu can mnitr thse messages in the SAP Applicatin Interface Framewrk Preparatin Display messages prcessed with the SAP Applicatin Interface Framewrk in ECH. This scenari applies if yu want t make use f the interface implementatin capabilities f the SAP Applicatin Interface Framewrk. Hwever, fr ding errr handling yu wuld like t use the ECH. The dcument will prvide yu with an example f hw yu can implement such an interface. Befre yu can use the SAP Applicatin Interface Framewrk with the Errr and Cnflict Handler (ECH), yu shuld make sure that the ECH is activated. Yu can activate the ECH in Custmizing (transactin SPRO) under Crss Applicatin CmpnentsPrcesses and Tls fr Business ApplicatinsEnterprise ServicesErrr and Cnflict HandlerActivate Errr and Cnflict Handler. A service interface shuld have been created in ESR. Then yu can generate the prxy class in yur applicatin system. Display Messages f ECH in Mnitring and Errr Handling If yu chse this scenari yu can d errr handling (fr example, edit, save, restart and cancel) fr yur ECH interface in the SAP Applicatin Interface Framewrk s Mnitring and Errr Handling, t. The lcking, versin handing, and status cntrlling reuse ECH standard functins, s that they are cnsistent and synchrnized between Mnitring and Errr Handling in the SAP Applicatin Interface Framewrk and ECH mnitring. This integratin scenari is independent f the SAP Applicatin Interface Framewrk runtime as Mnitring and Errr Handling wrks n the PPO persistence layer utilized by ECH. First f all yu need an implemented prxy interface. If yu have nt already dne s generate the prxy class frm the service interface yu wuld like t implement in transactin SPROXY. Implement the prxy methd. Example Implementatin f prxy class methd t create custmers: The implementatin belw shws hw the implementatin f the prxy methd culd lk like. The interface will create a custmer fr the flight mdel. In rder t create the custmer BAPI_FLCUST_CREATEFROMDATA will be called. T be able t display the messages in ECH yu need t call methd COLLECT f class CL_FEH_REGISTRATION in case the BAPI returns an errr. METHOD zaif_x102_ii_ech_aif_in01~test_inbund01. DATA: lt_add_data TYPE zaif_test_zgtp_test_raw_ad_tab, ls_custmer_data TYPE bapiscunew, lt_return TYPE bapirettab, ls_return TYPE bapiret2. FIELD-SYMBOLS: <ls_add_data> TYPE zaif_test_zgtp_test_raw_add_da. lt_add_data = input-zgtp_test_raw_mt-raw_add_data_t. LOOP AT lt_add_data ASSIGNING <ls_add_data>. ls_custmer_data-custname = <ls_add_data>-add_data_key. scn.sap.cm 2012 SAP AG 3

4 SAP Applicatin Interface Framewrk with Errr and Cnflict Handler ls_custmer_data-street = <ls_add_data>-add_data1. ls_custmer_data-pstcde = <ls_add_data>-add_data2. ls_custmer_data-city = <ls_add_data>-add_data3. ls_custmer_data-cuntr = <ls_add_data>-add_data4. ls_custmer_data-custtype = <ls_add_data>-add_data5. ls_custmer_data- = <ls_add_data>-add_data6. CALL FUNCTION 'BAPI_FLCUST_CREATEFROMDATA' EXPORTING custmer_data = ls_custmer_data TABLES return = lt_return. ENDLOOP. *check if an errr ccured during when creating the custmer READ TABLE lt_return INTO ls_return WITH KEY type = 'E'. IF sy-subrc = 0. DATA: lr_feh_registratin TYPE REF TO cl_feh_registratin, lv_errr_categry TYPE ech_dte_errr_categry, ls_main_bject TYPE ech_str_bject. lr_feh_registratin = cl_feh_registratin=>s_initialize( ). lv_errr_categry = 'PRE'. "as per table /SAPPO/SERR_CAT. ls_main_bject-bjcat = '1'. ls_main_bject-bjtype = 'SCUSTOM'. ls_main_bject-bjkey = ls_custmer_data-custname. TRY. lr_feh_registratin->cllect( i_single_b = input i_errr_categry = lv_errr_categry i_main_message = ls_return i_main_bject = ls_main_bject ). CATCH cx_ai_system_fault. ENDTRY. cl_prxy_fault=>raise( exceptin_class_name bapireturn_tab ). ENDIF. ENDMETHOD. = 'ZAIF_TEST_CX_ZGT_FAULT' = lt_return Furthermre, yu need an ECH actin class, which shuld implement interface IF_ECH_ACTION. Yur actin class needs a static attribute GO_ECH_ACTION, which shuld have the type f yur actin class. The visibility f the attribute shuld be set t prtected. Additinally, yu have t implement methd S_CREATE, with the cding displayed belw: METHOD if_ech_actin~s_create. IF NOT g_ech_actin IS BOUND. CREATE OBJECT g_ech_actin. ENDIF. r_actin_class = g_ech_actin. ENDMETHOD. scn.sap.cm 2012 SAP AG 4

5 SAP Applicatin Interface Framewrk with Errr and Cnflict Handler Furthermre, yu have t maintain sme ECH specific custmizing. Therefre, g t transactin SPRO and perfrm fllwing steps: Create an ECH business prcess and assign the actin class as well as the ntificatin class. T d s g t Crss Applicatin CmpnentsPrcesses and Tls fr Business ApplicatinsEnterprise ServicesErrr and Cnflict HandlerDefine Business Prcess. Yu have t maintain fllwing values: Cmpnent Business Prcess Actin Class (Nte: the actin class has t implement interface IF_ECH_ACTION) Ntificatin: CL_FEH_REGISTRATION Business Prcess Descriptin Create a business prcess fr the Pstprcessing Office. G t Crss Applicatin CmpnentsPrcesses and Tls fr Business ApplicatinsEnterprise ServicesErrr and Cnflict HandlerPstprcessing OfficeBusiness PrcessDefine Business Prcesses. Maintain fllwing fields: Sftware Cmpnent Prcess Prcess Descriptin Map the ECH Business Prcess t the PPO Business Prcess. G t Crss Applicatin CmpnentsPrcesses and Tls fr Business ApplicatinsEnterprise ServicesErrr and Cnflict HandlerDefine Business Prcess fr Pstprcessing Office. Maintain fllwing fields: Cmpnent Business Prcess (ECH) Sftware Cmpnent (PPO) PPO Prcess Assign the prxy class fr yur service peratin t the ECH prcess. G t Crss Applicatin CmpnentsPrcesses and Tls fr Business ApplicatinsEnterprise ServicesErrr and Cnflict HandlerAssign Caller t a Business Prcess. Maintain fllwing fields: API Name API Cmpnent Call Type Cmpnent Business Prcess In rder t be able t display messages f this service interface in Mnitring and Errr Handling, yu need t d sme SAP Applicatin Interface Framewrk specific custmizing. This can be dne in transactin /AIF/CUST. Create a new interface in Custmizing activity Define Interfaces. Select a namespace and maintain an interface name and an interface versin. Enter the name f yur prxy class int Prxy Class Inbund. The Raw Data Structure and Recrd Type in Raw Structure shuld be filled autmatically. Furthermre, enter the recrd type s type as SAP Data Structure. Furthermre, yu have t define which data messages shuld belng t yur interface in the SAP Applicatin Interface Framewrk. Therefre, g t Custmizing activity Additinal Interface PrpertiesAssign ECH Cmpnent. Select yur interface and enter the Sftware Cmpnent and the ECH Prcess. T enable the Mnitring and Errr Handling t select the messages prcessed with ECH, it is necessary t define the crrespnding interface engines. Yu can d this in Custmizing activity Specify Interface Engines. Select yur interface and maintain fllwing engines: Applicatin Engine: ECH scn.sap.cm 2012 SAP AG 5

6 SAP Applicatin Interface Framewrk with Errr and Cnflict Handler Persistence Engine: ECH Selectin Engine: ECH Lgging Engine: ECH If yu want t be able t edit messages in Mnitring and Errr Handling yu have t define thse fields as changeable. Yu can d this in custmizing activity Define Namespace-Specific Features (see ckbk) and Define Interface-Specific Features (see ckbk). After sending sme messages t yur new interface yu shuld be able t see them in Mnitring and Errr Handling (transactin /AIF/ERR). In rder t be able t reslve errrs sme further cding is required fr an ECH interface. Yu can implement fllwing methds f yur actin class: Retry: this methd needs t be implemented t trigger the reprcessing f a message. The message will be called if yu click Restart in Mnitring and Errr Handling r if yu select Repeat in Errr and Cnflict Handler Fail: This methd can be used if the errr cannt be reslved. After the methd is executed the message cannt be reprcessed anymre. Yu shuld at least call methd CL_FEH_REGISTRATION=>S_FAIL. This methd will be called if yu select Cancel in Mnitring and Errr Handling r if yu select Discard in Errr and Cnflict Handler Finish: Within this methd yu can fr example trigger the sending f an , t infrm a user that the prcessing steps have t be perfrmed manually. In any case methd CL_FEH_REGISTRATION=>S_FINISH shuld be called at the end. The methd will be called if yu select Cnfirm in Errr and Cnflict Handler. Nte: Since this dcument fcuses n the SAP Applicatin Interface Framewrk the implementatin f an actin class is shwn fr reasns f cmpleteness. If yu need mre infrmatin n hw the actin class fr the ECH can be implemented refer t the Applicatin Help fr the Errr and Cnflict Handler. In the fllwing nly simple examples are given. Example Implementatin f Retry Methd METHOD if_ech_actin~retry. DATA: lr_feh_registratin TYPE REF TO cl_feh_registratin, ls_api_data TYPE zaif_test_zgtp_test_raw_mt, lr_pre_input TYPE REF TO data, lr_pst_input TYPE REF TO data, ls_main_bject TYPE ech_str_bject, ls_custmer_data TYPE bapiscunew, lt_return TYPE bapirettab, ls_return TYPE bapiret2. FIELD-SYMBOLS: <ls_raw_data> TYPE any, <ls_rec_type> TYPE any, <ls_add_data> TYPE zaif_test_zgtp_test_raw_add_da, <lt_add_data> TYPE zaif_test_zgtp_test_raw_ad_tab. *create FEH instance fr retry lr_feh_registratin = cl_feh_registratin=>s_retry( i_errr_bject_id = i_err r_bject_id ). CREATE DATA lr_pre_input TYPE zaif_test_zgtp_test_raw_mt. CREATE DATA lr_pst_input TYPE zaif_test_zgtp_test_raw_mt. *retrieve data stred in FEH lr_feh_registratin->retrieve_data( EXPORTING i_data = i_data IMPORTING e_pre_mapping_data_ref = lr_pre_input e_pst_mapping_data_ref = lr_pst_input scn.sap.cm 2012 SAP AG 6

7 SAP Applicatin Interface Framewrk with Errr and Cnflict Handler ). ASSIGN lr_pst_input->* TO <ls_raw_data>. IF <ls_raw_data> IS INITIAL. ASSIGN lr_pre_input->* TO <ls_raw_data>. ENDIF. ASSIGN COMPONENT 'ZGTP_TEST_RAW_MT' OF STRUCTURE <ls_raw_data> TO <ls_rec_type >. ASSIGN COMPONENT 'RAW_ADD_DATA_T' OF STRUCTURE <ls_rec_type> TO <lt_add_data>. *try t re-prcess the data LOOP AT <lt_add_data> ASSIGNING <ls_add_data>. ls_custmer_data-custname = <ls_add_data>-add_data_key. ls_custmer_data-street = <ls_add_data>-add_data1. ls_custmer_data-pstcde = <ls_add_data>-add_data2. ls_custmer_data-city = <ls_add_data>-add_data3. ls_custmer_data-cuntr = <ls_add_data>-add_data4. ls_custmer_data-custtype = <ls_add_data>-add_data5. ls_custmer_data- = <ls_add_data>-add_data6. CALL FUNCTION 'BAPI_FLCUST_CREATEFROMDATA' EXPORTING custmer_data = ls_custmer_data TABLES return = lt_return. ENDLOOP. *check if an errr ccured during when creating the custmer READ TABLE lt_return INTO ls_return WITH KEY type = 'E'. IF sy-subrc = 0. e_return_message = ls_return. ls_main_bject-bjcat = '1'. ls_main_bject-bjtype = 'SCUSTOM'. ls_main_bject-bjkey = ls_custmer_data-custname. TRY. lr_feh_registratin->cllect( i_external_guid = i_errr_bject_id i_single_b = <ls_raw_data>"ls_api_data i_errr_categry = 'PRE' i_main_message = ls_return i_messages = lt_return i_main_bject = ls_main_bject i_pre_mapping = 'X' ). CATCH cx_ai_system_fault. ENDTRY. ENDIF. *update FEH lr_feh_registratin->reslve_retry( ). ENDMETHOD. scn.sap.cm 2012 SAP AG 7

8 SAP Applicatin Interface Framewrk with Errr and Cnflict Handler Example Implementatin f Fail methd METHOD if_ech_actin~fail. cl_feh_registratin=>s_fail( EXPORTING i_data = i_data IMPORTING e_executin_failed = e_executin_failed e_return_message = e_return_message ). ENDMETHOD. Example Implementatin f Finish methd METHOD if_ech_actin~finish. cl_feh_registratin=>s_finish( EXPORTING i_data = i_data IMPORTING e_executin_failed = e_executin_failed e_return_message = e_return_message ). ENDMETHOD. Display Messages Prcessed with SAP Applicatin Interface Framewrk in ECH A secnd scenari fr the integratin f ECH and SAP Applicatin Interface Framewrk exists. In this scenari the data will be prcessed with the SAP Applicatin Interface Framewrk. Generate a prxy frm yur service interface and implement the prxy methd. Within the prxy methd yu shuld call methd /AIFX/CL_AIF_ACTION_CLASS=>EXECUTE_AIF_AND_ECH. Fr example the methd s implementatin culd lk as fllws: METHOD zaif_x102_ii_ech_aif_in02~test_inbund01. DATA: lr_rt TYPE REF TO cx_rt, lr_previus TYPE REF TO zaif_test_cx_zgt_fault. SET UPDATE TASK LOCAL. TRY. /aifx/cl_aif_actin_class=>execute_aif_and_ech( i_input = input ). CATCH cx_rt INTO lr_rt. lr_previus?= lr_rt->previus. RAISE EXCEPTION TYPE zaif_test_cx_zgt_fault EXPORTING standard = lr_previus->standard. ENDTRY. ENDMETHOD. Afterwards yu have t define yur interface in the SAP Applicatin Interface Framewrk. In custmizing fr the SAP Applicatin Interface Framewrk g t Interface DevelpmentDefine Interfaces. Select a namespace and enter an interface name and versin. Furthermre, yu shuld maintain the SAP data structure and a prxy class. After entering the prxy class the raw data structure and recrd type shuld be filled autmatically. T map the surce structure t the destinatin structure, g t custmizing activity Define Structure Mappings. Furthermre, yu shuld assign an actin in this custmizing activity. Optinally, yu assign checks, value mappings and s n t the interface. Fr mre infrmatin n interface implementatin with the SAP Applicatin Interface Framewrk refer t the ckbk. scn.sap.cm 2012 SAP AG 8

9 SAP Applicatin Interface Framewrk with Errr and Cnflict Handler Nte: If yu use the SIW cnfiguratin /AIFX/DEFAULT_WO_ESR, yu can set the ECH indicatr in the Prject Cntext Data. If the ECH indicatr is set the prxy class implementatin will be created accrdingly. Furthermre, yu have t maintain sme ECH specific custmizing. Therefre, g t transactin SPRO and perfrm fllwing steps: Create an ECH business prcess and assign the actin class as well as the ntificatin class. T d s g t Crss Applicatin CmpnentsPrcesses and Tls fr Business ApplicatinsEnterprise ServicesErrr and Cnflict HandlerDefine Business Prcess. Yu have t maintain fllwing values: Cmpnent Business Prcess Actin Class: fr this scenari actin class /AIFX/CL_AIF_ACTION_CLASS is delivered with the SAP Applicatin Interface Framewrk. Ntificatin: CL_FEH_REGISTRATION Business Prcess Descriptin Create a business prcess fr the Pstprcessing Office. G t Crss Applicatin CmpnentsPrcesses and Tls fr Business ApplicatinsEnterprise ServicesErrr and Cnflict HandlerPstprcessing OfficeBusiness PrcessDefine Business Prcesses. Maintain fllwing fields: Sftware Cmpnent Prcess Prcess Descriptin Map the ECH Business Prcess t the PPO Business Prcess. G t Crss Applicatin CmpnentsPrcesses and Tls fr Business ApplicatinsEnterprise ServicesErrr and Cnflict HandlerDefine Business Prcess fr Pstprcessing Office. Maintain fllwing fields: Cmpnent Business Prcess (ECH) Sftware Cmpnent (PPO) PPO Prcess Assign the prxy class fr yur service peratin t the ECH prcess. G t Crss Applicatin CmpnentsPrcesses and Tls fr Business ApplicatinsEnterprise ServicesErrr and Cnflict HandlerAssign Caller t a Business Prcess. Maintain fllwing fields: API Name API Cmpnent Call Type Cmpnent Business Prcess T enable the Mnitring and Errr Handling t select the messages prcessed with AIF, it is necessary t define the crrespnding interface engines. Yu can d this in Custmizing activity Specify Interface Engines. Select yur interface and maintain fllwing engines: Applicatin Engine: ECH Persistence Engine: ECH Selectin Engine: AIF Index tables Lgging Engine: ECH r AIF Applicatin Lg If yu nw sent messages t yur interface yu shuld be able t see the messages in Mnitring and Errr Handling. In case an errr ccurred when the message was prcessed the status shuld be Transferred t External Applicatin. When yu select a data message the data structure and the lg messages shuld be displayed. Furthermre, if yu select a cmpnent in Data Structure view, the cntent f the structure will be displayed in Data Cntent view. Yu can use the Errr and Cnflict Handler fr editing, restarting and canceling messages. scn.sap.cm 2012 SAP AG 9

10 SAP Applicatin Interface Framewrk with Errr and Cnflict Handler Nte: In this scenari editing, restarting and canceling messages in Mnitring and Errr Handling is nly pssible after ntes and are implemented. Start the Errr and Cnflict Handler using transactin ECH_MONI_SEL. Enter selectin criteria in rder t be able t see the messages prcessed with yur interface. Fr example, enter Technical Creatin Date, select Order Assignment: All Orders. A list that fits the selectin criteria is displayed. After selecting a message, the Pstprcessing Desktp will be displayed. In rder t be able t edit a message in ECH yu need t be assigned as prcessr. Select Prcess t be assigned as prcessr. T edit a message select Message Data in Order Details and duble click Change. The paylad editr shuld start in change mde. Change the cntent f the fields that require changing and select As New Versin in the applicatin tlbar. When yu return t the pst prcessing ffice yu can restart the message by clicking Repeat in the applicatin tlbar. Fr mre infrmatin abut errr handling with Errr and Cnflict handler, refer t the applicatin help f Errr and Cnflict Handler. scn.sap.cm 2012 SAP AG 10

11 SAP Applicatin Interface Framewrk with Errr and Cnflict Handler Related Cntent Ckbk fr the SAP Applicatin Interface Framewrk SAP Applicatin Interface Framewrk and ECH Applicatin Help fr ECH scn.sap.cm 2012 SAP AG 11

12 SAP Applicatin Interface Framewrk with Errr and Cnflict Handler Cpyright Cpyright 2012 SAP AG. All rights reserved. N part f this publicatin may be reprduced r transmitted in any frm r fr any purpse withut the express permissin f SAP AG. The infrmatin cntained herein may be changed withut prir ntice. Sme sftware prducts marketed by SAP AG and its distributrs cntain prprietary sftware cmpnents f ther sftware vendrs. Micrsft, Windws, Excel, Outlk, and PwerPint are registered trademarks f Micrsft Crpratin. IBM, DB2, DB2 Universal Database, System i, System i5, System p, System p5, System x, System z, System z10, System z9, z10, z9, iseries, pseries, xseries, zseries, eserver, z/vm, z/os, i5/os, S/390, OS/390, OS/400, AS/400, S/390 Parallel Enterprise Server, PwerVM, Pwer Architecture, POWER6+, POWER6, POWER5+, POWER5, POWER, OpenPwer, PwerPC, BatchPipes, BladeCenter, System Strage, GPFS, HACMP, RETAIN, DB2 Cnnect, RACF, Redbks, OS/2, Parallel Sysplex, MVS/ESA, AIX, Intelligent Miner, WebSphere, Netfinity, Tivli and Infrmix are trademarks r registered trademarks f IBM Crpratin. Linux is the registered trademark f Linus Trvalds in the U.S. and ther cuntries. Adbe, the Adbe lg, Acrbat, PstScript, and Reader are either trademarks r registered trademarks f Adbe Systems Incrprated in the United States and/r ther cuntries. Oracle is a registered trademark f Oracle Crpratin. UNIX, X/Open, OSF/1, and Mtif are registered trademarks f the Open Grup. Citrix, ICA, Prgram Neighbrhd, MetaFrame, WinFrame, VideFrame, and MultiWin are trademarks r registered trademarks f Citrix Systems, Inc. HTML, XML, XHTML and W3C are trademarks r registered trademarks f W3C, Wrld Wide Web Cnsrtium, Massachusetts Institute f Technlgy. Java is a registered trademark f Oracle Crpratin. JavaScript is a registered trademark f Oracle Crpratin, used under license fr technlgy invented and implemented by Netscape. SAP, R/3, SAP NetWeaver, Duet, PartnerEdge, ByDesign, SAP Business ByDesign, and ther SAP prducts and services mentined herein as well as their respective lgs are trademarks r registered trademarks f SAP AG in Germany and ther cuntries. Business Objects and the Business Objects lg, BusinessObjects, Crystal Reprts, Crystal Decisins, Web Intelligence, Xcelsius, and ther Business Objects prducts and services mentined herein as well as their respective lgs are trademarks r registered trademarks f Business Objects S.A. in the United States and in ther cuntries. Business Objects is an SAP cmpany. All ther prduct and service names mentined are the trademarks f their respective cmpanies. Data cntained in this dcument serves infrmatinal purpses nly. Natinal prduct specificatins may vary. These materials are subject t change withut ntice. These materials are prvided by SAP AG and its affiliated cmpanies ("SAP Grup") fr infrmatinal purpses nly, withut representatin r warranty f any kind, and SAP Grup shall nt be liable fr errrs r missins with respect t the materials. The nly warranties fr SAP Grup prducts and services are thse that are set frth in the express warranty statements accmpanying such prducts and services, if any. Nthing herein shuld be cnstrued as cnstituting an additinal warranty. scn.sap.cm 2012 SAP AG 12