SAP Crystal Reports [Business Objects] pimB

< integrations

This page documents the enPortal integration for SAP Crystal Reports [Business Objects].

  • Vendor: SAP
  • Product: SAP Crystal Reports [Business Objects]
  • Supported Version(s): 2010 v14 (14.0.2)
  • Name of enPortal Integration Package: sap.businessobjects.crystalreports_pimB
  • Required enPortal Version: 4.6.1 and above


The following section documents supported platforms, installation, and configuration of the Crystal Reports Product Integration Module on enPortal versions 4.6.1 and above.

Page Contents

1. Support Matrix

The following Operating System, Database, and Web Browser platforms are supported:


1.1. Operating System

Please see the list of supported Operating Systems on the System Requirements page.


1.2. 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.


1.3. Web Browser

Please see the list of supported Web Browsers on the System Requirements page.


2. Installation

Perform the following steps to install the Crystal Reports PIM:

  1. Install AppBoard/enPortal as detailed in the Installation documentation
  2. Download the file sap.businessobjects.crystalreports_pimB.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 Crystal Reports 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_sap.businessobjects.crystalreports_pimB.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


3. Integration Details

The following sections provide special details for configuring the integration module after installation.


3.1. Channel Types

  • BILaunchPad - Channel that displays the BI Launch Pad's entry page. (URI: /BOE/BI)
  • CentralManagementConsole - Channel that displays Central Management Console. (URI: /BOE/CMC)
  • Home - Channel that displays the default Home page for the logged in user, this channel can be configured to show a report by using OpenDocument utility (URI: /BOE/OpenDocument). There are three pre-built channels that show how to access a report directly (rptNoParameter, rptParameterMulti, rptParameterSinger)
  • Proxy - Channel that is used by the system to display Crystal Reports channels (no custom configuration required)


3.2. Configuration

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

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


3.3. Create Channels

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

  1. Click on the Applications tab
  2. Right-click on the name "sample" in the row for sap.businessobjects.crystalreports_pimB 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 sap.businessobjects.crystalreports_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.


3.4. Known Issues

The following known issues are associated with this PIM:

  • The Single Sign On for this application is handled in runtime handler not in resolver due to the complex parameters it requires to log on.
  • There are different options for authenticate this user, ENTERPRISE and LDAP. It is likely CMC is using ENTERPRISE and BI and OpenDocument utilities are using LDAP. By using runtime handler to do the single sign on hide the complexity of this. All a portal administrator needs to do is to provision username / password in SSO token.


3.5. License Usage

In order for the AppBoard/enPortal administrator to configure the sap.businessobjects.crystalreports_pimB PIM, the AppBoard/enPortal license.properties file must include licensing for at least one sap.businessobjects.crystalreports_pimB 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 Crystal Reports server. The Crystal Reports application must be licensed to support the number of users that will be accessing the application through AppBoard/enPortal.


3.6. Version Support

The following matrix details the supported Crystal Reports and compatible AppBoard/enPortal versions:

Version Support
Package Name enPortal Version Crystal Reports Supported Versions
sap.businessobjects.crystalreports_pimB 4.6.1+ 14.0.2
To see the current enPortal version, run the portal version command from the [AppBoard_Home]/server/bin directory.


4. Crystal Reports Upgrades

4.1. Upgrading from an older version of Crystal Reports

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


4.2. Upgrading Crystal Reports to a newer version

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

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


5. Uninstall

Uninstalling the sap.businessobjects.crystalreports_pimB PIM will break all of the channels in your AppBoard/enPortal system that reference this integration.

Perform the following steps to uninstall the sap.businessobjects.crystalreports_pimB PIM:

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