Edge Documentation

Latest revision as of 05:16, 25 July 2014

This page documents the enPortal integration for HP Performance Insight (PI).

Vendor: HP
Product: Performance Insight (PI)
Supported Version(s): 5.41
Name of enPortal Integration Package: hp.pi_pimA.jar
Required enPortal Version: 4.6.1+ (with support for Cookie Manager)

The following section documents supported platforms, installation, and configuration of the HP Performance Insight 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 HP Performance Insight PIM:

Install AppBoard/enPortal as detailed in the Installation documentation
Download the file hp.pi_pimA.jar
Start AppBoard
Log in to AppBoard as an administrator
1. User Name: administrator
2. Password: administrator
3. Domain: System
Under the Advanced tab, select PIMImport
Click the Choose File button
Locate the hp.pi_pimA.jar file in the Open dialog
Click the Start button to extract the files from the PIM .jar archive
Under the Advanced tab, select XMLImport
Click the Start button to load the PIM into the system
Confirm that the following message is displayed: "Import completed; loaded the following file(s): load_hp.pi_pimA.txt"
Under the Advanced tab, select Explore System
Navigate to the /Directory/system/proxy/ folder and locate the “Manage Proxy” channel
Right-click on the “Manage Proxy” channel and select Open to launch the channel
In the Manage Proxy tool, click “Reset All”
Refresh the browser

Integration Details

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

Channel Types

Home - Channel that displays a user's entry page of Performance Insight
Catalog - Channel that displays a specific level of report catalog of Performance Insight. The level of catalog is determined by "fldr" value in the querystring
Proxy - Channel that is used by the system to display Performance Insight channels

Configuration

After installing the HP Performance Insight PIM, perform the following steps to configure access to the host Performance Insight server:

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

Create Channels

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

Click on the Applications tab
Right-click on the name "sample" in the row labeled "hp.pi_pimA" and select a channel type
In the "Channel Name" box, enter the name you want to give to the new channel
For "Channel Type", select "3rd Party Pims"
Click Next
Click Finish
Click on the Integrations tab
In the Explorer, under Packages, expand the hp.pi_pimA 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. Also follow the above section to configure the newly created channel. Select a different Channel Type in step 2 to create a different type of channel.

Custom Channel Settings

There are no custom channel settings for the HP Performance Insight PIM.

Known Issues

There are no known issues associated with this PIM:

License Usage

In order for the AppBoard/enPortal administrator to configure the hp.pi_pimA PIM, the AppBoard/enPortal license.properties file must include licensing for at least one hp.pi_pimA 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 HP Performance Insight server. The HP Performance Insight 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 HP Performance Insight and compatible AppBoard/enPortal versions:

*Version Support*
Package Name	enPortal Version	HP Performance Insight Version
hp.pi_pimA	4.6.1+ (with support for Cookie Manager)	HP Performance Insight Version 5.41

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

HP Performance Insight Upgrades

Upgrading from an older version of HP Performance Insight to HP Performance Insight Version 5.41

Older versions of HP Performance Insight are not supported by this PIM, so this upgrade path is not supported.

Upgrading from HP Performance Insight Version 5.41 to a newer version of HP Performance Insight

Perform the following steps when the HP Performance Insight v5.41 server is upgraded to a newer version of HP Performance Insight:

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

Perform the following steps to uninstall the hp.pi_pimA PIM:

Click on the Integrations tab
In the Explorer, under Packages, locate the hp.pi_pimA integration
Right click on the integration name, and select "Delete"
Click "Ok" to confirm that you want to delete the integration package