Show TOC

Accessing JavaDoc and Source Text of the Example Adapter/ModuleLocate this document in the navigation structure

Use

JavaDoc provides syntactical descriptions of the Adapter Framework API for the example adapter and the example module.

Use the example adapter and the example module as a starting point for your development.

Integration

The JavaDoc for the example adapter and example module is shipped with the Adapter Framework.

For information about shipment, see SAP Note 1004000.

More information: Example Adapter and Example Module

You can find JavaDoc for SAP NetWeaver at help.sap.com/javadocs/

Activities
  • Provide your Java project with a copy of the example source text.

    Compile, deploy, and test a simple scenario.

  • Then extend the source text step-by-step.
  • The documentation refers to the example adapter in many places.

    The adapter source text is not part of the documentation.

    Instead, the documentation refers to the relevant point in the source text of the example adapter.

    Tip

    SPIManagedConnectionFactory.java:CS_TXMGR shows how an adapter can access the Transaction Manager.

    To find the relevant place in the source code, open the file SPIManagedConnectionFactory.java in your preferred development environment.

    Search for CS_TXMGR.

    The code is located between the comment lines // CS_TXMGR START and // CS_TXMGR END.

Source Text for Example Adapter and Module

  • To keep the source text for the example adapter or example module, copy the SAPXIAF<sp>_<pl><-id>.SCA file to a local directory.

    sp stands for the Support Package number, pl for the patch level, id is the build ID.

    You can get the newest version on SAP Service Marketplace at service.sap.com/swdc.

    On the Find your software tab, select Support Packages and Patches - N → SAP NetWeaver → SAP NetWeaver 7.3 → Entry by Component → PI Partner Connectivity Kit → XI ADAPTER FRAMEWORK 7.13 → # OS independent. .

    Alternatively, you can get the newest version on the Process Integration/PCK DVD that is labeled with SAP NetWeaver <vers> PI Java.

    vers is for version.

  • Open the file and extract the following files:
    • com.sap.aii.adapter.sample.ra.rar
    • com.sap.aii.adapter.sample.module.app.sda
  • For source texts of the example adapter, open these files and extract src.zip in .rar.
  • For source text of the example mode, extract the .java file from the .jar file contained in .sda.