Настройка отчёта

Создание и настройка отчёта может проходить как в Web-клиенте, так и в Windows-клиенте.

Создание отчёта предполагает выполнения нескольких шагов:

  1. Настроить подключения источников данных.

  2. Создать шаблон отчёта и карточку файла шаблона отчёта.

  3. Создать и настроить отчёт.

Настройка подключений источников данных

Для настройки подключений источников данных откройте раздел (узел) Подключения в Web-клиенте в разделе отчёты.

Раздел "Подключения"
Рисунок 1. Раздел "Подключения"
Создайте новое подключение, заполните:

  1. Название — используется для отображения названия подключения при настройке Источников данных в отчёте.

  2. Описание — используется, как поясняющее назначение текущей строки подключения.

  3. Строка подключения — используется для хранения настройки подключения к БД, задается в формате "ADO.NET".

    Шаблон строки подключения:
    Data Source=<имя сервера СУБД>;Initial Catalog=<название БД DV или любой другой >;User ID=<логин >;Password=<пароль>;Integrated Security=False;
    Строка подключения к базе данных:

    Строка подключения содержит адрес подключения к базе данных для хранения настроек. Вид строки подключения зависит от выбранной базы данных.

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

    Для Microsoft SQL Server: Data Source=Адрес-сервера-баз-данных;Initial Catalog=Название-БД-Конструктора отчётов;Integrated Security=False;User ID=Имя-пользователя-БД;Password=Пароль-пользователя-БД;TrustServerCertificate=True.

    • Data Source — адрес сервера SQL для подключения к БД. В качестве Data Source может быть указан экземпляр SQL-сервера, например так: Data Source=DVDatabse\\Server1.

    • Название-БД-Конструктора отчётов — псевдоним базы данных.

    • Integrated Security — задает логическое значение, определяющее способ проверки подлинности:

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

      • True — при подключении будут использованы учетные данные текущей учетной записи Windows.

    • Имя-пользователя-БД — учётная запись пользователя для подключения к БД.

    • Пароль-пользователя-БД — пароль учётной записи для подключения к БД.

    • TrustServerCertificate=True — подробнее про настройку см. особенности настройки сертификата.

    При использовании строки подключения к хранилищу с Windows-аутентификацией для Microsoft SQL Server учетной записи службы Конструктора отчётов необходимо предоставить права на создание новых БД, а также полные права на БД, которая будет создана при запуске Конструктора отчётов.

    Если в строке подключения введены корректные данные, при запуске Конструктора отчётов будет создана новая или обновлена существующая БД Конструктора отчётов.

    Для PostgreSQL: host=Адрес-сервера-баз данных;Port=SQL-порт;database=Название-БД-Менеджера решений;Username=Имя-пользователя-БД;Password=Пароль-пользователя-БД.

    • Адрес-сервера-баз данных — адрес сервера SQL для подключения к БД.

    • SQL-порт — порт SQL-сервера.

    • Название-БД-Менеджера решений — псевдоним базы данных.

    • Имя-пользователя-БД — учётная запись пользователя для подключения к БД.

    • Пароль-пользователя-БД — пароль учётной записи для подключения к БД.

  4. Не используется — флаг, отражающий возможность использования данного подключения при настройке отчётов.

    Настройка подключений источников данных
    Рисунок 2. Настройка подключений источников данных

Создание шаблона отчёта

Шаблон отчёта — файл, в котором определяется, внешний вид отчёта, расположение элементов, источники данных и логика формирования содержимого.

Настройка шаблона происходит в зависимости от выбранного провайдера. Для создания шаблонов отчётов провайдера FastReport используйте конструктор "Fast Report Designer" (см. документацию FastReport 4.6).

Для провайдера FastReport загрузка шаблона происходит путем создания РК вида "Файл" и добавления файла расширения .frx в созданную карточку. Далее этот шаблон отчёта будет использоваться при настройке отчёта в Docsvision.

Загруженный файл шаблона в карточку
Рисунок 3. Загруженный файл шаблона в карточку

Создание и настройка отчёта

Для настройки самого отчёта, откройте раздел (узел) Настройка отчётов в Web-клиенте в разделе отчёты и нажмите кнопку создания отчёта, Синий плюс.

Карточка отчёта
Рисунок 4. Карточка отчёта
Чтобы создать отчёт, заполните:

  1. Название — используется для идентификации отчёта для пользователей на вкладках отчёты и Настройка отчётов.

  2. Провайдер — механизм, отвечающий за генерацию файла отчёта. Доступны следующие провайдеры:

    • "FastReport" — формирование отчёта выполняется на уровне сервера приложений Docsvision средствами библиотеки FastReport.OpenSource.

  3. Шаблон отчёта — при использовании провайдера "FastReport" выберите карточку вида Файл с загруженным файлом шаблона. При использовании других провайдеров генерации отчётов, файл шаблона загружать в Docsvision не требуется, если шаблон отчёта хранится на сервере генератора отчётов.

  4. Данные отчёта — выборки, значения которых будут отображены в сформированном отчёте.

    • Имя источника в шаблоне — наименование источника данных, указанное в файле шаблона отчёта FastReport.

    • Тип источника данных — определяет тип источника SQL или API. Работа с типом источника API описана в разделе "Источник данных API".

    • Подключение — ссылка на строку подключения к базе данных. Используется при "Типе" источника данных SQL.

    • Функция — текст SQL запроса или название метода при "Типе" источника данных API.

  5. Параметры отчёта — табличная часть, отражающая переменные, необходимые для ограничения выборки данных отчёта. Отчёт может не содержать параметров, в таком случае отчёт будет сформирован без вызова автогенерируемой формы ввода параметров.

    • Параметр — тип ЭУ параметра, отображаемого на форме ввода параметров отчёта, см. раздел "Преднастроенные параметры".

    • Название — наименование параметра, отображаемое на форме ввода пара-метров отчёта.

    • Текст метки — содержимое метки, отображаемой слева от ЭУ параметра.

    • Подсказка — содержимое всплывающей подсказки.

    • Узел конструктора справочника — узел Конструктора справочников, который будет использоваться для выбора строки справочника при выборе значения параметра. Используется для ЭУ Строка конструктора справочников.

    • Обязательность — флаг, указывающий на обязательность заполнения параметра.

    • Скрытый — флаг видимости параметра на форме (для передачи в отчёт параметров без необходимости их заполнения пользователем).

    • Свойства — настройка свойств для ЭУ параметров отчёта, к примеру свойство default - определяет значение по умолчанию для ЭУ. Примеры настройки см. в разделе "Преднастроенные параметры".