Adding a REST data source schema with the schema discovery wizard

A data source schema can be created for a REST data source. Creating schemas simplifies authoring document templates for modules with the same structure, and same or similar attribute list.

About this task

When you use the Schema Discovery wizard in IBM Engineering Lifecycle Optimization - Publishing (PUB) to create data source schemas, you can select from two reportable REST options. Your application might support either REST API 1.0 or REST API 2.0. Check with your system administrator if you do not know the REST API version that your application supports.

Schema Discovery (REST API 1.0)

Procedure

  1. In Document Studio, click Data > Schema Discovery > REST Schema Discovery.
  2. Specify the connection details:
    1. Enter a Name for the data source.
    2. Enter a Description for the data source.
    3. Specify the Base URL for the resource.
    4. Select the Authentication Type from the list.
      You can select one of the following authentication types:
      Note: If you are using smart card or SSL certificate authentication, you must also specify the smart card alias name or the path to the SSL certificate file.
    5. If the resource is on a secured server, specify the User name.
    6. If the resource is on a secured server, specify the Password.
    7. (Optional): If you are reporting on configurations, specify an OSLC configuration. See Discovering an OSLC resource for global configurations.
  3. Click Next.
  4. The Create a Resource window displays.
    1. Enter a Name for the new resource.
    2. Enter a Description for the new resource.
    3. Enter a Relative path for the new resource.
  5. Select the URL and either click Finish or use the URL to locate the child resource. To locate the child resource:
    1. Select the resource URL and click Next.
    2. Select an element in the XML schema pane.
    3. Select href from the attributes list.
  6. If you located a child resource, click Finish. When the wizard closes, you can see the URL in the Configuration window. Enter a user name and password in the Configuration window if the resource is on a secured server.

Schema Discovery (REST API 2.0)

About this task

Note: PUB supports only the abbreviated RDF. The providers must accept and honor application/xml requests. See Open Services for Lifecycle Collaboration Core Specification Version 2.0.
PUB supports only OSLC v2 providers that follow the Reportable REST v2 Specification.
  • An OSLC service must define query capabilities in the service resource for all resources that are intended for reporting.
  • Each query capability for reporting must meet these conditions:
    • The oslc:queryBase must point to the resource that lists the resources that are intended for reporting. The resources in the list must be identified as oslc:isMemberProperty in the resource shape resource of the list resource.
    • The oslc:resourceShape must describe the list resource.

Procedure

  1. Click Data > Schema Discovery > REST v2 Schema Discovery.
  2. Specify the connection details:
    1. Specify the Base URL for the resource.
      Learn more about the REST service provider URL: You must know the URL of the service provider that you want to accept. PUB fetches the data from the data source as a list of queries. These resources are stored by the service from which data can be queried and interpreted. The service also provides a query service to filter data according to a set condition or refine the subsets of data. These queries are by resource type so you can access a specific type of resource. A reportable ID2 service can expose many resources types, such as a product or user change request. The query service helps you retrieve data efficiently or a subset of the data, but it is not mandatory. Every product can define its resources and the queries that access these resources.
    2. Select an Authentication Type from the list.
      You can select one of the following authentication types:
      Note: If you are using smart card or SSL certificate authentication, you must also specify the smart card alias name or the path to the SSL certificate file.
    3. If the resource is on a secured server, specify the User name.
    4. If the resource is on a secured server, specify the Password.
  3. Click Next.
  4. Select a REST v2 service and its corresponding query and click Next.
    The properties of the selected services display.
  5. Select the required properties from the list and click Test oslc.select.
    When you see the Result Confirmation window, confirm that the list of selected services is correct. If you click Correct, the Test oslc.select field status changes to true. Click Next.
  6. You must enter only the filter or sort clause of the query, such as cq:Product{cq:Product=Engineering Publishing} in the Query include oslc.where clause and the Query include oslc.orderBy clause.
  7. Click Test oslc.where and Test oslc.orderBy to verify the connection.
    PUB creates the full request by using the options that are defined.
  8. Click Next to see the summary of your query, and click Finish. The URL is now in the Configuration window. If the resource is on a secured server, you can provide a user name and password in the Configuration window.