Integrations/sevone/sevone.nms pimD

This page documents the enPortal integration for SevOne Network Management System (NMS) application.

• Vendor: SevOne
• Product: Network Management System (NMS)
• Supported Version(s): 5.2.3.0
• Name of enPortal Integration Package: sevone.nms_pimD
• Required enPortal Version: 4.6.1 and above

The following section documents supported platforms, installation, and configuration of the SevOne NMS Product Integration Module on enPortal versions 4.6.1 and above.

Support Matrix

The following Operating System, Database, and Web Browser platforms are supported:

Operating System

Please see the list of supported Operating Systems on the System Requirements page.

Database

A special database is not required to implement this integration module. The AppBoard/enPortal database is used to store all configurations related to this integration module.

Web Browser

Please see the list of supported Web Browsers on the System Requirements page.

Installation

Perform the following steps to install the SevOne NMS PIM:

1. Install AppBoard/enPortal as detailed in the Installation documentation
2. Download the file sevone.nms_pimD.jar
3. Start enPortal and login as an administrator
   1. User Name: administrator
   2. Password: administrator
   3. Domain: System
4. Under the Advanced tab, select PIMImport
5. Click the Browse... button
6. Locate the SevOne NMS PIM JAR file in the Open dialog
7. Click the Start button to extract the files from the PIM .jar archive
8. Under the Advanced tab, select XMLImport
9. Click the Start button to load the PIM into the system
10. Confirm that the following message is displayed: "Import completed; loaded the following file(s): load_sevone.nms_pimD.txt"
11. Under the Advanced tab, select Explore System
12. Navigate to the /Directory/system/proxy/ folder and locate the “Manage Proxy” channel
13. Right-click on the “Manage Proxy” channel and select Open to launch the channel
14. In the Manage Proxy tool, click “Reset All”
15. Refresh the browser

Integration Details

The following sections provide special details for configuring the integration module after installation.

Channel Types

• Home - Channel that displays the default Home page for the logged in user, including full navigation controls (no custom configuration required). This home channel is using Force Login mechanism with "domino" parameter set to "dashboard"

• Proxy - Channel that is used by the system to display SevOne NMS channels (no custom configuration required)

• View - Channel that allows access to a particular View in SevOne. This Channel uses SevOne's forced Login mechanism. There are pre-built channels, About, Alerts, Map that demonstrates how to configure View Channel type to go to a particular SevOne View. The fields to customize are:
  • hideNav - Hide Navigation (1: hide / 0: show)
  • viewName - View Name, A particular View defined by SevOne application

By using Force Login, a portal administrator could create any short cut to almost any view in SevOne. Please see this for more information: https://sevdemov5.sevone.com/manual/guiparams.html

The parameter for each domino view type is in such a format
params[<param name>]=<param value>
i.e. params[mapId]=110

Configuration

After installing the SevOne NMS PIM, perform the following steps to configure access to the host SevOne NMS server:

1. Click on the Applications tab
2. Right-click on the name "sample" in the row for sevone.nms_pimD and select "Modify"
3. Fill in the items in the Modify Application Wizard dialog:
   1. Select the protocol used to access your SevOne NMS server (http or https)
   2. Change the host name from "changeme" to the hostname or ip address that will resolve to your SevOne NMS server
   3. Change the port to the port number of your SevOne NMS server
   4. Click "Save" to keep your changes
4. Click on the Integrations tab
5. In the Explorer, under Packages, expand the sevone.nms_pimD tree and click on the Sample target. Confirm that the information you entered is displayed for your SevOne NMS server
6. Under the Sample target, click on the Home channel. A login prompt should be displayed.
7. Log in using the same credentials you would use for accessing the SevOne NMS application in a browser. Confirm that the SevOne NMS Home page is displayed.

Create Channels

After installing the SevOne NMS PIM and configuring access to the host SevOne NMS server, perform the following steps to create channels to display SevOne NMS content:

1. Click on the Applications tab
2. Right-click on the name "sample" in the row for sevone.nms_pimD and select a channel type
3. In the "Channel Name" box, enter the name you want to give to the new channel
4. For "Channel Type", select "3rd Party Pims"
5. Click Next
6. Click Finish
7. Click on the Integrations tab
8. In the Explorer, under Packages, expand the sevone.nms_pimD tree and click on the Sample target. Confirm that the new channel is listed along with the other sample channels.

Repeat the above steps to create additional channels. Select a different Channel Type in step 2 to create a different type of channel.

Known Issues

The following known issues are associated with this PIM:

• To create an additional direct View/Page channel, Edge will need to work with the customers to update "view_handlers.xml" file

Out of box, the pim has three pre-built channels, About, Alerts, and Map that demonstrates the direct access of SevOne View/Page. Additionally, SevOne is using client event (via Javascript) to access a particular page. For enPortal to implement this, it requires a "view_handlers.xml" file to supply the appropriate query parameters for each client event.

Therefore, if customers require additional View/Page access, Edge will need to work with customers to modify view_handlers.xml to add additional parameters required for the additional SevOne View/Page.

Here is the description of Force Login mechanism (extracted from https://sevdemov5.sevone.com/manual/guiparams.html)

The Forced Login script provides the ability to authenticate and redirect a user to a given interface 
within SevOne NMS without human interaction. Additional parameters may also be included that will modify the interface
or perform various actions. All SevOne appliances come with the script available for use immediately. To take advantage, 
a URL must be constructed using the script and some combination of the the parameters listed below:

username	Required	A valid SevOne NMS username.
password	Required	The password of the valid SevOne NMS user.
domino	Required	The SevOne NMS interface to navigate the user to.
hideNav	Optional	Whether or not to "hide" the navigation bar at the top of the SevOne NMS interface. Default is 0.
params	Optional	An associative array of additional parameters to be sent to the interface.

As an example, a URL that would force the login of user jsmith with password sm!tty and navigate that user to the Alerts 
interface would look like so:

http://[IP_OF_APPLIANCE]/forcelogin.php?username=jsmith&password=sm!tty&domino=alerts

Passing additional parameters to an interface makes its possible to perform actions such as running reports automatically, 
getting a particular Device Quick Status report, or setting up default filters for a given interface.

As an example, a URL similar to above that would change the default grouping of Alerts to "Device Group" would look like so:

http://[IP_OF_APPLIANCE]/forcelogin.php?username=jsmith&password=sm!tty&domino=alerts&params[groupingType]=2

License Usage

In order for the AppBoard/enPortal administrator to configure the sevone.nms_pimD PIM, the AppBoard/enPortal license.properties file must include licensing for at least one sevone.nms_pimD server. The administrator can create one additional host ("target") in AppBoard/enPortal for each server license included in the license file.

Each AppBoard/enPortal user maintains one user session with the SevOne NMS server. The SevOne NMS application must be licensed to support the number of users that will be accessing the application through AppBoard/enPortal.

Version Support

The following matrix details the supported SevOne NMS and compatible AppBoard/enPortal versions:

Version Support

Package Name	enPortal Version	SevOne NMS Supported Versions
sevone.nms_pimD	4.6.1+	5.2.3.0

To see the current enPortal version, run the portal version command from the [AppBoard_Home]/server/bin directory.

SevOne NMS Upgrades

Upgrading from an older version of SevOne NMS

Older versions of SevOne NMS are not supported by this PIM, so this upgrade path is not supported. It is recommended that you validate the PIM in your SevOne NMS environment to confirm that it supports the required functionalities.

Upgrading SevOne NMS to a newer version

Perform the following steps when the SevOne NMS server is upgraded to a newer version of SevOne NMS:

1. Check the AppBoard/enPortal PIM online documentation to see if the new SevOne NMS version is supported by the existing sevone.nms_pimD PIM.
   1. To test if the new SevOne NMS version is supported by the existing PIM that you have installed, perform the following steps:
      1. Click on the Applications tab
      2. Right-click on the row for the old SevOne NMS server and select "Modify"
      3. Update the protocol, host, and port to reference the server where the new version of SevOne NMS is running
   2. If the new SevOne NMS version is not supported by the existing PIM that you have installed, perform the following steps to upgrade the PIM:
      1. Download the new PIM version from the PIM download site
      2. Follow the steps in the Installation section above to install and configure the new PIM version
      3. Re-create all SevOne NMS channels to reference the new PIM
      4. [Optional] Perform the steps outlined in the Uninstall section below to remove the old PIM from the system

Uninstall

Uninstalling the sevone.nms_pimD PIM will break all of the channels in your AppBoard/enPortal system that reference this integration.

Perform the following steps to uninstall the sevone.nms_pimD PIM:

1. Click on the Integrations tab
2. In the Explorer, under Packages, locate the sevone.nms_pimD integration
3. Right click on the integration name, and select "Delete"
4. Click "Ok" to confirm that you want to delete the integration package