Edge Documentation

Latest revision as of 04:06, 25 July 2014

This page documents the enPortal integration for Spectrum, OneClick Console.

Vendor: CA Technologies
Product: Spectrum, OneClick Console
Supported Version(s): 9.2.3
Name of enPortal Integration Package: ca.spectrum_pimB
Required enPortal Version: 4.6.1 and above

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

Install AppBoard/enPortal as detailed in the Installation documentation
Download the file ca.spectrum_pimB.jar
Start enPortal and login as an administrator
1. User Name: administrator
2. Password: administrator
3. Domain: System
Under the Advanced tab, select PIMImport
Click the Browse... button
Locate the Spectrum PIM JAR file in the Open dialog
Click the Start button to extract the files from the PIM .jar archive
Under the Advanced tab, select XMLImport
Click the Start button to load the PIM into the system
Confirm that the following message is displayed: "Import completed; loaded the following file(s): load_ca.spectrum_pimB.txt"
Under the Advanced tab, select Explore System
Navigate to the /Directory/system/proxy/ folder and locate the “Manage Proxy” channel
Right-click on the “Manage Proxy” channel and select Open to launch the channel
In the Manage Proxy tool, click “Reset All”
Refresh the browser
Due to the Java Webstart application (OneClick) in Spectrum. AppBoard/enPortal will need to be re-started to allow the supported jars to be loaded into the system

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 Spectrum channels (no custom configuration required)

OneClick - Channel that launches OneClick Java Webstart application.

Configuration

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

Click on the Applications tab
Right-click on the name "sample" in the row for CA Spectrum OneClick and select "Modify"
Fill in the items in the Modify Application Wizard dialog:
1. Select the protocol used to access your Spectrum server (http or https)
2. Change the host name from "changeme" to the hostname or ip address that will resolve to your Spectrum server
3. Change the port to the port number of your Spectrum server
4. Click "Save" to keep your changes
Click on the Integrations tab
In the Explorer, under Packages, expand the ca.spectrum_pimB tree and click on the Sample target. Confirm that the information you entered is displayed for your Spectrum server
Under the Sample target, click on the Home channel. A login prompt should be displayed.
Log in using the same credentials you would use for accessing the Spectrum application in a browser. Confirm that the Spectrum Home page is displayed.

Create Channels

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

Click on the Applications tab
Right-click on the name "sample" in the row for CA Spectrum OneClick and select a channel type
In the "Channel Name" box, enter the name you want to give to the new channel
For "Channel Type", select "3rd Party Pims"
Click Next
Click Finish
Click on the Integrations tab
In the Explorer, under Packages, expand the ca.spectrum_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:

The SSO token needs to be provisioned in advance in order for OneClick channel to launch successfully. If attempting to launch a OneClick channel without SSO token provisioned, an error message will be prompted. "The resource at <enPortal host> was not found. Could not complete the authorization."

The JRE requirements for OneClick (our current version) is to have the 32 bit version 1.6.0_35 or higher of Java installed. Note, it has to be 32 bit and it will not run in a 64 bit version of JRE.

License Usage

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

*Version Support*
Package Name	enPortal Version	Spectrum Supported Versions
ca.spectrum_pimB	4.6.1+	9.2.3

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

Spectrum Upgrades

Upgrading from an older version of Spectrum

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

Upgrading Spectrum to a newer version

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

Check the AppBoard/enPortal PIM online documentation to see if the new Spectrum version is supported by the existing ca.spectrum_pimB PIM.
1. To test if the new Spectrum 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 Spectrum server and select "Modify"
  3. Update the protocol, host, and port to reference the server where the new version of Spectrum is running
2. If the new Spectrum 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 Spectrum 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.spectrum_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.spectrum_pimB PIM:

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