Show TOC

Procedure documentationCreating a Service Interface Locate this document in the navigation structure

 

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

  • Inbound (Provider Role): You want to implement a service in an application system, which 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.

Prerequisites

Familiarize yourself with the basics of service interface.

More information: Service Interface

Procedure

  1. Create a service interface.

    More information: Creating an Object

    Note 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 up 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.

    End of the note.

  2. Define the category and interface pattern of the service interface.

  3. Define the security profile of the service interface (see above).

  4. 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.

  5. 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.

  6. 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.

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

    More information: Classifying Services in the Enterprise Services Repository

  8. Save your changes.

Result

You have created a service interface and can generate development objects for it in the application system by generating proxies.

More information: Proxy Generation