Integrations/ibm/ibm.webgui pimF

This page documents the enPortal integration for IBM Tivoli Netcool/OMNIbus (WebGUI) [Micromuse].

• Vendor: IBM
• Product: IBM Tivoli Netcool/OMNIbus (WebGUI) [Micromuse]
• Supported Version(s): 7.3.1, 7.3.0
• Name of enPortal Integration Package: ibm.webgui_pimF
• Required Netcool/Portal Version: 2.1.2.4 and above (with support for cookie manager)
• Required enPortal Version: 4.6.1 and above (with support for cookie manager)

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

1. Install AppBoard/enPortal as detailed in the Installation documentation
2. Download the files ibm.tip.common_pimD.jar and ibm.webgui_pimF.jar
3. Extract the package.jar file from ibm.tip.common_pimD.jar and rename it to tip.common_pimD_package.jar
4. Extract the package.jar file from ibm.webgui_pimF.jar and rename it to webgui_pimF_package.jar
5. Start AppBoard
6. Log in to AppBoard as an administrator
   1. User Name: administrator
   2. Password: administrator
   3. Domain: System
7. Under the Advanced tab, select PIMImport
8. Click the Choose File button
9. Locate the tip.common_pimD_package.jar file in the Open dialog
10. Click the Start button to extract the files from the PIM .jar archive
11. Under the Advanced tab, select XMLImport
12. Click the Start button to load the PIM into the system
13. Confirm that the following message is displayed: "Import completed; loaded the following file(s): load_ibm.tip.common_pimD.txt"
14. Under the Advanced tab, select PIMImport
15. Click the Choose File button
16. Locate the webgui_pimF_package.jar file in the Open dialog
17. Click the Start button to extract the files from the PIM .jar archive
18. Under the Advanced tab, select XMLImport
19. Click the Start button to load the PIM into the system
20. Confirm that the following message is displayed: "Import completed; loaded the following file(s): load_webgui_pimF.txt"
21. Under the Advanced tab, select Explore System
22. Navigate to the /Directory/system/proxy/ folder and locate the “Manage Proxy” channel
23. Right-click on the “Manage Proxy” channel and select Open to launch the channel
24. In the Manage Proxy tool, click “Reset All”
25. Refresh the browser

Integration Details

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

Channel Types

• AEL - Channel that displays the Active Event List page
• LEL - Channel that displays the LightWeight Event List page
• Chart - Channel that displays the Chart representation of events
• Map - Channel that displays the Map representation of events
• Table - Channel that displays the Table representation of events
• ManageMenus - Channel that displays the Menu management page
• Home - Channel that displays the top-level Home page of the Netcool WebGUI application
• Proxy - Channel that displays a Webtop page
• Dashboard - Channel that displays a WebGUI Dashboard page

Configuration

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

1. Click on the Applications tab
2. Right-click on the name "sample" in the row labeled "IBM Tivoli Integrated Portal" and select "Modify"
3. Fill in the items in the Modify Application Wizard dialog:
   1. Select the protocol used to access your TIP server (http or https)
   2. Change the host name from "changeme" to the hostname or ip address that will resolve to your TIP server
   3. Change the port from "16316" to the port number of your TIP server
4. Right-click on the name "sample" in the row labeled "IBM Tivoli OMNIbus WebGUI 7.3/7.3.1" and select "Modify"
5. Fill in the items in the Modify Application Wizard dialog:
   1. Select the protocol used to access your Netcool WebGUI server (http or https)
   2. Change the host name from "changeme" to the hostname or ip address that will resolve to your Netcool WebGUI server
   3. Change the port from "16316" to the port number of your Netcool WebGUI server
6. Click on the Integrations tab
7. In the Explorer, under Packages, expand the ibm.webgui_pimF tree and click on the Sample target. Confirm that the information you entered is displayed for your Netcool WebGUI server
8. Under the Sample target, click on the Home channel. A login prompt should be displayed.
9. Log in using the same credentials you would use for accessing the Netcool WebGUI application in a browser. Confirm that the Netcool WebGUI Home page is displayed.

Create Channels

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

1. Click on the Applications tab
2. Right-click on the name "sample" in the row labeled "IBM Tivoli OMNIbus WebGUI 7.3/7.3.1" 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. For "Type of PIM", select the appropriate values:
   1. Pim: "IBM Tivoli OMNIbus WebGUI 7.3/7.3.1"
   2. Class: The channel type to build (for example, "AEL")
   3. Target: "sample"
6. Click Next
7. Click Finish
8. Click on the Integrations tab
9. In the Explorer, under Packages, expand the ibm.webgui_pimF 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.

For any channels that use applets (such as the AEL Active Event List), do not include spaces in the channel name. This can result in a 505 error.

Custom Channel Settings

Perform the following steps to view the Readme file documenting the settings for each type of channel:

1. Click on the Integrations tab
2. In the Explorer, under Packages, expand the ibm.webgui_pimF tree
3. Click on the Channel titled "Create Channels". An HTML Channel is displayed, which contains details for configuring each type of channel.

Known Issues

The following known issues are associated with this PIM:

• The WebGUI PIM does not come with Single Sign-on (SSO) definitions. It relies on the TIP Common PIM to do the SSO. Since there is no SSO for this PIM, a portal administrator who is not familiar with the system may try to create a SSO off of the WebGUI package, which would result in an unneccessary resolver.xml file being created and a blank page displayed in the channel.

License Usage

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

Version Support

Bundle Label	Package Name	Associated Package Name	enPortal Version	TIP Version	Netcool WebGUI Version
CZX3CEN	ibm.webgui_pimE	ibm.tip.common.pimA	5.0+	1.x	IBM Tivoli WebGUI version 7.3.0
CI1W8EN (obsolete)	ibm.webgui_pimE	ibm.tip.common.pimB	5.0+	2.x	IBM Tivoli WebGUI version 7.3.1
CG4S6EN	ibm.webgui_pimF	ibm.tip.common.pimD	5.0+	2.x	IBM Tivoli WebGUI version 7.3.1

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

Netcool WebGUI Upgrades

Upgrading from an older version of Netcool WebGUI to Netcool WebGUI 7.3.1

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

Upgrading from Netcool WebGUI 7.3.1 to a newer version of Netcool WebGUI

Perform the following steps when the Netcool WebGUI 7.3.1 server is upgraded to a newer version of Netcool WebGUI:

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

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

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