Show TOC

Component documentationNavigation Web Service Locate this document in the navigation structure

 

The navigation Web service enables you to get all or part of the navigation tree for the currently authenticated user.

For each user, the portal's navigation service is responsible for generating a navigation tree of links to the portal content assigned to the user. An application - for example, a client running on a user's machine or a navigation iView running in the portal - can query the navigation service for the current user's navigation hierarchy or tree, and then display this tree to the user.

Portal applications can query the navigation service via a Java API. External applications can query the navigation service via this Web service.

For more information, see Navigating in the Portal.

Use Cases

Use the navigation Web service when creating a client for portal content, and you need to get and display the navigation links for the current user.

WSDL

The WSDL for this service is at the following URL:

http://<server>:<port>/NavigationWS/NavigationWSConfig?wsdl

where <server> and <port> are the server and port number for the portal.

This service requires HTTP authentication.

Accessing via EJB

You can also access the Web service's functionality by calling the underlying EJB, as follows:

  • JARs for Build Path / Classpath:

    • com.sap.portal.navigation.ws.NavigationWSBean.jar, located in the Java EE application com.sap.portal.navigation.ws.NavigationWSEar

    • com.sap.portal.ppse.common_api.jar, located in the Java EE application com.sap.portal.ppse.common

  • JNDI Name: NavigationWS

  • Home Interface: com.sap.portal.navigation.ws.NavigationWSHome

  • Remote Interface: com.sap.portal.navigation.ws.NavigationWSRemote

For general information on accessing portal EJBs, see Portal Web Services.

Requests
Data Types