Edge Documentation

This page documents the enPortal integration for Entuity.

* <b>Vendor</b>: Entuity
* <b>Product</b>: Entuity (BMC Product Name:  Entuity Network Monitoring and Analytics for BMC ProactiveNet Performance Management, 9.5.00)
* <b>Supported Version(s)</b>: 12.5
* <b>Name of enPortal Integration Package</b>: entuity.entuity_pimB
* <b>Required enPortal Version</b>: 4.6.1 and above


The following section documents supported platforms, installation, and configuration of the Entuity 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|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 Entuity PIM:
# Install AppBoard/enPortal as detailed in the [[Installation|Installation]] documentation
# Download the file entuity.entuity_pimB.jar
# Start enPortal and login as an administrator
## User Name: administrator
## Password: administrator
## Domain: System
# Under the <b>Advanced</b> tab, select <b>PIMImport</b>
# Click the <b>Browse...</b> button
# Locate the Entuity package.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_entuity.entuity_pimB.txt"
# Due to the Java Webstart application (Component Viewer) in Entuity. AppBoard/enPortal will need to be re-started to allow the supported jars to be loaded into the system

== Installation of ComponentViewer (Java Websart) ==
A modified ComponentViewer Java Webstart application is part of the pim package. The jars are modified to support SSO functionality. They are deployed in ${AppboardHome}/server/webapps/enportal/pkg/entuity/entuity_pimB/lib directory. The jars require to be signed. The default jars are signed with a self-signed certificate with six month validity from 1/30/2013. Therefore, to make it fully functional, the jars will need to be re-signed in the production environment. Edge will provide scripts and assist in re-signing the jars.
*for the development environment, 
##use Java's keytool utility to generate a self-signed certificate 
         to sign the jar. 

          For more information, please refer to this page                  
          http://java.sun.com/javase/6/docs/technotes/guides/plugin/developer_guide/extensions_example.html

          For example:

          You can create a keystore called thawte.p12 with the same 
          password, mypass, for both storepass and keypass and keystore 
          alias "Sun Microsystems Inc.'s Thawte Consulting cc ID"  
          by running the following steps:
            - Open a command prompt and cd to $JavaHome\bin.
            - Run the following command
             $JavaHome\bin\>keytool -genkey -alias "Sun Microsystems Inc.'s Thawte Consulting cc ID" -keypass mypass -keystore c:\temp\thawte.p12 -storetype pkcs12 -storepass mypass 
##Then sign the jar files with the following custom command delivered with the PIM.  
             $PortalHome\bin> sign <absolute path of keystore> <storepass> <keypass> <storetype> <alias>

          Continuing from the example in part a, the command to sign the jar files would be
            - Open a command prompt and cd to $JavaHome\bin.
            - Run the following command
              $PortalHome\bin> sign c:\temp\thawte.p12 mypass mypass pkcs12 "Sun Microsystems Inc.'s Thawte Consulting cc ID"

*for the production environment, 
##use Java's keytool utility to import the valid certificate to the
keystore by using -import option of keytool command. 
##After successful importing, run the sign command with the parameters of your keystore as in the self-signed case above.

== Known Issues with running ComponentViewer in Appboard/enPortal ==
# ComponentViewer can not be launched more than once in one portal user session. The 2nd launch in one portal session results in the communication failure between the ComponenentViewer client and Appboard/enPortal. This is caused by Java webstart client lose the Appboard/enPortal session cookie for the 2nd launch. This is related to Java webstart's default caching behavior.
# To work around the above issue, a user can turn off the Java caching. Here is the instruction. Open up the Java Control Panel, on the General tab, select Settings in the Temporary Internet Files section. From there, make sure the checkbox next to the "Keep temporary files on my computer" option is off.

=== Channel Types ===

* Proxy - Channel that is used by the system to display Entuity channels
* Home - Channel that displays the top-level entry page of the Entuity application
* HomeHTML - Channel that displays the top-level entry page without ComponentViewer Java Webstart support (The navigation bar does not show the option to launch ComponentViewer.)
* ComponentViewer - Channel that directly launches ComponentViewer Java Webstart application.

=== Configuration ===

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

# Click on the <b>Applications</b> tab
# Right-click on the name "sample" in the row for entuity.entuity_pimB and select "Modify"
# Fill in the items in the <b>Modify Application Wizard</b> dialog:
## Select the protocol used to access your Entuity server (http or https)
## Change the host name from "changeme" to the hostname or ip address that will resolve to your Entuity server
## Change the port to the port number of your Entuity server
## Click "Save" to keep your changes
# Click on the <b>Integrations</b> tab
# In the Explorer, under Packages, expand the entuity.entuity_pimB tree and click on the <b>Sample</b> target.  Confirm that the information you entered is displayed for your Entuity server
# Under the <b>Sample</b> target, click on the <b>HomeHTML</b> channel.  A login prompt should be displayed.
# Log in using the same credentials you would use for accessing the Entuity application in a browser.  Confirm that the Entuity Home page is displayed.
# To support ComponentViewer, the port 12321 need to be open in network. The port is used by ComponentViewer to communicate with the server. Therefore, this port needs to be open on Appboard/enPortal server. It should also be open between Appboard/enPortal and Entuity servers.

=== Create Channels ===

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

# Click on the <b>Applications</b> tab
# Right-click on the name "sample" in the row for entuity.entuity_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 entuity.entuity_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.

== Entuity Upgrades ==

=== Upgrading from an older version of Entuity ===

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


=== Upgrading Entuity to a newer version === 

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

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

Perform the following steps to uninstall the entuity.entuity_pimB PIM:

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