Для настройки модуля предназначена секция FileSystem в конфигурационном файле службы ввода appsettings.json.

 ВАЖНО. В примерах указаны пути до папок по умолчанию. В appsettings.json пути указываются только из docker-контейнера службы ввода документов.

Структура секции:

"FileSystem": {

  "DefaultLine": "DefaultSimpleLine",
  "CaptureLegacyFiles": "True",
  "Instances": [
    {
      "Name": "FileSystemIncoming",
      "FullPath": "FileSystem/Incoming",
      "Line": "ImagesToProgramLine",
      "IncludeSubdirectories": "False",
      "CreateLineForSubdirectories": "False",
      "DeleteOnCapture": "True",
      "ExcludeAttributes": "",
      "IncludeFiles": "",
      "ExcludeFiles": "",
      "WaitForFileUnlockTimeoutInSeconds": 10,
      "RecaptureLockedFilesIntervalInSeconds": -1,
      "DeleteEmptySubdirectoriesAfterCapture": "False",
      "UpdateIntervalInSeconds": 5
    }
  ]
},

DefaultLine. Линия для обработки документов со всех папок по умолчанию. Если необходимо использовать другую линию, то укажите ее в настройке экземпляра. Для выбора доступны линии из секции Lines. Параметр обязателен для заполнения.

CaptureLegacyFiles. Признак обработки существующих файлов в папке при запуске модуля ввода из файловой системы. Возможные значения:

•True – при запуске модуля все файлы, находящиеся в папке, заносятся в систему;

•False – при запуске модуля ни один файл, находящийся в папке, не заносится в систему.

Instances – настройки экземпляра захвата.

Name. Уникальное имя экземпляра захвата из файловой системы.

FullPath. Полный или относительный путь к папке, из которого необходимо заносить файлы в систему. Во втором случае путь задается относительно папки, указанной в параметре RootWorkingFolder.

Путь к сетевой папке в Microsoft Windows указывается в формате UNC: //<Имя компьютера>/<Имя общего ресурса>/<Папка>.

Line. Имя линии, которая будет использоваться для обработки файлов из данной папки. В качестве значения тега укажите одну из линий, перечисленных в секции Lines файла настроек. Параметр не обязательный. Если значение параметра не указано, то используется значение параметра DefaultLine из секции FileSystem.

IncludeSubdirectories. Признак обработки вложенных папок. Возможные значения:

•True – файлы из всех вложенных папок ввода заносятся в систему;

•False – файлы во вложенных папках не обрабатываются службами ввода.

CreateLineForSubdirectories. Признак создания линии для каждой вложенной папки. Определяет, как передаются на упаковку и отправку файлы из разных папок при наличии нескольких экземпляров ввода документов. Возможные значения:

•True – файлы из каждой вложенной папки обрабатываются отдельным экземпляром линии. Рекомендуется установить для поточной обработки файлов. Таким образом, если файлы поступают в разные вложенные папки, то при формировании пакетов они попадают в разные пакеты;

•False – файлы из папки ввода и всех его вложенных папок обрабатываются одной линией. Установлено по умолчанию.

DeleteOnCapture. Признак удаления файлов после занесения в систему. Возможные значения:

•True – файлы удаляются из папки ввода после успешного занесения в систему;

•False – файлы остаются в папке после занесения в систему. Установлено по умолчанию.

ExcludeAttributes. Список атрибутов файлов. Файлы, помеченные хотя бы одним из указанных атрибутов, не заносятся в систему Directum RX. Возможные значения зависят от используемой операционной системы.

Атрибуты, которые поддерживаются только в Microsoft Windows:

•a – «Архивный»;

•h – «Скрытый»;

•s – «Системный».

Атрибуты, которые поддерживаются в Microsoft Windows и Linux:

•r – «Только для чтения».

Например, если в качестве значения параметра задана строка hs, то скрытые и системные файлы не заносятся в систему. Если значение параметра не задано, то в систему заносятся все файлы.

IncludeFiles. Маски файлов, которые заносятся в систему. В качестве значения параметра укажите маски файлов через символ «;». Например: «*.doc;*.txt». Если значение параметра не задано, то в систему заносятся все файлы.

ExcludeFiles. Маски файлов, которые не заносятся в систему. В качестве значения параметра укажите маски файлов через точку с запятой. Например: «*.doc;*.txt». Если значение параметра не задано, то в систему заносятся все файлы.

WaitForFileUnlockTimeoutInSeconds. Максимальное время ожидания разблокировки файла перед захватом. Если файл, помещенный в папку для захвата, разблокируется за время, указанное в настройке, – он заносится в систему. Указывается в секундах, значение по умолчанию 10.

RecaptureLockedFilesIntervalInSeconds. Период времени после окончания ожидания разблокировки файлов в секундах, спустя который служба пытается вновь захватить их. Файлы помещаются в конец текущей очереди захвата. Значение по умолчанию -1, при котором разблокированные файлы не добавляются в очередь повторно.

DeleteEmptySubdirectoriesAfterCapture. Признак удаления пустых вложенных папок. Возможные значения: True, False. Значение по умолчанию False.

Примечание. Вложенные папки, которые существовали до запуска службы, не удаляются. Если настройка DeleteOnCapture имеет значение False, пустые вложенные папки не удаляются.

UpdateIntervalInSeconds. Интервал проверки папки ввода в секундах. Значение по умолчанию 5.

Пример настройки модуля ввода из файловой системы в Directum RX

Чтобы настроить занесение документов в систему из выделенной папки, в файле appsettings.json в секции FileSystem в параметре FullPath укажите путь до нужной папки. По умолчанию указана папка:

{DCS_DIR}/FileCapture/Incoming. Для работы службы ввода документов фрагмент пути «{DCS_DIR}» нужно заменить на реальный путь до папки с установленной службой DCS. Пример:

"FileSystem": {

  "DefaultLine": "DefaultSimpleLine",
  "CaptureLegacyFiles": "True",
  "Instances": [
    {
      "Name": "FileSystemIncoming",
      "FullPath": "D:/DCS/FileCapture/Incoming",
      ...
    }
  ]

/app/dcs/FileSystem/Incoming. Пример:

"FileSystem": {

  "DefaultLine": "DefaultSimpleLine",
  "CaptureLegacyFiles": "True",
  "Instances": [
    {
      "Name": "FileSystemIncoming",
      "FullPath": "/app/dcs/FileSystem/Incoming",
      ...
    }
  ]

СМ. ТАКЖЕ

© Компания Directum, 2024