Разработка шаблонов с помощью Rational Quality Manager в качестве источника данных

Проектировщики отчетов могут использовать Document Studio для импорта схем источников данных и построения шаблонов отчетов.

Прежде чем начать

Совет: Установка Rational Publishing Engine включает набор примеров отчетов. Прежде чем публиковать документы, вы можете изучить пример сценария генерации документа. См. раздел Создание примера шаблона REST.
Ознакомьтесь со службой REST Rational Quality Manager и различными URL, необходимыми для извлечения данных из Rational Quality Manager с помощью Rational Publishing Engine. См. раздел Документация по API REST Rational Quality Manager.

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

Данные извлекаются с помощью API REST. Этот интерфейс устанавливается и реализуется приложением источника данных и работает независимо от Rational Publishing Engine. Дополнительная информация об API REST для источника данных приведена в документации по источнику данных.

Процедура

  1. Обзор процесса разработки шаблона приведен в разделе Разработка шаблонов документов. Приступите к планированию структуры документа и данных, которые он может содержать. Например, определите, будет ли окончательный документ создан на основе одного шаблона или нескольких шаблонов, каждый из которых содержит многократно используемые фрагменты информации.
  2. В приложении Document Studio создайте шаблон документа.
  3. Определите схему источника данных из источника данных.
    • Для добавления конкретных фрагментов данных из набора, например сведений о тестовом наборе или тестовых сценариев, из проекта Rational Quality Manager или обращения к отдельному ресурсу с известным URL создайте URL с аргументом feed. Вы всегда используете эту схему и динамически настраиваете ее для конкретных фрагментов данных в шаблоне из своего проекта Rational Quality Manager.
      • Пример: https://сервер:порт/qm/service/com.ibm.rqm.integration.service.IIntegrationService/schema/feed.xsd
    • Для добавления конкретных фрагментов данных из отдельного ресурса, например сведений о тестовом наборе или тестовых сценариев, из проекта Rational Quality Manager или обращения к отдельному ресурсу с известным URL создайте URL с аргументом qm:
      • Пример: https://сервер:порт/qm/service/com.ibm.rqm.integration.service.IIntegrationService/schema/qm.xsd
    • Если для создания документа используется API REST v2, то требуется указать URL схемы источника данных, указывающий на поставщика служб, а не на корневую запись. Пример:
      • Неправильно: https://сервер:порт/qm/oslc_qm/catalog
      • Правильно: https://сервер:порт/qm/oslc_qm/catalog/хранилище/db/хранилище-схемы/
  4. Добавить схему источника данных в шаблон документа. Для Rational Quality Manager можно выполнить следующие действия:
    1. В Document Studio выберите Данные > Добавить схему источника данных.
    2. В поле Тип схемы выберите тип схемы в списке. Для Rational Quality Manager выберите Базовый XML.
    3. В поле Файл схемы вставьте URL схемы источника данных.
    4. Добавьте ?abbreviate=false в конец URL.
      • Пример: https://сервер:порт/qm/service/com.ibm.rqm.integration.service.IIntegrationService/resources/JKE Banking (Quality Management)/testcase?abbreviate=false
    5. В поле ИД источника данных введите имя источника данных в шаблоне. Нажмите кнопку Далее.
    6. Укажите имя пользователя, если ресурс расположен на защищенном сервере.
    7. Укажите пароль, если ресурс расположен на защищенном сервере.
    8. Выберите Тип идентификации в списке. Для Rational Quality Manager применяется тип идентификации OAuth. Если значение OAuth не выбрано, то правильный тип идентификации выбирается путем проверки всех типов идентификации. Это может привести к увеличению времени создания документов.
  5. Добавьте элементы в шаблон. Rational Publishing Engine содержит полный набор элементов шаблона, позволяющих структурировать документ. Вы можете перетаскивать элементы в редактор содержимого шаблона. Например, можно добавить элемент Контейнер для размещения нескольких абзацев. Каждый абзац может контролироваться тестовым условием, связывающим его только с определенными данными. Дополнительная информация приведена в разделах Элементы шаблона на панели Палитра и Добавление элементов в шаблон.
  6. Добавьте данные в шаблон с помощью запросов, атрибутов и переменных. Эти элементы указывают, какие фрагменты информации генерируются в отчете.
  7. Добавьте параметры форматирования и стиля элементов, чтобы настроить их внешний вид в выводе.
  8. Создайте фильтры для ограничения данных, добавляемых в отчет. С помощью фильтров, представляющих собой более детализированные разновидности общего URI источника данных, можно указывать конкретные подмножества данных, так чтобы Rational Publishing Engine не извлекал больше информации, чем необходимо, из источника данных во время генерации отчета. Эти фильтры должны быть достаточно широки для извлечения всех необходимых данных, на которые ссылается шаблон, в противном случае генерируемый отчет будет неполным. Дополнительная информация приведена в разделе API REST для создания отчетов Rational Quality Manager.
  9. Создайте сортировки для организации данных в отчете.

Комментарии