Integrations/hp/hp.sitescope pimA

Revision as of 19:15, 6 February 2014 by imported>Teri.roberts

This page documents the enPortal integration for HP SiteScope.

  • Vendor: HP
  • Product: SiteScope
  • Supported Version(s): 11.12
  • Name of enPortal Integration Package: hp.sitescope_pimA.jar
  • Required enPortal Version: 4.6.1+ (with support for Cookie Manager)


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

  1. Install AppBoard/enPortal as detailed in the Installation documentation
  2. Download the file hp.sitescope_pimA.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 hp.sitescope_pimA.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_hp.sitescope_pimA.txt"
  12. Under the Advanced tab, select Explore System
  13. Navigate to the /Directory/system/proxy/ folder and locate the “Manage Proxy” channel
  14. Right-click on the “Manage Proxy” channel and select Open to launch the channel
  15. In the Manage Proxy tool, click “Reset All”
  16. Refresh the browser

Integration Details

This sections provides special details for configuring the integration module after installation.


Channel Types

  • Home - Channel that displays the entry view of SiteScope Java Applet
  • Proxy - Channel that is used by the system to display SiteScope channel

Configuration

After installing the HP SiteScope PIM, perform the following steps to configure access to the host SiteScope server:

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


Create Channels

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

  1. Click on the Applications tab
  2. Right-click on the name "sample" in the row labeled "hp.sitescope_pimA" 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 hp.sitescope_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. Also follow the above section to configure the newly created channel. Select a different Channel Type in step 2 to create a different type of channel.


Custom Channel Settings

There are no custom channel settings for the HP SiteScope PIM.

Known Issues

One Java applet class on the SiteScope server will need to be modified to allow the applet proxied correctly in enPortal. The class contains "createDefaultConnectionProproperties" method. It is the class, hp.acm.swing.container.ACMBasicApplet, in swing-core.jar. 

// cp = ProxyUtils.createDefaultConnectionProproperties(codeBase.getHost(), getContextPath());
cp = ProxyUtils.createDefaultConnectionProproperties(codeBase.getHost(), codeBase.getPath());

It involves an effort to decompile the class and modify the source and compile the jar file.

License Usage

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

Version Support
Package Name enPortal Version HP SiteScope Version
hp.sitescope_pimA 4.6.1+ (with support for Cookie Manager) HP SiteScope Version 11.12
Template-tip.png
To see the current enPortal version, run the portal version command from the [Install_Home]/server/bin directory.


HP SiteScope Upgrades

Upgrading from an older version of HP SiteScope to HP SiteScope Version 11.12

Older versions of HP SiteScope are not supported by this PIM, so this upgrade path is not supported.


Upgrading from HP SiteScope Version 11.12 to a newer version of HP SiteScope

Perform the following steps when the HP SiteScope v11.12 server is upgraded to a newer version of HP SiteScope:

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

Perform the following steps to uninstall the hp.sitescope_pimA PIM:

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