Integrations/ibm/ibm.tcr pimC

{{#vardefine:pim_version|pimC}} {{#vardefine:pim_name|ibm.tcr_pimC}} {{#vardefine:pim_vendor|IBM}} {{#vardefine:pim_title|Tivoli Common Reporting (TCR)}} {{#vardefine:pim_prodvers|2.1.1}} {{#vardefine:portal_minversion|4.6.1}} {{#ifeq: "{{{version}}}" | "5.3" |{{#vardefine:portal_version|5.3}}|{{#vardefine:portal_version|5.4}}}} This page documents the enPortal integration for {{#var:pim_vendor}} {{#var:pim_title}}.

{{#ifeq: "5.3" | "{{#var:portal_version}}" | If you are using portal version 5.4 or above please click [[Special:Call/:integrations/ibm/{{#var:pim_name}},version=5.4|here]] for the integration documentation applicable to it | If you are using portal version 5.3 or earlier please click [[Special:Call/:integrations/ibm/{{#var:pim_name}},version=5.3|here]] for the integration documentation applicable to it }}

• Vendor: {{#var:pim_vendor}}
• Product: {{#var:pim_title}}
• Supported Version(s): {{#var:pim_prodvers}}
• Name of enPortal Integration Package: {{#var:pim_name}}
• Required enPortal Version: 4.6.1 and above

The following section documents supported platforms, installation, and configuration of the {{#var:pim_title}} Product Integration Module on enPortal versions 4.6.1 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_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

Integration Details

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

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

Configuration

After installing the {{#var:pim_title}} PIM, perform the following steps to configure access to the host {{#var:pim_title}} server:

{{#ifeq: "5.3" | "{{#var:portal_version}}" |

1. Click on the Applications tab

|

1. Under the Web Integrations tab, select Applications & Licenses

}}

1. Right-click on the name sample in the row for {{#var:pim_title}} ({{#var:pim_name}}) and select Modify
2. Fill in the items in the Modify Application Wizard dialog:
   1. Select the protocol used to access your {{#var:pim_title}} server (http or https)
   2. Change the host name from "changeme" to the hostname or ip address that will resolve to your {{#var:pim_title}} server
   3. Change the port to the port number of your {{#var:pim_title}} server
   4. Click "Save" to keep your changes

{{#ifeq: "5.3" | "{{#var:portal_version}}" |

1. Click on the Integrations tab

|

1. Under the Web Integrations tab, select Explorer

}}

1. 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 {{#var:pim_title}} server
2. Under the sample target, click on the Home channel. A login prompt should be displayed.
3. Log in using the same credentials you would use for accessing the {{#var:pim_title}} application in a browser. Confirm that the {{#var:pim_title}} Home page is displayed.

Create Channels

After installing the {{#var:pim_title}} PIM and configuring access to the host {{#var:pim_title}} server, perform the following steps to create channels to display {{#var:pim_title}} content:

{{#ifeq: "5.3" | "{{#var:portal_version}}" |

1. Click on the Applications tab
2. Right-click on the name "sample" in the row for {{#var:pim_name}} 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. Select Pim, Class, and Target for your channel
6. Click Next
7. Click Finish
8. Click on the Integrations tab

|

1. Under the Web Integrations tab, select Applications & Licenses
2. Right-click on the name sample in the row for {{#var:pim_name}} 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

}}

1. In the Explorer, under Packages, expand the {{#var:pim_name}} 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

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

License Usage

In order for the AppBoard/enPortal administrator to configure the {{#var:pim_name}} PIM, the AppBoard/enPortal license.properties file must include licensing for at least one {{#var:pim_name}} 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 {{#var:pim_title}} server. The {{#var:pim_title}} 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 {{#var:pim_title}} and compatible AppBoard/enPortal versions:

Version Support

Package Name	enPortal Version	{{#var:pim_title}} Supported Versions
{{#var:pim_name}}	{{#var:portal_minversion}}+	{{#var:pim_prodvers}}

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

Upgrades

Upgrading from an older version

Older versions of {{#var:pim_title}} are not supported by this PIM, so this upgrade path is not supported. It is recommended that you validate the PIM in your {{#var:pim_title}} environment to confirm that it supports the required functionalities.

Upgrading to a newer version

Perform the following steps when the {{#var:pim_title}} server is upgraded to a newer version of {{#var:pim_title}}:

1. Check the AppBoard/enPortal PIM online documentation to see if the new {{#var:pim_title}} version is supported by the existing {{#var:pim_name}} PIM.
2. Test if the new {{#var:pim_title}} version is supported by the existing PIM that you have installed, perform the following steps:

{{#ifeq: "5.3" | "{{#var:portal_version}}" |

1. 1. Click on the Applications tab

|

1. 1. Under the Web Integrations tab, select Applications & Licenses

}}

1. 1. Right-click on the row for the old {{#var:pim_title}} server and select "Modify"
   2. Update the protocol, host, and port to reference the server where the new version of {{#var:pim_title}} is running
2. If the new {{#var:pim_title}} 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 {{#var:pim_title}} 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

Perform the following steps to uninstall the {{#var:pim_name}} PIM:

Uninstalling the {{#var:pim_name}} PIM will break all of the channels in your AppBoard/enPortal system that reference this integration.

{{#ifeq: "5.3" | "{{#var:portal_version}}" |

1. Click on the Integrations tab

|

1. Under the Web Integrations tab, select Explorer

}}

1. In the Explorer, under Packages, locate the {{#var:pim_name}} integration
2. Right click on the integration name, and select "Delete"
3. Click "Ok" to confirm that you want to delete the integration package