NSP Help Center

Content

NSP user documentation is delivered in an on-product application, called NSP Help Center. During NSP installation, the NSP Help Center loads the information content associated with each product component in your NSP deployment, providing you with end-to-end search capability across the user documentation.

Context-sensitive help

When you click the ? button in an NSP banner bar, a Quick Help menu opens with suggested topics related to the current view. Short topics may be read in-line, whereas longer topics open in the NSP Help Center.

Access

The Help Center can be opened from a ? button available in the NSP banner bar. You can browse the documentation from menus on the NSP Help Center home page, or use the searching and filtering capabilities to isolate information quickly.

Browsing

From the Help Center home page, you can browse guides under the following menus:

• OVERVIEW

• INSTALL AND COMMISSION

• OPERATE AND MAINTAIN

• MONITOR AND TROUBLESHOOT

• REFERENCE

You can also browse within a guide using the table of contents tree in the left navigation panel.

Use the breadcrumb to return to search results or the home page. Use the browser back button to return to any previously visited page.

Searching

The NSP Help Center is centered on its robust search capabilities. When you conduct a search from the home page or search results page, the NSP Help Center executes a global search across documentation for all installed NSP components. As shown in the tooltip on the search bar, the boolean operators AND/OR/NOT are supported, as are the wildcard characters * (any string) and ? (any character). Exact-phrase search strings enclosed in quotation marks are also supported.

Note: Common, non-technical terms such as “the,” “and,” “on,” and others are ignored in all searches, including exact-string searches.

Search history is tracked as follows:

• The Recent Searches list on the home page is per-user, and the Popular Searches list shows the trend across all users of the system.

• When a search result link is clicked on the search results page, it is captured in the Recent Searches list and considered for forming the Popular Search list. Navigating to a page in any other way (for example, by browsing from the browse menu or following links within a browsed document) does not make the page eligible for capture in the Recent/Popular Searches list.

Searched terms are not highlighted on the target page, but you can use the browser find function to see the hits within a page of content.

Filtering

Filters on the left of the search results page display a count beside the filter facets that contain one or more hits on your searched terms. You can refine your search results by selecting one or more filter facets and clicking APPLY FILTERS.

You can filter by either or both of these facets:

• Location

  Select one or more guides or tools to narrow your search results to those areas.

• Information Type

  Select one or more content types to narrow your search results to hits that match the content type. For example, if your search term is “LSP” and you only want to see procedural information, select “Procedure” as the content type.

The content types for filtering are:

• Use cases - use-case-based material showcasing product or feature functionality

• Description - explanatory, non-procedural content

• Procedure - step-by-step instructions to complete a task

• Reference - brief look-up data, such as glossary terms

• Workflow - a sequence of procedures to complete an objective

NSP Help Center notable information

The following table explains the NSP Help Center handling of exceptional circumstances.

Table 4-1: Help Center notable information

Case	Description
Recent and popular search history	To avoid accumulation of a large number of records on Recent and Popular searches, NSP triggers a purge job every week, which keeps the 5000 most recent records and deletes the rest.
NSP component addition and removal	The NSP Help Center contains a base set of guides that are present in all deployment types. However, some NSP components load their own documentation to the Help Center. If an NSP component such as NFM-P is added or removed from the deployment, it could take up to 24 for its help to be added or removed from the Help Center.