Show TOC

Component documentationIntegration Directory Programming Interface Locate this document in the navigation structure

 

In addition to the Integration Builder you will also find a programming interface (Application Programming Interface (AP)) with which you can access, edit, and activate objects in the Integration Directory.

The programming interface is based on the fundamental configuration options that are possible in the Integration Directory.

The Integration Directory programming interface is particularly useful in the following types of scenarios:

More information: Application Cases

Note Note

This section of the documentation contains a description of the Integration Directory programming interface, as well as a description of procedures for using the programming interface.

End of the note.

Implementation Considerations

You can use this version of the programming interface if you have installed SAP NetWeaver PI 7.1 EhP1.

Note Note

For compatibility reasons, the earlier version of the programming interface that was delivered with previous Support Packages of SAP NetWeaver PI 7.1 is still available.

Their use is, however, restricted.

For some the following restrictions apply when using the previous interface version:

You cannot edit any configuration object type that only exists since SAP NetWeaver PI 7.1 (for example, direct connections).

You cannot read any change lists that contains such configuration object types.

You cannot edit any configuration object types that were functionally enhanced in SAP NetWeaver PI 7.1 and use related properties.

Ideally, you use the older version of the programming interface when you have already worked with the programming interface before installing SAP NetWeaver PI 7.1 and now want to proceed with this configuration work.

More information: Integration Directory Programming Interface (Previous Version)

End of the note.

Features

The programming interface consists of Web Services with which you can perform operations on configuration objects (for example, creating configuration objects or editing the attributes of configuration objects). The Web Services are fully implemented at the server and can be called by a valid client application.

Example Example

Examples of Web Service clients are Java proxies that have been generated using the SAP NetWeaver Developer Studio, or also external programs.

End of the example.

In this documentation you find a description of the programming interface,

Differences from the Integration Builder

Using the programming interface you can carry out almost all those actions which you can also carry out using the user interface (Integration Builder).

Note the following differences in comparison to working with the Integration Builder:

  • The programming interface is mass-enabled, which means for example that you can create several objects of the same type at the same time.

  • Using the programming interface you can only edit your own change lists. You cannot take on and edit the change lists of other users.

  • There are no default change lists, which means that you must always specify a change list. Otherwise a new change list will be created.

  • If you would like to change only a few attributes in an object using the programming interface then you need to update all the attributes, not just those that have been changed. If you perform the same action using the Integration Builder, then the unchanged attributes are already set and need not be entered again. This means that the programming interface does not support 'delta handling'.

Constraints

There are the following restrictions when working with the programming interface:

  • You cannot create or change any folders in the Integration Directory.

    Note Note

    However you can assign configuration objects to a specific folder.

    End of the note.

  • Receiver rules are not supported by the programming interface. You cannot create, edit, or read any receiver rules. You also cannot assign receiver rules to a receiver determination.

  • Integrated configurations and process components are not supported by the programming interface.

  • Parameterized integration processes and parameterized mappings are not supported in the receiver or interface determinations.