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

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

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

Совет: Установка Rational Publishing Engine включает набор примеров отчетов. Прежде чем публиковать документы, вы можете изучить пример сценария генерации документа. См. раздел Создание примера шаблона REST.
Ознакомьтесь со службой REST Rational Team Concert и различными URL, необходимыми для извлечения данных из Rational Team Concert при работе с Rational Publishing Engine. См. раздел Вики отчетных API REST: ресурсы, предоставляемые Rational Team Concert.
Отчетные API REST Rational Team Concert отличаются от многих традиционных доменных API. Вместо того чтобы предоставлять URL ресурсов, указывающие на конкретные элементы, такие как отдельный рабочий элемент или отдельный результат компоновки, отчетный API REST предоставляет доступ к монолитным ресурсам. Каждый монолитный ресурс - это контейнер, представляющий результат запроса для одного или нескольких элементов.
  • foundation: общие артефакты, такие как области проекта, области коллектива, авторы, итерации и ссылки.
  • workitem: артефакты заданий, такие как обзоры, категории, коды серьезности и приоритеты.
  • apt: артефакты гибкого планирования, такие как коллективная производительность, расписания для ресурсов и индикаторы отсутствия.
  • generic: общие артефакты.
  • build: артефакты компоновки, такие как результаты компоновки, дополнения с результатами компоновки, определения компоновки и службы компоновки.
  • scm: артефакты управления источниками, такие как потоки и компоненты, а также приращения, масштабирующие поток.
Эти ресурсы обеспечивают гибкость и поддержку запросов при сборе данных для отчета. Например, ресурс задания может содержать один или несколько элементов, связанных с заданиями, в зависимости от запроса или фильтра, переданного в API REST.

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

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

Процедура

  1. Обзор процесса разработки шаблона приведен в разделе Разработка шаблонов документов. Приступите к планированию структуры документа и данных, которые он может содержать. Например, определите, будет ли окончательный документ создан на основе одного шаблона или нескольких шаблонов, каждый из которых содержит многократно используемые фрагменты информации.
  2. В приложении Document Studio создайте шаблон документа.
  3. Добавить схему источника данных в шаблон документа. Для поиска схемы источника данных Rational Team Concert можно ввести базовый URL приложения.
    1. В Document Studio выберите Данные > Добавить схему источника данных.
    2. В поле Тип схемы выберите тип схемы в списке. Для Rational Team Concert выберите REST.
    3. В поле Файл схемы вставьте URL схемы источника данных.
      • https://сервер:порт/ccm/rpt/repository/foundation
      • https://сервер:порт/ccm/rpt/repository/workitem
      • https://сервер:порт/ccm/rpt/repository/apt
      • https://сервер:порт/ccm/rpt/repository/generic
      • https://сервер:порт/ccm/rpt/repository/scm
      • https://сервер:порт/ccm/rpt/repository/build
    4. Добавьте ?metadata=schema в конец URL.
      • Пример: https://сервер:порт/ccm/rpt/repository/workitem?metadata=schema
    5. В поле ИД источника данных введите имя источника данных в шаблоне. Нажмите кнопку Далее.
    6. Укажите имя пользователя, если ресурс расположен на защищенном сервере.
    7. Укажите пароль, если ресурс расположен на защищенном сервере.
    8. Выберите Тип идентификации в списке. Для Rational Team Concert применяется тип идентификации OAuth. Если значение OAuth не выбрано, то правильный тип идентификации выбирается путем проверки всех типов идентификации. Это может привести к увеличению времени создания документов.
    9. Нажмите Готово. Выбранная схема источника данных отображается на панели Схема источника данных.
  4. Добавьте элементы в шаблон. Rational Publishing Engine содержит полный набор элементов шаблона, позволяющих структурировать документ. Вы можете перетаскивать элементы в редактор содержимого шаблона. Например, можно добавить элемент Контейнер для размещения нескольких абзацев. Каждый абзац может контролироваться тестовым условием, связывающим его только с определенными данными. Дополнительная информация приведена в разделах Элементы шаблона на панели Палитра и Добавление элементов в шаблон.
  5. Добавьте данные в шаблон с помощью запросов, атрибутов и переменных. Эти элементы указывают, какие фрагменты информации генерируются в отчете.
  6. Добавьте параметры форматирования и стиля элементов, чтобы настроить их внешний вид в выводе.
  7. Создайте фильтры для ограничения данных, добавляемых в отчет. С помощью фильтров, представляющих собой более детализированные разновидности общего URI источника данных, можно указывать конкретные подмножества данных, так чтобы Rational Publishing Engine не извлекал больше информации, чем необходимо, из источника данных во время генерации отчета. Эти фильтры должны быть достаточно широки для извлечения всех необходимых данных, на которые ссылается шаблон, в противном случае генерируемый отчет будет неполным. Rational Team Concert поддерживает источники данных Reportable Rest v1 во внутренних фильтрах. Дополнительная информация приведена в разделе API Reportable REST на сайте Jazz.net. Пример:
    projectArea/name="Rational Publishing Engine"  and target/name="1.2.1"
    Обработанный запрос:
    fields=workitem/workItem[projectArea/name="Rational Publishing Engine" и target.name="1.2.1"]/(@href|summary)
    Прим.: Не все поля можно использовать в стандартной фильтрации.
  8. Создайте сортировки для организации данных в отчете.

Комментарии