Установка и обновление

Содержание

1. Системные требования
2. Установка
3. Запуск
4. Авторизация
5. Обновление
6. Интеграция с СУБД
7. Интеграция с SCADA
8. Удаление

Системные требования

Сервер

• Процессор: 64-разрядный с тактовой частотой 1 ГГц или выше.
• Свободное место на жестком диске: не менее 1ГБ.
• Оперативная память: не менее 2ГБ.
• Операционная система:
  • Windows:
    • Windows 10 и выше.
    • Windows Server 2012 (с расширенными обновлениями безопасности) и выше.
  • Linux:
    • Debian 12 и выше.
    • Ubuntu 20.04 и выше.
    • Fedora 39 и выше.
    • Производные от них.

СУБД:

• SQLite 3 (используется по умолчанию).
• PostgreSQL 11 и выше.
• Microsoft SQL Server 2017 и выше.
• MariaDB 10.3 и выше.

Клиент

• Браузер на основе Chromium последней версии: Google Chrome, Microsoft Edge, Яндекс Браузер и т.д.
• Браузер Mozilla Firefox последней версии.

Установка

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

1. Создать любую директорию, например, Programs.
2. Распаковать архив ТехноДок в созданную директорию.
3. Для Linux: Добавить право на запуск сервера ТехноДок и Chromium.

Linux

# Создать директорию "Programs"
sudo mkdir /opt/Programs && sudo chown $USER: /opt/Programs

# Распаковать архив "ТехноДок" в созданную директорию
unzip -d "/opt/Programs/TechnoDoc" "[Путь до архива ТехноДок]"

# Добавить право на запуск сервера "ТехноДок"
sudo chmod +x /opt/Programs/TechnoDoc/bin/Sms.TechnoDoc
sudo chmod +x /opt/Programs/TechnoDoc/bin/chromium/linux/chrome-headless-shell

Windows

rem Создать директорию "Programs"
mkdir "C:\Programs"

rem Распаковать архив "ТехноДок" в созданную директорию
unzip -d "C:\Programs\TechnoDoc" "[Путь до архива ТехноДок]"

Запуск

Запуск из терминала

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

1. Перейти в директорию scripts.
2. Выполнить скрипт run.

Linux

# Перейти в директорию "scripts"
cd /opt/Programs/TechnoDoc/scripts

# Выполнить скрипт "run"
sh run.sh

Windows

rem Перейти в директорию "scripts"
cd "C:\Programs\TechnoDoc\scripts"

rem Выполнить скрипт "run"
start "TechnoDoc" "run.bat"

Запуск в качестве сервиса

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

1. Перейти в директорию scripts/service.
2. Выполнить скрипт create.
3. Выполнить скрипт start.

Linux

# Перейти в директорию "scripts/service"
cd /opt/Programs/TechnoDoc/scripts

# Выполнить скрипт "create"
sh create.sh

# Выполнить скрипт "start"
sh start.sh

Важно: Для создания и запуска сервиса требуется наличие прав суперпользователя.

Windows

rem Перейти в директорию "scripts/service"
cd "C:\Programs\TechnoDoc\scripts\service"

rem Выполнить скрипт "create"
create.bat

rem Выполнить скрипт "start"
start.bat

Важно: Для создания и запуска сервиса требуется наличие прав администратора.

Примечания:

• Для останова сервиса необходимо выполнить скрипт stop.
• Для удаления сервиса необходимо выполнить скрипт delete.
• Перед запуском ТехноДок в качестве сервиса необходимо остановить ТехноДок, запущенный из терминала.

Авторизация

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

1. Открыть в браузере страницу http://127.0.0.1:8003.
2. Ввести лицензионный ключ и нажать кнопку Активировать в появившемся модальном окне Активация лицензии.
3. Ввести логин/пароль - admin/admin и нажать кнопку "Войти".

Примечания:

• Демо-лицензию можно получить, нажав на кнопку Запросить демо-лицензию.
• Долгосрочную лицензию можно запросить по адресу technodoc@sms-a.ru.

Обновление

Для обновления необходимо выполнить следующие шаги:

1. Остановить сервер текущей версии ТехноДок.
2. Распаковать новую версию ТехноДок в директорию отличную от той, в которой установлена и запущена текущая версия ТехноДок.
3. Скопировать следующие файлы из директории, в которой установлена текущая версия ТехноДок, в директорию куда была распакована новая версия ТехноДок с опцией замены файлов:
   • technodoc.settings.ini
   • data/technodoc.license
   • data/databases (если в качестве БД используется SQLite)
4. Перейти в директорию scripts.
5. Выполнить скрипт run-migrator.
6. Запустить сервер ТехноДок.

Важно:

• Перед обновлением рекомендуется создать резервную копию директории, в которой установлен и запущен ТехноДок.
• Перед обновлением, в случае интеграции с внешней СУБД, рекомендуется сделать резервную копию БД technodoc.
• Совместимость между мажорными релизами не гарантируется.
• В случае интеграции с внешними SCADA системами (КАСКАД, АСОКУ, Alpha) необходимо заменить файлы ТехноДок в проекте SCADA на новые версии файлов из директории components.

Обновление на новую мажорную версию

Если необходимо выполнить обновление на новую мажорную версию(например, обновить ТехноДок с версии 6 на версию 7), то рекомендуется выполнить следующие шаги:

1. Выполнить шаги из раздела выше, но не запускать ТехноДок.
2. Запустить ТехноДок из терминала, добавив аргумент content-database-update
   • Linux: ./Sms.TechnoDoc content-database-update
   • Windows: Sms.TechnoDoc.exe content-database-update
3. ТехноДок запустит процесс обновления существующих шаблонов отчетов и экземпляров отчетов.
4. Проверить работоспособность отчётов. При необходимости поправить формулы параметров и верстку в шаблонах отчетов.

Интеграция с СУБД

Для интеграции с СУБД необходимо выполнить следующие шаги:

1. Остановить сервер ТехноДок.
2. Открыть файл technodoc.settings.ini.
3. Раскомментировать ключи Type и ConnectionString в секции [Database:Connections:Primary] необходимой СУБД.
4. Указать корректное имя пользователя и пароль в строке соединения с СУБД (ключ ConnectionString).
5. Сохранить изменения в файле technodoc.settings.ini.
6. Запустить скрипт run-migrator, расположенный в директории scripts.
7. Запустить сервер ТехноДок.

Важно: Для СУБД MariaDB перед выполнением скрипта run-migrator необходимо добавить настройку sql-mode="ANSI_QUOTES" в секцию [mysqld] конфигурационного файл my.cnf и перезапустить сервер MariaDB.

Примечания:

• После успешного завершения выполнения скрипта run-migrator должна быть создана БД technodoc.
• Рекомендуется использовать одну из внешних СУБД для средних и крупных проектов.

Интеграция с SCADA

ТехноДок может быть встроен в панели SCADA систем, что дает возможность пользователям работать с отчетами не покидая экраны проекта SCADA.

КАСКАД Цифра

ТехноДок может быть встроен в SCADA систему КАСКАД Цифра. Для интеграции необходимо выполнить следующие шаги:

• Остановить проект КАСКАД.
• Скопировать директории components/kaskad/panels и components/kaskad/scripts из дистрибутива ТехноДок в корневую директорию проекта КАСКАД.
• Добавить в конец файла config/prog проекта КАСКАД строку

  WCCOActrl        | always |      30 |        2 |        2 |technodoc.ctl
• Запустить проект КАСКАД.
• Перейти в ТехноДок и открыть форму Внешние соединения. Добавить новое соединение с типом КАСКАД, нажать кнопку Сохранить. Настроенное соединение будет доступно для использования в системе.

Бесшовная авторизация из панели проекта

1. В проекте КАСКАД открыть скрипт scripts\libs\Technodoc\Core\technodocServerSettings.ctl.
   • Для переменной TECHNODOC_LOCAL_HTTP_ADDRESS указать корректный адрес сервера ТехноДок.
   • Если Технодок установлен в виде кластера, то для переменной TECHNODOC_CLUSTER_URLS задать в виде строк список адресов (URL) экземпляров ТехноДока в кластере.
   • Если ТехноДок и проект КАСКАД расположены на разных серверах, то в переменных TECHNODOC_LOCAL_HTTP_ADDRESS и TECHNODOC_CLUSTER_URLS указать адреса сервера(серверов) ТехноДок.
2. Для бесшовной авторизации пользователей перейти в настройки ТехноДок -> Аутентификация и включить опцию Включить авторизацию из внешних систем.
   • В поле Токен авторизации будет указано значение токена по умолчанию 9c5a61c7b1c14031a42f476cd09f8062.
   • Этот токен должен совпадать с переменной AUTH_TOKEN в коде панели technodoc.pnl. Если в настройках ТехноДок значение токена авторизации не изменяли, то редактировать панель technodoc.pnl не требуется.
   • Данная опция позволит выполнять вход пользователей КАСКАД в ТехноДок из панели technodoc.pnl.
   • Если пользователь входит впервые, то в ТехноДоке для него будет создана учетная запись.
   • При входе происходит синхронизация Групп прав КАСКАД и Ролей ТехноДока. Для каждой Группы прав создается Роль и назначается пользователю. Например, если в КАСКАД есть пользователь Иванов Иван с логином ivanov и группами прав Операторы и Инженеры, то при открытии панели technodoc.pnl будет создана соответствующая учетная запись и роли Операторы и Инженеры (если такие роли не были созданы ранее).
   • Администратор системы может назначить необходимые права для существующих и новых ролей.
3. Перезапустить проект КАСКАД.

Устранение проблем

• Если при запуске ТехоДока при помощи виджета WebView.ewo возникает ошибка 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. Для интеграции необходимо выполнить шаги аналогичные инструкции интеграции с КАСКАД.

Удаление

Для удаления необходимо выполнить следующие шаги:

1. Остановить сервер ТехноДок.
2. Удалить директорию, в которую был распакован архив ТехноДок.

Примечания:

• Если ТехноДок был запущен в качестве сервиса, то необходимо удалить сервис при помощи скрипта delete.
• Если ТехноДок был интегрирован с внешними СУБД, то необходимо вручную удалить БД technodoc.