Система архивирования
Система архивирования решает задачу формирования истории изменений контролируемых технологических параметров. Формируемая история может быть использована для анализа контролируемого процесса и может быть представлена оператору в виде графиков и отчетов. Значения параметров архивируются циклически, период архивирования и глубина архива может конфигурироваться отдельно для каждого параметра. Для настройки системы архивирования используется редактор архивов, располагаемый на вкладке “Архивы”
(Вставить рис. “Редактор архивов”).
Редактор архивов имеет 2 режима работы:
- “Архивы”
- “Мастера”
Режим архивов В режиме “Архивы” редактор позволяет работать с базой архивируемых параметров, добавлять новые архивы, производить их настройки, редактировать и удалять созданные ранее.
Режим архивов
В режиме “Архивы” редактор позволяет работать с базой архивируемых параметров, добавлять новые архивы, производить их настройки, редактировать и удалять созданные ранее.
Описание интерфейса редактора архивов
Для работы с базой архивов используется панель управления:
Элементы панели:
| Обновление отображения базы сообщений. Если над проектом одновременно работают несколько разработчиков кнопка может служить для получения обновлений, выполненных другими. | |
|---|---|
| Создание нового сообщения (см. п. “Создание/редактирование сообщения”) | |
| Создание новых сообщений с помощью мастера (см. п. “Создание сообщений с помощью мастера”) | |
| Изменение настроек выделенного сообщения | |
| Удаление выделенных сообщений | |
| Автоматическое создание мастера для по выделенным сообщениям (см. п. “Автоматическое создание мастера”) | |
| Переключатель режимов работы редактора | |
| Экспорт базы архивируемых сообщений в .csv файл (см. п. “Экспорт/Импорт конфигурации сообщений”) | |
| Импорт базы архивируемых сообщений из .csv файла (см. п. “Экспорт/Импорт конфигурации сообщений”) | |
Создание архивов
Создание новых архивов или редактирование настроек уже имеющихся производится с помощью формы:
Архив имеет следующий набор настроек:
| Имя | Имя архива. Для архивов рекомендуется использовать емкие названия отражающие хранимые в них данные, например, “Температура в котле”. Имя архива выводится в окне трендов (см. Тренды) по умолчанию. По названию архива оператору должно быть понятно с каким графиком он работает. Имя должно быть уникальным в рамках проекта. | Период | Значение параметра архивируется с заданной периодичностью. ВНИМАНИЕ! Изменение данного параметра может существенно отражаться на требованиях к аппаратному обеспечению сервера Faceplate. Уменьшение данного параметра ведет к увеличению нагрузки на ЦПУ, а также объему дискового пространства требуемому для хранения архивов. | Глубина | Длина хранимой истории изменений параметра в днях. Минимальное значение - 1 день, максимальное значение не ограничено. При конфигурировании глубины архивов необходимо учитывать свободное пространство на дисках сервера. Архив 1-го параметра периодичностью 1 сек. глубиной в 1 месяц занимает в среднем 20 MB. | Минимальный шаг | Если данный параметр задан, то система будет писать в архив новое значение, только если оно отличается от предыдущего на величину большую или равную значению данного параметра. Например, если в канале измерения наблюдается помеха, то в некоторых случаях приемлемо задать минимальный шаг изменения равный средней амплитуде помехи. Это позволит отражать в архиве только устойчивую тенденцию изменения параметра, не реагирую на кратковременные незначительные отклонения. Задание данного параметра может существенно снизить нагрузку на ЦПУ и диск сервера Faceplate. | Активен | Настройка позволяет отключить архивирование параметра в режиме исполнения | Тип | Значения:
|
|---|
Использование скриптов для предобработки архивируемых значений
Возможность использования скриптов для вычисления значения архивируемого параметра предоставляет разработчику гибкий инструмент, позволяющий выполнять сложную предобработку записываемого в архив значения, а также вычислять значение архива по значениям нескольких каналов измерения, например сумма показаний нескольких расходомеров. Задание скрипта выполняется с помощью формы создания/редактирования архива, при выборе типа SCRIPT:
Язык программирования скрипта - Erlang. Скрипт должен представлять собой функцию Erlang, которая принимает на вход 2 параметра:
- VARS - объект типа map содержащий значения полей тегов заданных в разделе объявления переменных. Для получения значения переменной из скрипта можно воспользоваться функцией Erlang maps:get(<имя переменной>,VARS) ВНИМАНИЕ! Для корректной работы скрипта рекомендуется при обращении к переменной проверять ее значение на none, так как поле тега, привязанное к переменной, может не содержать значения, например в случае сбоя в работе контроллерного соединения (см. Соединения).
- State - хранимое состояние. Если для вычисления текущего значения архива необходимо знать некоторую предысторию, например, его предыдущее значение, то скрипт должен возвращать кортеж вида: { <значение>, <хранимое состояние> } В этом случае возвращаемое хранимое состояние будет подано на вход скрипта при следующем вызове. Если не требуется хранить состояние, то допускается возврат только вычисленного значения архива. Данный механизм может быть использован, например для выполнения сглаживания, когда текущее значение архива рассчитывается как среднее с учетом нескольких предыдущих значений.
Для компиляции скрипта необходимо нажать кнопку:
Если компиляция выполнена без ошибок, то напротив кнопки компиляции появится надпись “ok”, иначе будет выведен список ошибок, например:
Общий принцип работы работы:
- Система архивирования считывает значения из полей тегов, к которым привязаны объявленные переменные
- Выполняется вызов скрипта с передачей на вход map с со значениями переменных
- Сохранение в базу значения, возвращаемого из скрипта.
Создание архивов с помощью мастера
Мастер служит для автоматизации действий разработчика при создании архивов на группу тегов. Создание архивов с помощью мастера выполняется с помощью следующего диалога:
Для запуска мастера нужно заполнить параметры:
| Мастер | Выбор мастера, из списка доступных. Мастера должны быть заранее сконфигурированы через “Автоматическое создание мастера” или с помощью “Режима настройки мастеров” в редакторе архивов. |
|---|---|
| Теги | Выбор тегов, для которых будут созданы сообщения. Поддерживается выбор тегов из выпадающего списка либо с помощью обозревателя тегов, вызываемого по кнопке:
Поддерживается множественный выбор, в этом случае сообщения будут созданы для всех выбранных тегов.
|
Автоматическое создание мастера
Если для одного тега созданы один или более архивов, можно создать по ним мастер, который далее может использоваться для автоматизации действий при создании архивов для данного типа тегов. Для создания мастера нужно выбрать один или более архивов, относящихся к одному и тому же тегу, после чего станет доступна кнопка “Создать мастер”. При щелчке по кнопке появится диалог, предлагающий задать имя создаваемого мастера:
При создании мастера автоматически будут созданы шаблоны архивов (см. п. “Создание/Редактирование шаблонов архивов”) на основе архивов выделенных в таблице.
Экспорт/Импорт конфигурации архивов
База архивируемых параметров может быть выгружена в .csv файл - кнопка “Экспорт” в редакторе архивов (см. Описание интерфейса редактора архивов). В результате браузер загрузит файл с базой архивируемых параметров - ARCHIVES_BASE.csv. Формат .csv является текстовым и предназначен для представления табличных данных. Используемая кодировка - UTF8, в качестве разделителя столбцов используется символ табуляции. Просмотр и редактирование файла удобно выполнять с помощью табличных редакторов, поддерживающих формат .csv (например Microsoft Excel - https://products.office.com/ru-ru/excel или LibreOffice - https://ru.libreoffice.org/), пример содержимого файла в редакторе LibreOffice:
Каждая строка соответствует одному архивируемому параметру имеет следующий набор полей:
| .name | Имя архива |
|---|---|
| var_list | Входные значение для вычисления результата архива. Формат: <имя переменной>|<тег>|<поле> Если для вычисления значения используется скрипт, в котором объявлено несколько переменных (см. Использование скриптов для предобработки архивируемых значений), то они будут перечислены через точку с запятой - “;” |
| script | Тело скрипта в формате base64 |
| active | Настройка позволяет отключить архивирование параметра в режиме исполнения |
| cycle | Период архивирования |
| days | Глубина архива |
| step | Минимальное отклонение параметра подлежащее фиксированию |
(см. Создание архивов)
В файле можно добавить или отредактировать строки. Сохранение нужно делать в том же формате (формат - csv с разделителями Tab, кодировка UTF8). Файл можно импортировать обратно в проект, в результате чего внесенные изменения будут загружены в базу. Также механизм экспорта/импорта позволяет переносить настройки между проектами, например с тестового сервера или станции разработчика на боевой проект. Для импорта файла нужно в редакторе архивов (см. Описание интерфейса редактора архивов) щелкнуть по кнопке “Импорт”. В результате появится диалог выбора файла:
Поддерживается выбор файлов с помощью проводника (кнопка “Browse”) или операции drag-and-drop, т. е. перетаскивания файла мышью в область с надписью “no file selected”. После выбора файла станет активна кнопка “OK”, при щелчке по которой будет выполнен импорт выбранного файла. В случае несогласованности импортируемых из файла данных, например при отсутствии указанного тега, будет выведена ошибка с указанием номера строки и текста ошибки, например:
Внимание! Импортируемый файл с базой архивируемых параметров должен обязательно иметь имя ARCHIVES_BASE.csv. Имя файла используется механизмом импорта для определения программного модуля, выполняющего загрузку данных из файла.
Режим настройки мастеров
Режим “Мастера” служит для конфигурации мастеров, используемых при создании архивов (см. п. “Создание архивов с помощью мастера”). Перейти в режим настройки мастеров можно с помощью переключателя:
В режиме мастеров редактор позволяет работать с базой мастеров и относящихся к ним шаблонов архивов. В редакторе можно создавать новые мастера. А также конфигурировать шаблоны архивов для них.
Интерфейс
Для работы с базой мастеров архивов используется следующая панель управления:
Элементы панели:
| Обновление отображения базы сообщений. Если над проектом одновременно работают несколько разработчиков кнопка может служить для получения обновлений, выполненных другими. | |
|---|---|
| Группа “Мастера” | |
| Создание нового сообщения (см. п. “Создание/редактирование сообщения”) | |
| Создание нового мастера (см. п. “Создание/Редактирование мастера”) | |
| Изменение настроек выделенного мастера | |
| Удаление выделенных мастеров | |
| Группа “Шаблоны” | |
| Создание нового шаблона архива (см. п. “Создание/Редактирование шаблонов архивов”) | |
| Изменение настроек выделенного шаблона архива | |
| Удаление выделенных шаблонов архивов | |
| Переключатель режимов работы редактора | |
Редактор мастеров сообщений выглядит следующим образом (см. рис. “Режим настройки мастеров архивов”):
В левой панели выводится список имеющихся мастеров. При выборе мастера в правую панель выводится список относящихся к нему шаблонов архивов.
Создание мастеров
Создание новых мастеров или редактирование настроек уже имеющихся производится с помощью формы:
Мастер имеет следующий набор настроек:
| Шаблон тега | Тип тегов: регулятор, аналоговый параметр и т. д. (см. Редактор шаблонов), для которых будет доступен создаваемый мастер |
|---|---|
| Имя | Имя мастера. При выборе шаблона тега название будет предложено автоматически исходя из выбранного шаблона и уже занятых имен мастеров, разработчик может сам задать имя мастера. Имя должно быть уникальным в рамках проекта |
Создание шаблонов архивов
Создание новых шаблонов архивов или редактирование настроек уже имеющихся производится с помощью формы:
Шаблон архива создается для выбранного в мастере типа тегов и имеет следующий набор настроек:
| Имя | Имя архива. Для архивов рекомендуется использовать емкие названия отражающие хранимые в них данные, например, “Температура в котле”. Имя архива выводится в окне трендов (см. Тренды) по умолчанию. По названию архива оператору должно быть понятно с каким графиком он работает. Имя должно быть уникальным в рамках проекта. В результате работы мастера результирующее имя архива архива будет представляет собой результат конкатенации имени тега, для которого запущен мастер и имени архива, определенного в данном шаблоне |
|---|---|
| Период | Значение параметра архивируется с заданной периодичностью. ВНИМАНИЕ! Изменение данного параметра может существенно отражаться на требованиях к аппаратному обеспечению сервера Faceplate. Уменьшение данного параметра ведет к увеличению нагрузки на ЦПУ, а также объему дискового пространства требуемому для хранения архивов. |
| Глубина | Длина хранимой истории изменений параметра в днях. Минимальное значение - 1 день, максимальное значение не ограничено. При конфигурировании глубины архивов необходимо учитывать свободное пространство на дисках сервера. Архив 1-го параметра периодичностью 1 сек. глубиной в 1 месяц занимает в среднем 20 MB. |
| Минимальный шаг | Если данный параметр задан, то система будет писать в архив новое значение, только если оно отличается от предыдущего на величину большую или равную значению данного параметра. Например, если в канале измерения наблюдается помеха, то в некоторых случаях приемлемо задать минимальный шаг изменения равный средней амплитуде помехи. Это позволит отражать в архиве только устойчивую тенденцию изменения параметра, не реагирую на кратковременные незначительные отклонения. Задание данного параметра может существенно снизить нагрузку на ЦПУ и диск сервера Faceplate. |
| Тип | Значения:
|
При создании архивов с помощью мастера (см. п. “Создание архивов с помощью мастера”) настройки создаваемых архивов будут взяты из настроек шаблонов принадлежащих мастеру.