Integrations/ibm/ibm.tbsm pimD

Revision as of 20:51, 29 July 2013 by imported>Teri.roberts (→‎Installation)

This page documents the enPortal integration for IBM Netcool TBSM.

  • Vendor: IBM
  • Product: Netcool TBSM
  • Supported Version(s): 4.1, 4.2, 4.2.1
  • Name of enPortal Integration Package: ibm.tbsm_pimD
  • Required enPortal Version: 2.1.2-20070711.0230 and above with support for cookie manager


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

  1. Install AppBoard/enPortal as detailed in the Installation documentation
  2. Download the files ibm.tip.common_pimC.jar and ibm.TBSM_pimD.jar
  3. Extract the package.jar file from ibm.tip.common_pimC.jar and rename it to tip.common_pimC_package.jar
  4. Extract the package.jar file from ibm.tbsm_pimD.jar and rename it to TBSM_pimD_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_pimC_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_pimC.txt"
  14. Under the Advanced tab, select PIMImport
  15. Click the Choose File button
  16. Locate the TBSM_pimD_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 folowing message is displayed: "Import completed; loaded the following file(s): load_tbsm_pimD.txt"
  21. Navigate to the /Directory/system/proxy/ folder and locate the “Manage Proxy” channel
  22. Right-click on the “Manage Proxy” channel and select Open to launch the channel
  23. In the Manage Proxy tool, click “Reset All”
  24. 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 TBSM application
  • Service - Channel that displays the Service Administration and Service Availability page
  • EventSummary - Channel that displays TBSM Event Summary
  • ServiceMap - Channel that displays TBSM Service Map applet
  • ServiceDetails- Channel that displays the TBSM Event List, Service State and SLA Status


Configuration

After installing the TBSM PIM, perform the following steps to configure access to the host TBSM 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 Business Service Manager" and select "Modify"
  5. Fill in the items in the Modify Application Wizard dialog:
    1. Select the protocol used to access your TBSM server (http or https)
    2. Change the host name from "changeme" to the hostname or ip address that will resolve to your TBSM server
    3. Change the port from "16316" to the port number of your TBSM server
  6. Click on the Integrations tab
  7. In the Explorer, under Packages, expand the ibm.TBSM_pimD tree and click on the Sample target. Confirm that the information you entered is displayed for your TBSM 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 TBSM application in a browser. Confirm that the TBSM Home page is displayed.


Create Channels

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

  1. Click on the Applications tab
  2. Right-click on the name "sample" in the row labeled "IBM Tivoli Business Service Manager" 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.TBSM_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.


Custom Channel Settings

  • Home Channel
    • The Home channel does not have any custom fields


  • Service Channel
    • pageID Parameter
      • Description - PageID refers to id of Service Administration and Service Availability page.
      • Example - 'com.ibm.tbsm.navigationElement.serviceAdmin'
      • URL Mapping - Maps to URL parameter 'pageID'
    • moduleRef Parameter
      • Description - moduleRef is the module reference of Service Administration and Service Availability page.
      • Example - 'TBSMPortlets'
      • URL Mapping - Maps to URL parameter 'moduleRef'


Following is the detailed mapping of values of above two URL parameters, with corresponding pages in the application.

Service Channel URL Mapping
Page/Channel moduleRef pageID
Service Administration TBSMPortlets com.ibm.tbsm.navigationElement.serviceAdmin
ServiceAvailability TBSMPortlets com.ibm.tbsm.navigationElement.desktop


  • EventSummary Channel
    • width Parameter
      • Description - Width of the image to be created.
      • Example - '400'.
      • URL Mapping - Maps to param 'width'
    • use3d Parameter
      • Description - Specifies whether or not the graphics should be rendered in 3D.
      • Example - 'false'.
      • URL Mapping - Maps to param 'use3d'
    • height Parameter
      • Description - Height of the image to be created.
      • Example - '300'.
      • URL Mapping - Maps to param 'height'
    • ChartConfig Parameter
      • Description - Configuration to use as a chart data source.
      • Example - 'SimpleOmnibusEventSummaryChart'.
      • URL Mapping - Maps to param 'ChartConfig'


Following is the detailed mapping of values of above URL parameter:

ChartConfig Mapping
ChartConfig Value Event Summary channel
SimpleOmnibusEventSummaryChart Show event summary for all services
NumEventsByServiceAndSeverityChart Show the event summary for childrens of the selected service
  • EventSummary Channel (cont.)
    • ParentServiceKey Parameter
      • Description - It is an internal service ID number that is unique to each service.
      • Example - '1'.
      • URL Mapping - Maps to param 'ParentServiceKey'


To determine the ParentServiceKey parameter for EventSummary channels:

  1. Go to Service Availability channel.
  2. Inside Service Tree portlet click on any service.
  3. In the Service Details portlet, click the Events tab. The link is displayed, for example:-"https://172.22.23.92:16316/RawEvents_55 ".
  4. The ParentServiceKey field would be:"55".
  5. Edit the EventSummary channels and put this ParentServiceKey in the ParentServiceKey parameter of the channel.


  • ServiceMap Channel
    • CanvasTemplate Parameter
      • Description - Service map canvas layout style.
      • Example - 'Relationships'
      • URL Mapping - Maps to URL parameter 'CanvasTemplate'
    • ServiceInstanceID Parameter
      • Description - Service instance identifier.
      • Example - '1'.
      • URL Mapping - Maps to URL parameter 'ServiceInstanceID'


To determine the ServiceInstanceID parameter for ServiceMap channels:

  1. Go to Service Availability channel.
  2. Inside Service Tree portlet click on any service.
  3. In the Service Details portlet, click the Events tab. The link is displayed, for example:-"https://172.22.23.92:16316/RawEvents_55 ".
  4. The InstanceId field would be:"55".
  5. Edit the ServiceMap channels and put this instance id in the ServiceInstanceID parameter of the channel.


  • ServiceDetails Channel
    • View Parameter
      • Description - The view of the data used to generate the Event List, Service State and SLA Status.
      • Example - 'ServiceState'
      • URL Mapping - Maps to URL parameter 'View'
    • RADEventFilterType Parameter
      • Description - Name of the filter use to filter the view of the data.
      • Example - 'ServiceState'.
      • URL Mapping - Maps to URL parameter 'RADEventFilterType'
    • InstanceId Parameter
      • Description - TBSM Service Instance Identifier used as a source of data for Event List, Service State and SLA Status.
      • Example - '55'.
      • URL Mapping - Maps to URL parameter 'InstanceId'
Template-note.png
InstanceId is mandatory parameter for Event List, Service State and SLA Status channels.

To determine the InstanceId parameter for ServiceDetails channels:

  1. Go to Service Availability channel.
  2. Inside Service Tree portlet click on any service.
  3. In the Service Details portlet, click the Events tab. The link is displayed, for example:-"https://172.22.23.92:16316/RawEvents_55 ".
  4. The InstanceId field would be:"55".
  5. Edit the ServiceDetails channels and put this instance id in the InstanceId parameter of the channel.


Following is the detailed mapping of values of above two URL parameters, View and RADEventFilterType, with corresponding pages in the application.

ServiceDetails Channel URL Mapping
Channel View RADEventFilterType
Event List RawEvents RawEvents
Service State ServiceState ServiceState
SLA Status SLAStatus SLATime


Known Issues

The following known issues are associated with this PIM:


  • Help is not working in all the applets loading in Service Editor and Service Viewer portlet.
  • Help is not working in all the applets loading via Service Map channel.
  • User needs to click any of these three channels Event List, Service State, SLA Status twice to load the content properly. Once the content loads next time onwards the contents of these channels loads properly.
  • In the ServiceMap channel, the ServiceMap is meant for view only. The context actions in the ServiceMap channel will not work, due to the TIP environment not being able to support them.


License Usage

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

Version Support
Package Name enPortal Version TIP Version TBSM Version
ibm.TBSM_pimD 5.0 2.1 IBM Tivoli Business Service Manager version 4.1, 4.2, 4.2.1
Template-tip.png
To see the current enPortal version, run the portal version command from the [AppBoard_Home]/server/bin directory.


TBSM Upgrades

Upgrading from an older version of TBSM to TBSM 4.2.x

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


Upgrading from TBSM 4.2.x to a newer version of TBSM

Perform the following steps when the TBSM 4.2.x server is upgraded to a newer version of TBSM:

  1. Check the AppBoard/enPortal PIM online documentation to see if the new TBSM version is supported by the existing ibm.TBSM_pimD PIM
    1. If the new TBSM 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 TBSM server and select "Modify"
      3. Update the protocol, host, and port to reference the server where the new version of TBSM is running
    2. If the new TBSM 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 TBSM 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

Template-warning.png
Uninstalling the ibm.TBSM_pimD PIM will break all of the channels in your AppBoard/enPortal system that reference this integration.

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

  1. Click on the Integrations tab
  2. In the Explorer, under Packages, locate the ibm.TBSM_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
Retrieved from "http://ab.edge-technologies.com/docs/index.php?title=Integrations/ibm/ibm.tbsm_pimD&oldid=1586"