The URL generator service creates URLs for applications and various kinds of resources. It is called whenever a URL is needed to access a resource, for example, the document icons displayed with the documents in a folder, a document link in a notification sent to a user, the start page of a dialog function, and so on.
The URL generator service is used by all functional Knowledge Management components.
The URL generator service assembles a complete URL from various components including resource URIs, system addresses, and paths specified in the configuration.
URL Generator Service Parameters
Parameter | Required | Description |
---|---|---|
Host |
Yes |
Address of server on which the portal and KM are running. If you are running a system with load balancing, enter the address of the Loadbalancer here. If you want to publish Web sites created using the Web Page Composer for external users, you must specify a host that is accessible for external users. |
Alternative Host |
No |
Alternative host address that can be used by backend systems. For example, you can specify an alternative host so that TREX can avoid certain authentication systems for indexing purposed. |
Default Configuration File |
Yes |
The default screen flow definition file (WDF) for the user interface controls of the KM dialog functions. If no other screen flow definition file is specified in requests to the URL generator, this file is used. |
Action Inbox Servlet |
Yes |
URL that displays the current notifications for the user who is logged on. |
Applog Download Servlet |
Yes |
URL requested to download an application log. |
Basic Search Servlet |
Yes |
URL of the servlet that launches the search screen. |
Business Card Servlet |
Yes |
URL requested to display a business card in a separate window when the user clicks a link representing a portal user. |
Collaboration Servlet |
Yes |
URL that is requested to display attachments in a new window. |
XCrawler Monitor Servlet |
Yes |
URL of the servlet that launches the crawler monitor. |
XCrawler Monitor Details Servlet |
Yes |
URL of the servlet used to launch the detail view of the crawler monitor. |
Discussion Servlet |
Yes |
URL that is requested to display discussion posts in a separate window. |
Highlighted Content |
Yes |
URL requested to display the HTML version of a document in the search results list. |
Ice Path |
Yes |
URI path to the directory containing configuration data for the content exchange service (ICE). |
Image Path |
Yes |
URI path used as a prefix for an image URI for displaying an image. |
Image Path of iView Service |
Yes |
URI path used by the portal iView service as a prefix for an image URI for displaying an image. |
Indexing Monitor Servlet |
Yes |
URL of the servlet that launches the indexing monitor. |
Indexing Monitor Details Servlet |
Yes |
URL of the servlet used to launch the detail view of the indexing monitor. |
Index Log Servlet |
Yes |
URL of the servlet used to display the progress when updating a query-based taxonomy. |
Meta Data Download Servlet |
Yes |
URL of the servlet used to download exported properties and metadata. |
Explorer Servlet |
Yes |
Portal component that is requested to display the content of a directory. The resource URI is appended to the portal component URI. |
Navigation Servlet |
Yes |
URL of the servlet that is used to navigate in directories. |
Resource Properties Page |
Yes |
Previous page requested to display the parameters of a resource. |
Resource Selector |
Yes |
URL that is requested to launch a dialog box for selecting resources. |
TREX Administration Servlet |
Yes |
URL of the servlet used to call the TREX monitor. |
New Resource Properties Page |
Yes |
Portal component requested to display the properties of a resource. |
Viewer |
Yes |
URL requested to display the content of a document. |
Content Access Path |
Yes |
URI path used as a prefix for a resource URI to access the resource content. |
Service Servlet |
Yes |
URL requested to call up functions using links in e-mails and other documents, for example, when a user approves a document, or deletes a subscription by clicking a link in a notification e-mail. |
Link List Servlet |
Yes |
Portal component requested to display the link list in the Link List iView. |
Favorite Servlet |
Yes |
URL requested to display a user's list of favorites in the Favorites iView. |
XML Forms CSS URL |
Yes |
URI path to the CSS used by the form-based publishing application. |
List Servlet |
Yes |
Portal component used to display lists in the application for form-based publishing. |
Edit Servlet |
Yes |
URL of the servlet used to call XML forms. |
Preview Servlet |
Yes |
Servlet URL used to preview forms in the application for form-based publishing. |
XML Forms Builder |
Yes |
URL requested to invoke the forms editor for maintaining forms used in form-based publishing. |
XML Forms Browser Servlet |
Yes |
URL requested to launch the different selection screens for the XML Forms Builder application. |
User Mapping Servlet |
No |
URL requested to perform a user mapping that is different from the standard user mapping. |
User Home |
Yes |
Prefix for the repository where user-specific inboxes are located. |
KM Details iView |
No |
Portal Content Directory (PCD) location of KM Detailed iView.
Note that if you want to view this location, you have to choose Content Administration → Portal Content → Content Provided by SAP → End User Content → Standard Portal Users → iViews → com.sap.km.iviews → URL Access → KM Details iView and then in the context menu of the KM Details iView, choose Open →Object →PCD Location. |
Client Side Edit |
Yes |
URL of the servlet used to call the Local Editing function. |
Feedback |
Yes |
URL of the Feedback servlet that can be requested by different applications, for example, the XML Forms Builder. |
SendMail |
Yes |
URL of the SendMail servlet that can be requested by different applications, for example, the XML Forms Builder. |
Subscription |
Yes |
URL requested to display the Details screen for a subscription. |
Subscription Administration |
Yes |
URL requested to display an overview of all subscriptions for a user. |
The URL generator service is preconfigured in the standard delivery. You do not normally need to modify the configuration. If necessary, you can enter an alternative host address.
In an upgrade or migration scenario, you can replace the entries for some parameters with shorter character strings. This can slightly improve performance and you avoid problems with some WebDAV clients due to URLs that are too long. This conversion also suppresses the basic authentication messages when opening MS Office documents.
To call up the configuration of the URL generator service, choose System Administration → System Configuration → Knowledge Management → Content Management → Global Services → URL Generator Service in the portal.
Make the following changes:
/irj/servlet/prt/portal/prtroot/com.sap.km.cm.docs in the parameters Image Path, Viewer, XML Forms CSS URL, and Content Access Path with /irj/go/km/docs
The entry in the Image Path parameter must look as follows: /irj/go/km/docs/etc/public/mimes/images
/irj/servlet/prt/portal/prtroot/com.sap.km.cm.uidetails in the parameters Resource Properties Page and New Resource Properties Page with /irj/go/km/details
/irj/servlet/prt/portal/prtroot/com.sap.km.cm.navigation in the parameters Explorer Servlet and Navigation Servlet with /irj/go/km/navigation
/irj/servlet/prt/portal/prtroot/com.sap.km.cm.highlightedcontent in the parameters Highlighted Content with /irj/go/km/highlightedcontent
/irj/servlet/prt/portal/prtroot/com.sap.km.cm.basicsearch in the parameter Basic Search Servlet with /irj/go/km/basicsearch