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

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

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

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

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

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

Процедура

  1. Обзор процесса разработки шаблона приведен в разделе Разработка шаблонов документов. Приступите к планированию структуры документа и данных, которые он может содержать. Например, определите, будет ли окончательный документ создан на основе одного шаблона или нескольких шаблонов, каждый из которых содержит многократно используемые фрагменты информации.
  2. В приложении Document Studio создайте шаблон документа.
  3. Определите схему источника данных из источника данных. Для добавления конкретных фрагментов данных из проекта Rational Focal Point или обращения к отдельному ресурсу с известным URL создайте URL с аргументом resources. Откройте схему источника данных и затем возьмите URI для конкретного ресурса из файла XML.
    • Пример: http://сервер:порт/fp/resources
    Прим.: Схемы Rational Focal Point зависят от конкретной установки приложения. Это означает, что шаблон, созданный для одного сервера Rational Focal Point, нельзя повторно использовать на другом сервере Rational Focal Point.
    В случае применения API REST отчетов Rational Requirements Composer введите URL в следующем формате:
    • https://сервер:порт/rm/publish/артефакт
  4. Добавить схему источника данных в шаблон документа. Для Rational Focal Point можно выполнить следующие действия:
    1. В Document Studio выберите Данные > Добавить схему источника данных.
    2. В поле Тип выберите тип схемы в списке. Для Rational Focal Point выберите Базовый XML.
    3. В поле Файл схемы вставьте URL схемы источника данных.
    4. Добавьте ?metadata=schema в конец URL.
      • Пример: http://сервер:порт/fp/resources?metadata=schema
      В случае применения API REST отчетов Rational Requirements Composer введите URL в следующем формате:
      • Пример: https://сервер:порт/rm/publish/артефакт?metadata=schema
    5. Укажите имя пользователя, если ресурс расположен на защищенном сервере.
    6. Укажите пароль, если ресурс расположен на защищенном сервере.
    7. Выберите Тип идентификации в списке. Для Rational Focal Point применяется тип идентификации OAuth. Если значение OAuth не выбрано, то правильный тип идентификации выбирается путем проверки всех типов идентификации. Это может привести к увеличению времени создания документов.
  5. Добавьте элементы в шаблон. Rational Publishing Engine содержит полный набор элементов шаблона, позволяющих структурировать документ. Вы можете перетаскивать элементы в редактор содержимого шаблона. Например, можно добавить элемент Контейнер для размещения нескольких абзацев. Каждый абзац может контролироваться тестовым условием, связывающим его только с определенными данными. Дополнительная информация приведена в разделах Элементы шаблона на панели Палитра и Добавление элементов в шаблон.
  6. Добавьте данные в шаблон с помощью запросов, атрибутов и переменных. Эти элементы указывают, какие фрагменты информации генерируются в отчете.
  7. Добавьте параметры форматирования и стиля элементов, чтобы настроить их внешний вид в выводе.
  8. Создайте фильтры для ограничения данных, добавляемых в отчет. С помощью фильтров, представляющих собой более детализированные разновидности общего URI источника данных, можно указывать конкретные подмножества данных, так чтобы Rational Publishing Engine не извлекал больше информации, чем необходимо, из источника данных во время генерации отчета. Эти фильтры должны быть достаточно широки для извлечения всех необходимых данных, на которые ссылается шаблон, в противном случае генерируемый отчет будет неполным.
  9. Создайте сортировки для организации данных в отчете.

Комментарии