In Rational® Publishing
Engine 1.1.2.2 or later, you can add metadata to the variables or
data source schemas in a template. Then, you can import the template
into the integrated product that uses Rational Reporting for Document Generation
and filter your data as needed.
Before you begin
- Create a variable or data source schema.
- Optional: To use static metadata in the
metadata, create a value set in the Central
Management component. To use dynamic metadata, you are not required
to create a value set.
Procedure
- In the Outline view, right-click the variable or data source
schema.
- Click Edit configuration metadata.
- Enter the metadata details for either dynamic or static
data:
- Dynamic metadata:
- Type: The value type. Example: string
- Identifier: An xPath expression that is
evaluated to provide a list of values for the parameter. You can type
a value or drag one from the Data source schema view. Example: workitem/workitem/id.
The expression is evaluated on the XML returned from fetching the
request URL. If an identifier expression is not provided, then the
request URL itself is the value for the parameter.
- Display: An xPath expression that is evaluated
to provide display strings for the parameter selections. You can type
a value or drag one from the Data source schema view. Example: workitem/workitem/summary.
The identifier and display xPath expressions must return matching
results sets, such as the same size and ordering. If a display value
is not provided, then the identifier is used as the display string
instead.
- Request URL: The full URL to retrieve the
information from when finding the parameter value. If no request URL
is provided, then the user must manually enter a value for the parameter.
- Static metadata:
- Value Set: If you are connected to the
Central Management component, you can select a predefined set of data.
During document generation, you select a single value from this list
to configure your report.
- If you entered dynamic metadata, review the metadata you
entered and replace values with variables that are defined by your
data source whenever possible. For example, Rational solution for Collaborative
Lifecycle Management provides
these variables for the identifier, display, and request URL parameters:
- ${public}: Resolves to the front-side URL of
the application where the report is running
- ${projectAreaUUID}: Resolves to the UUID of the
project where the report is running
- ${userInput}: Replaced by a user-provided filter
string when the report is run
- Click OK to save the changes.
- Save the template.
What to do next
Generate the document or import the
Rational Publishing Engine template
into the integrated product.