Integrations/ibm/ibm.tnpm pimB

This page documents the enPortal integration for IBM Tivoli Netcool Performance Manager (TNPM).

• Vendor: IBM
• Product: IBM Tivoli Netcool Performance Manager (TNPM)
• Supported Version(s): 1.3.1
• Name of enPortal Integration Package: ibm.tnpm_pimB
• Required enPortal Version: 4.6.1 and above (with support for cookie manager)

The following section documents supported platforms, installation, and configuration of the TNPM Product Integration Module on enPortal versions 5.0 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 TNPM PIM:

1. Install AppBoard/enPortal as detailed in the Installation documentation
2. Download the file ibm.tnpm_pimB.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 TNPM package.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_ibm.tnpm_pimB.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

This sections provides special details for configuring the integration module after installation.

Channel Types

• Home - Channel that displays the top-level Home page of the TNPM application
• TNPM - Channel that displays TNPM content view (DiagnosticsView and DefinedResourceView)
• DataViewNavigator - Channel that defines a Java Web Start application: DataView Navigator which can be used to create TNPM custom reports and style sheets.

Configuration

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

1. Click on the Applications tab
2. Right-click on the name "sample" in the row labeled "IBM Tivoli Network Performance Manager" and select "Modify"
3. Fill in the items in the Modify Application Wizard dialog:
   1. Select the protocol used to access your TNPM server (http or https)
   2. Change the host name from "changeme" to the hostname or ip address that will resolve to your TNPM server
   3. Change the port to the port number of your TNPM server
4. Click on the Integrations tab
5. In the Explorer, under Packages, expand the ibm.tnpm_pimB tree and click on the Sample target. Confirm that the information you entered is displayed for your TNPM 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 TNPM application in a browser. Confirm that the TNPM Home page is displayed.
8. In order for DataViewNavigator channel to work, Appboard/enPortal needs to be re-started to set the com.edgetech.eportal.dispatch.WebStartRequestAccessor as default request accessor.

Create Channels

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

1. Click on the Applications tab
2. Right-click on the name "sample" in the row labeled "IBM TNPM" 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 ibm.tnpm_pimB 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

• After this pim is installed, AppBoard/enPortal needs to be re-started to load the request accessor class that would allow DataViewNavigator channel to run successfully.

Version Support

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

Version Support

Package Name	enPortal Version	TNPM Version
ibm.tnpm_pimB	4.6.1+	IBM Tivoli Netcool Performance Manager version 1.3.1

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

TNPM Upgrades

Upgrading from an older version of TNPM to TNPM 1.3.1

Older versions of TNPM are not supported by this PIM, so this upgrade path is not supported

Upgrading from TNPM 1.3.1 to a newer version of TNPM

Perform the following steps when the TNPM 1.3.1 server is upgraded to a newer version of TNPM:

1. Check the AppBoard/enPortal PIM online documentation to see if the new TNPM version is supported by the existing ibm.tnpm_pimB PIM
   1. If the new TNPM 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 TNPM server and select "Modify"
      3. Update the protocol, host, and port to reference the server where the new version of TNPM is running
   2. If the new TNPM 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 TNPM 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 ibm.tnpm_pimB PIM will break all of the channels in your AppBoard/enPortal system that reference this integration.

Perform the following steps to uninstall the ibm.tnpm_pimB PIM:

1. Click on the Integrations tab
2. In the Explorer, under Packages, locate the ibm.tnpm_pimB integration
3. Right click on the integration name, and select "Delete"
4. Click "Ok" to confirm that you want to delete the integration package
5. [Optional] Stop AppBoard/enPortal. Go to AppBoard/enPortal file system and delete pkg-ibm.tnpm_pimB.properties file in ${ApplicationHome}/WEB-INF/config directory and pkg-tnpm_pimB.jar in ApplicationHome}/WEB-INF/lib directory