Добавление схемы источника данных REST с помощью мастера поиска схемы

Схему источника данных можно создать для источника данных REST. Схемы упрощают создание шаблонов документов для модулей с одинаковой структурой и совпадающими или аналогичными списками атрибутов.

Об этой задаче

При создании схем источников данных с помощью матера Обнаружение схем можно выбрать одну из следующих версий REST, которую может поддерживать ваше приложение: API REST 1.0 или API REST 2.0. Обратитесь к системному администратору, если вам неизвестна поддерживаемая приложением версия API REST.

Обнаружение схемы (REST API 1.0)

Процедура

  1. В Document Studio выберите Данные > Поиск схем > Поиск схем REST.
  2. Укажите сведения о соединении:
    1. Введите Имя источника данных.
    2. Введите Описание источника данных.
    3. Укажите Базовый URL для ресурса.
    4. Выберите Тип идентификации в списке. Если тип не указан, будут применяться все типы по очереди. Этого можно избежать, указав тип.
    5. Укажите имя пользователя, если ресурс расположен на защищенном сервере.
    6. Укажите пароль, если ресурс расположен на защищенном сервере.
  3. Нажмите кнопку Далее.
  4. В зависимости от того, применяет ли источник данных службы данных, отображается одно из следующих окон:

    Если источник данных не использует службы данных, то откроется окно Создать ресурс.

    1. Введите Имя нового ресурса.
    2. Введите Описание нового ресурса.
    3. Введите Относительный путь нового ресурса.
    Если источник данных REST доступен с помощью адаптеров Reporting Data Services, откроется окно Найти с помощью службы данных.
    1. Выберите элемент в дереве схемы XML.
    2. Выберите значение href в списке атрибутов.
    3. Нажмите кнопку Далее. URL ресурса отображается для выбранного ресурса.
  5. Выберите URL и нажмите кнопку Готово или найдите дочерний ресурс с помощью URL. Для того чтобы найти дочерний ресурс, выполните следующие действия:
    1. Выберите URL ресурса и нажмите кнопку Далее.
    2. Выберите элемент на панели схемы XML.
    3. Выберите href в списке атрибутов.
  6. Если найден дочерний ресурс, нажмите кнопку Готово. Работа мастера завершается и URL отображается в окне Конфигурация. Введите идентификационные данные пользователя в окне конфигурации, если ресурс расположен на защищенном сервере.

Обнаружение схемы (REST API 2.0)

Об этой задаче

Прим.: Rational Publishing Engine поддерживает только сокращенный RDF. Провайдеры должны принимать и поддерживать запросы application/xml. См. раздел Open Services for Lifecycle Collaboration Core Specification версии 2.0.
Rational Publishing Engine поддерживает провайдеров только OSLC v2, соответствующих требованиям спецификации Reportable REST v2 Specification.
  • Для всех ресурсов службы OSLC, которые планируется использовать в отчетах, должны быть указаны функции запросов.
  • Требования к функциям запросов для создания отчетов:
    • Требуется свойство oslc:queryBase, указывающее на ресурс со списком ресурсов, которые планируется использовать в отчетах. Ресурсам в списке должны быть присвоены идентификаторы oslc:isMemberProperty.
    • Требуется свойство oslc:resourceShape для описания ресурса списка.

Процедура

  1. Выберите Данные > Поиск схем > Поиск схемы REST v2.
  2. Укажите сведения о соединении:
    1. Укажите Базовый URL для ресурса.
      Вам должен быть известен URL принимаемого провайдера службы. Этот URL аналогичен URL приложения Reporting Data Services для источника данных Reportable REST. Rational Publishing Engine извлекает данные из источника данных в качестве списка запросов. Эти ресурсы хранятся службой, в которой можно запросить данные для интерпретации. Кроме того, служба предоставляет службу запросов, обеспечивающую фильтрацию данных с учетом указанного условия или уточнение подмножеств данных. Эти запросы позволяют обратиться к ресурсам конкретного типа. Отчетная служба ID2 поддерживает ресурсы различных типов, такие как продукты и запрос на смену пользователя. Служба запросов помогает пользователю извлекать данные или подмножества данных. Служба запроса существует для всех ресурсов. Каждый продукт может определять собственные ресурсы и запросы для доступа к ним.
    2. Выберите Тип идентификации в списке.
    3. Укажите имя пользователя, если ресурс расположен на защищенном сервере.
    4. Укажите пароль, если ресурс расположен на защищенном сервере.
  3. Нажмите кнопку Далее.
  4. Выберите службу REST v2 вместе с соответствующим запросом и нажмите кнопку Далее. Отображаются свойства выбранных служб.
  5. Выберите требуемые свойства в списке и нажмите кнопку Проверить oslc.select. Выбранные службы отображаются в окне Подтверждение результата. Проверьте правильность служб. Если нажать кнопку Исправить, то состояние поля Проверить oslc.select изменится на true. Нажмите кнопку Далее.

    Поле Проверить oslc.properties применяется редко.

  6. В полях Включите оператор oslc.where в запрос и Включите оператор oslc.orderBy в запрос введите только оператор фильтрации или сортировки, например cq:Product{cq:Product="Rational Publishing Engine"}.
  7. Выберите Проверить oslc.where и Проверить oslc.orderBy для проверки соединения. Rational Publishing Engine создает полный запрос с помощью заданных параметров.
  8. Нажмите кнопку Далее. Отображается обзор запросов. Нажмите кнопку Готово. Работа мастера завершается и URL отображается в окне Конфигурация. Если ресурс расположен на защищенном сервере, то в окне Конфигурация можно указать идентификационные данные пользователя.

Комментарии