Установка и первоначальная настройка Консоли управления Docsvision

Без установки и первоначальной настройки Консоли управления Docsvision не будет функционировать базовый модуль "Служба фоновых операций", необходимый для создания групп заданий и отправки почтовых уведомлений.

Состав установочного комплекта

Пакет установки Консоли управления Docsvision: Docsvision 5 ManagementConsole.msi.

Установка Консоли управления Docsvision

Инсталлятор установит одновременно Консоль управления Docsvision и Хранилище (сервис) настроек. Установка должна выполняться на одной машине, установка на разные серверы не поддерживается.

Установка Консоли управления Docsvision на отдельный сервер:

Консоль управления Docsvision можно установить на отдельный от Docsvision сервер.

В таком случае требуется выполнить следующие условия:

Пользователь, от имени которого запускается Консоль управления Docsvision, должен быть добавлен в группу Docsvision Management Console Administrators на сервере Docsvision и на сервере Консоли управления Docsvision.
Сервис внешнего API необходимо установить на машине с серверными компонентами Docsvision, отдельно от Консоль управления Docsvision.
При дальнейшей установке Консоли управления, укажите корректный адрес Сервиса внешнего API.

Чтобы установить Консоль управления Docsvision:

Откройте пакет установки Docsvision 5 ManagementConsole.msi.

Пользователь, выполняющий установку, получит доступ к программе Консоль настройки Docsvision — будет добавлен в группы Docsvision Management Console Administrators и Docsvision SettingsService Administrators.

Рисунок 1. Установка Консоли управления Docsvision
Нажмите Далее, ознакомьтесь с условиями лицензионного соглашения. Подтвердите, что вы согласны с лицензионным соглашением и нажмите Далее.

Рисунок 2. Лицензионное соглашение
Выберите необходимые компоненты Консоли управления Docsvision.

Рисунок 3. Выбор устанавливаемых компонентов

Базовые компоненты

Основные компоненты Консоли управления Docsvision и сервиса настроек, предоставляющие базовую функциональность.

Компоненты внешнего API

Компоненты сервиса внешнего REST API Консоли. Данный сервис предоставляет возможность получения сообщений и списка сообщений из системы Docsvision.
При необходимости выберите место установки Консоли управления Docsvision.

Рисунок 4. Выбор расположения установки

На следующем шаге будет предложено указать настройки Консоли управления Docsvision.

Рисунок 5. Настройки Консоли управления Docsvision

Порт для Консоли управления Docsvision

Порт для доступа к Консоли управления Docsvision из браузера по HTTP. По умолчанию 5100.

Порт для Сервиса настроек

Порт для подключения Консоли к Сервису настроек. По умолчанию 5200.

Порт для Сервиса внешнего API Консоли управления Docsvision

Порт для доступа к внешнему REST API Консоли. Данный сервис предоставляет возможность получения сообщений и списка сообщений из системы Docsvision. Указать порт можно, только если устанавливаются компоненты внешнего API.

Соединение между Консолью и сервисом устанавливается от имени авторизованного пользователя Консоли. Сервис также проверяет пользователя на принадлежность к группе Docsvision Management Console Administrators.

Сессия в Сервисе запускается от имени пользователя, запустившего Сервис или пул IIS.

Выберите тип сервера БД из списка

Microsoft SQL Server или PostgreSQL в зависимости от используемой базы данных.

Строка подключения к базе данных для хранения настроек

Строка подключения содержит адрес подключения к базе данных для хранения настроек. Вид строки подключения зависит от выбранной базы данных.

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

Для Microsoft SQL Server: Data Source=Адрес-сервера-баз-данных;Initial Catalog=Название-БД-Службы-фоновых-операций;Integrated Security=False;User ID=Имя-пользователя-БД;Password=Пароль-пользователя-БД;TrustServerCertificate=True.

Data Source — адрес сервера SQL для подключения к БД. В качестве Data Source может быть указан экземпляр SQL-сервера, например так: Data Source=DVDatabse\Server1.
Название-БД-Службы-фоновых-операций — псевдоним базы данных.
Integrated Security — задает логическое значение, определяющее способ проверки подлинности:
- False — при подключении в строке должны быть указаны идентификатор пользователя и пароль.
- True — при подключении будут использованы учетные данные текущей учетной записи Windows.
Имя-пользователя-БД — учётная запись пользователя для подключения к БД.
Пароль-пользователя-БД — пароль учётной записи для подключения к БД.
TrustServerCertificate=True — подробнее про настройку см. особенности настройки сертификата.

При использовании строки подключения к хранилищу с Windows-аутентификацией для Microsoft SQL Server учетной записи службы Сервиса настроек необходимо предоставить права на создание новых БД, а также полные права на БД, которая будет использована для Сервиса настроек.

Если строке подключения введены корректные данные, при запуске Сервиса настроек будет создана новая или обновлена существующая БД.

Для PostgreSQL: host=Адрес-сервера-баз данных;Port=SQL-порт;database=Название-БД-Менеджера решений;Username=Имя-пользователя-БД;Password=Пароль-пользователя-БД.

Адрес-сервера-баз данных — адрес сервера SQL для подключения к БД.
SQL-порт — порт SQL-сервера.
Название-БД-Менеджера решений — псевдоним базы данных.
Имя-пользователя-БД — учётная запись пользователя для подключения к БД.
Пароль-пользователя-БД — пароль учётной записи для подключения к БД.

Нажмите кнопку Установить, чтобы начать установку или кнопку Назад, чтобы вернуться на предыдущий шаг.

Рисунок 6. Продолжить установку или вернуться на предыдущий шаг
Нажмите кнопку Готово, чтобы закрыть мастер установки.

После установки "Консоли управления" на отдельный сервер будет добавлены две локальные группы Windows:

Docsvision Management Console Administrators — пользователи, входящие в эту группу, имеют право работать с Консолью управления Docsvision.
Docsvision SettingsService Administrators — пользователи, входящие в эту группу, имеют право менять настройки в Сервис настроек.

Консоль управления Docsvision по умолчанию запускает Docsvision Settings Service под учётной записью Network Service, которая включается в группы Docsvision SettingsService Administrators и Docsvision Management Console Administrators автоматически. Чтобы предоставить доступ к Сервису настроек другим пользователям, выполните инструкцию в пункте Предоставление доступа к Консоли управления Docsvision.

Настройка Консоли управления Docsvision

Установка приносит настройки, которые не зависят от машины где развертывается Консоль управления Docsvision. После установки создаётся файл настроек Консоли управления Docsvision По умолчанию в файле указываются настройки для BackOffice. В файле содержатся: имена типов реализаций подключаемых к Службе фоновых операций, настройки их сопоставления, роли обработки задач BackOffice, а также настройки самой Службы фоновых операций (включая очереди, фабрики и прочие).

После установки Консоль управления Docsvision требуется выполнить первичную настройку Консоли и Службы фоновых операций. Если проигнорировать первичную настройку:

Не будут создаваться и отправляться группы заданий.
Не будут отправляться почтовые уведомления исполнителям.

См. подробнее "Первичная настройка Консоли управления Docsvision".

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

Настройка актуальная только для Microsoft SQL, для PostgreSQL дополнительных настроек не требуется.

Поскольку Консоль управления Docsvision работает под управлением .NET 6, компонент System.Data.SqlClient был заменён на Microsoft.Data.SqlClient как более перспективный с точки зрения развития.

В этом компоненте значение Encrypt по умолчанию изменилось. По умолчанию провайдер считает соединение с БД защищённым.

Если соединение не защищено (т.е. не настроен сертификат на уровне БД, используется самозаверенный или недействительный сертификат), необходимо в строке соединения указывать TrustServerCertificate = true, это сообщит провайдеру, что серверу можно доверять.

Если есть потребность защитить соединение, настройте Microsoft SQL сервер в соответствии с инструкцией.

Установка Консоли управления Docsvision на контроллере домена

Установка Консоли управления Docsvision на контроллере домена происходит в стандартном режиме, но при настройке имеются следующие особенности:

Службы Docsvision создаются автоматически, и будут запускаться от имени Сетевой службы (УЗ Network Service).
Системные группы Docsvision создаются автоматически, но по умолчанию в группы не будут добавлены пользователи. Пользователей необходимо добавить в группы самостоятельно.
После завершения установки необходимо вручную заменить УЗ, от имени которых запускаются службы и добавить их во все необходимые системные группы.
По завершении настройки Консоль управления Docsvision будет работать в стандартном режиме.

Удаление Консоли управления Docsvision

Чтобы удалить Консоль управления Docsvision, запустите инсталлятор в режиме удаления.

Созданные группы и службы будут удалены, Сервис настроек станет недоступно.