Edge Documentation

{{DISPLAYTITLE:VMware Ops Center pimA}}
[[Category:Integrations]]This page documents the enPortal integration for VMware Ops Center.

* <b>Vendor</b>: VMware
* <b>Product</b>: Ops Center
* <b>Supported Version(s)</b>: 1.0
* <b>Name of enPortal Integration Package</b>: vmware.vcops._pimA
* <b>Required enPortal Version</b>: 4.6.1 and above (with support for cookie manager)


The following section documents supported platforms, installation, and configuration of the VMware Ops Center 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 VMware Ops Center PIM:
# Install AppBoard/enPortal as detailed in the [[Installation|Installation]] documentation
# Download the file vmware.vcops._pimA.jar
# Start AppBoard/enPortal
# Log in to AppBoard/enPortal 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 vmware.vcops._pimA.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_vmware.vcops._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 ==
This sections provides special details for configuring the integration module after installation.


=== Channel Types ===

* Home - Channel that displays the Home screen of the application


=== Configuration ===

After installing the VMware Ops Center PIM, perform the following steps to configure access to the host VMware Ops Center server:

# Click on the <b>Applications</b> tab
# Right-click on the name "sample" in the row labeled "vmware.vcops_pimA" and select "Modify"
# Fill in the items in the <b>Modify Application Wizard</b> dialog:
## Select the protocol used to access your VMware Ops Center server (http or https)
## Change the host name to the hostname or ip address that will resolve to your VMware Ops Center server
## Change the port to the port number of your VMware Ops Center server
# Click on the <b>Integrations</b> tab
# In the Explorer, under Packages, expand the vmware.vcops_pimA tree and click on the <b>Sample</b> target.  Confirm that the information you entered is displayed for your VMware Ops Center 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 VMware Ops Center application in a browser.  Confirm that the VMware Ops Center Home page is displayed.


=== Create Channels ===

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

# Click on the <b>Applications</b> tab
# Right-click on the name "sample" in the row labeled "vmware.vcops_pimA" 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"
# For "Type of PIM", select the appropriate values:
## Pim: "vmware.vcops_pimA"
## Class: The channel type to build (for example, "Home")
## Target: "sample"
# Click <b>Next</b>
# Click <b>Finish</b>
# Click on the Integrations tab
# In the Explorer, under Packages, expand the vmware.vcops_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.


==== Custom Channel Settings ====

* Home Channel
** resourceid Settings
*** The format of resourceid is a 5-digit string.  It is passed in the Home channel to display resource details.
*** Example: resourceid = 22755


=== 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 vmware.vcops_pimA PIM, the AppBoard/enPortal license.properties file must include licensing for at least one vmware.vcops_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 VMware Ops Center server.  The VMware Ops Center 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 VMware Ops Center 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" | VMware Ops Center Supported Versions
|-
| vmware.vcops_pimA
| 4.6.1+
| 1.0
|}

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


== VMware Ops Center Upgrades ==

=== Upgrading from an older version of VMware Ops Center to VMware Ops Center v1.0 ===

Older versions of VMware Ops Center are not supported by this PIM, so this upgrade path is not supported


=== Upgrading from VMware Ops Center v1.0 to a newer version of VMware Ops Center === 

Perform the following steps when the VMware Ops Center server is upgraded to a newer version of VMware Ops Center:

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

Perform the following steps to uninstall the vmware.vcops_pimA PIM:

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