Архив рубрики: Reporting

Конфигурирование функции dpQuery

Тип функции

Параметры

ПараметрОписание
querySQL-оператор

ПРИМЕЧАНИЕ

Дополнительную информацию по функции и параметрам можно найти здесь.

Запрос SOAP

Редактирование параметра:

SELECT ‘_alert_hdl.._active, _alert_hdl.._act_text, _alert_class.._ack_type’ FROM ‘ExampleDP_Arg1’

ПРИМЕЧАНИЕ

С помощью функции создания отчетов dpQuery может быть запрошено не более 6 атрибутов. Доступно 7 элементов (столбцы 1 — 7, см. «Отображение данных в столбцах»), однако, столбец 1 автоматически используется для элемента точки данных.

Отклик SOAP

Отображение данных в строках

Отображение данных в столбцах

Код ошибкиОписание
-1Отказ функции dpQuery
-2Ошибка группы ответов

Отображение выборочных данных:

Конфигурирование функции dpGetAsynch

Тип функции

Параметры

ПараметрОписание
timeИсходное время
dpNameЭлемент точки данных, который должен быть запрошен.

ПРИМЕЧАНИЕ

Для определения элемента точки данных (параметра dpName) не должны использоваться символы обобщения.

ПРИМЕЧАНИЕ

Дополнительную информацию по функции и параметрам можно найти здесь.

Запрос SOAP

Редактирование параметра:

Отклик SOAP

Отображение данных в строках

Отображение данных в столбцах

Код ошибкиОписание
-1Точка данных не найдена
-2Ошибка группы ответов
-3Ошибка в запросе RDB

Отображение выборочных данных:

Конфигурирование функции dpGetPeriod

Тип функции

Параметры

ПараметрОписание
startTimeВремя начала запрашиваемого временного диапазона
endTimeВремя окончания запрашиваемого временного диапазона
bonusКоличество значений до startTime и после endTime, которое также должно отображаться.
dpNameЭлемент точки данных, который должен быть запрошен.

ПРИМЕЧАНИЕ

Для определения элемента точки данных (параметра dpName) не должны использоваться символы обобщения.

ПРИМЕЧАНИЕ

Дополнительную информацию по функции и параметрам можно найти здесь.

Запрос SOAP

Редактирование параметра:

Отклик SOAP

Отображение данных в строках

Отображение данных в столбцах

Код ошибкиОписание
-1Точка данных не найдена
-2Ошибка группы ответов
-3Ошибка в запросе RDB

Отображение выборочных данных:

Конфигурирование функции dpGet

Тип функции

Параметры

ПараметрОписание
dpNameЭлемент точки данных, который должен быть запрошен.

ПРИМЕЧАНИЕ

Дополнительную информацию по функции и параметрам можно найти здесь.

Запрос SOAP

Редактирование параметра:

Отклик SOAP

Отображение данных в строках

Отображение данных в столбцах

Код ошибкиОписание
-1Точка данных не найдена
-2Ошибка группы ответов

Отображение выборочных данных:

В случае если точка данных не существует, экран выглядит следующим образом:

Примечания и ограничения

Ниже перечислены важные примечания и ограничения, касающиеся инструмента BIRT.

  • Использование HTTPS невозможно с бесплатной версией программы BIRT. Конфигурационный параметр httpsPort = 443 задан по умолчанию, следовательно, другой порт должен быть задан с использованием параметра httpPort.
  • При использовании программы BIRT Designer (бесплатная версия) конфигурационный параметр httpAuth не должен задаваться.
  • При определении параметра элемента точки данных функции какие-либо конфигурирования не допускаются (например, ExampleDP.value, но не ExampleDP.value:_original.._value).
  • Планирование не поддерживается.
  • Компактное отображение оперативных данных не поддерживается.
  • Могут запрашиваться только статистические данные.

Многоязычность

Языковые настройки можно адаптировать для содержимого отчета, для средства просмотра отчетов и для конструктора отчетов. В этой главе описывается, как адаптировать языковые настройки.

Два файла ресурсов (“localization.properties» и “localization_de_AT.properties») поставляются вместе с установкой “КАСКАД Цифра”. Таким образом, вы можете отображать готовые к использованию отчеты, поставляемые с установкой “КАСКАД Цифра», также на немецком языке.

Языковые настройки отчета

Вы можете создать отчет на разных языках (например, Report_DE и Report_EN) или адаптировать язык с помощью файлов ресурсов.

Как создать файл ресурсов

  1. Создайте файл ресурсов в том же каталоге, что и ваш отчет. Вам нужен файл по умолчанию, например, с именем “localization” (имя файла: localization.properties, см. Рисунок ниже). Чтобы добавить дополнительные языки, создайте файлы, такие как localization_de_AT.properties или localization_en_US.properties. Добавьте файл “localization” в редактор свойств с помощью Add File..

Рисунок: Файл ресурсов “локализация”

Файл ресурсов состоит из пар ключ-значение. Для каждого элемента, который должен быть адаптирован, должна быть указана пара ключ-значение. Обратите внимание, что каждый файл ресурсов, например localization_de_AT.properties или localization_en_US.properties, должен содержать те же ключи, что и файл по умолчанию “localization”.

  1. После создания файла “локализация” нажмите на кнопку Обзор…:

Рисунок: Укажите пары Ключ-значение

  1. Укажите пару ключ-значение и нажмите Добавить. Повторите этот шаг, чтобы добавить другие пары ключ-значение.

Рисунок: Добавление пар Ключ-значение

  1. Создайте новый файл ресурсов “localization_de_AT”. Скопируйте записи из файла ”localization» в файл “localization_de_AT» и переведите записи.

Рисунок: Файл ресурсов localization_de_AT и переведенные записи

  1. Теперь вы можете открыть свой отчет в браузере на немецком языке. Сначала добавьте переведенный файл “localization_de_AT” в ресурсы. Теперь вы можете изменить язык по умолчанию непосредственно в конструкторе, переместив файл “localization_de_AT” вверх в конструкторе (см. Рисунки ниже).:

Рисунок: Язык отчета установлен на английский (выбран файл “локализация”).

Рисунок: Язык отчета установлен на немецкий (выбран файл “localization_de_AT”).

Вы также можете изменить язык в браузере с помощью параметра __locale=<язык>, например, на __locale=de_AT. ОБРАТИТЕ ВНИМАНИЕ на двойное подчеркивание параметра “__locale”. Если параметр __locale не отображается, добавьте его вручную в браузер. Смотрите также главу Веб-просмотр. Убедитесь, что ваши файлы ресурсов расположены в том же каталоге, что и ваш отчет.

ОСТОРОЖНО

Файлы ресурсов должны быть в кодировке ASCII (не UTF-8), в противном случае при отображении, например, русских символов или умляутов могут возникать ошибки отображения.

Вы можете изменить приглашение и текст справки для параметров отчета в редакторе свойств в разделе Свойства/Локализация (см. рисунок “Локализация” ниже). Они отображаются в окне параметров при открытии отчета (см. рисунки “Окно параметров и переведенная подсказка» и “Окно параметров и текст справки “Формат Erforderliches” ” ниже).

Рисунок: Локализация

Рисунок: Окно параметров и переведенная подсказка

Рисунок: Окно параметров и текст справки “Формат Erforderliches”

Языковые настройки дизайнера

Язык дизайнера по умолчанию — английский.

  • Чтобы изменить язык конструктора, загрузите соответствующий языковой zip-файл:

http://download.eclipse.org/technology/babel/babel_language_packs/R0.12.1/luna/luna.php

например, http://www.eclipse.org/downloads/download.php?file=/technology/babel/babel_language_packs/R0.12.1/luna/BabelLanguagePack-birt-de_4.4.0.v20141223043836.zip

  • Скопируйте каталоги zip-файла в установочный каталог eclipse.
  • Запустите BIRT через исполняемый файл <eclipsePath>eclipse.exe <язык>, например, D:\eclipse\eclipse.exe -nl en или ru

ОСТОРОЖНО

Языковые файлы не гарантируют полного перевода (см. процентное соотношение на странице http://download.eclipse.org/technology/babel/babel_language_packs/R0.12.1/luna/luna.php).

Языковые настройки программы просмотра

Язык программы просмотра BIRT по умолчанию — английский. Чтобы изменить язык программы просмотра, загрузите соответствующий языковой zip-файл и скопируйте каталоги zip-файла в установочный каталог eclipse (см. описание выше). Затем вы можете изменить язык программы просмотра в окне / Настройки / Предварительный просмотр / Выбрать свой языковой стандарт:

Рисунок: Языковые настройки для программы просмотра

Веб-представление

Как было описано в разделе Просмотр отчета, по умолчанию отчеты отображаются с помощью средства BIRT Report Viewer. Тем не менее также имеется возможность отображения отчета в веб-браузере. Откройте меню Window (Окно) и щелкните по пункту Preferences (Предпочтения). Выберите пункт меню Report Design — Preview (Конструкция отчета — Предварительный просмотр).

Щелкните по флажку Always use external browsers (Всегда использовать внешние браузеры), чтобы активировать веб-браузеры для отображения отчетов. После этого перейдите к пункту Report Design — Preview (Конструкция отчета — Предварительный просмотр сервера) и задайте IP-адрес и порт для внутреннего сервера приложений. Необходимо использовать IP-адрес и номер порта хоста, на котором работает программа BIRT.

При необходимости можно задать браузер по умолчанию в секции Web Browser (Веб-браузер).

С помощью данной конфигурации при щелчке по кнопке  отчет отображается в веб-браузере.

Просмотр отчета

Для отображения отчетов необходимо только вставить соответствующий набор данных проводника данных в пустой лист, используя перетаскивание.

Открывается окно Data Set Binding (Привязка набора данных), в котором вы можете определить, какие столбцы набора данных должны быть видны в отчете.

После подтверждения выбранных столбцов с помощью кнопки OK автоматически создается соответствующая таблица.

Если щелкнуть по кнопке , расположенной на панели инструментов, отобразится BIRT Report Viewer (Средство просмотра отчетов BIRT). Если параметры отчета привязаны к набору данных, перед отображением отчета открывается следующее окно:

Подтвердите настройки с помощью кнопки OK, и отчет будет выведен на экран:

Графическое представление

С целью визуального представления результатов имеется возможность добавления графиков в отчет. Для этого обратитесь к меню Insert (Вставка) и щелкните по кнопке Chart (График). Выберите тип графика и привяжите значения набора данных. После этого график автоматически вставляется под таблицей.

В созданном отчете (после щелчка по кнопке ) график отображается следующим образом:

Параметры отчета

Параметры отчета необходимы с целью быстрого и простого использования наборов данных в отчете. В противном случае каждый раз перед генерированием нового отчета в настройках набора данных необходимо изменять параметр по умолчанию. В случае с параметрами отчета имеется возможность простой замены запрашиваемых элементов перед отображением отчета.

Создание параметра отчета

Посредством щелчка правой кнопки мыши по пункту Report Parameters (Параметры отчета) в Проводнике данных (Data Explorer) можно вывести на экран следуюшее контестное меню:

Щелкните по пункту New Parameter (Новый параметр), чтобы открыть следующее окно, в котором вы сможете задать имя, тип данных, параметр по умолчанию и т.д.:

ПРИМЕР — ПАРАМЕТР ОТЧЕТА ДЛЯ ПАРАМЕТРА START TIME ФУНКЦИИ DPGETPERIOD

Дайте параметру имя (наприме, start) и задайте значение по умолчанию. Для параметра отчета, привязанного к параметру startTime функции dpGetPeriod, окно конфигурирования выглядит следующим образом:

ПРИМЕР — ПАРАМЕТР ОТЧЕТА ДЛЯ ПАРАМЕТРА DPNAME ФУНКЦИИ DPGETPERIOD

Дайте параметру имя (наприме, Datapoint) и задайте значение по умолчанию. Для параметра отчета, привязанного к параметру dpName функции dpGetPeriod, окно конфигурирования выглядит следующим образом:

Связывание параметров

Для связывания параметров набора данных с параметрами отчета выполните следующее:

Откройте меню Edit Data Set (Редактирование набора данных) соответствующего набора данных (например, сделав двойной щелчок по набору данных dpGetPeriod) и щелкните по пункту меню Parameters (Параметры).

Выберите соответствующий параметр и щелкните по кнопке Edit (Редактировать), чтобы открыть следующее окно:

Имеется возможность выбора ранее созданного параметра отчета с помощью выпадающего списка Linked To Report Parameter (Связанный с параметром отчета). После связывания всех параметров (в данном примере с параметрами отчета Start, End и Datapoint) окно обзора должно иметь следующий вид:

Теперь, если вы генерируете новый отчет (см. также раздел Просмотр отчета), вы имеете возможность предварительного редактирования его параметров.

Конфигурирование функции alertGetPeriod

Тип функции

Выберите тип функции alertGetPeriod после создания и наименования нового набора данных (см. Создание набора данных).

Параметры

Показывает параметры, которые доступны для конфигурирования. Необходимо выбрать все параметры.

ПараметрОписание
startTimeВремя начала запрашиваемого временного диапазона
endTimeВремя окончания запрашиваемого временного диапазона
alertAttributeЭлемент точки данных, атрибуты алармов которого должны быть запрошены.

ПРИМЕЧАНИЕ

Для определения элемента точки данных (параметра alertAttribute) не должны использоваться символы обобщения.

ПРИМЕЧАНИЕ

Дополнительную информацию по функции и параметрам можно найти здесь.

Запрос SOAP

С целью получения значений от «КАСКАД Цифра» генерируемый запрос SOAP передается менджеру создания отчетов «КАСКАД Цифра» в формате XML. Запрос SOAP содержит динамические параметры, которые заменяются определенными переменными.

С помощью кнопки Edit Parameter (Редактирование параметра) для каждого параметра можно определить значения по умолчанию. Это является не обязательным, но необходимым, если вы хотите проверить свои настройки позже (через Column Mapping (Отображение данных в столбцах) — Sample Data (Выборочные данные)). Для данного примера используются следующие значения по умолчанию:

Отклик SOAP

Для этого окна никакие изменения не требуются.

Отображение данных в строках

Отчеты программы BIRT должны использовать данные, представленные в виде таблиц (со строками и стобцами). В коде XML для предоставления данных используются элементы и атрибуты. Следовательно, вы должны определить, как элементы XML должны быть связаны со строками и столбцами.

Отображение данных в строках (Row Mapping) задает, какой элемент XML добавляется в качестве строки нового набора данных. Любое появление выбранного элемента XML привязывается к столбцу нового набора данных.

Представление XPath (выбранный элемент в структуре XML) может быть передано посредством щелчка по кнопке >. Имеется возможность определения абсолютного, относительного и определенного пользователем пути. Путь, начинающийся с /, является абсолютным, а путь, начинающийся с //, – относительным.

Отображение данных в столбцах

Отображение данных в столбцах (Column Mapping) определяет столбцы для строки таблицы. Столбцы назначаются для дочерних элементов или атрибутов внутри выбранного элемента строки данных. В отличие от отображения данных в строках имеется возможность выбора нескольких элементов.

Также имеется возможность выдачи кода ошибки и текста ошибки из атрибутов алармов. Однако, поскольку эти два элемента находятся на том же уровне, что и /table, невозможно выдать их в одном и том же наборе данных. Следовательно, для выдачи кода и текста ошибки должен быть создан второй идентичный набор данных.

Код ошибкиОписание
-1Точка данных не найдена
-2Ошибка группы ответов
-3Ошибка в запросе RDB

Как было сказано ранее, с целью использования кнопки Show Sample Data (Отображение выборочных данных) необходимо определить значения по умолчанию для параметров. Если заданы значения по умолчанию, то имеется возможность проверки настроек до завершения конфигурирования.

Редактирование набора данных

Меню Edit Data Set (Редактирование набора данных) можно открыть посредством двойного щелчка по набору данных в проводнике данных (data explorer). Имеется возможность редактирования всей конфигурации набора данных.

Следующие пункты меню предлагают дополнительные возможности конфигурирования.

Выводимые столбцы (Output Columns)

Этот пункт меню позволяет редактировать имя, имя дисплея, текст подсказки и т.д., отображаемые в таблице при открытии на рабочем листе.

Производные стобцы (Computed Columns)

Этот пункт меню позволяет добавлять в отчет дополнительные столбцы, которые могут использоваться, к примеру, для выполнения расчетов.

Щелкните по кнопке New (Новый) и выберите имя и соответствующий тип данных для данных, которые будут возвращаться.

В строке Expression (Выражение) вы можете определить содержание, которое должно отображаться в столбце Expression. Построитель выражений (Expression Builder) позволяет добавлять существующие наборы данных и функции посредством двойного щелчка. Этот столбец отображается в окне Выводимые столбцы после завершения конфигурирования.

Параметры

Для параметров можно задать значения по умолчанию. Однако эти параметры используются для предварительного просмотра результатов, а не для кнопки Show Sample Data (Отображение выборочных данных) в окне «Отображение данных в столбцах». Более того, эти параметры могут быть привязаны к параметрам отчета.

Фильтры

Этот пункт меню определяет, какие значения должны отображаться в отчете и какие должны фильтроваться.

Щелкните по кнопке New (Новый) и выберите столбец выпадающего списка. Содержимое этого столбца будет фильтроваться в соответствии с заданными условиями.

Предварительный просмотр результатов

Этот пункт меню служит для проверки конфигурации и возвращает результаты в соответствии со значениями по умолчанию, определенными ранее (см. Параметры).