Adding a data source schema

Templates operate with data schemas, not with actual data sources. You can add a data source schema to an open template.

Before you begin

You cannot edit with the Schema discovery wizard, export, or replace data source schemas that contain custom attributes.

About this task

The data source schema for each data source type is structured differently. If you are unsure which data source type your product is, in the Integrating section, refer to the "Designing templates" topic for your product. Each topic includes steps for adding a data source schema with the appropriate data source type selection. The data source schema URL is verified before you complete the wizard to add it. If you happen to select the wrong data source type when you are configuring the data source schema, you receive an error and cannot complete the wizard. If this issue occurs and you know that your URL is correct, use a different data source type.

Procedure

  1. Choose one of the following methods to open the Add data source schema wizard:
    • In Document Studio, click Data > Add Data Source Schema.
    • In the Outline view, click Data Source Schemas > Insert > Data Source Schema.
    • In the Data Source Schemas view, click the Add data source schema icon Add data source schema icon.
  2. In the Add data source schema welcome window, click Next.
  3. Select a data source schema:
    1. In the Predefined field, select one of the following data sources:
      • DS
      • DOORS®
      • DOORS_DB
      • Rhapsody®
      • RQM Feed
      • RQM QM
      • RTC Workitems
      • ReqPro Sample
      • Tau
    1. In Type, select the type of the schema from the list. You can select one of the following types:
      • Generic XML
      • REST
      • REST v2
      • Rational® DOORS
      • Rational DOORS structure
      • IBM® Rational Tau
    2. Edit the Schema field or click Browse to select the path for the schema file. The schema can be on the local file system, the Central Management component, or can be a URI that is accessible from the computer. You must provide a full path.
      Tip: To construct a specific resource type schema, open your data source schema and from the .xml file take the URI for a particular resource. Then, add ?metadata=schema to the end of the URI. Examples:
      • http://server:port/fp/resources/workspaces/4/modules/1/elements/?metadata=schema
      • https://server:port/ccm/rpt/repository/workitem?metadata=schema
    3. Provide a name and description for the schema or accept the default settings.
    4. Click Next.
  4. In the Summary window, review the information and click Finish.

What to do next

When displaying a data source schema, the label annotation is used, if present, by default. You can display the names in the Rational Publishing Engine browser. To view the raw schema instead:
  1. Click Window > Preferences.
  2. Expand RPE.
  3. Select the Document Design tab.
  4. For the Use Schema annotations for display option, select No.
  5. Click OK to save the change.

You can search for a list of elements that use a specific query or attribute in a template by right-clicking the query or attribute in the Data Source Schemas view and selecting Search data references. The Search view opens and a list of occurrences displays. You can double-click an occurrence in the results to edit it.


Feedback