Show TOC

Process documentationInterface Creation

 

In the SAP Application Interface Framework, interface developers create and customize interfaces and assign recipients to them to enable business users to monitor the interfaces they are responsible for.

Prerequisites

Before an interface can be developed using the SAP Application Interface Framework, some steps have to be performed. However, the actual steps to be performed depend on the interface technology you want to use.

Example Example

  • For proxy interfaces, it is necessary that the proxy class and the related proxy structure are generated.

  • For IDocs, some ALE settings have to be made, for example, create message type and maintain process code.

End of the example.

Depending on the interface technology and scenario, the following steps have to be executed before the interface can be customized for the SAP Application Interface Framework:

  • Implement the call of the SAP Application Interface Framework

  • Find or create BAPI(s) and function module(s)

    Usually, the business logic in the back end is executed by methods (for example, of business objects), BAPIs, or function modules that can be predefined by SAP or implemented specifically for your company. In order to call these objects in an action of the SAP Application Interface Framework, you have to build your SAP data structure to accommodate the required data and their expected format.

  • Create SAP data structure

    You need to create an SAP data structure to exchange values during the processing of the function modules. The structure can consist of a hierarchy of substructures and tables. For an outbound interface, the SAP data structure constitutes the source structure. Its components are usually defined by the format of the data stored in the system. For an inbound interface, the SAP data structure constitutes the destination structure. Its components are usually defined by the class methods or function modules you want to execute in the system.

Process

Note Note

Depending on your scenario and interface technology, the steps described below might vary.

End of the note.

  1. You define a namespace in Customizing for SAP Application Interface Framework (transaction code /AIF/CUST) under Start of the navigation path Interface Development Next navigation step Define Namespace End of the navigation path.

  2. You define an interface in Customizing for SAP Application Interface Framework under Start of the navigation path Interface Development Next navigation step Define Interfaces End of the navigation path.

    You have to define an interface name, a version, the name of the inbound or outbound proxy class, the raw data structure, and the SAP data structure.

    Note Note

    If your interface is a proxy interface, when you define the name of the inbound or outbound proxy class and choose Enter, the raw data structure and record type (which are derived from the proxy class) are filled automatically in the raw data structure.

    End of the note.

  3. Depending on the interface technology and scenario, you have to maintain the engines used to handle messages of the interface. You maintain engines in Customizing for SAP Application Interface Framework under Start of the navigation path Interface Development Next navigation step Additional Interface Properties Next navigation step Specify Interface Engines End of the navigation path.

  4. You can define your interface building blocks in Customizing for SAP Application Interface Framework (transaction code/AIF/CUST) under Interface Development as follows:

    • Create structure mappings

      In structure mapping, you map the fields of the source structure to the fields of the destination structure. You also assign value mappings, fix values, checks, and actions. You do this under Define Structure Mapping.

      Note Note

      You can define the following objects in the list either by forward navigation from Define Structure Mapping or you can access Customizing activities to create them individually. If you want to use forward navigation from Define Structure Mapping, enter the namespace and the name of the object you want to create and choose Enter. If the object does not exist, you can choose to create it. If you want to access Customizing activities to create the objects individually, it is recommended that you create the objects (value mappings, fix values, checks, actions) before you create the structure mapping.

      End of the note.

    • If necessary, define the following:

      • Value mappings

        Value mappings are used to derive one value in the destination structure from up to five values in the source structure that can be optionally enriched with further data from the back end system. You do this under Define Value Mappings.

      • Fix values

        You can use fix values if you want a certain field in the destination structure to always have the same value. You can either enter a fix value directly into the structure mapping or you can create a named fix value, which can be assigned to a field in the structure mapping. You define fix values under Define Fix Values.

        Recommendation Recommendation

        It is recommended to use a named fix value so that you can reuse it in different structure mappings.

        End of the recommendation.

      • Checks

        You can use checks to verify if the content of the specified field or fields match a certain condition. Checks can be used in several places in the SAP Application Interface Framework, for example you can assign them in structure mapping or you can assign them to a function in an action. You define checks under Define Checks.

      • Actions

        Actions contain the business logic of your interface. You can assign multiple action function modules. Within these function modules, you can call BAPIs, SAP standard function modules, or customer function modules that process the data of the SAP data structure. You define actions under Define Actions.

  5. Depending on your scenario, you have to set up interface determination to configure which interface in the SAP Application Interface Framework should be used to process a message. You do this in Customizing for SAP Application Interface Framework under Interface Determination (see Interface Determination).

    Example Example

    Scenario: You have multiple interfaces in the SAP Application Interface Framework for the same ABAP Proxy.

    Scenario: You use the generic process function delivered with SAP Application Interface Framework to process an IDoc in the SAP Application Interface Framework.

    End of the example.

  6. You define a recipient, which is needed for alert configuration, and you can subsequently assign users to it. You define the recipient in Customizing for SAP Application Interface Framework under Start of the navigation path Error Handling Next navigation step Namespace-Specific Features End of the navigation path. Enter the namespace you want to create the recipient for and choose Define Recipients. Define a name and a description for your recipient.

    Note Note

    You can reuse existing recipients.

    End of the note.

  7. You assign users to your recipient in Customizing for SAP Application Interface Framework under Start of the navigation path System Configuration Next navigation step Assign Recipients End of the navigation path. Enter the namespace and the name of your recipient.

    You can assign users, roles, or external addresses as follows:

    • Assign users/roles

      Select the message type that is to be included in an alert message. If you set the Include in overview screen indicator, the users or roles that are assigned to the recipient see the messages in the Interface Monitor of the SAP Application Interface Framework. If you set the Technical User indicator, this identifies technical users or roles who can also see messages that have the status In Process or Technical Error in the Interface Monitor.

    • Assign external addresses

      This enables you to define external addresses (for example, e-mail and fax) that are notified if messages with the specified type occur.

    Note Note

    While assigning users to recipients provides you with a recipient-specific view, a user-centric view exists as well. You can use transaction /AIF/RECIPIENTS to display and maintain the recipients a specific user belongs to. Alternatively, you can use transaction /AIF/MYRECIPIENTS to see the recipients your user is assigned to.

    End of the note.

More Information

For more information about the maintenance of users and recipients, see Maintenance of Users and Recipients.

For more information about creating interfaces, see the SAP Application Interface Framework Cookbook on SAP Help Portal at Start of the navigation path http://help.sap.com/Information published on SAP site Next navigation step SAP Business Suite Next navigation step SAP ERP Add-Ons Next navigation step SAP Application Interface Framework 2.0 Next navigation step Additional Information End of the navigation path.