Skip to main content
Ask ChatGPT

Connection Crystal Reports

Aprimo Reporting API Overview​

The Aprimo Reporting API allows data from Aprimo list and summary reports to be used in Crystal Reports and other external reporting tools.

Limitations:

  • Does not support cross-tab reports or reports with charts.

Supported API Calls​

  • XML – Returns report data in XML format.
  • XSD – Returns schema data (XSD) for the report.
  • JSON – Returns report data in JSON format.
  • Crystal Reports requires XML/XSD endpoints.

Getting Started​

Initial Setup for Crystal Reports Integration​

  1. Configure Aprimo Prerequisites
  2. Configure Crystal Reports Prerequisites
  3. Expose a Report to the Reporting API
  4. Set Report Criteria & Parameters
  5. Configure URL Endpoints
  6. Create a Connection to the Aprimo API
  7. Generate a Crystal Report

To Expose a Report to the Reporting API​

  1. Expose the report in Aprimo
  2. Set report criteria & parameters
  3. Configure URL Endpoints
  4. Create a connection in Crystal Reports
  5. Generate a Crystal Report

To Run a Crystal Report​

  • Create a Crystal Report from a connected Aprimo report.

Aprimo Prerequisites​

Ensure the following are configured:

  • The mpm-web-service feature flag is activated.
  • The user has the necessary domain rights:
    • Analysis, Web Service Access Administration
    • Report, View
    • Report, Edit

Crystal Reports Prerequisites​

1. Install Java 1.8 or Later​

Aprimo uses TLS 1.2, which requires Java 1.8 or later.

2. Add Aprimo SSL Certificates to the Trusted Certificate Store​

Steps (Internet Explorer):

  1. Go to your Aprimo login page.
  2. Click the lock icon in the browser URL bar → View Certificates.
  3. On the Certification Path tab, double-click Trend Micro.
  4. Click the Details tab → Copy to File.
  5. Select DER encoded binary X.509 (.CER) format and save the file.
  6. Repeat for AffirmTrust Certificate Authority-ov1 and additional environments.

Steps (Chrome):

  1. Open Developer Tools → Security tab → View Certificate.
  2. Follow the same steps as above.

3. Import Certificates into Crystal Reports Trusted Keystore​

  1. Close Crystal Reports.
  2. Open a Command Prompt and navigate to the jre\bin folder.
  3. Run the following command (modify file paths as needed):
    keytool -import -alias cert1 -file "C:\temp\cert1.cer" -keystore "C:\path\to\cacerts" -storepass changeit
  1. Repeat for additional certificates.
  2. Restart Crystal Reports.

Expose a Report to the Reporting API​

  1. In Aprimo, go to Report List → Edit Report Details.
  2. Open the Web Service Access tab.
  3. Set Allow External Web Service Access to Yes.
  4. Save the changes and note the report ID & authentication token.

Set Report Criteria & Parameters​

Configure Report Criteria​

  1. In Report List, go to Edit Report Configuration → Criteria tab.
  2. Set criteria as needed, but note:
    • Operators like "Is equal to" are not supported for relative dates.
    • Run and save the report to apply changes.

Configure Parameters​

  1. In Report List, go to Edit Report Details → Parameters tab.
  2. Select checkboxes for criteria to expose via the API.
  3. The API only recognizes Attribute names.

Configure URL Endpoints​

An XML or XSD URL consists of:

  • Endpoint: https://[CustomerURL]/
  • Resource: /webapi/api/reports/{ReportID}/###.{Type}
    • Type can be XML or XSD
  • Parameters: ?Name=Value

Example XML URL:

https://aprimo.com/webapi/api/reports/2203.xml/?Status=Open&ActivityType=Activity+Type+1

Example XSD URL:

https://aprimo.com/webapi/api/reports/2203.xsd/

Create a Connection in Crystal Reports​

  1. Open Crystal Reports → File → New → Standard Report.
  2. In Available Data Sources, expand My Connections → XML and Web Services.
  3. Enter:
    • XML URL Endpoint
    • Report ID (User ID)
    • Authentication Token (Password)
  4. Enter XSD URL Endpoint → Finish.

Generate a Crystal Report​

  1. Open Crystal Reports → File → New → Standard Report.
  2. Expand My Connections → Select the correct connection.
  3. If parameters are required, enter values and click OK.
  4. Select Report Details/Row and add to Selected Tables.
  5. Select desired fields and configure:
    • Grouping
    • Sorting
    • Filters
  6. Click Finish → OK. The report is now generated.