ReportFB

<< Click to Display Table of Contents >>

Navigation:  Проект в MasterSCADA 4D > Дерево библиотек > Библиотека BaseObjects > BaseObjects.ФБ.Системные > Отчёты >

ReportFB

Функциональный блок ReportFB служит для запуска процедуры формирования отчета. Может использоваться для решения вспомогательных задач: открыть в окне клиента сформированный отчет, распечатать и др. Этот функциональный блок может использоваться как самостоятельно, вне программ, так и в составе любой программы.

Вид в дереве

Вид в редакторе FBD

ReportFB

ReportFB_1

Входы и выходы ФБ:

Название

Тип

Назначение

Входы

Execute

BOOL

По переднему фронту изменения значения на этом входе начинает формироваться отчет.

Name

STRING

Указывается имя отчета в проекте. Один функциональный блок может использоваться для формирования разных отчетов, шаблоны которых заданы в дереве системы в группе узла Отчеты, либо в группе Ресурсы у объектов. Для наглядности, для каждого шаблона добавляется свой функциональный блок. В этом случае данный вход является константой, которая задается в поле свойства входа Начальное значение.

Имя отчета формируется из имени объекта и его родительских элементов, в которых отчет находится, а также из самого имени отчета. Таким образом, для использования в качестве имени можно использовать Полное имя отчета, предварительно удалив из него ненужные элементы. Например, если свойство Полное имя имеет значение: Объекты.Формирование отчета.Ресурсы.Отчеты.Отчет 1, необходимо сохранить только Объекты.Формирование отчета.Отчет 1.

Сформированный отчет будет иметь имя <имя указанное на входе Name>_YYYY_mm_DD_HH_MM_SS.<значение входа Format>

InPath

STRING

Указывается место на диске, где сформируется отчет. Может быть указана произвольная папка. Также, если значение входа InPath оканчивается расширением, то оно используется как имя файла. Например:

<C:\Users\Пользователь\AppData\Roaming\MPSSoft\MasterSCADA4D1.3\ProjectsServiceData\Проект\Debug\АРМ 1\PLC\htdocs\Пример.xlsx>

В этом случае сформированный отчет будет иметь имя Пример.xlsx (без указания даты формирования).

Важно! Указать произвольную папку на диске можно, если для просмотра отчётов использовать внешние по отношению к продуктам компании МПС Софт средства. Если необходимо обеспечить просмотр отчетов в графическом клиенте, то файлы с отчетами должны находиться внутри папки htdocs.

Следует учитывать, что для отображения отчета в окне клиента исполнительной системы (и для выполнения других действий, которые будут выполняться из графического клиента с файлом отчета), файл отчета должен быть доступен web-серверу, а значит должен находиться внутри папки \htdocs проекта , загруженного в среду исполнения.  

Если этот параметр не задан, то по умолчанию используется папка <папка узла>\htdocs\reports Например:

если узел запускается локально из среды разработки, то используется папка <имя пользователя>\AppData\Roaming\MPSSot\MasterSCADA4D<версия>\ProjectsServiceData\<имя проекта>\Debug\<имя узла>\PLC\htdocs\reports ,

если узел запускается локально в режиме эмуляции из среды разработки, то используется папка <имя пользователя>\AppData\Roaming\MPSSot\MasterSCADA4D<версия>\ProjectsServiceData\<имя проекта>\Debug\web_imit\htdocs\reports ,

если используется  отдельно установленная исполнительная система MasterSCADA 4D RT, то узел запускается из папки запуска проекта по умолчанию среды исполнения для Windows - C:\ProgramData\MPSSoft\MasterSCADA4DRT<версия>\Server\htdocs\reports ;

Format

STRING

Задается формат файла отчета (pdf, html, docx и xlsx). По умолчанию, если вход не задан, то отчет сформируется в формате pdf. В случае если требуется отображать отчет в клиенте, то желательно выбирать формат сохранения html или pdf. Для экспорта в MS Excel требуется установить значение xlsx.

Report

REF_TO

Служит для установления прямой связи с отчетом. Если использовать данный вход, то вход Name можно не использовать и тогда сформированный отчет будет иметь имя <полное имя отчета>_YYYY_mm_DD_HH_MM_SS.<значение входа Format>

Способы установления связи с отчетом:

Если ФБ используется вне программы, добавлен в дерево. Перетащить отчет на данный вход в дереве.

Если ФБ используется внутри программы. В программу добавляется параметр типа REF_TO. На данный параметр перетаскивают отчет, а уже этот параметр связывают с данным входом ФБ

Выходы

Building

BOOL

Информирует, что идет формирование отчета. Этот выход принимает значение TRUE на время генерации отчета.

Error

STRING

Информирует о возникновении ошибок при генерации отчета. Текст ошибки записывается в этот выход.

Path

STRING

Указывает путь к созданному файлу отчета относительно папки htdocs. Этот путь можно использовать при создании проекта для открытия отчета в контейнере окна, копирования, печати и др. Если генерация отчета завершена успешно, то отчет создается в папке, которая указана на входе InPath.

Рекомендации по работе с отчетом

Формирование входа Name

Пример программы:

ReportFB_2

В приведенном примере создаваемый в библиотеке отчет носит имя otchet

Между входом Name функционального блока ReportFB и выходом получившейся программы устанавливается связь.

Смотрите также