IBM Enterprise Records, Version 5.1.2    

Creating a report

IBM® Enterprise Records includes more than 41 reports that provide a statistical view of different activities performed by users.

About this task

An administrator can create a report, in addition to the reports included in IBM Enterprise Records. For a list of all available reports, see the report configuration and prerequisites topic.

To create a report, complete these general steps:

Create new report criteria

Before you create new report criteria, review the ReportDefinitions.xml file because you can use existing criteria for your new report.

Procedure

To create new report criteria:

  1. On the Content Platform Engine server, open IBM Administration Console for Content Platform Engine.
  2. Create a new Content Platform Engine property template in IBM Administration Console for Content Platform Engine, using the Create a Property Template wizard. For details about creating the property template, see the Content Platform Engine online help and the context-sensitive help in the wizard.
  3. After you complete the wizard, go to the Other Classes/Custom Objects/Report Holdings in IBM Administration Console for Content Platform Engine.
  4. Add the new property template in the Report Holdings class.
  5. Add the new criteria to the ReportDefinitions.xml file. See the modifying ReportDefinitions.xml topic.

Results

Design a new report

To design a report:
  1. On the reports server, start Crystal Reports Designer.
  2. Select the Create a New Report option to start the Reports Creation wizard.
  3. When the wizard prompts you to create a connection between the database and Crystal Reports, select Create New Connection - JDBC to connect to the Content Platform Engine database.
    Note: The connection settings are configured in the CRConfig.xml file during IBM Enterprise Records installation. See the IBM Enterprise Records Installation and Upgrade Guide.
  4. When the wizard prompts you, enter the following information:
    • Data source (the object store you are accessing).
    • User ID and password of an account with access rights to the data source.
  5. After the wizard connects to the data source, you see a list of all of the classes in the object store. Select one or more of the classes, as needed, for your new report.
  6. Create a query based on the classes you selected in the wizard.

    If you want to include new criteria, enter parameter fields that exactly match the symbolic names you created for the new criteria.

    Your report uses the query to generate report results. For more information about using Crystal Reports Designer, see the Crystal Reports Designer online help.

  7. Save the new report in the same location as the Crystal Reports Application Server, using one of the following naming conventions:
    • Summary report name.rpt
    • Detailed report name.rpt

    For example, if the report name is classification action then save the report as Summary classification action.rptor Detailed classification action.rpt.IBM Enterprise Records requires each report to have two versions: Summary and Detailed. Therefore, you must create two Crystal Report templates for the same report name: one for the Summary report and the other for the Detailed report.

    The path for the location of the Crystal Reports Application Server is:

    <install drive>:\Program Files\Business Objects\Business Objects Enterprise 12.0\Samples\En\Reports.
  8. Exit from Crystal Reports Designer.

Modify ReportDefinitions.xml

To modify the MXL file:
  1. On the web application server where IBM Enterprise Records runs, use an XML editor to open the ReportDefinitions.xml file, in the configuration folder for IBM Enterprise Records. The default location is <ier_install_path>\Config.
  2. Add a value to the array that corresponds to the data model used in your FPOS, and make other required changes to the xml file. For more information, see the adding a report to ReportDefinitions.xml topic.
  3. Restart the web application server where IBM Enterprise Records runs for the changes to take effect.

Add report to PRB file

To add a report:
  1. On the server where IBM Enterprise Records is installed, browse to <ier_install_path>\RecordsManager\WEB-INF\lib.
  2. Use a text editor to open the server.strings.<language>.<country>.prb file for your environment in the p8RecordsManagerResources.jar.
  3. Enter the following text strings in the PRB file:
    localizationKey="server.report_title.n"=report name
    where report name is the title of the report that IBM Enterprise Records displays.
    localizationKey="server.report_desc.n"=description
    where description is text that IBM Enterprise Records displays, briefly describing the purpose of the report.

    n is the id value specified in the data model array in ReportDefinitions.xml. For more information, see the adding a report to ReportDefinitions.xml topic.

  4. Redeploy the IBM Enterprise Records application. For information about redeploying IBM Enterprise Records, see the IBM Enterprise Records Installation and Upgrade Guide.
  5. Restart the web application server where IBM Enterprise Records runs for the changes to take effect.


Feedback

Last updated: November 2013
create_report.htm

© Copyright IBM Corporation 2013