Установка и обновление
Требования
Сервер
ТехноДок поддерживает ОС Windows и Linux:
- Windows
- Windows 10 и выше.
- Windows Server 2012 (с расширенными обновлениями безопасности) и выше.
- Необходим пакет
Microsoft Visual C++ 2015-2022 Redistributable
.
- Linux
- Debian 11 и выше.
- Ubuntu 20.04 и выше.
- Fedora 38 и выше.
- Производные от них.
- Необходимые компоненты:
wkhtmltopdf
lp
Клиент
- Браузер Google Chrome 89.0+ или Mozilla Firefox 87.0+.
Установка
Для установки необходимо выполнить следующие шаги:
- Создать директорию (например, Programs), в которую будет установлено ТехноДок:
- Linux: sudo mkdir
/opt/Programs && sudo chown $USER: /opt/Programs
- Windows:
mkdir "C:/Programs"
- Linux: sudo mkdir
Для установки ТехноДок выбирайте директорию так, чтобы путь до директории и название директории содержали только символы из английского алфавита.
- Распаковать архив с ТехноДок в созданную директорию:
- Linux:
unzip -d /opt/Programs/TechnoDoc [Путь до директории архивом ТехноДок]/TechnoDoc-[версия приложения].zip
- Windows:
unzip -d "C:/Programs/TechnoDoc" [Путь до директории с архивом ТехноДок]/TechnoDoc-[версия приложения].zip
- Linux:
- Добавить прав о на запуск сервера и мигратора ТехноДок:
- Для Linux:
sudo chmod +x /opt/Programs/TechnoDoc/bin/Sms.TechnoDoc
- Для Windows: выполнение команд не требуется
- Для Linux:
- Запустить скрипт
start
, расположенный в директорииscripts
в корневой директори ТехноДок:- Для Linux:
sh /opt/Programs/TechnoDoc/scripts/start.sh
- Для Windows:
start C:/Programs/TechnoDoc/scripts/start.bat
- Для Linux:
- Открыть браузер и перейти по адресу
http://localhost:8003
. - В появившемся модальном окне
Активация лицензии
ввести лицензионный ключ и нажать кнопкуАктивировать
. Лицензионный ключ для демо-лицензии может быть запрошен из модального окна. Долгосрочная лицензия может быть запрошена по адресу technodoc@sms-a.ru. - Авторизоваться в системе. Логин и пароль по умолчанию - admin.
Запуск в качестве сервиса
Для запуска в качестве сервиса необходимо перейти в директорию scripts/service
и выполнит ь соответствующий скрипт:
Для Linux (из терминала):
sh create.sh
- для создания сервиса.sh start.sh
- для запуска сервиса.sh stop.sh
- для останова сервиса.sh delete.sh
- для удаления сервиса.
Для Windows (из командной строки с правами администратора):
create.bat
- для создания сервиса.start.bat
- для запуска сервиса.stop.bat
- для останова сервиса.delete.bat
- для удаления сервиса.
PostgreSQL, MS SQL, MariaDB, SQLite
По умолчанию ТехноДок использует встроенную БД SQLite. Данная БД подходит для ознакомления и небольших проектов. Для средних и крупных проектов рекомендуется использовать СУБД PostgreSQL (Microsoft SQL Server, MariaDB). Для интеграции ТехноДок с СУБД PostgreSQL (Microsoft SQL Server, MariaDB) необходимо:
- Остановить сервер ТехноДок.
- Открыть файл
technodoc.settings.ini
в котором:- Закомментировать настройки соединения с текущей БД (по умолчанию SQLite).
- Раскомментировать настройки со единения с БД PostgreSQL (Microsoft SQL Server, MariaDB).
- Указать корректное имя пользователя и пароль в строке соединения.
- Для MariaDb в конфигурационном файле добавить в секцию
[mysqld]
на отдельной строке ключsql-mode
со значением"ANSI_QUOTES"
(пример: sql-mode="ANSI_QUOTES"). - Сохранить изменения.
- Запустить скрипт
setup.bat
. - Перейти в корневую директорию приложения.
- Открыть файл
technodoc.settings.ini
в котором:- В секции
Database:Connections:Primary
для ключаType
указать значениеPostgreSql
(MsSql
илиMariaDB
). - В секции
Database:Connections:Primary
для ключаConnectionString
указать корректное имя пользователя и пароль. - Сохранить изменения.
- В секции
- Запустить сервер ТехноДок.
Интеграция со SCADA
ТехноДок может быть встроен в панели SCADA систем, что дает возможность пользователям работать с отчетами не покидая экраны проекта SCADA.
КАСКАД Цифра
ТехноДок может быть встроен в SCADA систему КАСКАД Цифра. Для интеграции выполните следующие шаги:
- Остановить проект КАСКАД.
- Скопировать директории
components/kaskad/panels
иcomponents/kaskad/scripts
из дистрибутива ТехноДока в корневую директорию проекта КАСКАД. - Добавить в конец файла
config/prog
проекта КАСКАД строкуWCCOActrl | always | 30 | 2 | 2 |technodoc.ctl
- Запустить проект КАСКАД.
- Перейти в ТехноДок и открыть форму
Внешние соединения
. Добавить новое соединение с типомКАСКАД
, нажать кнопкуСохранить
. Настроенное соединение будет доступно для параметра с типомКАСКАД
при разработке шаблона.
Бесшовная авторизация из панели проекта
- В проекте КАСКАД открыть скрипт
scripts\libs\Technodoc\Core\technodocServerSettings.ctl
.- Для переменной
TECHNODOC_LOCAL_HTTP_ADDRESS
указать корректный адрес сервера ТехноДок. - Если Технодок установлен в виде кластера, то для переменной
TECHNODOC_CLUSTER_URLS
задать в виде строк список адресов (URL) экземпляров ТехноДока в кластере. - Если ТехноДок и проект КАСКАД расположены на разных серверах, то в переменных
TECHNODOC_LOCAL_HTTP_ADDRESS
иTECHNODOC_CLUSTER_URLS
указать адреса сервера(серверов) ТехноДок.
- Для переменной
- Для бесшовной авторизации пользователей перейти в настройки
ТехноДок -> Аутентификация
и включить опциюВключить авторизацию из внешних систем
.- В поле
Токен авторизации
будет указано значение токена по умолчанию9c5a61c7b1c14031a42f476cd09f8062
. - Этот токен должен совпадать с переменной
AUTH_TOKEN
в коде панелиtechnodoc.pnl
. Если в настройках ТехноДок значение токена авторизации не изменяли, то редактировать панельtechnodoc.pnl
не требуется. - Данная опция позволит выполнять вход пользователей КАСКАД в ТехноДок из панели
technodoc.pnl
. - Если пользователь входит впервые, то в ТехноДоке для него будет создана учетная запись.
- При входе происходит синхронизация Групп прав КАСКАД и Ролей ТехноДока. Для каждой Группы прав создается Роль и назначается пользователю. Например, если в КАСКАД есть пользователь Иванов Иван с логином ivanov и группами прав
Операторы
иИнженеры
, то при открытии панелиtechnodoc.pnl
будет создана соответствующая учетная запись и ролиОператоры
иИнженеры
(если такие роли не были созданы ранее). - Администратор системы может назначить необходимые права для существующих и новых ролей.
- В поле
- Перезапустить проект КАСКАД.
Устранение проблем
- Если возникает ошибка
Failed to create OpenGL context for format QSurfaceFormat...
при использовании приложения из панели КАСКАД. Для ее устранения необходимо добавить переменнуюQT_OPENGL
со значениемangle
илиsoftware
в переменные среды и перезапустить КАСКАД.
Альфа платформа
Бесшовная авторизация из панели проекта
- Импортировать панель для работы с ТехноДок из директории
/components/Alpha/panels/TechnodocPanel.omobj
с помощьюAlpha.HMI
. - Отредактировать обработчик события
Opened
с именемOpenTecnhodoc
:- Указать адрес ТехноДок в переменной
TechnodocBaseUrl
. - Указать ссылку на переменную с типом
Контекст безопасности
. В панели ссылка указана в видеunit.Global.SecurityContext
.
- Указать адрес ТехноДок в переменной
- Перейти на форму
ТехноДок -> Аутентификация
и включить опциюВключить авторизацию из внешних систем
.- В поле
Токен авторизации
будет указано значение токена по умолчанию9c5a61c7b1c14031a42f476cd09f8062
. - Этот токен должен совпадать с переменной
token
в коде панелиTechnodocPanel.omobj
. Если в настройках ТехноДок значение токена авторизации не изменяли, то редактировать панельTechnodocPanel.omobj
не требуется.
- В поле
- Данная опция позволит выполнять вход пользователей проекта Альфа платформы в ТехноДок из панели
TechnodocPanel.omobj
без ввода логина и пароля- Если пользователь входит впервые, то в ТехноДоке для него будет создана учетная запись.
- При входе происходит синхронизация
Групп
пользователя из проекта Альфа платформа со списокмРолей
ТехноДока. Для каждойГруппы
из проекта Альфа платформа создаетсяРоль
в ТехноДоке и назначается пользователю. - Например, если в проекте Альфа платформа есть пользователь Иванов Иван с логином ivanov и
Группами
Операторы
иИнженеры
, то при открытии панелиTechnodocPanel.omobj
в ТехноДоке будет создана соответствующая учетная запись пользователя и ролиОператоры
иИнженеры
(если такие роли не были созданы ранее). - Администратор системы может назначить необходимые права для существующих и новых ролей.
Аутентификация LDAP
- Для доступа к ТехноДок из браузера с учетной записью LDAP выполните настройку LDAP Аутентификации.
Получение данных в отчеты
- Перейдите на вкладку
Внешние соединения
и добавьте соединение сOPC UA
серверомAlpha.Server
по протоколуOPC TCP
. - Настроенное соединение будет доступно в конструкторе отчетов при добавлении параметра с типом
OPC
. - Таким образом вы можете наполнять отчет данными на основе тегов проекта Альфа платформы.
АСОКУ
ТехноДок может быть встроен в SCADA систему АСОКУ. Для интеграции необходимо выполнить шаги аналогичные инструкции интеграции с КАСКАД.
WinCC OA
ТехноДок может быть встроен в SCADA систему WinCC OA. Для интеграции необходимо выполнить шаги аналогичные инструкции интеграции с КАСКАД.
Обновление
ТехноДок поддерживает систему семантического версионирования и гарантирует обратную совместимость для новых версий внутри мажорного релиза. Например, БД и шаблоны отчетов созданные для версии 6.0.0
после процесса обновления будут совместимы с версией 6.2.3
.
Совместимость между мажорными вресиями ТехноДока не гарантируется.
Для обновления на новую мажорную версию см. шаги описанные ниже.
Для обновления сервера выполните следующие действия:
- Остановите ТехноДок:
- Если ТехноДок запущен в терминале при помощи скрипта
start.sh/start.bat
, то закройте терминал или остановите процесс (CTRL+C). - Если ТехноДок запущен при помощи службы, то остановите службу
technodoc-server/TechnoDocServer
.
- Если ТехноДок запущен в терминале при помощи скрипта
- Сделайте бэкап текущей установки (директория установки) и БД ТехноДок.
- Обновите файлы:
- Если используете БД
SQLite
со стандартным путем установки, то удалите все директории кромеdata/databases
, файлаdata/technodoc.license
и файлаtechnodoc.settings.ini
. - Если используете другой тип БД, то удалите все данные из директории установки кроме файла
data/technodoc.license
и файлаtechnodoc.settings.ini
. - Разархивируйте новую версию в директорию, где была установлена старая версия без замены файлов.
- Если используете БД
- Обновите БД:
- В файле
technodoc.settings.ini
укажите настройки подключения к БД. - Запустите мигратор при помощи скрипта
setup.sh/setup.bat
- В файле
- Запустите ТехноДок:
- Если ТехноДок установлен в качестве службы, то запустите скрипт
start.sh/start.bat
из директорииscripts/service
. - Если ТехноДок запускается в ручную, то запустите скрипт
start.sh/start.bat
из директорииscripts
.
- Если ТехноДок установлен в качестве службы, то запустите скрипт
- Если ТехноДок интегрирован со SCADA системами (КАСКАД, Alpha, АСОКУ или WinCC OA), то скопируйте скрипты и панели из директории
components
в директории проекта SCADA системы и перезапустите проект.
Обновление на новую мажорную версию
Если необходимо выполнить обновление на новую мажорную версию(например, обновить ТехноДок с версии 6 на версию 7), то рекомендуется выполнить следующие шаги:
- Выполнить шаги из раздела выше, но не запускать ТехноДок.
- Запустить ТехноДок из терминала, добавив аргумент
content-database-update
- Linux:
./Sms.TechnoDoc content-database-update
- Windows:
Sms.TechnoDoc.exe content-database-update
- Linux:
- ТехноДок запустит процесс обновления существующих шаблонов отчетов и экземпляров отчетов.
- Проверить работоспособность отчётов. При необходимости поправить формулы параметров и верстку в шаблонах отчетов.