Действия после обновления системы
Настройка сквозной аутентификации
|
Чтобы иметь возможность использования сквозной аутентификации в Web-клиенте, Windows-клиенте, РМА и Консоли управления Docsvision в Linux необходимо выполнить специальные настройки Kerberos и используемого браузера, см. подробнее "Настройка прозрачной аутентификации". |
Настройка входа в Web-клиент
Начиная, с версии 6.2, сборка 1444 и выше, в Web-клиент могут входить пользователи, добавленные в справочник сотрудников или в группу Администраторы.
Сотрудники, входящие в группу Администраторы (например, добавленные в группу через Консоль управления Docsvision), могут войти в Web-клиент, даже если их учётная запись отсутствует в справочнике сотрудников.
Если пользователь отсутствует в справочнике сотрудников, но является членом группы Администраторы, перед выполнением входа автоматически создается запись о сотруднике в Справочнике сотрудников. Запись о сотруднике будет добавлена в первую по списку организацию, если в справочнике есть хотя бы одна организация. Если в справочнике нет ни одной организации, будет создана организация с именем DocsVision, в которую будет добавлен сотрудник. Заполняется только поле Пользователь, остальные поля не заполняются
Если пользователь отсутствует в Справочнике сотрудников и не входит в группу Администраторы, он не сможет получить доступ в Web-клиент. При попытке входа появляется сообщение об ошибке: Не удалось войти: Сотрудник с именем пользователя не найден в Справочнике сотрудников и не является администратором.
Требования учётной записи системного пользователя, обновляющего БД
Пользователи указанных групп должны обладать следующими правами на системные папки:
| Папка | Права | Комментарий |
|---|---|---|
|
Полный доступ для членов группы Администраторы КС |
Важно, чтобы у карточек в папке были следующие права: у администраторов — полные, у всех остальных — на чтение |
|
Полный доступ для членов группы Администраторы УД, Системная для WF |
|
|
Полный доступ для членов группы Администраторы УД, права на чтение для Всех/Everyone. |
|
|
Полный доступ для членов группы Администраторы УД, права на чтение для Всех/Everyone |
Требования к учётной записи модуля Управление процессами
Администратор должен создать учётную запись для СУБП, службы dvworkflow для Linux и Docsvision Workflow Server для Windows.
-
На сервере Docsvision включите учётную запись в локальные группы DocsVision Power Users.
Группы настраиваются:-
В Консоли управления Docsvision, разделе "Управление доступом", подробнее см. в документации модуля Консоль управления Docsvision, раздел "Управление доступом".
-
в конфигурационном файле Сервера приложений (модуля Платформа), подробнее см. в документации модуля Платформа, раздел "Конфигурация Сервера приложений".
-
-
На компьютере с серверными компонентами модуля:
-
Включите учётную запись в локальную группу Users.
-
-
Предоставьте созданной учётной записи полные права по дискреционной модели безопасности на все папки и справочники системы Docsvision.
-
Для работы с карточками приложения Управление документами, включите учётную запись в группу Системная для WF в Справочнике сотрудников.
-
Назначьте учётной записи персональную лицензию в Docsvision (см. документацию модуля "Платформа".
Требования к учётной записи Службы фоновых операций
Служба фоновых операций является базовым модулем системы Docsvision. Для учётной записи, от имени которой запускается Служба фоновых операций, требуются такие же права, как и для учётной записи модуля Управление процессами. Подробно требования перечислены ниже.
-
Членство в группе Системная для WF. Доменная учётная запись, указанная в Консоли управления Docsvision для подключения Службы фоновых операций (См. документацию модуля Консоль управления Docsvision, раздел "Настройки соединений Docsvision"), должна состоять в группе Системная для WF в справочнике сотрудников на сервере Docsvision.
Используйте учётную запись, которая будет указана в Консоли управления Docsvision для подключения Службы фоновых операций к серверу. -
Права на карточку сообщений очереди почтовых уведомлений. Пользователь, от имени которого запускается Служба фоновых операций, должен обладать правами на чтение, изменение и удаление карточки с идентификатором
0C052E58-3C25-4F29-8CE1-FF9CC2D1F31B.По умолчанию необходимые права выдаются автоматически при создании карточки сообщений. Если УЗ была изменена, соответствующие права на карточку необходимо выдать вручную.
Требования учётной записи файлового сервиса
Перечисленные права должны быть предоставлены учётной записи службы Файлового сервиса.
-
Полный доступ на все подключенные внешние хранилища, доступ к которым осуществляется под учётной записью службы.
-
Полный доступ к папке
FileStream, если подключено хранилище FileStream во внешней базе данных Microsoft SQL Server или FileStream хранилище в базе данных Docsvision.
Перевод решений на .NET 8.0
Начиная с версии 6.1 сборки 170 и выше, Web-клиент работает на .NET 8.0, поэтому при переходе с Web-клиент, использующего .NET предыдущих версий, необходимо перевести на .NET 8.0 собственные решения.
Изменение файла проекта
-
При помощи автоматических инструментов (см. документацию Microsoft).
-
При помощи создания нового проекта, нацеленного на .NET 8. При создании проекта предпочтительно использовать шаблоны VisualStudio из примеров разработки расширений для версии 6.1.
В проектах нового типа нет необходимости добавлять файлы с исходным кодом в .csproj-файл проекта. По умолчанию автоматически все файлы в папке проекта считаются частью проекта. Это существенно упрощает процесс преобразования проекта.
Важной особенностью нового проекта является атрибут Sdk на корневом элементе Project файла .csproj, это xml-файл, который можно открыть в блокноте. Для web-расширений рекомендуется значение Microsoft.NET.Sdk.Web, для расширений конструктора разметок Microsoft.NET.Sdk.
Значение тега TargetFramework для web-расширений должно быть net8.0, для расширений конструктора разметок — net8.0-windows.
Для проектов расширений конструктора разметок также могут быть полезны следующие элементы:
<UseWindowsForms>true</UseWindowsForms>
<UseWPF>true</UseWPF>
<ImportWindowsDesktopTargets>true</ImportWindowsDesktopTargets>
Особенности сборки
Для сборки C# кода для .NET 8 требуется VisualStudio 2022 или старше.
При использовании сторонних зависимостей требуется обновить их до версий, поддерживающих .NET 8. В случае нарушений совместимости при сборке будет выдаваться предупреждение CA1416. Данные предупреждения следует все устранять.
При разработке расширений для программы Конструктор Web-разметок и другого кода, рассчитанного на работу в ОС Windows следует использовать атрибут SupportedOSPlatform. Его можно назначить на отдельный класс, либо на всю сборку:
[assembly: SupportedOSPlatform("windows")]
Без этого атрибута также может возникать предупреждение CA1416, при обращении к API, рассчитанному на работу в ОС Windows.
Логика привязки параметров в запросах
-
Метод контроллера либо принимает несколько параметров простых типов через query-параметры, либо один параметр, значение которого читается из тела запроса.
-
Рекомендуется явно указывать, откуда читается параметр с помощью атрибутов
[FromBody]и[FromQuery]. Если ранее использовался атрибутFromUri, то нужно заменить наFromQuery. -
Рекомендуется явно помечать методы атрибутами
[HttpGet],[HttpPost], для указания метода вызова
public class MathController : ControllerBase
{
[HttpGet]
public double GetSquare([FromQuery] double value) {
return
}
}
let result = await requestManager.get(`/Math/GetSquare?value=2`, null);
class MinValueParams {
public List<double> Values { get; set; };
}
public class MathController : ControllerBase
{
[HttpPost]
public double MinValue([FromBody] MinValueParams arg) {
return arg.Values.Min();
}
}
Если не указать [FromBody] для сложного параметра, его значение не привяжется.
|
let arg = { values: [ 1, 5, 3, 2] };
let result = await requestManager.post(`/Math/MinValue`, JSON.stringify(arg));
| При передаче параметра в теле запроса нельзя указывать имя параметра, т.к. он может быть только один. |
let data = { arg: { values: [ 1, 5, 3, 2] } }; (1)
let result = await requestManager.post(`/Math/MinValue`, JSON.stringify(data)); (2)
| 1 | Неверный код. |
| 2 | Код не будет работать. |
Внедрение зависимостей
В Web-клиенте 18 (6.1) вместо Autofac используется стандартный механизм внедрения зависимостей .NET. В связи с этим в классе серверного расширения нужно произвести следующие изменения:
InitializeContainer определить метод:public override void InitializeServiceCollection(IServiceCollection services)
{
(1)
}
| 1 | Регистрация сервисов. |
containerBuilder.RegisterType<YourServiceClass>().As<YourServiceInterface>().SingleInstance();
->
services.AddSingleton<YourServiceInterface, YourServiceClass>();
containerBuilder.RegisterOrderedType<YourBindingConverterType, IBindingConverter>();
->
services.AddSingleton<IBindingConverter, YourBindingConverterType>();
containerBuilder.RegisterOrderedType<YourBindingResolverType, IBindingResolver>();
->
services.AddSingleton<IBindingResolver, YourBindingResolverType>();
containerBuilder.RegisterOrderedType<YourControlResolverType, IControlResolver>();
->
services.AddSingleton<IControlResolver, YourControlResolverType>();
containerBuilder.RegisterOrderedType<YourPropertyResolverType, IPropertyResolver>();
->
services.AddSingleton<IPropertyResolver, YourPropertyResolverType>();
containerBuilder.RegisterType<YourCardLifeCycle>().Keyed<ICardLifeCycle>(CardTypeID).SingleInstance();
->
services.AddTransient<ICardLifeCycle, YourCardLifeCycle>();
containerBuilder.RegisterType<YourRowLifeCycle>().Keyed<IRowLifeCycle>(SectionID).SingleInstance();
->
services.AddTransient<IRowLifeCycle, YourRowLifeCycle>();
Прочие изменения
-
В конструкторе класса расширения при вызове базовой реализации теперь не нужно передавать
serviceProvider:Былоpublic ServerExtension(IServiceProvider serviceProvider) : base(serviceProvider) { }Сталоpublic ServerExtension(IServiceProvider serviceProvider) : base() { } -
Классы контроллеров рекомендуется наследовать от
Microsoft.AspNetCore.Mvc.ControllerBase. При переводе методыrequestManagergetиpostв некоторых случаях могут изменить возвращаемое значение. В частности, ранее они могли возвращать строку, а после перевода — объект — результатJSON.parseэтой строки. С примером можно ознакомиться ниже.Былоconst response = JSON.parse(await requestManager.get(url));Сталоconst response = await requestManager.get(url) -
Также в отдельных случаях может измениться регистр первой буквы в названии свойств ответа сервера. Например, следующим образом:
Былоconst name = response.IssueName;Сталоconst name = response.issueName; -
Изменился способ загрузки и скачивания файлов. Пример реализации соответствующего метода на .NET6 можно найти в примере
ExternalWebService, в файлеDocumentsController.cs, методахUploadFileиDownloadFile. -
Чтение настроек из конфигурационного файла Web-сервиса изменилось. Прежние сервисы оставлены для обратной совместимости, однако рекомендуется использовать стандартный механизм работы с настройками .NET 8. В частности, использовать внедрение интерфейса
IOptionsчерез конструктор для получения настройки иAddOptions+BindConfigurationпри регистрации сервисов для регистрации настройки. Пример работы с настройками можно найти в примереKonturIntegration(регистрация см.KonturServerExtension.cs/InitializeServiceCollection, чтение см.KonturRequestService.cs). -
Библиотека
iTextSharp, которая использовалась в примереWatermark, поддерживает .NET6 только в новой версии, под названиемitext7. В этой новой версии полностью изменился API.
Обновление компонентов собственных решений
-
В Docsvision 6.1 были обновлены собственные компоненты Docsvision. Перекомпилируйте свои проекты, в которых есть зависимости от сборок Docsvision.
-
В новой версии Docsvision изменился способ хранения расширенных метаданных в БД: теперь данные хранятся в основных таблицах секций, а не в отдельных "extended"-таблицах. При обновлении системы стандартным образом все существующие данные из extended-таблиц будут перенесены в основные таблицы секций, а сами extended-таблицы переименованы в
dvtable_{ID-секции}_extended_old_data.После обновления системы необходимо изменить код скриптов, напрямую обращающихся к extended-таблицам в БД, если такие функции были реализованы в Решении, например, для расчёта ролевой модели безопасности. К примеру, если существующий скрипт содержал обращение к таблице
dvtable_{3997861d-4ff5-496a-b8a2-d16617de91d7}\_extended, теперь нужно обращаться к таблицеdvtable_{3997861d-4ff5-496a-b8a2-d16617de91d7}.Данное изменение не затрагивает динамические метаданные. Скрипты, работающие с таблицами динамических секций и полей, изменять не нужно. -
Изменился цикл жизни серверного расширения: теперь на каждое обращение к расширению создаётся новый экземпляр, а затем уничтожается. Это может потребовать изменить код серверного расширения, если расширение сохраняет своё состояние между вызовами.
-
Изменилось описание расширенных отчётов в схеме библиотеки карточек, теперь указывается тип файла отчёта, задаётся описание колонок результирующей выборки и другие. Это может потребовать повторного формирования и загрузки собственных отчётов.
Обновление компонентов собственных библиотек карточек
В новой версии модуля Платформа изменился механизм проверки соответствия клиентских компонентов библиотек карточек.
-
Подключите новые сборки Docsvision к проекту компонента.
-
Добавьте в ресурсы XML-файл с описанием библиотеки карточек.
-
В реализацию класса
CardLibrary— если .NET-сборка — добавить переопределение методаGetLibraryDefinition. Метод должен возвращать описание библиотеки карточек.protected override string GetLibraryDefinition() { return Resources.CardLibDefinition; } -
Повторно соберите, протестируйте работоспособность и распространите клиентский компонент библиотеки карточек.
Для С++ реализации клиентского компонента библиотеки карточек нужно:-
Поддержать интерфейс
ICardLibraryInfo2; -
Изменить поведение свойства
ICardLibraryInfo.Version.См. подробнее в руководстве разработчика, раздел "Разработка компонента библиотеки карточек").
-
Перенос загружаемых данных приложений Docsvision
При обновлении БД Docsvision библиотеки карточек Модулей и Приложений будут перезагружены. Если ранее была разработана собственная библиотека карточек, её нужно будет также загрузить:
-
Если библиотека карточек загружалась с помощью CardManager:
-
Создайте новую папку в каталоге
/lib/docsvision/database/. Например, создайте папкуMyCarLib. -
Скопируйте в созданную папку (
/lib/docsvision/database/MyCarLib) файлы библиотеки карточек. -
Создайте новую папку в каталоге
C:\Program Files\Docsvision\Database. Например, создайте папкуMyCarLib. -
Скопируйте в созданную папку (
C:\Program Files\Docsvision\Database\MyCarLib) файлы библиотеки карточек. -
Создайте в данной папке новый файл с названием
Install.xmlи следующим содержимым:<?xml version="1.0" encoding="UTF-8"?> <SqlPackage> <SqlFile>MyOwnCardLib.xml</SqlFile> (1) </SqlPackage>1 Вместо MyOwnCardLib.xmlукажите собственное название файла со схемой библиотеки карточек.Данная библиотека карточек станет доступна для загрузки при обновлении БД Docsvision.
Если дополнительно было разработано собственное решение, его также потребуется адаптировать согласно инструкции, описанной в руководстве по разработке, "Разработка решений на платформе Docsvision".
-
Прочие действия
-
Если ранее было настроено хранилище для вытесненных файлов, то данное хранилище настроить заново. Вытесненные файлы останутся доступны. Если нужно задействовать данное хранилище для хранения новых вытесненных файлов, настройте правило помещения:
-
В версии 5.5.3 Конструктор согласований был переведён на работу с усовершенствованным согласованием. При обновлении БД с более ранних версий, система будет поддерживать работу с согласованием с использованием БП. При создании новой БД, согласование с использованием БП работать не будет.
После обновления необходимо вручную в Справочнике видов карточек удалить режимы создания из карточки Согласование КС. Это необходимо, чтобы у пользователя не отображались одновременно старое согласование через бизнес-процессы и усовершенствованное согласование.
-
В версии модуля Платформа 5.5.2 была упразднена функция архивирования журналов работы, с помощью которой журналы можно было архивировать во внешнюю БД. Теперь журналы могут храниться в основной или сателлитной БД.
Функциональность очистки журналов с возможностью сохранения резервных копий не затронута. Если функция архивирования применялась с целью снятия нагрузки с основной БД Docsvision, воспользуйтесь альтернативным решением — используйте для хранения журналов сателлитную БД. Инструкция по переносу журналов из основной БД в сателлитную приведена в документации Консоли управления Docsvision, раздел "Перенести журналы в сателлитную БД". При этом можно отключить периодическую отчистку журналов.
Рисунок 1. Параметры резервного копирования/очистки журнала
Настройка приложения "Управление документами"
Следующие настройки обязательно должны быть выполнены для доступа к файлам в заданиях и группах заданий.
Настройка прав доступа к файлам
При добавлении файлов или отчета в "Задания УД" и "ГЗ" создаются карточки вида "Файл". Чтобы доступ к таким карточкам работал корректно и только участники заданий могли работать с файлами, необходимо настроить ролевую модель для вида документа "Файл" следующим образом:
|
Для новых БД, созданных после обновления до Управление документами версии 6.1, сборка 93 и выше, права доступа будут применены автоматически, дополнительных действий не требуется. Хранимые процедуры |
-
Откройте Конструктор ролей.
-
Выберите вид карточек Документ — Файл.
-
Создайте роль с названием Участник задания с отчётом.
-
Измените корневой оператор в значение ИЛИ.
-
Добавьте условия для роли Участник задания с отчётом:
-
Я — временный заместитель в период неактивности замещаемого, Равно, хранимая процедура dvbo_Operand_FileReport_TaskEmployees.
-
Я, Равно, хранимая процедура dvbo_Operand_FileReport_TaskEmployees.
-
Я — постоянный заместитель, Равно, хранимая процедура dvbo_Operand_FileReport_TaskEmployees.
-
-
Создайте роль с названием Участник задания с файлом.
-
Измените корневой оператор в значение ИЛИ.
-
Добавьте условия для роли Участник задания с файлом:
-
Я — временный заместитель в период неактивности замещаемого, Равно, хранимая процедура dvbo_Operand_FileDocument_TasktreeEmployees.
-
Я, Равно, хранимая процедура dvbo_Operand_FileDocument_TasktreeEmployees.
-
Я — постоянный заместитель, Равно, хранимая процедура dvbo_Operand_FileDocument_TasktreeEmployees.
-
-
Создайте роль с названием Регистратор.
-
Измените корневой оператор в значение ИЛИ.
-
Добавьте условия для роли Регистратор:
-
Я — временный заместитель в период неактивности замещаемого, Равно Основная информация.Автор.
-
Я, Равно Основная информация.Автор.
-
Я — постоянный заместитель, Равно Основная информация.Автор.
-
-
Для созданных ролей в матрице доступа выдайте все права, которые настроены для роли Все.
-
Для роли Все в матрице доступа удалите все назначенные права.
-
Сохраните настройки ролей.
После сохранения настроек доступ к новым и существующим карточкам файлов автоматически будет определяться в соответствии с новой логикой.