IBM Tivoli Common Reporting (TCR) pimC

< integrations

This page documents the enPortal integration for IBM Tivoli Common Reporting (TCR).

If you are using portal version 5.3 or earlier please click here for the integration documentation applicable to it

  • Vendor: IBM
  • Product: Tivoli Common Reporting (TCR)
  • Supported Version(s): 2.1.1
  • Name of enPortal Integration Package: ibm.tcr_pimC
  • Required enPortal Version: 4.6.1 and above


The following section documents supported platforms, installation, and configuration of the Tivoli Common Reporting (TCR) Product Integration Module on enPortal versions 4.6.1 and above.

Page Contents

1. Support Matrix

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


1.1. Operating System

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


1.2. 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.


1.3. Web Browser

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


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

3. Integration Details

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


3.1. Channel Types

  • Home - Channel that displays the default Home page for the logged in user, including full navigation controls (no custom configuration required)
  • Proxy - Channel that is used by the system to display Tivoli Common Reporting(TCR) channels (no custom configuration required)
  • TCR - A channel that displays the Tivoli Common Report entry page. (uri: /ibm/console/xLaunch.do)
  • RunReport - A channel that allows a specific report to be run. (uri:/tarf/servlet/dispatch). Here are list of channel parameters:
    • ui.object: The path of a report object (for example: /content/package[@name='Netcool_OMNIbus']/report[@name='Event Severity'])
    • run.prompt: A flag to indicate whether to show prompt or not (true, false)
    • ui.action: run, indicating to run a report
    • b_action: cognosViewer
    • run.outputFormat: The format of Report. The possible values are (CSV, HTML, HTMLFragment, MHT, PDF, singleXLS, XHTML, XLS, XLWA, and XML)
  • ViewReport - A channel that displays a saved Report. Here are list of channel parameters:
    • ui.object: The path of a report object (for example: /content/package[@name='Netcool_OMNIbus']/report[@name='Event Severity'])
    • ui.name: The name of a report
    • ui.action: view, indicating to view a report
    • b_action: cognosViewer
    • run.outputFormat: The format of Report. The possible values are (CSV, HTML, HTMLFragment, MHT, PDF, singleXLS, XHTML, XLS, XLWA, and XML)
  • QueryStudio - A channel that launches Query Studio

3.2. Configuration

After installing the Tivoli Common Reporting (TCR) PIM, perform the following steps to configure access to the host Tivoli Common Reporting (TCR) server:

  1. Under the Web Integrations tab, select Applications & Licenses
  2. Right-click on the name sample in the row for Tivoli Common Reporting (TCR) (ibm.tcr_pimC) and select Modify
  3. Fill in the items in the Modify Application Wizard dialog:
    1. Select the protocol used to access your Tivoli Common Reporting (TCR) server (http or https)
    2. Change the host name from "changeme" to the hostname or ip address that will resolve to your Tivoli Common Reporting (TCR) server
    3. Change the port to the port number of your Tivoli Common Reporting (TCR) server
    4. Click "Save" to keep your changes
  4. Under the Web Integrations tab, select Explorer
  5. In the Explorer, under Packages, expand the cuculus.zonoscontrolcenter_pimA tree and click on the sample target. Confirm that the information you entered is displayed for your Tivoli Common Reporting (TCR) 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 Tivoli Common Reporting (TCR) application in a browser. Confirm that the Tivoli Common Reporting (TCR) Home page is displayed.


3.3. Create Channels

After installing the Tivoli Common Reporting (TCR) PIM and configuring access to the host Tivoli Common Reporting (TCR) server, perform the following steps to create channels to display Tivoli Common Reporting (TCR) content:

  1. Under the Web Integrations tab, select Applications & Licenses
  2. Right-click on the name sample in the row for ibm.tcr_pimC and select a channel type
  3. In the "Channel Name" box, enter the name you want to give to the new channel
  4. Click Next
  5. Click Finish
  6. Under the Web Integrations tab, select Explorer
  7. In the Explorer, under Packages, expand the ibm.tcr_pimC 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.


3.4. Known Issues

The following known issues are associated with this PIM:

  • This pim depends on ibm.tip.common_pimD to perform SSO. Therefore, you will need to install ibm.tip.common_pimD along with this pim.
  • For additional information on configuring the channel, see IBM document for TCR. Drill down to "Working with reports" chapter and "Using parametrized URLs to perform tasks outside Tivoli Common Reporting".

3.5. License Usage

In order for the AppBoard/enPortal administrator to configure the ibm.tcr_pimC PIM, the AppBoard/enPortal license.properties file must include licensing for at least one ibm.tcr_pimC 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 Tivoli Common Reporting (TCR) server. The Tivoli Common Reporting (TCR) application must be licensed to support the number of users that will be accessing the application through AppBoard/enPortal.


3.6. Version Support

The following matrix details the supported Tivoli Common Reporting (TCR) and compatible AppBoard/enPortal versions:

Version Support
Package Name enPortal Version Tivoli Common Reporting (TCR) Supported Versions
ibm.tcr_pimC 4.6.1+ 2.1.1
To see the current enPortal version, run the portal version command from the [AppBoard_Home]/server/bin directory.

4. Upgrades

4.1. Upgrading from an older version

Older versions of Tivoli Common Reporting (TCR) are not supported by this PIM, so this upgrade path is not supported. It is recommended that you validate the PIM in your Tivoli Common Reporting (TCR) environment to confirm that it supports the required functionalities.


4.2. Upgrading to a newer version

Perform the following steps when the Tivoli Common Reporting (TCR) server is upgraded to a newer version of Tivoli Common Reporting (TCR):

  1. Check the AppBoard/enPortal PIM online documentation to see if the new Tivoli Common Reporting (TCR) version is supported by the existing ibm.tcr_pimC PIM.
  2. Test if the new Tivoli Common Reporting (TCR) version is supported by the existing PIM that you have installed, perform the following steps:
    1. Under the Web Integrations tab, select Applications & Licenses
    2. Right-click on the row for the old Tivoli Common Reporting (TCR) server and select "Modify"
    3. Update the protocol, host, and port to reference the server where the new version of Tivoli Common Reporting (TCR) is running
  3. If the new Tivoli Common Reporting (TCR) 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 Tivoli Common Reporting (TCR) 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


5. Uninstall

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


Uninstalling the ibm.tcr_pimC PIM will break all of the channels in your AppBoard/enPortal system that reference this integration.
  1. Under the Web Integrations tab, select Explorer
  2. In the Explorer, under Packages, locate the ibm.tcr_pimC integration
  3. Right click on the integration name, and select "Delete"
  4. Click "Ok" to confirm that you want to delete the integration package