Adding a data source schema

Templates operate with data schemas, not with actual data sources. You can add a data source schema to a template that is open in the template editor.

1. Choose one of the following methods to open the Add data source schema wizard:
   • In Document Studio, click Data > Add Data Source .
   • In the Outline view, click Data Source Schemas > Insert > Data Source Schema.
   • In the Data Source View, click the Add data source schema icon .
2. In the Add Data Source Schema Wizard, click Next.
3. Select a data source schema:
   1. In the Predefined field, select one of the following data sources:
      • DS
      • DOORS® Next Text
      • DOORS Next Module
      • DOORS
      • DOORS_DB
      • Rhapsody®
      • Engineering Test Management Feed
      • Engineering Test Management QM
      • Engineering Workflow Management Workitems
      • Requirement Sample
      • JIRA Issue
      • Rhapsody Model Manager Architecture Element (AM)
      • Rhapsody Model Manager Architecture Element Statistics (AM)
      • Rhapsody Model Manager Architecture Element (CCM)
      • Rhapsody Model Manager Architecture Element Statistics (CCM)
      • GC

      Note: You can also add your own data source schema to this Predefined list .
   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
      • DOORS
      • DOORS structure
      • JSON
   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 or can be a URI that is accessible from the computer. 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. Example:

      • https://server:port/ccm/rpt/repository/workitem?metadata=schema
   3. Provide a name and description for the schema or accept the default settings.
   4. Select the Authentication Type from the list and enter your credentials:
      • Auto
      • Basic
      • Form
      • OAuth
      • OAuth-OSLC
      • SSL Certificate: If you choose SSL Certificate, enter the certificate path and password.
      • Smart-Card: If you choose Smart-Card, select the certificate and enter the password.
      • Kerberos-SPNEGO
   5. Enter your credentials for the data source.
      Note: The user can specify the user password or the application password that is generated by the configured third-party identity provider, such as SAML or OIDC. User must select Basic authentication method while using application password.
   6. In the Extra Headers field, enter a POX (Plain Old XML) link, for example <http://jazz.net/ns/profile#POX>; rel="profile". This is useful when creating traceability documents from Engineering Lifecycle Management applications.
   7. Click Next.
4. In the Summary window, review the information and click Finish.

What to do next

Tip: You can search for an element or attributes in a schema by entering text in the search field of the Data Source view.

When displaying a data source schema, the label annotation is used, if present, by default. You can display the names in the embedded browser. To view the raw schema instead:

1. Click Window > Preferences.
2. Expand PUB.
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 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.