Show TOC

Creating a Service InterfaceLocate this document in the navigation structure

Prerequisites

Familiarize yourself with the basics of service interface.

More information: Service Interface

Context

You create a service interface depending on the following use cases:

  • Inbound (Provider Role): You want to implement a service in an application system that can be called by a user.

  • Outbound (Consumer Role): You want to call a service of a provider. To do so, you require the outbound service interface that matches your inbound service interface.

  • Abstract : In enhanced communication using the Integration Server, you want to exchange messages with a buffered integration process .

    More information: Process Signature

Procedure

  1. Create a service interface.

    More information: Creating an Object .

    Note

    Together with the service interface, the service interface editor creates an operation with the same name as the service interface. You can change the name of the operation until you save the service interface for the first time. To change the name after this point, you must delete the operation and create it again.

  2. Define the category and interface pattern of the service interface.
  3. Define the security profile of the service interface.
  4. To define a business event that can be consumed by other applications as Web services, select the Event Interface check box.
    Note

    An event is an outbound service interface with multiple asynchronous operations. When you mark a service interface as event, the event classification is assigned to it.

  5. If you want to enable the encryption at run time for a service interface, then select the check box for Sensitive Data
    Note

    You can use this feature if you run scenarios that involve the exchange of sensitive data and you want to prevent malicious users from accessing this data. For more information, see Start of the navigation path help.sap.com Next navigation step SAP NetWeaver Process Integration Next navigation step Special Developement Tasks Next navigation step Encrypting Message Content on Database Level End of the navigation path

  6. Depending on the interface pattern, you require one or more operations. Use the operation list to create new operations. You can continue to change the name of the operation until you save the service interface for the first time.
  7. Define the operation pattern and mode for each operation. Depending on the interface pattern, the service interface editor provides you with different operation patterns and modes to select from (see above).

    For inbound category, synchronous mode, and any interface pattern other than TU&C/C, an option called Idempotent is available.

  8. Using the input help, assign each operation a message schema for the request message and, if applicable, response and fault messages. The corresponding interface objects must be in the same software component version as the service interface, or in an underlying software component version .
  9. In enhanced communication, you can simply access the message payload by using context objects for logical routing. In the service interface editor, you can assign a request message context object from the same software component version or from an underlying software component version.

    More information: Context Objects

  10. You can classify service interfaces based on application name, industry, deployment unit, and so on.

    More information: Classifying Services in the Enterprise Services Repository

  11. Save your changes.

Results

You have created a service interface and can generate development objects for it in the application system by using proxy generation .