Verena Wörner is a developer for SAP Custom Development. She is a member of the development team for the SAP Application Interface Framework.

Transcription

1 Template Function Modules of the SAP Application Interface Framework Applies to: SAP Application Interface Framework Summary In customizing of the SAP Application Interface Framework several places exist where function modules can be maintained. Those function modules need to have the correct parameters. Therefore, template function modules are delivered with the SAP Application Interface Framework. This document provides you with information about those template function modules. Author: Verena Wörner Company: SAP AG Created on: 03 December 2012 Author Bio Verena Wörner is a developer for SAP Custom Development. She is a member of the development team for the SAP Application Interface Framework SAP AG 1

2 Table of Contents Introduction... 3 Function Modules in Define Interfaces... 3 /AIF/FILE_TEMPL_CHECK_MAPPING... 3 /AIF/FILE_TEMPL_INIT_MAPPING... 4 /AIF/FILE_TEMPL_INIT_PROCESS... 4 Value Mappings... 5 /AIF/FILE_TEMPL_VALMAPPING... 5 Checks 5 /AIF/FILE_TEMPL_CHECK... 5 Define Structure Mapping... 7 /AIF/FILE_TEMPL_MAP... 7 Define Actions... 8 /AIF/FILE_TEMPL_INIT_ACTION... 8 /AIF/FILE_TEMPL_PROCESS... 8 Related Content Copyright SAP AG 2

3 Introduction In the SAP Application Interface Framework, several places exist where function modules can be used. These function modules are usually called dynamically by the SAP Application Interface Framework and consequently need to implement a specific, predefined signature. To support the interface developer in creating the function modules, template function modules are delivered with the SAP Application Interface Framework. The template function modules can be found in function group /AIF/AIF_TEMPLATES. The interface developer can copy the templates to a new function module and implement it. Alternatively you have the possibility to directly create your function module from the corresponding input field in customizing. You have to enter the name of the function module you would like to create. If the function module does not exist the system will ask you if you want to create it. The template function module will be copied to your new function module and you can implement it. Note that the templates have some parameters, where no type is specified, for example, for the raw or SAP data structure. You might want to change the types according to your needs, for example, to benefit from code inspector checks. In this document, an overview of existing templates is given. The document explains where the templates are used and gives details about the function module s parameters. Function Modules in Define Interfaces /AIF/FILE_TEMPL_CHECK_MAPPING Importing RAW_STRUCT Contains the data of the source structure RETURN_TAB_MAPPING Contains the messages that occurred during mapping. In the function module, you can evaluate the errors that occurred during mapping. maintained in System Field in the interface definition. If the function module should behave differently for different senders, you can use this parameter to differentiate the behavior. Tables RETURN_TAB Insert messages, for example, if an error occurred, into this table (for example, with helper function /AIF/UTIL_ADD_MSG). The messages are written to the application log. Changing OUT_STRUCT Contains the data of the destination structure. With this function module, you can change the mapped data. Using importing parameter RETURN_TAB_MAPPING, you may be able to correct errors that occurred during mapping. The function module needs to be maintained in Check Function Module. The function module is executed after the mapping and before the execution of the actions. You can use the function module to facilitate a certain behavior depending on the result of the mapping. For example, you could correct mapping errors in the function module SAP AG 3

4 /AIF/FILE_TEMPL_INIT_MAPPING Importing CONTEXT Defines in which context the function module is called (for example, CONTEXT = TRANSFORM) FINF Contains the data of the interface definition of the current interface you are using (for example, raw data structure, sap data structure, and proxy class). module should behave differently for different senders, you can use this parameter to differentiate the behavior. example, with helper function /AIF/UTIL_ADD_MSG). The messages are written to the application log. Changing DATA Contains the destination structure. The destination structure should be empty since the function module is executed before the mapping. However, you may enrich the structure with data in the function module. RAW_STRUCT Contains the data of the source structure. You can change the data in the function module. Exceptions CANCEL Exception that can be raised by the function module in case of errors. However, it is recommended to add errors to return tab RETURN_TAB. The function module is executed before mapping in the SAP Application Interface Framework. You can use the function module to manipulate data in the source or destination structure before the mapping is started. The template has to be used in Init Function Before Mapping in Customizing activity Define Interfaces. /AIF/FILE_TEMPL_INIT_PROCESS Importing CONTEXT Defines in which context the function module is called (for example, CONTEXT = PROCESS) FINF Contains the data of the interface definition of the current interface you are using (for example, raw data structure, SAP data structure, and proxy class). module should behave differently for different senders, you can use this parameter to differentiate the behavior. example, with helper function /AIF/UTIL_ADD_MSG). The messages are written to the application log. Changing DATA Contains the data of the destination structure after mapping. You may change the data in this function module. Exceptions CANCEL Exception that can be raised by the function module in case of errors. However, it is recommended to add errors to return tab RETURN_TAB. The function module needs to be maintained in Init Function Before Processing. This function module is called after mappings were executed but before the processing of the action starts. You can use this function module to manipulate the data in the destination structure before the processing of the action(s) starts SAP AG 4

5 Value Mappings /AIF/FILE_TEMPL_VALMAPPING Importing VALUE_IN The fields defined in the field mapping (Fieldname 1 to Fieldname 5) VALUE_IN2 are used as importing parameters. VALUE_IN3 VALUE_IN4 VALUE_IN5 maintained in System Field in the interface definition. You can enter different values, based on the system the data comes from, into parameter VALUE_OUT. example, with helper function /AIF/UTIL_ADD_MSG). The messages are written to the application log. Changing VALUE_OUT Value that the field in the destination structure should have after the mapping function is executed. Exceptions NO_VALUE_FOUND Exception that can be raised if the correct value could not be mapped. The function module is executed during mapping. There are several places where the template function module is used: Customizing activity Define Value Mappings Customizing activity Define Field Mappings Customizing activity Interface Variants Define Variant Mappings Assign/Define Field Mappings Checks /AIF/FILE_TEMPL_CHECK Importing DATA_STRUCT Contains the data of the current structure. In case the check is executed during structure mapping, the current structure is either the SAP or raw data structure. This is dependent on the Check raw data indicator in the check assignment. In case the check is executed in an action, the structure is the destination structure. If the check is executed for a condition, the current structure is the source structure. DATA_LINE DATA_FIELD MSGTY VALUE1 VALUE2 Contains the current line of the structure that is mapped If the check function is executed in the structure mapping or as condition and at least Fieldname 1 is defined, this field contains the value of the field defined in Fieldname 1. Message type Contain the values of the fields defined when the check is assigned (Fieldname 1 to Fieldname 5). VALUE3 VALUE SAP AG 5

6 VALUE4 T_IFCHECK T_IFACT T_ACCHECK T_FUNC T_FMAPCOND T_CHECK T_TABCHK Contains the Customizing data of the check assignment. This parameter is filled if the check function is executed during structure mapping. Contains the Customizing data of the assigned action for which the check function is executed. This parameter is only filled if the check is assigned to an action in the Customizing activity Define Actions. Contains the Customizing data of the check assigned to the current action. This parameter is only filled if the check is assigned to an action in the Customizing activity Define Actions. Contains the Customizing data of the function, whose execution depends on the result of the check. This parameter is only filled if the check is assigned to an action in the Customizing activity Define Actions. Contains the Customizing data of the Conditional Mapping. This parameter is only filled if the check is assigned to a conditional field mapping. Contains the Customizing data of the assigned check. This field is always filled. Contains the Customizing data of the single check that is currently executed. module should behave differently for different senders, you can use this parameter to differentiate the behavior. example, with helper function /AIF/UTIL_ADD_MSG). The messages are written to the application log. DATA_TABLE Table that contains all data of the current structure that is mapped. You can change this data in your check function. Changing ERROR Indicator for indicating if the check was successful. Needs to be set by a developer. If ERROR = abap_true, the check is treated as unsuccessful. You can use this function module to execute any type of check and return the result to the SAP Application Interface Framework. There are the following places within Customizing where this template is used as follows: Customizing activity Define Structure Mapping Assign Checks Customizing activity Define Structure Mapping Define Conditions Customizing activity Define Actions Customizing activity Interface Variants Define Variant Mapping 2012 SAP AG 6

7 Define Structure Mapping /AIF/FILE_TEMPL_MAP Importing RAW_STRUCT Contains the source structure of the interface. RAW_LINE SMAP INTREC Contains the row of the table/structure of the source structure for which the after mapping function is currently executed. Contains the Customizing data of the current structure mapping. Contains the record type of the current structure module should behave differently for different senders, you can use this parameter to differentiate the behavior. example, with helper function /AIF/UTIL_ADD_MSG). The messages are written to the application log. Changing OUT_STRUCT Contains the destination structure DEST_LINE DEST_TABLE APPEND_INDICATOR Contains the data of the current line in the destination structure. You might change the data of this parameter in this function module. Contains the data of the current structure in a table Indicator for indicating if a line should be added to the destination table. Usually, if an error occurs in a value mapping, the line is not added to the destination structure and the indicator is blank. If you want to add the line anyway, you have to set this indicator. The function module is processed after or before the mapping of the current structure. This template is used in the Customizing activity Define Structure Mapping for function after mapping and function before mapping in Assign Destination Structure SAP AG 7

8 Define Actions /AIF/FILE_TEMPL_INIT_ACTION Importing CONTEXT Defines in which context the function module is called (for example, CONTEXT = TRANSFORM) FINF ACTION Contains the Customizing data of the current interface Contains the name of the current action module should behave differently for different senders, you can use this parameter to differentiate the behavior. example, with helper function /AIF/UTIL_ADD_MSG). The messages are written to the application log. Changing DATA Contains the data of the destination structure after mapping. You can adapt the data in your function module. Exceptions CANCEL Exception that can be raised by the function module in the case of errors. However, it is recommended to add errors to return tab RETURN_TAB. The template can be used in the Customizing activity Define Actions. The function module is executed at the beginning of each action call before the action function modules are called. How often this processing function is executed is finally determined during runtime, based on the content of the message that is mapped and the main component type the action handles. If the component type is a structure, the function is executed only once. In the case of the main component type being a table, the function module is executed for every dataset in the table. /AIF/FILE_TEMPL_PROCESS Importing TESTRUN Indicator for indicating if the action is executed in test mode. You can set this indicator, for example, to prevent database updates if the action is executed in test mode. Furthermore, you can use it to pass it to BAPIs supporting test calls. module should behave differently for different senders, you can use this parameter to differentiate the behavior. Tables RETURN_TAB Insert messages, for example, if an error occurred, into this table, (for example, with helper function /AIF/UTIL_ADD_MSG). The messages are written to the application log. Changing DATA Contains the data of the destination structure after mapping CURR_LINE SUCCESS OLD_MESSAGES Contains the data of the current line. When copying the template you should at least change the type of CURR_LINE to the main component type. Indicator for indicating if the action was executed successfully. Contains messages that might have occurred in past processing of the action 2012 SAP AG 8

9 This template should be used for every function of the Customizing activity Define Actions Define Functions. Note that you should not raise an error. Instead, you should fill return table RETURN_TAB with your messages. If there is a message of type E or A in the return table, the SAP Application Interface Framework implies that the function call was not successful. However, you may overwrite this behavior. You can set the SUCCESS indicator to Y explicitly to indicate success even though the RETURN_TAB contains error messages. You can set the SUCCESS indicator to N explicitly to indicate failure even though RETURN_TAB does not contain error messages SAP AG 9

10 Related Content Cookbook for the SAP Application Interface Framework 2012 SAP AG 10

11 Copyright Copyright 2012 SAP AG. All rights reserved. No part of this publication may be reproduced or transmitted in any form or for any purpose without the express permission of SAP AG. The information contained herein may be changed without prior notice. Some software products marketed by SAP AG and its distributors contain proprietary software components of other software vendors. Microsoft, Windows, Excel, Outlook, and PowerPoint are registered trademarks of Microsoft Corporation. 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, PowerVM, Power Architecture, POWER6+, POWER6, POWER5+, POWER5, POWER, OpenPower, PowerPC, BatchPipes, BladeCenter, System Storage, GPFS, HACMP, RETAIN, DB2 Connect, RACF, Redbooks, OS/2, Parallel Sysplex, MVS/ESA, AIX, Intelligent Miner, WebSphere, Netfinity, Tivoli and Informix are trademarks or registered trademarks of IBM Corporation. Linux is the registered trademark of Linus Torvalds in the U.S. and other countries. Adobe, the Adobe logo, Acrobat, PostScript, and Reader are either trademarks or registered trademarks of Adobe Systems Incorporated in the United States and/or other countries. Oracle is a registered trademark of Oracle Corporation. UNIX, X/Open, OSF/1, and Motif are registered trademarks of the Open Group. Citrix, ICA, Program Neighborhood, MetaFrame, WinFrame, VideoFrame, and MultiWin are trademarks or registered trademarks of Citrix Systems, Inc. HTML, XML, XHTML and W3C are trademarks or registered trademarks of W3C, World Wide Web Consortium, Massachusetts Institute of Technology. Java is a registered trademark of Oracle Corporation. JavaScript is a registered trademark of Oracle Corporation, used under license for technology invented and implemented by Netscape. SAP, R/3, SAP NetWeaver, Duet, PartnerEdge, ByDesign, SAP Business ByDesign, and other SAP products and services mentioned herein as well as their respective logos are trademarks or registered trademarks of SAP AG in Germany and other countries. Business Objects and the Business Objects logo, BusinessObjects, Crystal Reports, Crystal Decisions, Web Intelligence, Xcelsius, and other Business Objects products and services mentioned herein as well as their respective logos are trademarks or registered trademarks of Business Objects S.A. in the United States and in other countries. Business Objects is an SAP company. All other product and service names mentioned are the trademarks of their respective companies. Data contained in this document serves informational purposes only. National product specifications may vary. These materials are subject to change without notice. These materials are provided by SAP AG and its affiliated companies ("SAP Group") for informational purposes only, without representation or warranty of any kind, and SAP Group shall not be liable for errors or omissions with respect to the materials. The only warranties for SAP Group products and services are those that are set forth in the express warranty statements accompanying such products and services, if any. Nothing herein should be construed as constituting an additional warranty SAP AG 11