Системные настройки

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

Настройки

Основные

Раздел содержит общие параметры приложения.

• Заголовок приложения — название, отображаемое в заголовке страницы браузера и в шапке интерфейса.
• Домашняя страница — URL-адрес страницы, которая открывается при входе пользователя в систему.
• Язык — язык интерфейса. Доступные варианты: Русский и English.

Аутентификация

По умолчанию ТехноДок поддерживает базовую аутентификацию пользователей по логину и паролю.

Настройки пользователей находятся в меню Настройки -> Безопасность. На форме Пользователи можно добавить и отредактировать существующих пользователей и их роли. На форме Роли можно настроить права для существующих ролей и добавить новые роли.

Дополнительно к базовой аутентификации можно включить способы аутентификации, перечисленные ниже.

Токены

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

• Время жизни токена доступа (мин) — период действия токена доступа в минутах. Допустимый диапазон: 1–525 600 (не более 1 года). По истечении срока пользователю потребуется повторная авторизация либо обновление токена.
• Время жизни токена обновления (дней) — период действия токена обновления в днях. Допустимый диапазон: 1–3 650 (не более 10 лет). Токен обновления позволяет получить новый токен доступа без повторного ввода логина и пароля.

Внешняя аутентификация

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

• Для включения аутентификации по токену активируйте опцию.
• В поле Токен введите значение токена (секретный ключ). Значение по умолчанию 9c5a61c7b1c14031a42f476cd09f8062.
• После сохранения пользователи могут авторизоваться в ТехноДок если перейдут по адресу http://localhost:8003/#/login?login=ivanov&token=9c5a61c7b1c14031a42f476cd09f8062&type=3&username=Иванов Иван&roles=Инженеры,Операторы, где:
  • localhost:8003 - хост и порт сервера ТехноДок.
  • login=ivanov - логин пользователя.
  • token=9c5a61c7b1c14031a42f476cd09f8062 - значение токена.
  • type=3 - тип авторизации по токену для внешних систем.
  • username=Иванов Иван - ФИО пользователя.
  • roles=Инженеры,Операторы - перечень ролей пользователя.
• Для доступа новых пользователей к ТехноДок включите опцию Создавать учетную запись пользователя при первом входе. Если в ТехноДок отсутствует учетная запись пользователя, то учетная запись будет создана при первом входе. Если опция отключена, то пользователь сможет авторизоваться только в том случае, если администратор системы создал учетную запись для пользователя вручную.

Для SCADA систем КАСКАД, Альфа платформа, АСОКУ и WinCC OA доступны заранее настроенные панели/мнемосхемы которые могут быть интегрированы в проект SCADA системы без дополнительных настроек. Подробнее про интеграцию со SCADA системами можно ознакомиться по ссылке.

Службы каталогов ADSI

Позволяет пользователям входить в ТехноДок с использованием учётных записей Windows-домена (Active Directory).

• Включить ADSI аутентификацию — активирует интеграцию с доменом. После включения пользователи могут авторизоваться по доменному логину и паролю.
• Создавать учётную запись пользователя при первом входе — если опция включена и в ТехноДок нет учётной записи для входящего пользователя, она будет создана автоматически. Если отключена — пользователь сможет войти только при наличии заранее созданной учётной записи.
• Синхронизировать роли — при каждом входе роли пользователя в ТехноДок обновляются в соответствии с его группами в Active Directory.

Службы каталогов X.500 (LDAP)

Позволяет пользователям входить в ТехноДок с использованием учётных записей LDAP-директории.

• Включить — активирует интеграцию с LDAP-сервером.
• Создавать учётную запись пользователя при первом входе — если опция включена и в ТехноДок нет учётной записи для входящего пользователя, она будет создана автоматически. Если отключена — пользователь сможет войти только при наличии заранее созданной учётной записи.
• Синхронизировать роли — при каждом входе роли пользователя в ТехноДок обновляются в соответствии с его группами в LDAP-директории.
• Адрес сервера — имя хоста или IP-адрес LDAP-сервера.
• Порт — порт подключения к LDAP-серверу.
• Административный пользователь — DN учётной записи с правами на чтение директории, используемой для поиска пользователей. Пример: cn=Manager,dc=maxcrc,dc=com.
• Пароль — пароль административной учётной записи.
• Путь до директории пользователей — базовый DN для поиска пользователей. Пример: ou=Users,ou=AlphaSecurity,dc=maxcrc,dc=com.
• Путь до директории групп — базовый DN для поиска групп (используется при синхронизации ролей).
• Атрибут идентификатора — имя атрибута, используемого как уникальный идентификатор пользователя. Пример: uid.
• Атрибут логина — имя атрибута, по которому выполняется поиск пользователя при входе. Пример: cn.
• Атрибут имени пользователя — имя атрибута с отображаемым именем пользователя. Пример: displayName.

Почтовый клиент

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

• Включить — активирует отправку почтовых сообщений. Пока опция отключена, почтовые задания накапливаются в очереди, но не отправляются.
• Адрес SMTP-сервера — имя хоста или IP-адрес исходящего почтового сервера.
• Порт SMTP — порт подключения к SMTP-серверу (например, 25, 465 или 587).
• Адрес отправителя — email-адрес, от имени которого отправляются все письма системы.
• Логин — учётное имя для авторизации на SMTP-сервере.
• Пароль — пароль учётной записи SMTP.
• Использовать SSL — включает шифрование соединения с SMTP-сервером по протоколу SSL/TLS.
• Проверять корректность сертификата — при включённом SSL проверяет действительность и цепочку доверия SSL-сертификата сервера. Рекомендуется включить в производственных средах.
• Проверять отзыв сертификата — дополнительно проверяет, не был ли сертификат SMTP-сервера отозван. Требует доступ к CRL или OCSP от сервера системы.
• Период хранения истории писем (дней) — через сколько дней записи об отправленных письмах удаляются из журнала. Значение 0 означает бессрочное хранение.
• Количество попыток отправки — сколько раз система повторяет попытку отправки, прежде чем пометить письмо как неотправленное. Значение 0 означает единственную попытку без повторов.

Для проверки доступности SMTP-сервера используйте кнопку Проверить соединение.

Отчеты

Раздел управляет поведением подсистемы отчётов: режимом эмуляции данных, правилами автоматической обработки и параметрами экспорта.

Общие настройки

• Режим эмуляции — при включении система подставляет сгенерированные случайные значения вместо реальных данных из внешних источников. Удобно для демонстрации и отладки шаблонов без подключения к источникам данных.
  • Количество эмулируемых значений — сколько случайных значений генерируется на один тег при эмуляции.
  • Тип эмулируемых значений — тип данных генерируемых значений: Double, Int или Text.
  • Минимальное значение / Максимальное значение — диапазон для числовых типов (Double, Int).
• Показывать нумерацию страниц при экспорте в PDF — добавляет колонтитул с номером страницы в каждый лист PDF-выгрузки отчёта.
• Формат даты компонента «Дата» — формат отображения даты и времени по умолчанию для компонента Дата в параметрах отчётов. Значение по умолчанию — HH24:mm:ss. Используется при создании новых компонентов Дата, если для них не задан собственный формат.

Правила

• Пересчитывать зависимые отчёты при изменении значений — при изменении значения в отчёте система автоматически инициирует пересчёт всех отчётов, которые ссылаются на этот отчёт через правила.
• Пересчитывать параллельно — разрешает одновременный пересчёт нескольких зависимых отчётов. Ускоряет обработку при большом числе зависимостей, но увеличивает нагрузку на сервер.
• Глубина генерации — максимальное количество отчётов, которое может быть создано за один запуск правила автогенерации. Ограничение предотвращает неконтролируемое размножение отчётов при неверно настроенных правилах.
• Количество параллельно обрабатываемых отчётов — ограничивает число отчётов, обрабатываемых одновременно при массовом пересчёте. Позволяет сбалансировать нагрузку на сервер.
• Максимальное количество попыток выполнения действия — сколько раз система повторяет попытку выполнить действие правила (например, отправку письма или экспорт) при возникновении ошибки.
• Игнорируемые типы действий — список типов правил, которые система полностью пропускает при обработке. Доступные значения: Пересчёт, Отправка по почте, Экспорт в файл, Блокировка, Создание, Печать, Удаление.

Бланки переключений

Раздел содержит параметры выполнения команд, экспорта и проверки ключа дистанционного управления для модуля бланков переключений.

Основные настройки

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

Соединения с внешними системами

Для выполнения команд записи и верификации бланк обращается к внешней SCADA-системе. Выберите нужное соединение для каждого из поддерживаемых протоколов:

• Соединение WinCC OA — соединение с системой WinCC OA.
• Соединение OPC — соединение с OPC-сервером.
• Соединение КАСКАД 4 — соединение с системой КАСКАД 4.

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

Все временны́е параметры задаются в миллисекундах.

• Максимальное количество попыток верификации — сколько раз система повторяет команду верификации при неудачном результате.
• Максимальное количество попыток записи — сколько раз система повторяет команду записи при неудаче.
• Задержка перед командой верификации — пауза между инициацией шага и отправкой команды верификации.
• Задержка перед командой записи — пауза между инициацией шага и отправкой команды записи.
• Задержка после команды верификации — пауза после получения ответа на команду верификации.
• Задержка после команды записи — пауза после получения ответа на команду записи.
• Задержка между попытками — интервал ожидания между повторными попытками верификации или записи.
• Задержка между шагами — пауза перед переходом к следующему шагу бланка.

Безопасные IP-адреса

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

Экспорт

• Сохранять бланк при остановке или закрытии — при остановке или закрытии бланка система автоматически экспортирует его в файл.
  • Тип файла — формат экспортируемого файла: PDF или DOCX.
  • Путь для сохранения — абсолютный путь к каталогу на сервере, в который сохраняются файлы.

Ключ дистанционного управления

• Включить проверку ключа дистанционного управления — перед выполнением команды записи система проверяет, что ключ ДУ находится в разрешённом положении (значение тега совпадает с эталонным). Шаг не будет выполнен, пока ключ не переведён в нужное положение.
  • Источник — тип системы, из которой считывается положение ключа: OPC, WinCC OA или КАСКАД.
  • Тег ключа — адрес тега в выбранном источнике данных.
  • Эталонное значение — значение тега, соответствующее разрешённому положению ключа ДУ.

Шаблон по умолчанию

• Заголовок — HTML-разметка, которая автоматически подставляется в верхний колонтитул при создании нового шаблона бланка переключений.
• Нижний колонтитул — HTML-разметка нижнего колонтитула по умолчанию.

Безопасность

Пользователи

На странице Пользователи отображается список учётных записей системы со следующими колонками:

• ФИО — отображаемое имя пользователя.
• Роли — перечень ролей, назначенных пользователю.
• Должность — должность пользователя.
• Тип аутентификации — способы входа: Внутренний, Внешний, Служба каталогов (Active Directory), Служба каталогов (X.500).
• Статус активности — активна ли учётная запись.
• В сети — присутствует ли пользователь в системе в данный момент.

Список можно фильтровать по имени, ролям, должности, типам аутентификации, статусу активности и признаку присутствия в сети. Для экспорта списка пользователей используйте кнопку Экспорт — доступны форматы CSV и Excel.

Добавление и редактирование пользователя

При нажатии кнопки Добавить или Редактировать открывается диалог со следующими полями:

• Имя — отображаемое имя пользователя (обязательное поле).
• Должность — должность пользователя.
• Активен — переключатель, определяющий, может ли пользователь выполнить вход в систему.
• Методы аутентификации — один или несколько методов входа для учётной записи. Для каждого метода указываются: тип (ADSI, LDAP, Внешняя система, Внутренняя), логин и пароль (для внутреннего типа). Тип ADSI дополнительно предоставляет возможность выбрать пользователя из дерева домена.
• Роли — одна или несколько ролей, определяющих права доступа пользователя.
• Подпись — изображение подписи пользователя (PNG/JPEG, не более 10 КБ, рекомендуемый размер 150×75 или 75×150 пикселей).

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

Роли

На странице Роли управляются наборы прав доступа. Слева расположен список ролей с возможностью поиска. Справа — редактор выбранной роли:

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

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

Системные права

• Администрирование — доступ к разделу настроек системы и управлению пользователями.
• Просмотр системного журнала — доступ к журналу событий в разделе диагностики.

Модуль «Отчеты»

Базовые права (применяются ко всем отчётам без привязки к конкретному шаблону):

• Администрирование модуля отчетов
• Просмотр отчета
• Редактирование отчета
• Создание отчета
• Удаление отчета
• Экспорт отчета
• Просмотр изменений отчета
• Отправка отчета по почте
• Печать отчета
• Блокировка отчета
• Переформирование отчета

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

• Отчеты → <Раздел> → <Шаблон>
• Другие отчеты → <Шаблон> (для шаблонов, не включённых ни в один раздел)

Модуль «Справочная информация»

• Просмотр справочной информации
• Редактирование справочной информации
• Администрирование справочной информации

Внешние соединения

• Просмотр внешних соединений
• Редактирование внешних соединений

Модуль «Наработка оборудования»

• Просмотр наработки оборудования
• Редактирование наработки оборудования
• Перерасчет наработки оборудования
• Администрирование наработки оборудования

Модуль «Бланки переключений»

• Просмотр бланков переключений
• Создание и работа с бланками переключений
• Администрирование шаблонов бланков переключений
• Редактирование команд шаблонов бланков переключений
• Просмотр справочника операций
• Редактирование справочника операций
• Редактирование команд справочника операций
• Просмотр справочника условий
• Редактирование справочника условий
• Редактирование команд справочника условий
• Просмотр справочника сигнализаций
• Редактирование справочника сигнализаций

Диагностика

Сервер

Страница диагностики сервера содержит информацию о состоянии системы, разбитую на несколько секций.

Информация о сервере

Отображает версию приложения и сведения о дисковом пространстве: свободный и общий объём в ГБ. При низком уровне свободного места выводится предупреждение. Если система развёрнута в кластерной конфигурации, дополнительно отображается список узлов кластера с адресом и статусом доступности каждого (Доступен / Недоступен).

Информация о лицензии

Содержит параметры текущей лицензии:

• Владелец — наименование организации, на которую выдана лицензия.
• Дата окончания — дата истечения лицензии или ∞ для бессрочной.
• Пользователи — текущее / максимальное число пользователей.
• Устройства — текущее / максимальное число устройств.
• Шаблоны отчётов — текущее число шаблонов (при наличии модуля отчётов).
• Шаблоны бланков — текущее число шаблонов (при наличии модуля бланков).
• Модули — список активных модулей лицензии.

При приближении даты окончания или истечении срока выводится соответствующее предупреждение. Для файловых лицензий доступна кнопка Активировать лицензию.

Периодические задачи

Фоновый планировщик выполняет следующие задачи:

• Отправка почты — отправляет все письма, накопившиеся в очереди и ещё не отправленные.
• Удаление почты — удаляет записи писем, у которых истёк срок хранения (задаётся в настройках почтового клиента).
• Расчет наработки — рассчитывает показатели наработки оборудования за прошедший период.
• Создание отчетов — создаёт отчёты согласно настроенным правилам автогенерации по расписанию.
• Обработка правил отчетов — обрабатывает правила (пересчёт, отправка, экспорт и другие) для существующих отчётов.
• Очистка журнала выполненных задач — удаляет устаревшие записи о выполненных задачах планировщика.

Для каждой задачи отображаются период выполнения, время последнего и следующего запуска, а также статус (Выполнено / Ошибка). Каждое задание можно запустить вручную кнопкой Запустить. Задания с ошибкой выделяются предупреждающей иконкой.

Информация о базе данных

Для каждого соединения с базой данных отображается:

• Роль — Primary (активный узел) или Standby (резервный).
• Тип — PostgreSQL, SQLite или MariaDB.
• Строка подключения — параметры соединения с БД.
• Состояние — Доступна / Недоступна.

Для конфигураций с MariaDB дополнительно отображается статус репликации: состояние потока репликации, задержка в секундах и тексты последних ошибок репликации (IO и SQL).

На странице также доступна функция экспорта системных логов по кнопке Экспортировать логи - доступен экспорт за текущий день, неделю и всё время.

Журнал писем

Страница отображает историю исходящих почтовых сообщений. Доступны следующие фильтры:

• Период — дата и время начала и окончания выборки.
• Статус — фильтр по состоянию доставки: Все, Отправлено, Ожидание, Не отправлено.
• Поиск — текстовый поиск по получателям, теме и именам вложений.

Каждая запись содержит:

• Время — дата и время отправки.
• Получатели — список адресов электронной почты.
• Тема — тема письма.
• Вложения — список прикреплённых файлов.
• Статус — состояние доставки; для писем в статусе Ожидание дополнительно отображается счётчик совершённых попыток.

Ненужные записи можно удалить кнопкой удаления в строке. Для экспорта журнала писем используйте кнопку Экспорт, записи будут выбраны согласно указанным фильтрам.

Журнал событий

Страница содержит аудит действий пользователей и системных событий. Доступны следующие фильтры:

• Период — дата и время начала и окончания выборки.
• Тег — фильтр по категории события: Все или конкретный тег (Error, Info, Warning и другие, загружаемые динамически).
• Поиск — текстовый поиск по описанию события и имени пользователя.

Каждая запись содержит:

• Время — метка времени действия.
• Пользователь — имя пользователя, выполнившего действие.
• Описание — человекочитаемое описание события.

Строки с тегом Error выделяются красным фоном. Если событие сопровождается изменением данных, в строке отображается ссылка Изменения — при переходе по ней открывается дерево изменённых полей с указанием старых и новых значений. Для экспорта журнала событий используйте кнопку Экспорт, записи будут выбраны согласно указанным фильтрам.

Настройка https

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

• Остановить сервер ТехноДок.
• В файле application.conf перейдите к секции Kestrel:Endpoints:Https и сконфигурируйте точки подключения по https:
  • Для ключа Url укажите адрес подключения (с портом).
  • Для ключа SslProtocols укажите используемые SSL протоколы.
  • В секции Certificate укажите путь до файла сертификата, а также пароль сертификата.
• Запустить сервер ТехноДок.

Перенаправление запросов на https

Ключ EnableRedirection в секции Kestrel:Endpoints:Https включает автоматическое перенаправление запросов, пришедших по http, на адрес https. По умолчанию ключ закомментирован, перенаправление отключено.

• EnableRedirection = True — запросы по http перенаправляются на https. Порт для перенаправления берется из ключа Url секции Kestrel:Endpoints:Https; если порт определить не удалось, используется 443.
• EnableRedirection = False — сервер отвечает на запросы по обоим протоколам, перенаправление не выполняется.

Строгая транспортная безопасность (HSTS)

HSTS (HTTP Strict Transport Security) — заголовок Strict-Transport-Security, которым сервер сообщает браузеру, что к данному узлу следует обращаться только по https в течение указанного времени. После получения заголовка браузер самостоятельно подменяет http на https, не отправляя незащищенный запрос.

Настройки задаются в секции Kestrel:Endpoints:Https файла application.conf. После изменения настроек необходимо перезапустить сервер ТехноДок.

• EnableHsts — отправлять заголовок Strict-Transport-Security. По умолчанию ключ закомментирован, HSTS отключен.
• HstsMaxAge — время действия политики в секундах (директива max-age). Значение по умолчанию — 2592000 (30 дней).

Пример конфигурации:

[Kestrel:Endpoints:Http]
Url                   = http://0.0.0.0:80
#
[Kestrel:Endpoints:Https]
Url                   = https://0.0.0.0:443
Certificate:Path      = /opt/SMS-Automation/certs/technodoc.pfx
Certificate:Password  = password
EnableRedirection     = True
EnableHsts            = True
HstsMaxAge            = 2592000

Условия применения HSTS

Заголовок отправляется только в том случае, если запрос пришел на порт по умолчанию, то есть в запросе не указан явный порт: https слушает порт 443, а http либо закрыт, либо слушает порт 80. Если сервер работает на нестандартных портах (например, 8003 и 8004), заголовок не отправляется: браузер применяет политику HSTS ко всему узлу, из-за чего доступ к нестандартному http-порту был бы потерян.

Кроме того, заголовок не отправляется:

• для запросов по http — политика передается только по защищенному соединению;
• для узлов localhost, 127.0.0.1 и [::1];

Диагностика конфигурации

При старте сервера конфигурация HSTS проверяется, и в журнал событий записываются предупреждения:

• HSTS не включен, т.к. порт HTTPS не задан — ключ EnableHsts включен, но не задан ключ Url в секции Kestrel:Endpoints:Https. Заголовок отправляться не будет.
• HSTS включен, но перенаправление запросов отключено. Клиенты впервые подключившиеся по HTTP не будут перенаправлены на HTTPS — одновременно открыта точка подключения по http и отключен ключ EnableRedirection. Браузер, который еще не получал заголовок от сервера, выполнит первый запрос по http и останется на незащищенном соединении. Для полноценной работы HSTS рекомендуется включить EnableRedirection либо закрыть точку подключения по http.

предупреждение

Браузер запоминает политику HSTS на время, указанное в HstsMaxAge, и до истечения этого срока продолжит обращаться к серверу только по https. Отключения ключа EnableHsts для отмены политики недостаточно, так как сервер просто перестает отправлять заголовок.

Чтобы отменить ранее выданную политику, оставьте EnableHsts = True и укажите HstsMaxAge = 0. Сервер будет отправлять заголовок с нулевым временем жизни, и браузеры сбросят политику при следующем обращении по https. После того как клиенты подключатся к серверу, HSTS можно отключить полностью. Также политику можно сбросить вручную в настройках браузера (например, на странице chrome://net-internals/#hsts в браузерах на основе Chromium).

Настройки выполнения приложения

При запуске приложения в средах с ограниченными ресурсами может потребоваться указать ограничения для выполняемого процесса. Настройки, описанные ниже, задаются в файле bin/Sms.TechnoDoc.runtimeconfig.json в секции runtimeOptions:configProperties. После изменения настроек необходимо перезапустить приложение.

• System.GC.Server — задает режим сборки мусора для приложения. Принимает значение true (серверный режим, используется по умолчанию) или false (режим рабочей станции). Серверный режим выделяет больше памяти для повышения пропускной способности, а режим рабочей станции позволяет снизить потребление памяти.
  Пример:

{
  "runtimeOptions": {
    "configProperties": {
      "System.GC.Server": false
    }
  }
}

примечание

При задании значения false потребление памяти снижается, но это может привести к уменьшению общей производительности приложения.

• System.GC.HeapHardLimit — задает максимальный размер памяти, потребляемый приложением. Указывается в байтах (по умолчанию ограничение не задано). Например, для ограничения в 200 МБ необходимо указать значение 209715200. Пример:

{
  "runtimeOptions": {
    "configProperties": {
      "System.GC.HeapHardLimit": 209715200
    }
  }
}

примечание

При задании слишком низкого значения для опции System.GC.HeapHardLimit могут возникать ошибки OutOfMemoryException при работе с большими объемами данных (например, при формировании отчетов с секундным шагом за период более одного часа).

Подробнее о данных и других настройках можно прочитать на сайте Параметры конфигурации среды выполнения .NET.