Documentation architecture

Types of help

NSP end user documentation consists of:

• product-level guides

• component-level guides

• component-specific tools

Product-level guides

Information about NSP in general is communicated in product-level documentation. The NSP Help Center includes a base set of product-level guides in all deployments and may describe functions not available in the current deployment.

The NSP Release Notice and NSP and NFM-P Network Element Compatibility Guide are PDF-only deliverables on the Doc Center and not part of the NSP Help Center.

Component-level guides

Component-level user documentation is included in the on-product NSP Help Center if the component is installed in the deployment.

Component-specific tools

Several tools are available as part of the end user documentation; that is, they are delivered with the guides and help inside the NSP Help Center or the Doc Center.

NSP Alarm Search Tool

NSP alarms can be searched or browsed from the NSP Alarm Search Tool in the on-product NSP Help Center. NSP system alarms, along with alarms originating on MDM- or NFM-P-managed devices, appear in the tool and can be searched, filtered, and exported.

The alarm information displayed in the NSP Alarm Search Tool is drawn from alarm dictionary files installed on the NSP. Alarm dictionaries are added automatically during component installation ensuring the NSP Alarm Search Tool only contains relevant information. Some components may not yet provide an alarm dictionary. For adaptors, refer to the adaptor documentation for information about alarm dictionaries included with the adaptor. Adaptors from older NSP releases do not have alarm dictionaries.

Telemetry Statistic Search Tool

Telemetry statistics can be searched or browsed using the Telemetry Statistic Search Tool in the on-product NSP Help Center. The tool displays statistics for feature packages, adaptor files, and mapping files for cut-through telemetry that are installed on the NSP. For a statistic to appear in the tool, you must first install the yang files and then the artifacts related to those statistics; for information about installing yang files see the NSP System Administrator Guide, and for information about installing artifacts see the NSP Network Automation Guide.

The Telemetry Statistic Search Tool is available if Model Driven Configurator is included in the deployment.

Other tools

The following developer tools and search tools are no longer delivered on-product; they are available from either the Doc Center or the Network Developer Portal.

• IPDR Reference

• JMS Example Code

• MV Metadata Navigator

• NFM-P Alarm Search Tool

• NFM-P Statistics Search Tool

• Schema Reference

• SDK Navigator

• Template Development Information

• XML API Reference

Delivery formats and locations

NSP guides are available in the following formats and locations:

• on-product, accessible from the NSP Help Center

• off-product as PDF or HTML collection, accessible from the Doc Center on the Nokia Support Portal

See Documentation delivery online for more information about the NSP HTML collection.