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

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

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

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

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

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

Процедура

  1. Обзор процесса разработки шаблона приведен в разделе Разработка шаблонов документов. Приступите к планированию структуры документа и данных, которые он может содержать. Например, определите, будет ли окончательный документ создан на основе одного шаблона или нескольких шаблонов, каждый из которых содержит многократно используемые фрагменты информации.
  2. В приложении Document Studio создайте шаблон документа.
  3. Добавить схему источника данных в шаблон документа. Для поиска схемы источника данных Rational ClearQuest можно ввести базовый URL приложения.
    1. Откройте мастер поиска схемы, относящийся к применяемой версии Rational ClearQuest
      • Для Rational ClearQuest более ранних версий на основе REST v1 выберите Данные > Поиск схем > Поиск схем REST.
      • Для более поздних версий Rational ClearQuest на основе REST v2 выберите Данные > Поиск схемы > Поиск схемы REST v2.
    2. Укажите Базовый URL для ресурса.
      • Для версий Rational ClearQuest на основе REST v1 Rational Publishing Engine использует службы данных Rational для поиска схемы и запроса данных. Базовый URL приложения Службы данных: https://сервер:порт/DataServices/ClearQuest
      • Для Rational ClearQuest на основе REST v2 в случае запуска с помощью URL ServiceProvider. Пользователи могут узнать URL ServiceProvider, введя URL REST v2 ServiceCatalog Rational ClearQuest, такой как https://сервер:порт/context/oslc. Задайте 2.0 в качестве значения OSLC-Core-Version для заголовков HTTP и примите application/rdf+xml. В возвращенном результате найдите URL ServiceProvider rdf:about.
        Если для создания документа используется API REST v2, то требуется указать URL схемы источника данных, указывающий на поставщика служб, а не на корневую запись. Пример:
        • Неправильно: https://сервер:порт/cqweb/oslc
        • Правильно: https://сервер:порт/cqweb/oslc/repo/repository/db/schema_repository/
    3. Выберите Тип идентификации в списке. Если тип не выбран, то правильный тип определяется путем проверки всех типов. Это может привести к увеличению времени создания документов.
    4. Укажите имя пользователя, если ресурс расположен на защищенном сервере.
    5. Укажите пароль, если ресурс расположен на защищенном сервере.
    6. Нажмите кнопку Далее. К указанному базовому URL автоматически добавляется строка ?metadata=schema. Пример: https://сервер:порт/service/cq/records/defects?metadata=schema
    7. Нажмите Готово. Выбранная схема источника данных отображается на панели Схема источника данных.
  4. Добавьте элементы в шаблон. Rational Publishing Engine содержит полный набор элементов шаблона, позволяющих структурировать документ. Вы можете перетаскивать элементы в редактор содержимого шаблона. Например, можно добавить элемент Контейнер для размещения нескольких абзацев. Каждый абзац может контролироваться тестовым условием, связывающим его только с определенными данными. Дополнительная информация приведена в разделах Элементы шаблона на панели Палитра и Добавление элементов в шаблон.
  5. Добавьте данные в шаблон с помощью запросов, атрибутов и переменных. Эти элементы указывают, какие фрагменты информации генерируются в отчете.
  6. Добавьте параметры форматирования и стиля элементов, чтобы настроить их внешний вид в выводе.
  7. Создайте фильтры для ограничения данных, добавляемых в отчет. С помощью фильтров, представляющих собой более детализированные разновидности общего URI источника данных, можно указывать конкретные подмножества данных, так чтобы Rational Publishing Engine не извлекал больше информации, чем необходимо, из источника данных во время генерации отчета. Эти фильтры должны быть достаточно широки для извлечения всех необходимых данных, на которые ссылается шаблон, в противном случае генерируемый отчет будет неполным.

    Адаптер Rational ClearQuest поддерживает внутреннюю фильтрацию источников данных Reportable Rest v1. Встроенные фильтры Reportable Rest v1 требуются только для вводе текста между квадратных скобок []. Остальной фильтр создается Rational Publishing Engine. Дополнительная информация приведена в разделе Reportable Rest v1.

    Rational ClearQuest версии 8 без адаптера поддерживает внутреннюю фильтрацию источников данных Reportable Rest v2. Дополнительная информация приведена в разделе API REST Rational ClearQuest OSLC CM .

    Пример фильтра переменной:
    cq:Product{cq:Product="${productName}") 
    Пример обработанного фильтра, где productName - это Rational Publishing Engine:
    cq:Product{cq:Product="Rational Publishing Engine")
    Прим.:
    • Запросы выполняются к источнику данных только при необходимости. Например, можно использовать условия для показа элемента в выводе, только когда он содержит данные. Условием для элемента контейнера может быть переменная == "true". Если это условие не выполнено, и никакие данные не удовлетворяют условию переменной, запросы к источнику данных не выполняются.
    • Можно вычислить внутренние фильтры перед выполнением запроса. Внутренний фильтр вычисляется в той точке, где встречен запрос, и использует значения переменных в этой точке. Таким образом, можно выполнить вычисления в шаблоне, которые влияют на внутренние фильтры.
  8. Создайте сортировки для организации данных в отчете.

Комментарии