IBM Enterprise Records, Version 5.1.2    

Defining the report

This task defines the report in the ReportDefinitions.xml file in the IBM® Enterprise Records server. This file is at <ier_install_path>\Config\ ReportDefinitions.xml. For example: C:\Program Files\IBM\EnterpriseRecords\Config\ReportDefinitions.xml.

Procedure

To Define the report in ReportDefinitions.xml:

  1. Open the ReportDefinitions.xml file in an XML editor.
  2. Add the <object key="reportDefinition"> under <list key="reportDefinitions">:
    <object key="reportDefinition">   
    	<setting key="id">42</setting>
     <setting key="title" localizationKey="server.report_title.42">Physical
    Records by Media Type Created within a Specific Period</setting>
     <setting key="desc" localizationKey="server.report_desc.42"> This
    report lists the physical records that were created within a specific
    period and with a specific media type.</setting>   
    	<setting key="url">RMViewReport.jsp</setting>   
    	<setting key="img">images/action/report.gif</setting>
     <setting key="reportName" localizationKey="server.report_name.42">Physical
    Records By Media Type Created.rpt</setting>   
    	<array key="excludedObjectStores"/>   
    	<list key="properties">   
    		<object key="property">   
    			<setting key="symbolicName">fileplan_browse</setting>    
    			<setting key="required">1</setting>   
    		</object>   
    		<object key="property">
      		<setting key="symbolicName">start_date</setting>  
     			<setting key="required">1</setting>   
    		</object>   
    		<object key="property">   
    			<setting key="symbolicName">end_date</setting>
       		<setting key="required">1</setting>   
    		</object> 
    		<object key="property">   <setting key="symbolicName">media_type</setting>
       		<setting key="required">1</setting>   
    		</object>   
    		<object key="property">   
    			<setting key="symbolicName">report_type</setting>
       		<setting key="required">0</setting>   
    		</object>   
    	</list> 
    </object>

    The XML nodes and values are as follows:

    • The id must be unique across all report definitions in the XML.
    • The id is used as part of a unique localizationKey. For example, localizationKey="server.report_title.42”
    • The title and description must be unique because they are shown in the IBM Enterprise Records web user interface.
    • The default values for url and img are RMViewReport.jsp, images.gif, action.gif, and report.gif. Do not change these values.
    • The report name must match the report template file name that you created in Crystal Report Designer, without the prefix of Detailed or Summary.
    • On the properties list, specify the exact same symbolic name as in the Content Platform Engine property template for each report parameter.
    • The last property must be report_type, which is used to show the Detailed or Summary option.
  3. Add this report to the data model. For example, If the FPOS uses the Base data model, add <value>42</value> to <array key="baseReports"> at the beginning of the XML file.
  4. Restart the web application server.


Feedback

Last updated: November 2013
example_define_report.htm

© Copyright IBM Corporation 2013