Установка DVWebTool и DVSupService

DVWebTool и DVSupService предоставляются пользователям возможность открывать приложенные к карточкам файлы. DVWebTool устанавливается на компьютеры пользователей в ОС Windows при помощи WebToolBuilder (входит в комплект утилит Docsvision web-client toolkit.msi), DVSupService устанавливается в ОС Linux стандартными инструментами системы.

Данный раздел описывает:

Установка DVWebTool при помощи WebToolBuilder

Программа WebToolBuilder предназначается для сборки DVWebTool, минуя Панель управления Web-клиентом. WebToolBuilder входит в комплект утилит Docsvision web-client toolkit.msi.

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

  1. Когда устанавливается версия Web-клиента без программы Панель управления Web-клиентом

  2. Когда изменились файлы DVWebTool или вышла новая версия

  3. Когда изменился адрес или порт сервера Web-клиента

  4. Когда изменились внутренние расширения DVWebTool

Программа "WebToolBuilder" устанавливается:

  • Из инсталлятора комплекта утилит Docsvision web-client toolkit.msi. Docsvision Web-клиент Toolkit содержит WebToolBuilder и Конструктор Web-разметок, пакет утилит устанавливается в ОС Windows. Программа WebToolBuilder может быть запущена с минимальным пользовательским интерфейсом или как консольное приложение.

    • Файлы утилиты будут расположены по пути: C:\Program Files (x86)\Docsvision\WebClientToolKit\WebToolBuilder\

    • Файлы DVWebTool будут расположены по пути (в манифесте прописан localhost): C:\Program Files (x86)\Docsvision\WebClientToolKit\WebToolBuilder\DVWebTool\

Новая версия WebToolBuilder выпускается при каждом исправлении в Web-клиенте. Для распространения WebToolBuilder могут использоваться групповые политики.

Запуск в режиме окна

Окно программы "WebToolBuilder"
Рисунок 1. Окно программы "WebToolBuilder"
В окне приложения отображается следующий набор элементов:

  • Путь к манифесту приложения — поле для выбора файла манифеста DocsVision.DVWebTool.application

  • Три точки — кнопка для выбора манифеста приложения из файловой системы

  • Адрес Web-клиента — полный адрес сервера Web-клиента

  • Порт — порт для подключения к DVWebTool

  • Флаг Автозапуск — отвечает за автоматический запуск DVWebTool при загрузке системы

  • Кнопка Пересобрать неактивна, пока не выбран файл манифеста и не заполнены поля Адрес Web-клиента и Порт

  • Поле Журнал, в котором записываются действия при работе с программой

Запуск в консольном режиме

  1. Перейдите в каталог с WebToolBuilder (по умолчанию C:\Program Files\Docsvision\WebClientToolKit\WebToolBuilder\WebToolBuilder.exe) и запустите утилиту командой с указанием пути к файлу манифеста:

    ./WebToolBuilder C:\Program Files\Docsvision\WebClientToolKit\WebToolBuilder\DVWebTool\DocsVision.DVWebTool.application

  2. Чтобы получить справку по работе с утилитой в консольном режиме, введите -h при нахождении в папке утилиты:

    Доступные опции:

    • -u, --url — URL развёртывания манифеста приложения на сервере (обязательная опция)

    • -p, --port — Порт для работы DVWebTool (записывается в конфигурационный файл DVWebTool)

    • -a, --autorun — Флаг, отвечающий за автоматический запуск DVWebTool при загрузке системы

    • -c, --certificate — Путь к файлу сертификата для подписания манифеста приложения и манифеста развёртывания

    • --version — Узнать версию приложения

    • -?, -h, --help — Показать справку

    • --whatIf — Отображает список параметров, которые будут использоваться при пересборке DVWebTool

Сборка DVWebTool через WebToolBuilder

Программа DVWebTool необходима для выполнения сканирования документов и открытия файлов в офисном редакторе в ОС Microsoft Windows.

Программа DVWebTool работает только в ОС Microsoft Windows. Для работы требуется установить .NET Desktop Runtime (x86/x64) версии 8.0.
Чтобы установить "DVWebTool":

  1. Чтобы установить DVWebTool, необходимо создать образ утилиты. Для этого запустите WebToolBuilder на Windows.

  2. В поле Путь к манифесту приложения выберите файл манифеста C:\Program Files (x86)\Docsvision\WebClientToolKit\WebToolBuilder\DVWebTool\DocsVision.DVWebTool.application. После выбора файла автоматически будут заполнены другие поля.

    • В поле Адрес Web-клиента указывается адрес сервера Web-клиента

    • В поле Порт указывается порт для подключения к DVWebTool (по умолчанию 5413)

  3. При необходимости установите флаг Автозапуск, чтобы DVWebTool запускалась автоматически при загрузке системы.

  4. Нажмите кнопку Пересобрать, чтобы открыть каталог.

    Успешное завершение сборки
    Рисунок 2. Успешное завершение сборки

    После завершения сборки появится окно об успешном завершении операции. При нажатии на кнопку ОК будет открыта папка в файловой системе с собранными файлами DVWebTool.

  5. Скопируйте открытую папку DVWebTool на сервер Docsvision по пути путь-установки-Web-клиента/Content/Tools (если папка отсутствует, создайте её самостоятельно).

  6. Перезапустите службу Web-клиента.

  7. DVWebTool будет установлена при первом открытии файла из карточки в ОС Windows. Программу также можно установить вручную из Профиля пользователя  Установки  Установить DVWebTool.

    После завершения установки программа DVWebTool будет запущена автоматически, а в области уведомлений Windows появится значок программы (Две стрелочки в зелёном круге).

    Программа устанавливается только для текущего пользователя. Если на компьютере работает несколько пользователей (несколько профилей Windows), программу нужно установить каждому пользователю.

Установка и запуск службы DVSupService

Служба DVSupService необходима для открытия файлов в офисном редакторе в ОС Linux.

Служба DVSupService работает только в ОС Linux. Для работы требуется установить ASP.NET Core Runtime версии 8.0.
Чтобы установить "DVSupService":

  1. Выполните следующую команду:

    • Astra Linux / Альт Сервер

    • РЕД ОС / SberLinux

    $ sudo apt install docsvision-dvsupservice

    $ sudo dnf install docsvision-dvsupservice

    Служба будет установлена в каталог /lib/docsvision/dvsupservice от имени суперпользователя. Если на компьютере работает несколько пользователей, службу нужно установить один раз.

    В конфигурационном файле службы по адресу /usr/lib/docsvision/dvsupservice/appsettings.json можно указать настройку WebClientAddress (по умолчанию null). Если для этой настройки указать адрес сервера (например http://docsvision.server.com:5004), служба будет принимать запросы на открытие только с указанного адреса. При необходимости можно указать несколько адресов.

  2. Запустите службу следующей командой:

    $ sudo systemctl start dvsupservice

    Диалог сохранения в Р7-Офис
    Рисунок 3. Диалог сохранения в Р7-Офис
    При работе DVSupService с Р7-Офис может появляться диалог сохранения. В таком случае необходимо, не изменяя директорию, нажать Сохранить  Да.

  3. Посмотреть журнал работы можно по адресу /var/log/docsvision/dvsupservice/$ДД-ММ-ГГГГ_DvSupService.log.
    Путь по умолчанию может быть изменён в конфигурационном файле службы:

    {
"fileName": "/var/log/docsvision/dvsupservice/${shortdate}_DvSupService.log"
}

  4. Чтобы просмотреть информацию о службе, выполните команду:

    • Astra Linux / Альт Сервер

    • РЕД ОС / SberLinux

    $ apt list docsvision-dvsupservice

    $ dnf list docsvision-dvsupservice

  5. Обновить службу можно, выполнив следующие команды:

    • Astra Linux / Альт Сервер

    • РЕД ОС / SberLinux

    sudo apt-get update
sudo apt-get install docsvision-dvsupservice
    sudo dnf makecache
sudo dnf update docsvision-dvsupservice

  6. Удалить службу можно с помощью следующей команды:

    • Astra Linux / Альт Сервер

    • РЕД ОС / SberLinux

    $ sudo apt-get purge --autoremove docsvision-dvsupservice
    $ sudo dnf remove package docsvision-dvsupservice

Сменить пользователя DVSupService

По умолчанию служба DVSupService запускается от имени пользователя ROOT.

  1. Чтобы запустить службу от имени другого пользователя, необходимо выполнить следующую команду:

    sudo systemctl edit dvsupservice

  2. Записать следующее содержимое в появившемся окне:

    [Service]
User=user
Group=user

    В примере выше user — пользователь, от имени которого необходимо запускать DVSupService.