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

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

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

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

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

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

Процедура

  1. Обзор процесса разработки шаблона приведен в разделе Разработка шаблонов документов. Приступите к планированию структуры документа и данных, которые он может содержать. Например, определите, будет ли окончательный документ создан на основе одного шаблона или нескольких шаблонов, каждый из которых содержит многократно используемые фрагменты информации.
  2. В приложении Document Studio создайте шаблон документа.
  3. Добавить схему источника данных в шаблон документа. Для поиска схемы источника данных Design Management можно ввести базовый URL приложения.
    1. В Document Studio выберите Данные > Поиск схем > Поиск схем REST.
    2. Введите Имя источника данных.
    3. Введите Описание источника данных.
    4. Укажите Базовый URL для ресурса. Базовый URL Design Management: https://сервер:порт/dm/reporting
    5. Выберите Тип идентификации в списке.
      Важное замечание: Для Design Management необходимо указать тип идентификации, применяемый для доступа к данным отчета. Rational Publishing Engine не обнаруживает тип идентификации в автоматическом режиме.
    6. Укажите имя пользователя, если ресурс расположен на защищенном сервере.
    7. Укажите пароль, если ресурс расположен на защищенном сервере.
    8. Нажмите кнопку Далее. К указанному базовому URL автоматически добавляется строка ?metadata=schema. Пример: https://сервер:порт/dm/reporting?metadata=schema
    9. Нажмите Готово. Выбранная схема источника данных отображается на панели Схема источника данных.
  4. Добавьте элементы в шаблон. Rational Publishing Engine содержит полный набор элементов шаблона, позволяющих структурировать документ. Вы можете перетаскивать элементы в редактор содержимого шаблона. Например, можно добавить элемент Контейнер для размещения нескольких абзацев. Каждый абзац может контролироваться тестовым условием, связывающим его только с определенными данными. Дополнительная информация приведена в разделах Элементы шаблона на панели Палитра и Добавление элементов в шаблон.
  5. Добавьте данные в шаблон с помощью запросов, атрибутов и переменных. Эти элементы указывают, какие фрагменты информации генерируются в отчете.
  6. Добавьте параметры форматирования и стиля элементов, чтобы настроить их внешний вид в выводе.
  7. Создайте фильтры для ограничения данных, добавляемых в отчет. С помощью фильтров, представляющих собой более детализированные разновидности общего URI источника данных, можно указывать конкретные подмножества данных, так чтобы Rational Publishing Engine не извлекал больше информации, чем необходимо, из источника данных во время генерации отчета. Эти фильтры должны быть достаточно широки для извлечения всех необходимых данных, на которые ссылается шаблон, в противном случае генерируемый отчет будет неполным. Design Management поддерживает внутреннюю фильтрацию источников данных Reportable Rest v1. Встроенные фильтры Reportable Rest v1 требуются только для вводе текста между квадратных скобок []. Остальной фильтр создается Rational Publishing Engine. Дополнительная информация приведена в разделе Reportable Rest v1.
  8. Создайте сортировки для организации данных в отчете.

Комментарии