This topic describes how to modify title and description
of each report that IBM® Enterprise
Records displays, and change the image file associated with a report.
About this task
At installation, the IBM Enterprise
Records packaged property resource
bundle (PRB) files into the p8RecordsManagerResources.jar file in theier_install_path\RecordsManager\WEB-INF\lib. The PRB files are used for language globalization and contain all
reports that are shipped with IBM Enterprise
Records. If the report you want to modify is shipped with IBM Enterprise
Records, then you must modify
the server.strings.language.country.prb file in p8RecordsManagerResources.jar.
If you want to modify a new report, then modify the ReportDefinitions.xml file using valid XML characters.
Procedure
To change the report title and description in ReportDefinitions.xml:
- Use an XML editor to open the ReportDefinitions.xml file in the configuration folder for IBM Enterprise
Records. (The default location
is <rm_install_path>\config.)
- Under <List key="reportDefinitions">, find <object key="reportDefinition"> for the
report that you want to modify.
- 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 Enterprise
Records displays.
<setting key="desc" localizationKey="server.report_desc.n">description</setting>
where
description is text that
IBM 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.
n is the ID value specified in the corresponding array for a report.
Do not change this value unless you are creating a report.
- Save ReportDefinitions.xml.
- Restart the web application server where IBM Enterprise
Records runs.
Results
To change the report title and description in the PRB file:
- On the server where IBM Enterprise
Records is installed, browse to ier_install_path\RecordsManager\WEB-INF\lib.
- Copy the p8RecordsManagerResources.jar file
to a temporary folder.
- From the temporary folder, extract the server.strings.<language>.<country>.prb file for your environment from the p8RecordsManagerResources.jar.
- Use a text editor to open the PRB file.
- Search for server.report_title.n, and enter the title for this
report.
- Search for server.report_desc.n, and enter the description for
this report. n is the ID value for the report specified in
the corresponding data model array in the ReportDefinitions.xml file.
- Save the PRB file.
- Update the p8RecordsManagerResources.jar with
the modified PRB file. The PRB file packaged in the p8RecordsManagerResources.jar must have the path com\filenet\rm\apps\server\util.
Important: The PRB file packaged in the p8RecordsManagerResources.jar must be extracted to the com\filenet\rm\apps\server\util directory and repackaged with the directory path, as indicated in
the path column of the p8RecordsManagerResources.jar.
- Copy the modified p8RecordsManagerResources.jar from the temporary folder back to ier_install_path\RecordsManager\WEB-INF\lib.
- Redeploy the IBM Enterprise
Records application. For information about redeploying IBM Enterprise
Records, see the IBM Enterprise
Records Installation and Upgrade Guide.
- Restart the web application server where IBM Enterprise
Records runs for the changes to
take effect.
To change the image file associated with a report:
- If you want to use a new image file, copy the file to ier_install_path\RecordsManager\images\action. The image file must be in GIF format and the same pixel size as
the default image files.
- 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.
- Under <List key="reportDefinitions">, find <object key="reportDefinition"> for the report that you
want to update with the image file.
- 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.
- Save ReportDefinitions.xml.
- Restart the web application server where IBM Enterprise
Records runs for the changes to
take effect.