Skip to Content
Author's profile photo Daniel Wroblewski

New Reference for Portal APIs

You’ve told us for a long time that one of the more difficult things is to figure out how to find the right JAR files and sharing references for specific APIs. Here is the answer:

An excel that lists every portal API, every class and interface, and how to reference them. For every class and interface, we provide the following:

  • Class and interface name
  • Package name
  • JAR name
  • Location of JAR
  • Sharing reference, if required, for the portalapp.xml

The Excel file — — is provided in XML format inside a ZIP file. 

Remember, these are only the officially public APIs. Though you may have used non-public APIs — since there are no permissions and nothing that stops you from using them — the APIs in the Excel are the only officially public APIs.

NWDI users should use DC references, but since not all portal APIs are exposed via DCs, the list provides JAR references for the APIs.

The Excel also includes a separate sheet for references for portal JSP tag libraries.

Send Us Your Thoughts

Please feel free to point out omissions or inaccuracies in the list, or suggestions for additional information that you would like to see. Add a comment or email me.

We plan to provide a similar list (must sooner 🙂 for the Composition Environment, but supplying SC and DC names for each API.

Assigned Tags

      You must be Logged on to comment or reply to a post.
      Author's profile photo Kenneth Murray
      Kenneth Murray
      Hi, I don't get it!  This is the "Official API Reference Guide"?  An excel spreadsheet?  Does SAP not have the resources to publish something online in a professional format?  Is this available online anywhere else as well.
      Author's profile photo Former Member
      Former Member

      Not sure, but I think that when it comes to that kind of info, it's easier to use an Excel sheet, because it gives you the option of using filtering...You can't do that on a PDF file, right?

      Also, it's a reference guide, not an "Official API Reference guide" -;)



      Author's profile photo Christopher Solomon
      Christopher Solomon
      Geeez, give folks something for FREE and they still gripe! haha Thank you very much for delivering this!

      I am now waiting for the first one who is gonna churn out some nice little widget that reads the XML file in and serves the info up in some nice little "smart" UI! Or the person who creates some web page with an AJAX table that can use  filter functions and update on the fly!

      Throwing down the gauntlet! haha

      Author's profile photo Sandip Agarwalla
      Sandip Agarwalla
      Hi Daniel,
      It will be really helpful for the developers. Great to have this complete reference sheet..

      Hope to see the complete reference guide for KM APIs on SDN soon 🙂

      Best Regards

      Author's profile photo Daniel Wroblewski
      Daniel Wroblewski
      Blog Post Author

      The official documentation for portal APIs is located, as always, at (2004) and 2004s).

      The guides are linked to from the main SDN portal page (at the bottom, in key topics area), from the 1st sticky post in the Portal Content Development forum, and within the portal documentation for 2004 and in the NetWeaver developer guide for 2004s.

      I have tried to add all sharing references and JAR files in any documentation that I write. However, the portal developer guide does not include descriptions of all APIs (only the main scenarios are described, not every class and interface), and some developers may not read the guide.

      In addition, publishing it as an Excel (actually an XML) allows developers to sort the information as they like, and also makes it easy to see what JAR files contain public APIs. It provides a good overview of the portal APIs.

      For example, you may know the package of the class you need but not the class name. You may know the class but not the sharing reference, or you may know the class but not the package. Many customers complained they did not know the JARs and references that were needed for specific APIs, so we assembled this list of all APIs. We also added a quick guide for using the built-in tag libraries.

      If there is a way to improve the Excel, or the documentation, please feel free to tell me.

      Thanks for your comments.


      Author's profile photo Manuel-Jeremy Schaffner
      Manuel-Jeremy Schaffner
      How can we use/reference these API's when usinh NWDI (used DC references)?

      Do we still need to build ExternalLib-DC's with the jar's and include these?

      Author's profile photo Daniel Wroblewski
      Daniel Wroblewski
      Blog Post Author

      Yes, that is what you need to do. Some of the portal's APIs are wrapped as DCs, but many, perhaps most, are not.

      In the next major release, and in the composition environment, all APIs are wrapped in DCs. I will provide a similar excel for mapping APIs to SC/DC.


      Author's profile photo Former Member
      Former Member

      As mentioned in your excel PcdSearchControls, PcmConstants and IPcdContext classes are not there in their respective jar files on server. I am using 2004s SP10, this excel is for what version?