Crystal Reports pimB

Revision as of 16:04, 7 October 2013 by imported>Teri.roberts (Created page with 'This page documents the enPortal integration for xxxproduct. * <b>Vendor</b>: xxxvendor * <b>Product</b>: xxxproduct * <b>Supported Version(s)</b>: xxxversion * <b>Name of enPo…')
(diff) ← Older revision | Latest revision (diff) | Newer revision → (diff)

This page documents the enPortal integration for xxxproduct.

  • Vendor: xxxvendor
  • Product: xxxproduct
  • Supported Version(s): xxxversion
  • Name of enPortal Integration Package: xxxpackage
  • Required enPortal Version: 4.6.1 and above


The following section documents supported platforms, installation, and configuration of the xxxproduct 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 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 xxxproduct PIM:

  1. Install AppBoard/enPortal as detailed in the Installation documentation
  2. Download the file xxxpackage.jar
  3. Start enPortal and login as an administrator
    1. User Name: administrator
    2. Password: administrator
    3. Domain: System
  4. Under the Advanced tab, select PIMImport
  5. Click the Browse... button
  6. Locate the xxxproduct PIM JAR file in the Open dialog
  7. Click the Start button to extract the files from the PIM .jar archive
  8. Under the Advanced tab, select XMLImport
  9. Click the Start button to load the PIM into the system
  10. Confirm that the following message is displayed: "Import completed; loaded the following file(s): load_xxxpackage.txt"
  11. Under the Advanced tab, select Explore System
  12. Navigate to the /Directory/system/proxy/ folder and locate the “Manage Proxy” channel
  13. Right-click on the “Manage Proxy” channel and select Open to launch the channel
  14. In the Manage Proxy tool, click “Reset All”
  15. 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 xxxproduct channels (no custom configuration required)


Configuration

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

  1. Click on the Applications tab
  2. Right-click on the name "sample" in the row for xxxappname and select "Modify"
  3. Fill in the items in the Modify Application Wizard dialog:
    1. Select the protocol used to access your xxxproduct server (http or https)
    2. Change the host name from "changeme" to the hostname or ip address that will resolve to your xxxproduct server
    3. Change the port to the port number of your xxxproduct server
    4. Click "Save" to keep your changes
  4. Click on the Integrations tab
  5. In the Explorer, under Packages, expand the xxxpackage tree and click on the Sample target. Confirm that the information you entered is displayed for your xxxproduct 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 xxxproduct application in a browser. Confirm that the xxxproduct Home page is displayed.


Create Channels

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

  1. Click on the Applications tab
  2. Right-click on the name "sample" in the row for xxxappname 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 xxxpackage 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 xxxpackage PIM, the AppBoard/enPortal license.properties file must include licensing for at least one xxxpackage 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 xxxproduct server. The xxxproduct 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 xxxproduct and compatible AppBoard/enPortal versions:

Version Support
Package Name enPortal Version xxxproduct Supported Versions
xxxpackage 4.6.1+ xxxversion
Template-tip.png
To see the current enPortal version, run the portal version command from the [AppBoard_Home]/server/bin directory.


xxxproduct Upgrades

Upgrading from an older version of xxxproduct

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


Upgrading xxxproduct to a newer version

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

  1. Check the AppBoard/enPortal PIM online documentation to see if the new xxxproduct version is supported by the existing xxxpackage PIM.
    1. To test if the new xxxproduct 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 xxxproduct server and select "Modify"
      3. Update the protocol, host, and port to reference the server where the new version of xxxproduct is running
    2. If the new xxxproduct 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 xxxproduct 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

Template-warning.png
Uninstalling the xxxpackage PIM will break all of the channels in your AppBoard/enPortal system that reference this integration.

Perform the following steps to uninstall the xxxpackage PIM:

  1. Click on the Integrations tab
  2. In the Explorer, under Packages, locate the xxxpackage integration
  3. Right click on the integration name, and select "Delete"
  4. Click "Ok" to confirm that you want to delete the integration package
Retrieved from "http://ab.edge-technologies.com/docs/index.php?title=Crystal_Reports_pimB&oldid=4931"