Integrations/ca/concord.ehealth pimB

This page documents the enPortal integration for CA eHealth.

• Vendor: CA Technologies
• Product: eHealth [Concord]
• Supported Version(s): 6.2
• Name of enPortal Integration Package: ca.ehealth_pimB
• Required enPortal Version: 4.6.1 and above

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

1. Install AppBoard/enPortal as detailed in the Installation documentation
2. Download the file ca.ehealth_pimB.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 Choose File... button
6. Locate the ca.ehealth_pimB.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.ehealth_pimB.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

Channel Types

• Home - Channel that displays the top-level entry page of the CA eHealth application
• Proxy - Channel that is used by the system to display CA eHealth channels
• Report List - Display a list of 'reports', without the top-level tabs.
  • Parameter: fltrSubj
    • Label: Filter Subject
    • Description: Shows only the reports for the specified subject name. A report subject can be a group, group list, one or more elements. The valid values are the full name of the subject or the value every. The default is all.
    • Example: 'all'
    • URL Mapping: Maps to eHealth URL parameter 'fltrSubj'
  • Parameter: fltrRptType
    • Label: Report Type
    • Description: Shows only the reports of the specified report type. The valid values are 109002 - glance, 109007 - trend, 109008 - traffic, 109006 - topN, 109005 - service, 109003 - health, 109010 - whatIf, and 0 - all. The default is every.
    • Example: '0'
    • URL Mapping: Maps to eHealth URL parameter 'fltrRptType'
  • Parameter: fltrDate
    • Label: Filter Date Range
    • Description: Shows only the reports that were created for a specific time period. The valid values are 1 - today, 2 - prevHour, 3 - prev4hours, 4 - prev12hours, 5 - yesterday, 6 - thisWeek, 7 - lastWeek, 8 - thisMonth, 9 - lastMonth, and 0 - all. The default is all.
    • Example: '0'
    • URL Mapping: Maps to eHealth URL parameter 'fltrDate'
  • Parameter: fltrTech
    • Label: Filter Technology
    • Description: Shows only the reports for the specified technology type. The valid values are 105002 - application, 105003 - lanWan, 105011 - mobile wireless, 105001 - multiTechnology, 105008 - qos, 105004 - remoteAccess, 105005 - response, 105006 router/switch, 105007 - system, and 0 - all. The default is every. If you filter by a technology type and you show all report types, eHealth does not display Traffic Accountant reports.
    • Example: '0'
    • URL Mapping: Maps to eHealth URL parameter 'fltrTech'
  • Parameter: fltrSched
    • Label: Filter Schedule
    • Description: Shows only the reports created by the specified method. eHealth administrators can schedule reports to run automatically as well as run reports on demand from the eHealth console. Web users can run reports on-demand from the Web interface.
    • Example: '0'
    • URL Mapping: Maps to eHealth URL parameter 'fltrSched'
  • Parameter: sort
    • Label: Sort By
    • Description: The report list sort order.
    • Example: 'date'
    • URL Mapping: Maps to eHealth URL parameter 'sort'
  • Parameter: displayFilters
    • Label: Show Filters
    • Description: Specifies whether you want to show the report list filter options. If you specify yes, the page will show the report list filters, which allow the Web user to change the filter criteria and display other reports. If you specify no, the page will not show the report list filters. The default is no.
    • Example: 'no'
    • URL Mapping: Maps to eHealth URL parameter 'displayFilters'
  • Parameter: output
    • Label: Output Type
    • Description: Specifies whether you want display the report list in xml or html. Default is html.
    • Example: 'html'
    • URL Mapping: Maps to eHealth URL parameter 'output'
  • Parameter: TreeTargetFrame
    • Label: Target Frame
    • Description: Identifies a named frame the report should target: _top=topmost frame, crstop='top' of the channel, newframe= launch a new frame, or '_self'=current frame.

Configuration

After installing the CA eHealth PIM, perform the following steps to configure access to the host CA eHealth server:

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

Create Channels

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

1. Click on the Applications tab
2. Right-click on the name "sample" in the row for ca.ehealth_pimB 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.ehealth_pimB 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.ehealth_pimB PIM, the AppBoard/enPortal license.properties file must include licensing for at least one ca.ehealth_pimB 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 CA eHealth server. The CA eHealth 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 CA eHealth and compatible AppBoard/enPortal versions:

Version Support

Package Name	enPortal Version	CA eHealth Supported Versions
ca.ehealth_pimB	4.6.1+	6.2

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

CA eHealth Upgrades

Upgrading from an older version of CA eHealth

Older versions of CA eHealth are not supported by this PIM, so this upgrade path is not supported.

Upgrading CA eHealth to a newer version

Perform the following steps when the CA eHealth server is upgraded to a newer version of CA eHealth:

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

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

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