Создание нового типа правил добавления в хранилище

Администратор может настроить правила помещения бинарных данных файлов в определённые группы хранилищ, в зависимости от типа файла, его размера или принадлежности к справочникам Docsvision. Разработчику предоставляется возможность реализовать собственные типы правил для настройки условий помещения в хранилища.

Для использования собственного типа правил добавление в хранилище необходима опция лицензии Docsvision модуль интеграции с произвольными файловыми хранилищами.

Компонент, реализующий правило добавления в хранилище, представляет собой библиотеку .dll с классом, реализующим интерфейсы IBinaryStorageRule и IExtensionInitialize.

Интерфейс IBinaryStorageRule определяет метод проверки выполнения условий помещения в хранилище. Интерфейс IExtensionInitialize определяет метод инициализации провайдера (Initialize), принимающий в сериализованном виде настройки хранилища. Настройки хранилища устанавливаются с помощью графического интерфейса настройки (рассмотрено далее).

Стандартной реализацией интерфейсов IBinaryStorageRule и IExtensionInitialize является класс BaseBinaryStorageRule, который можно использовать в качестве базового класса разрабатываемого компонента с правилом добавления в хранилище.

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

Пример

Далее демонстрируется пример реализации правила помещения в хранилища в зависимости от установленного в настройках шаблона файлов. Исходный код примера доступен по ссылке.

  1. Основной класс.

    В данном примере основной класс правила базируется на классе BaseBinaryStorageRule. Класс должен быть помечен атрибутом System.ComponentModel.DisplayName с указанием отображаемого названия типа правила — отображается в Консоли управления Docsvision.

    Реализация компонента правила предполагает возможность его настройки с помощью Консоли управления Docsvision. Для этого класс должен быть помечен атрибутом System.ComponentModel.Editor, в котором нужно указать полное название класса, реализующего форму настройки (описание будет приведено далее).

    using DocsVision.Platform.StorageServer.BinaryStorages.Rules;
    using DocsVision.Platform.StorageServer.Files;
    using System;
    using System.ComponentModel;
    using System.Text.RegularExpressions;
    
    namespace RuleByFileName
    {
        [DisplayName("Шаблон файла")]
        [Editor(
            "RuleByFileName.FileNamePatternPropertyControl, RuleByFileName, Version=1.0.0.0, Culture=neutral, PublicKeyToken=774759c67c4f8865, processorArchitecture=MSIL"
            , "DocsVision.Platform.WinForms.Controls.IExtensionPropertiesControl, DocsVision.Platform.WinForms"
        )]
        public class FileNameStorageRule : BaseBinaryStorageRule
        {
            string fileNamePattern;
    
            public FileNameStorageRule() (1)
            {
            }
    
            public FileNameStorageRule(IServiceProvider serviceProvider) : base(serviceProvider, null)
            {
            }
    
            public override bool IsRuleSatisfied(IFileInfo fileInfo) (2)
            {
                Regex regex = new Regex(fileNamePattern, RegexOptions.IgnoreCase); (3)
                return regex.IsMatch(fileInfo.Name);
            }
    
            protected override void ReadSettings() (4)
            {
                fileNamePattern = Settings.Replace(@"\", @"\\").Replace(".", @"\.").Replace("*", ".*"); (5)
                fileNamePattern = "^" + fileNamePattern + "$";
            }
        }
    }
    1 Обязательный конструктор без аргументов.
    2 Метод, осуществляющий проверку соответствия файла условиям данного правила.
    3 Файл проверяется по маске с помощью регулярного выражения fileNamePattern.
    4 Загрузка настроек.

    По умолчанию настройки, установленные в Консоли управления Docsvision, загружаются в строковую переменную Settings. Предполагается, что пользователь будет указывать шаблон файла в виде Акт*.doc*, а для проверки соответствия имени файла шаблону будет использоваться регулярное выражение. Чтобы привести установленный пользователем шаблон к виду шаблона регулярного выражения был переопределён стандартный метод загрузки настроек ReadSettings.

  2. Компонент настройки.

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

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

    Настройки правил хранилища
    Рисунок 1. Настройки правил хранилища
Для реализации данной функции нужно:
  1. Создать класс с формой настройки.

  2. Указать данный класс в атрибуте Editor основного класса правила помещения в хранилище.

    Класс с формой настройки представляется собой компонент типа System.Windows.Forms.UserControl с реализованным программным интерфейсом IExtensionPropertiesControl. Далее приведён код примера данного класса.

    using DocsVision.Platform.WinForms.Controls;
    using System;
    using System.Windows.Forms;
    
    namespace RuleByUser
    {
        public partial class FileNamePatternPropertyControl : UserControl, IExtensionPropertiesControl
        {
    
            public FileNamePatternPropertyControl()
            {
                InitializeComponent();
            }
    
            public string Settings
            {
                get;
                private set;
            }
    
            public event EventHandler OnPropertiesChanged;
    
            public void Initialize(string settings) (1)
            {
                Settings = settings ?? "*.*"; (2)
    
                PatternBox.Text = Settings; (3)
            }
    
            public bool Save() (4)
            {
                Settings = PatternBox.Text; (5)
    
                return true;
            }
    
            private void PatternBox_TextChanged(object sender, EventArgs e)
            {
                OnPropertiesChanged?.Invoke(this, e);
            }
        }
    }
    1 Вызывается при загрузке компонента.
    2 Если строка настройки отсутствует, используется стандартный шаблон *.*.
    3 Отображаем загруженный шаблон в графическом интерфейсе.
    4 Вызывается при сохранении настроек.
    5 Шаблон, установленный пользователем, должен быть сохранён в переменную Settings.
    У класса формы две основных задачи:
    • Показать пользователю текущие настройки при открытии формы настройки при вызове метода Initialize;

    • Сохранить настройки пользователя в переменную Settings при вызове метода Save.

      При вызове Save можно осуществить проверку настроек пользователя: если настройки не содержат ошибки нужно вернуть true, иначе — false.

  3. Подписание сборки.

    Разработанный компонент должен быть подписан. Это необходимо для формирования полного имени сборки и регистрации компонента.

  4. Регистрация компонента на сервере.

    Собранный компонент, включающий основной класс и класс формы настройки, должен быть помещён в каталог /usr/lib/docsvision/common/ на сервере Docsvision.

Проверка

Настройка нового правила помещения в хранилище:
  1. Откройте Консоль управления Docsvision.

  2. В Консоли управления Docsvision выберите настраиваемую базу данных на странице Серверы  Имя-сервера  Сервер приложений  Базы данных и нажмите на строку нужной базы данных.

  3. Настройте параметры в группе Внешние хранилища при настройке свойств БД, см. раздел "Работа с внешними хранилищами в Docsvision" в документации Консоли управления Docsvision.

  4. Нажмите на кнопку Плюс в столбце настроек

  5. В столбце "Правила помещения в хранилища" добавьте новые правила.

  6. При добавлении в параметре Тип выберите вариант Собственное правило и укажите имя сборки с реализованным новым правилом в поле Имя сборки, нажмите кнопку Получить данные.

  7. В поле Свойства укажите шаблон файла.

  8. В списке Группа хранилищ выберите группу, в которую будет помещаться файлы по данному правилу.

  9. Перетащите правило в начало списка правил, чтобы оно проверялось первым при добавлении файла.

  10. Если требуется, настройте другие параметры хранилищ.

  11. Нажмите кнопку Применить в правом верхнем углу окна Консоли, чтобы применить настройки хранилищ и перезапустите службу Сервера Docsvision. Уже сохранённые в БД хранилища, группы и правила отображаются обычным шрифтом, новые и отредактированные — выделяются жирным. После применения и успешного сохранения настроек в БД выделение жирным пропадает.

  12. Создайте карточку и добавьте файл с названием, соответствующим указанному в правиле шаблону. Файл будет сохранён в хранилище из группы хранилищ, указанных при настройке правила.