You can modify the special report criteria that a user
selects or enters to generate a report.
About this task
The special report criteria include:
- Entity types, such as categories, folders, and records.
- Classification actions, such as upgrading, downgrading, and declassification.
Specify entity types as criteria in a report
Procedure
To specify entity types as criteria in a report:
- Open the ReportDefinition.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 modify.
- Under <object key="reportDefinition">, locate <list key="properties">.
- Under the properties list key, add the entity_type symbolic
name, followed by the "required" setting key (1=required, 0=not required).
For example:
<object key="property">
<setting key="symbolicname">entity_type</setting>
<setting key="required">1</setting>
- Add <list key="values"> where you enter
the entity types that a user can select to include in the report.
For example:
<list key="values">
<object key="value">
<setting key="id">EntityType</setting>
<setting key="value" localizationKey=serve.report_n.EntityType">Entity</setting>
</object>
where
- EntityType is RecordCategory, RecordFolder,
or Record. You can include all three entity types, but you must enclose
each in separate <object key="value"> tags.
- n is the number identified in Step 3 earlier.
- Entity is Record Category, Record Folder, or
Record.
For example, if your report includes statistics about Record
Categories and Record Folders, this section of the XML file is similar
to the following example:
<object key="property">
<setting key="symbolicname">entity_type</setting>
<setting key="required">1</setting>
<list key="values">
<object key="value">
<setting key="id">RecordCategory</setting>
<setting key="value" localizationKey=serve.report_42.RecordCategory">Record Category</setting>
</object>
<object key="value">
<setting key="id">RecordFolder</setting>
<setting key="value" localizationKey=serve.report_42.RecordFolder">Record Folder</setting>
</object>
</list>
</object>
Results
To specify classification actions in a report
- Open the ReportDefinition.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 modify.
- Under <object key="reportDefinition">, locate <list key="properties">.
- Under the properties list key, add the classification_action symbolic
name, followed by the required setting key (1=required, 0=not required).
For example:
<object key="property">
<setting key="symbolicname">classification_action</setting>
<setting key="required">1</setting>
- Add <list key="values"> where you enter the
classification actions that a user can select to include in a report.
For example:
<list key="values">
<object key="value">
<setting key="id">ClassificationAction</setting>
<setting key="value" localizationKey=serve.report_n.ClassificationAction">ClassificationAction</setting>
</object>
where
- ClassificationAction is Upgrading, Downgrading,
or Declassification. You can include all three classification actions,
but you must enclose each in separate <object key="value"> tags.
- n is the ID value of this report in the array
for the data model.
- Content engine uses the localizationKey for translation into the
local language.
For example, if your report includes statistics about
downgrading and declassification actions, this section of the XML
file is similar to the following example:
<object key="property">
<setting key="symbolicname">classification_action</setting>
<setting key="required">1</setting>
<list key="values">
<object key="value">
<setting key="id">Downgrading</setting>
<setting key="value" localizationKey=serve.report_42.Downgrading">Downgrading</setting>
</object>
<object key="value">
<setting key="id">Declassification</setting>
<setting key="value" localizationKey=serve.report_42.Declassification">Declassification</setting>
</object>
</list>
</object>