Modify report title and description

This topic describes how to modify:

At installation, the IBM InfoSphere Enterprise Records installer copies property resource bundle (PRB) files to <rm_install_path>\FileNet\RM\RecordsManager\WEB-INF\Resources. The PRB files are used for language localization and contain all reports that are shipped with IBM InfoSphere Enterprise Records. If the report you want to modify is shipped with IBM InfoSphere Enterprise Records, then you must modify the server.strings.<language>.<country>.prb file. See Change the report title and description in the PRB file.

If you want to modify a new report, then modify the ReportDefinitions.xml file using valid XML characters.

Change the report title and description in ReportDefinitions.xml

  1. Use an XML editor to open the ReportDefinitions.xml file located in the configuration folder for IBM InfoSphere Enterprise Records. (The default location is <rm_install_path>\FileNet\Config\RM.)
  2. Under <List key="reportDefinitions">, find <object key="reportDefinition"> for the report that you want to modify.
  3. Within the reportDefinition object key, modify the following tags, entering the appropriate values:

    <setting key="title" localizationKey="server.report_title.n">report name</setting>, where report name is the title of the report that IBM InfoSphere Enterprise Records displays.

    <setting key="desc" localizationKey="server.report_desc.n">description</setting>, where description is text that IBM InfoSphere Enterprise Records displays, briefly describing the purpose of the report. For example, "This report lists the volumes that were opened/closed within a specific period."

    NOTE n is the "id" value specified in the corresponding array for a report. Do not change this value unless you are creating a new report. See Add a new report to ReportDefinitions.xml.

  4. Save ReportDefinitions.xml.
  5. Restart the Web application server where IBM InfoSphere Enterprise Records runs.

Change the report title and description in the PRB file

  1. On the server where IBM InfoSphere Enterprise Records is installed, browse to <rm_install_path>\FileNet\RM\RecordsManager\WEB-INF\Resources.
  2. Use a text editor to open the PRB file for your environment.
  3. Search for server.report_title.n, and enter the title for this report.
  4. Search for server.report_desc.n, and enter the description for this report.

    NOTE n is the id value for the report specified in the corresponding data model array in the ReportDefinitions.xml file.

  5. Save the PRB file.
  6. Redeploy the IBM InfoSphere Enterprise Records application. For information about redeploying IBM InfoSphere Enterprise Records, see the IBM InfoSphere Enterprise Records Installation and Upgrade Guide.
  7. Restart the Web application server where IBM InfoSphere Enterprise Records runs for the changes to take effect.

Change the image file associated with a report

  1. If you want to use a new image file, copy the file to <rm_install_path>\FileNet\RM\RecordsManager\WEB-INF\Resources\images\action. Note that the image file must be in GIF format and the same pixel size as the default image files.
  2. Use an XML editor to open the ReportDefinitions.xml file located in the configuration folder for IBM InfoSphere Enterprise Records. (The default location is <rm_install_path>\FileNet\Config\RM.)
  3. Under <List key="reportDefinitions">, find <object key="reportDefinition"> for the report that you want to update with the image file.
  4. Within the reportDefinition object key, modify the following tag, entering the appropriate value:

    <setting key="img">relative path to image file</setting>. For example, images\action\report.gif.

  5. Save ReportDefinitions.xml.
  6. Restart the Web application server where IBM InfoSphere Enterprise Records runs for the changes to take affect.