Edge Documentation

This page documents the enPortal integration for Riverbed OPNET. 

* <b>Vendor</b>: Riverbed
* <b>Product</b>: OPNET
* <b>Supported Version(s)</b>: 2.2
* <b>Name of enPortal Integration Package</b>: riverbed.opnet_pimA
* <b>Required enPortal Version</b>: 4.6.1 and above


The following section documents supported platforms, installation, and configuration of the OPNET Product Integration Module on enPortal versions 4.6.1 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 OPNET PIM:
# Install AppBoard/enPortal as detailed in the [[Installation|Installation]] documentation
# Download the file riverbed.opnet_pimA.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 OPNET PIM 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_riverbed.opnet_pimA.txt"
# Under the <b>Advanced</b> tab, select <b>Explore System</b>
# Navigate to the /Directory/system/proxy/ folder and locate the “Manage Proxy” channel
# Right-click on the “Manage Proxy” channel and select <b>Open</b> to launch the channel
# In the Manage Proxy tool, click “Reset All”
# Refresh the browser


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

This application is built by using GWT (Google Web Toolkit) framework.

=== Configuration ===

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

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

=== Create Channels ===

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

# Click on the <b>Applications</b> tab
# Right-click on the name "sample" in the row for xxxappname 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 riverbed.opnet_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.  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 riverbed.opnet_pimA PIM, the AppBoard/enPortal license.properties file must include licensing for at least one riverbed.opnet_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 OPNET server.  The OPNET 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 OPNET 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" | OPNET Supported Versions
|-
| riverbed.opnet_pimA
| 4.6.1+
| 2.2
|}

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


== OPNET Upgrades ==

=== Upgrading from an older version of OPNET ===

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


=== Upgrading OPNET to a newer version === 

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

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

Perform the following steps to uninstall the riverbed.opnet_pimA PIM:

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