Integrations/ca/ca.pc pimA: Difference between revisions

imported>Teri.roberts
(Created page with 'This page documents the enPortal integration for CA Performance Center. * <b>Vendor</b>: CA * <b>Product</b>: Performance Center * <b>Supported Version(s)</b>: 2.2.0.0 * <b>Nam…')
 
imported>Jason.nicholls
 
(9 intermediate revisions by 2 users not shown)
Line 1: Line 1:
{{DISPLAYTITLE:CA Performance Center pimA}}
[[Category:Integrations]]
This page documents the enPortal integration for CA Performance Center.  
This page documents the enPortal integration for CA Performance Center.  


* <b>Vendor</b>: CA
* <b>Vendor</b>: CA Technologies
* <b>Product</b>: Performance Center
* <b>Product</b>: Performance Center
* <b>Supported Version(s)</b>: 2.2.0.0
* <b>Supported Version(s)</b>: 2.2.0.0
Line 42: Line 44:
# Click the <b>Start</b> button to load the PIM into the system
# Click the <b>Start</b> button to load the PIM into the system
# Confirm that the following message is displayed: "Import completed; loaded the following file(s): load_ca.pc_pimA.txt"
# Confirm that the following message is displayed: "Import completed; loaded the following file(s): load_ca.pc_pimA.txt"
# Under the <b>Advanced</b> tab, select <b>Explore System</b>
# Navigate to the /Directory/system/proxy/ folder and locate the “Manage Proxy” channel
# Right-click on the “Manage Proxy” channel and select <b>Open</b> to launch the channel
# In the Manage Proxy tool, click “Reset All”
# Refresh the browser




Line 49: Line 57:


=== Channel Types ===
=== Channel Types ===
* Page - Channel that displays a specific page (URI: /pc/desktop/page) based on the following parameters:
**GroupID (Group ID of a dashboard)
**endTime (End Time)
**mn (minute range)
**pg (page id)
**sid (sid)
**startTime (Start Time)
**timeRange (Time Range)
* Anonymous - Channel that displays the default Home page without any credential information. CA PC can operate with a generic/default user without asking for a logon credential.
* AnonymousPage - Channel that displays a specific page without any credential information. CA PC can operate with a generic/default user without asking for a logon credential.


* Home - Channel that displays the default Home page for the logged in user, including full navigation controls (no custom configuration required)
* 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 Performance Center channels (no custom configuration required)
* Proxy - Channel that is used by the system to display Performance Center channels (no custom configuration required)




Line 60: Line 82:


# Click on the <b>Applications</b> tab
# Click on the <b>Applications</b> tab
# Right-click on the name "sample" in the row for xxxappname and select "Modify"
# Right-click on the name "sample" in the row for "CA Performance Center" and select "Modify"
# Fill in the items in the <b>Modify Application Wizard</b> dialog:
# Fill in the items in the <b>Modify Application Wizard</b> dialog:
## Select the protocol used to access your Performance Center server (http or https)
## Select the protocol used to access your Performance Center server (http or https)
Line 70: Line 92:
# Under the <b>Sample</b> target, click on the <b>Home</b> channel.  A login prompt should be displayed.
# Under the <b>Sample</b> target, click on the <b>Home</b> channel.  A login prompt should be displayed.
# Log in using the same credentials you would use for accessing the Performance Center application in a browser.  Confirm that the Performance Center Home page is displayed.
# Log in using the same credentials you would use for accessing the Performance Center application in a browser.  Confirm that the Performance Center Home page is displayed.


=== Create Channels ===
=== Create Channels ===
Line 76: Line 100:


# Click on the <b>Applications</b> tab
# Click on the <b>Applications</b> tab
# Right-click on the name "sample" in the row for xxxappname and select a channel type
# Right-click on the name "sample" in the row for "CA Performance Center" and select a channel type
# In the "Channel Name" box, enter the name you want to give to the new channel
# In the "Channel Name" box, enter the name you want to give to the new channel
# For "Channel Type", select "3rd Party Pims"
# For "Channel Type", select "3rd Party Pims"

Latest revision as of 03:57, 25 July 2014

This page documents the enPortal integration for CA Performance Center.

  • Vendor: CA Technologies
  • Product: Performance Center
  • Supported Version(s): 2.2.0.0
  • Name of enPortal Integration Package: ca.pc_pimA
  • Required enPortal Version: 4.6.1 and above


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

  1. Install AppBoard/enPortal as detailed in the Installation documentation
  2. Download the file ca.pc_pimA.jar
  3. Start enPortal and login as an administrator
    1. User Name: administrator
    2. Password: administrator
    3. Domain: System
  4. Under the Advanced tab, select PIMImport
  5. Click the Browse... button
  6. Locate the Performance Center PIM JAR file in the Open dialog
  7. Click the Start button to extract the files from the PIM .jar archive
  8. Under the Advanced tab, select XMLImport
  9. Click the Start button to load the PIM into the system
  10. Confirm that the following message is displayed: "Import completed; loaded the following file(s): load_ca.pc_pimA.txt"
  11. Under the Advanced tab, select Explore System
  12. Navigate to the /Directory/system/proxy/ folder and locate the “Manage Proxy” channel
  13. Right-click on the “Manage Proxy” channel and select Open to launch the channel
  14. In the Manage Proxy tool, click “Reset All”
  15. Refresh the browser


Integration Details

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


Channel Types

  • Page - Channel that displays a specific page (URI: /pc/desktop/page) based on the following parameters:
    • GroupID (Group ID of a dashboard)
    • endTime (End Time)
    • mn (minute range)
    • pg (page id)
    • sid (sid)
    • startTime (Start Time)
    • timeRange (Time Range)
  • Anonymous - Channel that displays the default Home page without any credential information. CA PC can operate with a generic/default user without asking for a logon credential.
  • AnonymousPage - Channel that displays a specific page without any credential information. CA PC can operate with a generic/default user without asking for a logon credential.
  • 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 Performance Center channels (no custom configuration required)


Configuration

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

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


Create Channels

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

  1. Click on the Applications tab
  2. Right-click on the name "sample" in the row for "CA Performance Center" 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 ca.pc_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. 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:

  • There are currently not any known issues associated with this PIM


License Usage

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

Version Support
Package Name enPortal Version Performance Center Supported Versions
ca.pc_pimA 4.6.1+ 2.2.0.0
Template-tip.png
To see the current enPortal version, run the portal version command from the [AppBoard_Home]/server/bin directory.


Performance Center Upgrades

Upgrading from an older version of Performance Center

Older versions of Performance Center are not supported by this PIM, so this upgrade path is not supported. It is recommended that you validate the PIM in your Performance Center environment to confirm that it supports the required functionalities.


Upgrading Performance Center to a newer version

Perform the following steps when the Performance Center server is upgraded to a newer version of Performance Center:

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

Perform the following steps to uninstall the ca.pc_pimA PIM:

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