Gizmo Type: helpgizmo

Content

Description

The helpgizmo is part of a framework that is designed to allow HTML documents from the deployed labvantagedoc.war to be registered in the LabVantage database and linked to Web pages. Registered help links are defined in the Help Gizmo properties as "Fixed Help Pages".

In LabVantage 8.x, this functionality has been restricted to the Help Gizmo displaying registered help links rather than context-sensitive page links. The LabVantage OOB configuration provides a link to the standard help index located in the labvantagedoc.war that is deployed in the Application Server. See the LabVantage Installation Documentation for details concerning document installation.

Properties

Top

Property Name

Description

Common Properties

Defines high-level characteristics of the Gizmo:

Property Name	Description
title	title text displayed on the Gizmo.
Help Text	Tooltip displayed onMouseOver.
Image	Image displayed for the Gizmo.
Tab Id	If using tabs, specify an identifier for the tab. If not using tabs, leave this blank. If you leave this blank and you are using tabs, the Gizmo will not be displayed.
Show Gizmo	Yes/No shows/hides the Gizmo.

Help URL Root

This property is provided to let you specify the full URL of the root directory for the deployed labvantagedoc.war.

If you leave this property blank, it defaults to http://hostname:port/labvantagedoc, using the hostname of the local machine and the default Application Server port. Therefore, you must set this property if labvantagedoc.war resides on a different machine and/or you are not running on the Application Server's default HTTP port.

If left blank, this property gets the port number for the Application Server's HTTP listener that is set in the "Startup Settings" of LabVantage Console. Note that this is specified as a requirement at the end of each procedure for Adding Applications in the LabVantage Product Documentation.

For more information, see "Document Installation" in the LabVantage Installation Documentation.

Fixed Help Pages

Details concerning the page opened by the Gizmo:

Property Name	Description
title	title text displayed on the Gizmo.
Tip	Tooltip displayed onMouseOver.
URL	URL of the page to open from the "Help URL Root". By default, this is set to open /index.htm. Accordingly, with the default "Help URL Root", the Gizmo opens http://hostname:port/labvantagedoc/index.htm.
Show	Yes/No shows/hides the page.
Prepend Help Root	Determines if the "Help URL Root" precedes the "URL".

REST API Role

The link to the REST Built-In API Documentation is shown in the Help menu only if the User has this Role. The link is not shown if no Role is specified.

Issue Logger Role

If a Role is specified here, only Users who are members of that Role will be able to see the Issue Management menu items in the Help menu.

Leave this blank to allow all Users to see the menu items (this is the default).

Mode

Determines the menu items shown in the Help menu:

Value	Menu Items Shown in the Help Menu
Help Only	Only the deployed Product Documentation WAR file.
Issue Only	Only the Issue Management operations.
Help & Issue	Both of the above. This is the default.

Hide Help if not installed

If the Product Documentation WAR file is not deployed in the application server, a "Help not installed" message is displayed on the Help menu. "Yes" hides this message. The default is "No".