Introducing the SAP Application Interface Framework Interface Development Process

Objective

After completing this lesson, you will be able to identify and explain the main components and required steps in SAP Application Interface Framework interface development.

Scenario

During this training, we'll create an SAP Application Interface Framework interface step by step. In this process, we'll have a look at different SAP Application Interface Framework objects like structure mappings, value mappings, and checks. The goal of the exercises is to have an SAP Application Interface Framework interface that will create customers and book flights for those newly created customers.

While SAP Application Interface Framework is able to handle messages from different interfaces, we'll use SAP Application Interface Framework’s XML runtime and persistence for our interface. These are the steps in the scenario:

Flow diagram depicting the steps outlined in the below scenario.
  1. Customers book one or more flights over a sales agent.
  2. The sales agent sends the flight bookings and the customer data to the booking system.
  3. In the booking system, different tasks are executed and, finally, the flights are booked.
  4. For each new customer, customer information must be created.
  5. For each flight booking, booking information must be created.
  6. Before the flights can be booked, some checks have to be carried out.
    • We'll have to verify if there's a flight available for the date and for the start and destination airports.
    • No flight is available. An error message is displayed in Monitoring and Error Handling.
  7. After everything has been checked successfully, the flights are booked.

Besides enabling the system to create the customers and book the flights, it's necessary to enable a business user to monitor the interface. The business user needs to be able to display the messages of the interface, solve errors, restart messages, and so on. Therefore, we have to create and assign recipients, alerts, and so on, to the business user monitoring the interface.

Development Process

Welcome to the development process overview in the SAP Application Interface Framework where we explore the essential steps for efficiently creating and processing SAP Application Interface Framework interfaces, distinguishing between mandatory tasks and optional enhancements to streamline operations. Watch this video to learn more:

  1. Create a namespace, or use an existing one: Establish a namespace for organizing interface components effectively.
    • To create a new namespace, go to SAP Application Interface Framework Customizing. The SAP Application Interface Framework Customizing can be found in the SAP menu under Cross-Application ComponentsSAP Application Interface FrameworkSAP Application Interface Framework, AdministrationConfigurationCustomizing.
    • Via transaction /AIF/CUST, you can go directly to Customizing. You can create a new namespace in the activity Define Namespace, which you can find in Customizing under the Interface Development topic. Create a new namespace via the New Entries button. Assign a name to the namespace, and provide a short description.
  2. Create an interface with essential details: Define an interface with key elements such as Interface Name, Version, RAW structure, and SAP structure.
    • A new SAP Application Interface Framework interface can be created in AIF Customizing (/AIF/CUST) via Define Interfaces.
    • To create a new interface, go to the SAP Application Interface Framework Customizing, and start the Define Interfaces activity, which can be found under the Interface Development node. As stated before, interfaces are namespace dependent and, therefore, you have to enter the namespace.
    • An interface requires a name and a version. You can create different versions of an SAP Application Interface Framework interface. Every SAP Application Interface Framework interface also requires a version number. The purpose of the interface should be described in the description field. In addition to the interface name, version, and description, you have to define at least the raw data structure and the SAP data structure for the interface.
  3. Maintain Engines: Ensure proper configuration and maintenance of engines for seamless processing.
  4. Create structure mappings and assign validations: Map source to destination structure, assign value mappings and checks for data validation, and assign actions for processing the message.
  5. Decide on the interface for message processing: Select the appropriate interface when multiple interfaces can process similar data.
  6. Define recipients and set alerts: Specify recipients, assign users or roles, and establish alerts for streamlined communication and monitoring.

How to Create Structures in SAP

Watch this demo to learn how to create a structure for Application Interface Framework. In this step-by-step guide, you will learn how to efficiently create and manage structures within the SAP system.

Log in to track your progress & complete quizzes