Начало работы#

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

Настройка модуля#

Перед первым запуском модуля необходимо указать его настройки в конфигурационном файле Gems.ReportEditor.exe.config:

<add key="hostReportingApiAddress" value="https://публичное доменное имя системы/api/reporting"/> — сервис отчетности
<add key="hostTokenServiceAddress" value="https://публичное доменное имя системы/connect/token"/> — сервис авторизации
<add key="ignoreSslCertificateValidating" value="true" /> — игнорировать или нет невалидный сертификат
<add key="LocalizationCulture" value="ru" />, где ru — язык редактора отчёта

Примечание

  • На данный момент доступны языки: ru, en.

  • Локализация шаблона должна соответствовать локализации Geometa (шаблон созданный в русскоязычной локализации Geometa должен использоваться только в русскоязычной Geometa).

  • В редакторе масок текст настраивается с помощью xml-файла mask.xml в корне приложения. Тексты и параметры генерации QR-кода задаются json-описанием в БД в таблице kazan.d_sys_settings с наименованием ReportingProjectSettings.

Если подключаться к Системе по IP-адресу, то в файле Gems.ReportEditor.exe.config нужно указать порты:

<add key="hostReportingApiAddress" value="https://IP-адрес системы:5001/api/reporting"/>
<add key="hostTokenServiceAddress" value="https://IP-адрес системы:5002/connect/token"/>

Запуск редактора отчетов#

Для начала работы необходимо запустить модуль «Редактор отчетов» с помощью исполняемого файла Gems.ReportEditor.exe.

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

Заполните поля [Имя пользователя], [Пароль] и нажмите кнопку «Войти».

При успешном прохождении авторизации будет открыто окно редактора отчетов.

Описание редактора отчетов#

Главное окно модуля «Редактор отчетов» состоит из:

  1. Панель инструментов главного окна.

  2. Панель описания параметров метаданных.

  3. Панель шаблона отчета.

  4. Панель выбора метаданных.

../../_images/main_window_2.png

Панель инструментов главного окна#

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

Панель описания параметров метаданных#

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

В панели описания параметров метаданных выполняется настройка параметров и ограничений вывода значений элементов шаблона отчета. (См. Редактирование метки в шаблоне, Удаление метки на объект)

Чтобы панель автоматически сворачивалась нажмите кнопку закрепить в правом верхнем углу панели. Чтобы закрепить панель в открытом виде, повторно нажмите кнопку.

Панель можно переместить в любую часть монитора, зажав левую кнопку мыши.

Панель шаблона отчета#

В панели шаблона отчета выполняется изменение внешнего вида (Изменить внешний вид шаблона), а также изменение формата вывода на печать и тиражирование шаблонов. (См. Как изменить формат вывода шаблона на печать , Как тиражировать шаблоны отчетов)

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

Панель выбора метаданных#

Панель выбора метаданных состоит из вкладок Метаданные и Внешние данные.

Чтобы панель выбора метаданных автоматически сворачивалась, нажмите кнопку закрепить в правом верхнем углу панели. Чтобы закрепить панель в открытом виде, повторно нажмите кнопку.

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

Метаданные#

Во вкладке «Метаданные» можно выбирать метки объектов, которые могут быть вставлены в отчет (см. Добавление, изменение, удаление метки объекта).

../../_images/panel2%2B.png

Метки отображаются в виде дерева с главным элементом - тип объекта, к которому привязан шаблон отчета.

Остальные элементы дерева - это поля объекта, а также набор связанных других типов объектов.

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

Внешние данные#

Во вкладке «Внешние данные» формируется структура данных таблиц, используемых для взаимодействия с плагинной системой.

../../_images/external_data.png
Взаимодействие приложения и плагина#

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

Ниже представлена схема взаимодействия модуля «Редактор отчетов» и плагинной системы:

../../_images/plugin.png
Настройка шрифта#

Если в операционной системе установлен шрифт «Arial», то он будет использоваться в тексте изображения (поворотные точки, выноски, экспликационные номера, отступы). В случае, если шрифт не установлен, то будет использоваться шрифт по умолчанию «Pt Astra Sans».