Web parameter: helpServerContext

Web parameters change the behavior of the web clients that connect to the web tier. You can set some of these parameters from the web client login URL, some from the web tier configuration file (web.xml), and some from both.

Parameter

helpServerContext

Description

This parameter defines the context path when deploying the Service Manager help on a web server (for example, Apache). The context path refers to the name of the virtual directory where the Service Manager help is installed. It excludes the web server’s document directory path. For example, if the help is deployed in C:/Apache/2.2/htdocs/sm_help, the document directory path is C:/Apache/2.2/htdocs/ and the virtual directory name is sm_help. Therefore, the context path is sm_help.

Note  

  • You need to define this parameter only if you deploy the Service Manager help in a virtual directory within your web server’s root document directory. Once you have added this parameter to the web tier's web.xml, Service Manager will launch the Help Server using this URL: http://<helpServerHost>:<helpServerPort>/<helpServerContext>.
  • If this parameter is not included in the web.xml, Service Manager will launch the Help Server using http://<helpServerHost>:<helpServerPort>/help.

 

Valid if set from

Web tier configuration file (web.xml)

Requires restart of the web applications server?

Yes

Default value

help

Possible values

Relative paths from the web server’s document directory (such as "sm_help," or "sm/help")

Example usage

<init-param>
  <param-name>helpServerContext</param-name>
  <param-value>sm/help</param-value>
</init-param>

 

<init-param>
  <param-name>helpServerContext</param-name>
  <param-value/>
</init-param>