Lesson 3: Add configuration metadata to the data source schema

From the Outline view, you can access the configuration layer for a data source schema and apply details that are selectable later in the document-style report generation configuration wizard.

Before you begin

Tip: In the configuration layer, only use unique data. If you try to use priority or severity, for example, where many pieces of data have the same value, when you configure the document-style report generation, your configuration layer dropdown values display duplicates.

Remember that the configuration layer is not meant to be used as a filter, but as a method for selecting a human readable value instead of a complex URL.

Procedure

  1. In the Outline view, expand Data source schemas.
  2. Right-click the configLayerSchema schema that you added in the previous lesson.
  3. Click Edit configuration metadata.
  4. For the Type, select anyuri.
  5. For the Identifier, drag an attribute from the Data Source View that includes the URL for the data source information you are trying to recover.

    The Identifier is 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 View. 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.

    Example:
    • IBM Engineering Test Management: /feed/entry/id
    • IBM Engineering Workflow Management: /workitem/teamArea/@href
  6. For the Display, drag a query from the Data Source View to use as the selectable value that displays as you configure the document-style report generation.

    The Display is an xPath expression that is evaluated to provide display strings for the parameter selections. 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.

    Example:
    • Engineering Test Management: /feed/entry/title
    • Engineering Workflow Management: /workitem/teamArea/name
  7. For the Request URL, enter a URL or file path to your data.

    The Request URL is 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.

    Example:
    • Engineering Test Management: https://server:port/qm/service/com.ibm.rqm.integration.service.IIntegrationService/resources/JKE+Banking+Quality+Management/testplan
    • Engineering Workflow Management: https://server:port/jazz/rpt/repository/workitem?fields=workitem/teamArea/(@href|name)
  8. Click OK.

Lesson checkpoint

You configured the metadata in the configuration layer.