Как работать с построителем отчетов FastReport Desktop из командной строки

В состав программного комплекса FastReport Desktop входит консольный построитель отчетов.

Построитель отчетов – это консольная программа для автоматизации операций над отчетами.

Он может выполнять следующие операции:

• пакетная обработка отчетов;
• экспорт во все доступные форматы;
• подключение источника данных;
• отправка результата по e-mail;
• сохранение результата локально, на ftp и на облачные хранилища.

Построитель отчетов тесно связан с Конфигуратором, который создает специальные конфигурационные файлы-инструкции. Эти инструкции позволяют задать экспорт отчета, выбрать место сохранения отчета и отправлять отчеты по email. Построитель получает эти инструкции и выполняет их по расписанию, которое в свою очередь создается в программе Планировщик.

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

Давайте рассмотрим три варианта взаимодействия с построителем отчетов:

• Передавать построителю конфигурационный файл. Для этого запускаем построитель отчетов в командной строке Windows и передаем ему конфигурационный файл:

"Builder.exe path/to/config.xml"

Тут, как вы поняли, вызов построителя с одним параметром – путь к конфигурационному файлу;

• Передавать построителю конфигурационный файл и переопределять некоторые его параметры. У вас есть возможность загрузить конфигурационный файл и заменить нужные параметры, например, директорию сохранения экспорта отчета:

"Builder.exe --Config-Path=path/to/config.xml --Save-Path=./dir"

То есть для переопределения атрибута нужно использовать следующую схему:

--{имя команды}-{имя параметра}={значение}

Получается вот так:

--Save-Path=./dir

В варианте с переопределением команд нужно указывать команду Config для определения пути к файлу конфигурации.

• Передавать в построитель параметры-команды. При этом подходе мы не загружаем конфигурационный файл, а по сути формируем инструкцию для построителя в командной строке. Передаем параметры, также как бы мы их определяли в Конфигураторе. Давайте посмотрим на пример:

--Report-Path="report.frx" --Export-As=image --Export-ImageFormat=Jpeg --Export-JpegQuality=80 --Save-To=folder --Save-Path="path/to/folder"

Так как мы не загружаем файл конфигурации команда --Config здесь не нужна. Обратите внимание, что мы три раза использовали команду --Export. Для каждого свойства экспорта, которое вы хотите переопределить (в отличие от значений по умолчанию) нужно писать имя команды. Таким образом можно определить любой параметр доступный в Конфигураторе. Полный список команд и свойств (атрибутов) можно посмотреть в документации к FastReport Desktop.

Итак, мы рассмотрели различные варианты работы с консольным построителем отчетов. Теперь вы можете использовать его в комплексе со своими программами, достаточно лишь передать набор параметров.