Integrations/emc/watch4net.apg pimA

This page documents the enPortal integration for Watch4Net APG.

• Vendor: Watch4Net
• Product: APG
• Supported Version(s): 5.x
• Name of enPortal Integration Package: watch4net.apg_pimA
• Required enPortal Version: 4.6.1-20090826.0310 and above

This page documents the enPortal integration for Watch4Net APG 5.x.

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 watch4net.apg_pimA PIM:

1. Install AppBoard/enPortal as detailed in the Installation documentation
2. Download the file watch4net.apg_pimA.jar
3. Start AppBoard
4. Log in to AppBoard as an administrator
   1. User Name: administrator
   2. Password: administrator
   3. Domain: System
5. Under the Advanced tab, select PIMImport
6. Click the Browse button
7. Locate the watch4net.apg_pimA.jar file in the Open dialog
8. Click the Start button to extract the files from the PIM .jar archive
9. Under the Advanced tab, select XMLImport
10. Click the Start button to load the PIM into the system
11. Confirm that the following message is displayed: "Import completed; loaded the following file(s): load_watch4net.apg_pimA.txt"

Integration Details

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

Channel Types

• Home - Channel that displays the top-level Home page of the APG application
• Proxy - Channel that is used by the system to display APG channels
• Report - Channel that displays a specific report specified by "select" parameter provided by the APG application

Configuration

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

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

Create Channels

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

1. Click on the Applications tab
2. Right-click on the name "sample" in the list and select a channel type
3. In the "Channel Name" box, enter the name you want to give to the new channel
4. For "Channel Type", select "3rd Party Pims"
5. Click Next
6. Click Finish
7. Click on the Integrations tab
8. In the Explorer, under Packages, expand the watch4net.apg_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
  • The Home channel does not have any custom fields
• Proxy
  • The Proxy channel does not have any custom fields
• Report
  • The Report channel has "select" field. The select is a HEX string used by APG to identify a specific report.

Known Issues

There are currently not any known issues with the watch4net.apg_pimA PIM.

License Usage

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

Version Support

Package Name	enPortal Version	APG Version
watch4net.apg_pimA	5.0	5.x

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

APG Upgrades

Upgrading from an older version of APG to APG 5.x

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

Upgrading from APG 5.x to a newer version of APG

Perform the following steps when the APG 5.x server is upgraded to a newer version of APG:

1. Check the AppBoard/enPortal PIM online documentation to see if the new APG version is supported by the existing watch4net.apg_pimA PIM
   1. If the new APG 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 APG server and select "Modify"
      3. Update the protocol, host, and port to reference the server where the new version of APG is running
   2. If the new APG 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 APG 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 watch4net.apg_x PIM will break all of the channels in your AppBoard/enPortal system that reference this integration.

Perform the following steps to uninstall the watch4net.apg_x PIM:

1. Click on the Integrations tab
2. In the Explorer, under Packages, locate the watch4net.apg_pimA integration
3. Right click on the integration name, and select "Delete"
4. Click "Ok" to confirm that you want to delete the integration package