Alpha.Community

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

Описание интерфейса и функций программы

Запуск и авторизация

Чтобы запустить приложение Alpha.Reports.Configurator, укажите в браузере адрес: http://127.0.0.1:5000/Report/Configurator/?auth=Секретная строка.

Секретная строка – это уникальная строка, которая генерируется при запуске Alpha.Reports.

Пример секретной строки:

eyJzZXJ2ZXIiOiJodHRwOi8vMTI3LjAuMC4xOjUwMDAiLCJwYXNzd29yZCI6IjYwMTNlNjc1NjFmYmEwMmUwMjlhOTgwNGFjNWZkNDYzIiwidXNlciI6ImFkbWluIn0=

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

  • Программно обратитесь к функции GetAuthString().
  • Найдите строку |Info|Alpha.Reports|Строка авторизации в файле

    • Windows: C:\Program Files\Automiq\Alpha.Reports\logs\Service.log
    • Linux: /var/log/Automiq/Alpha.Reports/Service.log

    Файл создаётся при запуске службы Alpha.Reports.

В случае успешного запуска в окне браузера отобразится окно конфигуратора сервера отчётов. В случае проблем нужно проанализировать файлы-логи, исправить ошибки и переустановить приложение, если это потребуется.

Описание пользовательского интерфейса

После успешной авторизации, нажмите кнопку Конфигуратор: откроется окно пользовательского интерфейса.

Работа с шаблонами

Шаблоны – это файлы в формате *.xlsx, которые можно создать с помощью программы Alpha.Reports.Designer. На основе этих файлов строятся отчёты. Подробнее о построении шаблонов можно прочитать в документации на Alpha.Reports.Designer.

Добавление

Чтобы добавить шаблон:

  1. В списке шаблонов в контекстном меню выберите Добавить шаблон или нажмите кнопку + над списком.

  2. В открывшемся окне нажмите кнопку Выбрать и выберите шаблон отчёта, созданный в Alpha.Reports.Designer.

  3. Введите название и описание шаблона.

  4. Нажмите кнопку Добавить.

Редактирование

Чтобы редактировать шаблон, нажмите кнопку Открыть в дизайнере: выбранный шаблон откроется в Alpha.Reports.Designer.

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

Чтобы открыть предварительный просмотр шаблона, нажмите кнопку Открыть для просмотра: выбранный отчёт откроется в окне предварительного просмотра без возможности редактирования.

Чтобы сохранить отчёт в Excel, нажмите кнопку Сохранить в Excel.

Чтобы сохранить отчёт в PDF, нажмите кнопку Сохранить в PDF.

Чтобы сохранить отчёт в CSV-файл, нажмите кнопку Сохранить как CSV.

Чтобы отправить отчёт на печать, нажмите кнопку Печать.

При печати из встроенного веб-браузера в Alpha.HMI для вызова диалога печати нужно после нажатия кнопки Печать вызвать функцию WebContent.PrintDialog().

Вызов печати для встроенного веб-браузера в Alpha.HMI в текущем виде – временное решение, в будущем вызов печати будет переработан.

Чтобы задать переменные:

  1. Нажмите кнопку Задать переменные.

  2. В появившемся окне:

    1. Оставьте значения, указанные по умолчанию, или нажмите кнопку Текущая дата, чтобы заполнить значения текущими датой-временем.
    2. Нажмите кнопку Сформировать.

Чтобы сделать нажатие на какую-либо из этих кнопок недоступным, в адресной строке после названия отчёта добавьте &ExportToPrint=false, или &ExportToPDF=false, или &ExportToExcel=false.

Удаление

Чтобы удалить шаблон, выберите его и выполните одно из действий:

  • В контекстном меню выберите Удалить шаблон.

  • Нажмите кнопку Удалить шаблон.

Сохранение

Чтобы сохранить шаблон, выберите шаблон и выполните одно из действий:

  • В контекстном меню выберите Скачать шаблон.

  • Нажмите кнопку Скачать шаблон.

Работа с заданиями на автоматическое формирование отчётов

Создание

Чтобы создать задание для шаблона:

  1. В области Параметры задания нажмите кнопку Создать задание.

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

  2. В поле Описание введите название задания.
  3. В поле Маска файла:

    1. Нажмите кнопку ....

      Откроется окно Настройка задания.

    2. В поле задайте маску файла.

      Кнопки [name], [desc], [args], [datetime], [ticks], [tz] добавляют в поле строку соответствующего параметра. Также допустимо вводить свой текст.

      Значения параметров
      Параметр Описание
      [name] Имя шаблона отчёта.
      [desc] Описание шаблона отчёта.
      [args] Значения переменных, внесённых в отчёт по заданию.
      [datetime] Текущая дата и время на момент сохранения, без двоеточий.
      [ticks] Количество интервалов в 100 нс, прошедших с полуночи 1 января 0001 года до момента сохранения отчёта.
      [tz] Временная зона клиента.
    3. Нажмите кнопку Сохранить.
  4. В поле Аргументы:

    1. Нажмите кнопку ....

      Откроется окно Настройка задания.

      В окне отображается список всех переменных, содержащихся в отчёте.

    2. Чтобы добавить значение переменной к имени файла, в столбце Добавить к имени файла поставьте . Добавляться будет значение на момент формирования отчёта.

      Значения переменных будут добавляться к имени файла, если в маску файла был добавлен параметр [args].

      Чтобы в отчёте, сформированном по заданию, отображалась переменная с текущей датой и временем, в столбце Значение по умолчанию для этой переменной укажите *.

      Кроме * можно указать:

      • T – текущая дата
      • W – дата начала недели
      • M – дата начала месяца
      • Y – дата начала года

      Указанной дате можно добавить смещение: *+1d – текущая дата и время, смещённая на 1 день вперёд (завтрашний день). Модификаторы даты/времени:

      • s – секунда
      • m – минута
      • h – час
      • d – день
      • M – месяц
      • y – год

      Значение типа Дата выбирается из календаря.

      Значение типа Время выбирается из списка времени.

      Переменная Список содержит значения списка, который был создан и присвоен переменной при создании отчёта.

    3. Нажмите кнопку Сохранить изменения.
  5. Для отправки отчёта на почту:

    1. Добавьте адресата в список, нажав кнопку ....

      Откроется окно Настройка рассылки отчёта.

    2. Нажмите кнопку Добавить.

      Откроется окно Новый адрес электронной почты.

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

      Если введёный адрес является невалидным, появится сообщение

      Введённый адрес имеет неправильный формат
    4. Нажмите кнопку Сохранить.
  6. Выберите формат:

    • xlsx (Excel)
    • pdf
    • csv

  7. Нажмите кнопку Сохранить.

    Данные отобразятся в списке заданий.

Редактирование

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

После внесения изменений, нажмите кнопку Сохранить. Чтобы отменить внесение изменений, нажмите кнопку Отмена.

Удаление

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

Выполнение

Чтобы создать отчёт по заданию на текущий момент времени, выберите задание и выполните одно из действий:

  • В контекстном меню выберите Выполнить задание.

  • Нажмите кнопку Выполнить задание над списком заданий.

В результате будет сформирован и сохранён отчёт.

Триггеры

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

Заданиям нужно задать триггер на выполнение. Для этого:

  1. Выберите задание и выполните одно из действий:

    • В контекстном меню выберите Триггеры.

    • Нажмите кнопку Триггеры над списком заданий.

    Откроется окно Триггеры.

  2. Нажмите кнопку Создать триггер.

    Поля параметров триггера станут доступны для редактирования.

  3. Укажите параметры триггера:

    1. В поле Описание введите название триггера.
    2. Задайте тип формирования отчёта:

      • По расписанию
      • По событию.
    3. Для отчёта по расписанию:

      1. Нажмите кнопку Настройка расписания.

        Откроется окно Настройка расписания.

      2. Настройте параметры расписания.
      3. Сохраните настройки расписания.
    4. Для отчёта по событию:

      1. Нажмите кнопку Настройка условий.

        Откроется окно настройки условий.

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

        В открывшемся окне:

        1. Укажите переменную.
        2. Выберите источник данных.
        3. Выберите атрибут из выпадающего списка тегов.
        4. Нажмите кнопку Сохранить.

        Переменная отобразится в разделе Переменные.

      3. В поле Формула пропишите условие формирования отчёта по событию с использованием логических операторов или функций из выпадающего списка.

      4. Чтобы проверить формулу, нажмите кнопку Проверка и в открывшемся окне задайте значение для каждой переменной, после чего нажмите кнопку Вычислить.

        Результатом проверки будет число или значение true/false.

  4. В поле Срок хранение (дней) укажите количество дней хранения отчёта.

    0 – отчёт удаляться не будет.

  5. Сохраните триггер.

Чтобы редактировать триггер, выберите его в списке и нажмите кнопку Редактировать. После внесения изменений, сохраните внесённые изменения (кнопка Сохранить) или отмените их (кнопка Отмена).

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

При выполнении задания с указанием формата задания PDF (в параметрах задания), сохранённый файл отчёта отображается не полностью. Нужно вместить все столбцы отчёта на одну страницу.

Сохранение отчёта на компьютер

Чтобы сохранить отчёт на компьютер, выберите отчёт в списке файлов и в контекстном меню выберите Скачать отчёт или нажмите кнопку Скачать отчёт над списком.

Удаление отчёта из списка файлов

Чтобы удалить отчёт из списка файлов, выберите отчёт и выполните одно из действий:

  • В контекстном меню выберите Удалить отчет.

  • Нажмите кнопку Удалить отчет.

Просмотр отчётов

  1. В главном меню нажмите кнопку Просмотр отчётов.

    Откроется окно пользовательского интерфейса.

  2. Выберите шаблон и список заданий.

  3. В списке файлов выберите отчёт:

    • Чтобы открыть отчёт для просмотра, нажмите кнопку Просмотреть отчет.

    • Чтобы скачать отчёт, нажмите кнопку Скачать отчет.

Обновление информации

Чтобы заново загрузить информацию с сервера Alpha.Reports, на панели инструментов нажмите кнопку Обновить.

Статус подключения к серверу

Статус подключения к серверу Alpha.Reports указан в строке состояния:

  • Подключено – подключение активно.
  • Отключено – связь отсутствует.