Configuring the Online Help

JasperReports Server professional edition includes an online help system that describes the web interface. If your users don’t have internet connectivity, or if you don’t want to provide access to this system, you can configure the server to hide the help links completely.

Online Help Configuration Options

Configuration File

…\WEB-INF\applicationContext-webHelp.xml

Property

Bean

Description

showHelp

webHelp

Determines whether the help links are displayed in the JasperReports Server web UI. Valid values are true and false.

The help link appears on the login page (Online Help) as well as to the left of Logout on other pages.

hostURL

webHelp

Indicates the name of the computer hosting the web server where the help is running. The value depends on the version of JasperReports Server. Do not change this value.

pagePrefix

webHelp

Defines the default page name to pass to the web server hosting the help system. The only valid value is Default_CSH.htm for this property.

helpContextMap

webHelp

Maps contexts in the application to topic identifiers in the help system. Many pages in the web application are configured for context-sensitivity. When a user clicks Help on such a page, JasperReports Server loads a specific topic in the help system. The topic that appears is determined by a map in the applicationContext-webHelp.xml file. The only valid values are the defaults.

Version: 
Feedback