Show TOC

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

 

You create a service interface in SAP NetWeaver Developer Studio when:

  • You want to implement a service, or

  • You want to call a service of a provider.

Prerequisites

  • You are familiar with the basics of service interface. For more information, see Service Interface.

Procedure

1. Define Basic Data

  1. In the context menu of software component version, namespace, or folder, choose   New   Service Interface  .

  2. Enter a name and namespace for the service interface.

    Note Note

    If you choose to create a service interface from the context menu of namespace or folder, the namespace is populated automatically.

    End of the note.

  3. Choose Finish.

    The Select Change List window appears.

  4. Select an existing change list or choose New to create a new change list for the service interface.

  5. Choose OK.

    The Service Interface Overview tab page appears.

  6. In the Lifecycle section, select a Release State for the service interface.

  7. In the Advanced section, select a Category, Interface Pattern, and Security Profile for the service interface.

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

    Note 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   help.sap.com   SAP NetWeaver Process Integration   Special Developement Tasks   Encrypting Message Content on Database Level  

    End of the note.
2. Assign Values to Service Interface Attributes

  1. In the Custom Attributes section, choose Edit.

    The Edit Attributes window is displayed.

    Note Note

    You can assign values only if at least one attribute definition is assigned to a service interface.

    End of the note.

  2. Assign values for the each attribute and choose Save.

3. Assign Classifications to Service Interface

  1. In the Classification section, choose Add.

    The Assign Classifications window is displayed.

  2. Select a classification system from the Classification dropdown list.

    Based on the classification system selected, different set of classification values are displayed in the Values table.

  3. Select the values you want to assign to the service interface from the Values table and choose Assign.

    The classification values assigned to the service interface is displayed in the classification system table.

  4. To assign the classification values, choose OK.

    The classification values assigned are displayed in the table in the Classification section.

4. Assign Internal Documentation to Service Interface

  1. In the Documentation section, choose Edit Documentation.

    Note Note

    This field is available only if you have selected the Use External Documentation check box, while defining the software component version.

    End of the note.

  2. In the Internal Documentation window, switch to:

    • Edit Documentation tab page to enter the documentation content.

    • Preview Documentation tab page to view the entered content.

  3. Choose OK.

  4. If you want to view documentation of the service interface in the Web browser, choose View Documentation.

5. Define Operations

  1. To define operations and assign input, output, or fault messages to it, switch to the Definition tab page.

  2. Select the operation node and choose Add Operation.

    A new operation with associated input, output, and fault message is displayed.

    Note Note

    When you create a service interface, an operation, with associated input, output, and fault message is available. Input and output messages are displayed depending on the mode of operation chosen.

    End of the note.

  3. In the Details section, enter the Type, Release State, and Operation Pattern for the selected operation.

  4. To define an input message for the operation, select the input node and choose Add Input Message.

  5. In the Details section, choose Browse to enter the name of the input message.

    The Select Message Type wizard is displayed.

  6. Run the wizard to assign a data type or message type to the input message.

    Note Note

    If you want to create a new message type for a selected data type, choose Create Message Type field in the wizard.

    End of the note.

  7. To define an output message for the operation, select the output node and choose Add Output Message.

  8. In the Details section, choose Browse to enter the name of the output message.

    The Select Message Type wizard is displayed.

  9. Run the wizard to assign a data type or message type to the output message.

  10. To define a fault message for the operation, select the Faults node and choose Add Fault Message.

  11. In the Details section, choose Browse to select a fault message.

    The Select Fault Message Type wizard is displayed.

  12. Run the wizard to assign a fault message type to the input message.

    Note Note

    If you want to create a new fault message type for a selected data type, choose Create Fault Message Type in the wizard.

    End of the note.

  13. If you want to create more operations, repeat steps 5.2 to 5.12.

  14. Save the object and activate your changes.

    For more information on how to activate your changes, see Working with Change List in SAP NetWeaver Developer Studio.