Edge Documentation

This page documents the enPortal integration for HP Service Manager.

* <b>Vendor</b>: HP
* <b>Product</b>: Service Manager
* <b>Supported Version(s)</b>: 9.2
* <b>Name of enPortal Integration Package</b>: hp.sm_pimB.jar
* <b>Required enPortal Version</b>: 4.5.2-20070711.0230 and above


The following section documents supported platforms, installation, and configuration of the HP Service Manager Product Integration Module on enPortal versions 5.0 and above.  


== Support Matrix ==
The following platforms are supported:


=== Operating System ===
Please see the list of supported Operating Systems on the [[System_Requirements|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|System Requirements]] page.


== Installation ==

Perform the following steps to install the HP Service Manager PIM:
# Install AppBoard/enPortal as detailed in the [[Installation|Installation]] documentation
# Download the file hp.sm_pimB.jar
# Start AppBoard
# Log in to AppBoard as an administrator
## User Name: administrator
## Password: administrator
## Domain: System
# Under the <b>Advanced</b> tab, select <b>PIMImport</b>
# Click the <b>Choose File</b> button
# Locate the hp.sm_pimB.jar file in the Open dialog
# Click the <b>Start</b> button to extract the files from the PIM .jar archive
# Under the <b>Advanced</b> tab, select <b>XMLImport</b>
# 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_hp.sm_pimB.txt"


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


=== Channel Types ===

* Home - Channel that displays the user's Home page
* Proxy - Channel that displays the proxy for Service Manager


=== Configuration ===

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

# Click on the <b>Applications</b> tab
# Right-click on the name "sample" in the row labeled "hp.sm_pimB" and select "Modify"
# Fill in the items in the <b>Modify Application Wizard</b> dialog:
## Select the protocol used to access your Service Manager server (http or https)
## Change the host name from "changeme" to the hostname or ip address that will resolve to your Service Manager server
## Change the port from "80" to the port number of your Service Manager server
## Click "Save"
# Click on the <b>Integrations</b> tab
## Confirm target information: In the Explorer, under Packages, expand the hp.sm_pimB tree and click on the <b>Sample</b> target.  Confirm that the information you entered is displayed for your HP Service Manager server
## Configure appRoot (application context) information in Authentication definition: In the Explorer, under Packages, expand the hp.sm_pimB tree and click on the <b>hp.sm_pimB</b> Authentication Definition (purple icon).  Update appRoot information. appRoot is the application context where Service Manager is running under. For example, if your Service Manager instance is running as "http://servicemanager:80/sm/index.do", you will enter appRoot as "sm". Click on "Save" to save the changes.
# Configure <b>Home</b> channel.
## Configure appRoot (application context) information in the channel: Right-click on <b>Home</b> channel, update "Application Root Directory" with your Service Manager's application context. 
## Configure showHeader value. This is a flag to indicate whether HP Service Manager's header logo area will be shown or not inside portal's channel frame.
## Configure clientType (Web Client Type): Service Manager v9.2 provides four client types: index.do, ess.do, accessible.do, accessible_ess.do. Set the one that you intend to use.
## Click on "Save" to save the changes.
# Launching the <b>Home</b> channel.
## Under the <b>Sample</b> target, click on the <b>Home</b> channel.  A login prompt should be displayed.
## In the login prompt, enter the username and password along with the correct appRoot and clientType information. clientType should be consistent with the Home channel's web client type.
## Click on "OK" or the <enter> key.
# Confirm that the HP Service Manager Home page of the specified client type is displayed.


=== Create Channels ===

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

# Click on the <b>Applications</b> tab
# Right-click on the name "sample" in the row labeled "hp.sm_pimB" 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 <b>Next</b>
# Click <b>Finish</b>
# Click on the Integrations tab
# In the Explorer, under Packages, expand the hp.sm_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. Also follow the above "Configure <b>Home</b> channel" 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 Service Manager PIM.


=== Known Issues ===

There are no known issues associated with this PIM:


=== License Usage ===

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

{| class="wikitable" border="1" style="background-color:#eeeeee;"
|+ align="bottom" style="color:#e76700;" |''Version Support''
|-
! width="150" | Package Name
! width="150" | enPortal Version
! width="150" | HP Service Manager Version
|-
| hp.sm_pimB
| 5.0+
| HP Service Manager version 9.2
|}

{{Tip|To see the current enPortal version, run the <tt>portal version</tt> command from the <tt>[Install_Home]/server/bin</tt> directory.}}


== HP Service Manager Upgrades ==

=== Upgrading from an older version of HP Service Manager to HP Service Manager 9.2 ===

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


=== Upgrading from HP Service Manager 9.2 to a newer version of HP Service Manager === 

Perform the following steps when the HP Service Manager 9.2 server is upgraded to a newer version of HP Service Manager:

# Check the AppBoard/enPortal PIM online documentation to see if the new HP Service Manager version is supported by the existing hp.sm_pimB PIM
## If the new HP Service Manager version is supported by the existing PIM that you have installed, perform the following steps:
### Click on the <b>Applications</b> tab
### Right-click on the row for the old HP Service Manager server and select "Modify"
### Update the protocol, host, and port to reference the server where the new version of HP Service Manager is running
## If the new HP Service Manager version is not supported by the existing PIM that you have installed, perform the following steps to upgrade the PIM:
### Download the new PIM version from the PIM download site
### Follow the steps in the Installation section above to install and configure the new PIM version
### Re-create all HP Service Manager channels to reference the new PIM
### [Optional] Perform the steps outlined in the Uninstall section below to remove the old PIM from the system


== Uninstall ==

{{Warning|Uninstalling the hp.sm_pimB PIM will break all of the channels in your AppBoard/enPortal system that reference this integration.}}

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

# Click on the <b>Integrations</b> tab
# In the Explorer, under Packages, locate the hp.sm_pimB integration
# Right click on the integration name, and select "Delete"
# Click "Ok" to confirm that you want to delete the integration package