Archive API¶

В этом разделе перечислены настройки, которые можно задать в конфигурационном файле Archive API.

Аутентификация и авторизация¶

"Jwt": {
    "Key": "guid"   // ключ для шифрования токенов
},

В поле Key задается ключ для шифрования токенов, которые используются для аутентификации и авторизации в API.

Примечание

Используйте единое значение ключа для всех компонентов Продукта в рамках одной инсталляции.

Предупреждение

Не используйте ключ по умолчанию для шифрования токенов и не передавайте ключ третьим лицам. Это может привести к несанкционированному доступу к данным, в том числе к содержимому документов и паролям.

См. также:

Аутентификация и авторизация

Параметры multipart-запросов¶

"FormOptions": {
    "ValueLengthLimit": 0,          // ограничение размера поля multipart-запроса, байт
    "MultipartBodyLengthLimit": 0   // ограничение размера тела multipart-запроса, байт
}

Multipart-запросы используются для сохранения файлов в архиве.

В поле ValueLengthLimit задается ограничение размера поля multipart-запроса. Размер сохраняемого файла не может превышать это значение. Значение по умолчанию - 31457280 байт (30 Мб).

В поле MultipartBodyLengthLimit задается ограничение размера тела multipart-запроса. Значение по умолчанию - 31460352 байт.

Кеширование¶

"ApiCachingPolicyOptions": {
    "CacheInvalidationInterval": 60 // интервал обновления закешированных данных
},

В поле CacheInvalidationInterval задается интервал обновления закешированных данных. Кешируются настройки и прочие редко меняющиеся данные. Интервал задается в минутах. По умолчанию данные обновляются раз в час.

Шифрование паролей¶

"DataProtectionKey": "guid"

В поле DataProtectionKey задается ключ для шифрования паролей в настройках подключения к внешним системам, для которых нужна авторизация по логину и паролю.

Примечание

Используйте единое значение ключа для всех компонентов Продукта в рамках одной инсталляции.

Предупреждение

Не используйте ключ по умолчанию для шифрования паролей и не передавайте ключ третьим лицам. Это может привести к несанкционированному доступу к данным, в том числе к содержимому документов и паролям.

Степень параллелизма¶

"DegreeOfParallelism": 0

В поле DegreeOfParallelism задается степень параллелизма при обработке данных.

Минимальное значение: 4.
Максимальное значение: 128.
Значение по умолчанию: число процессоров, умноженное на 4.

Примечание

Степень параллелизма должна быть соразмерна числу процессоров (ядер). Если значение будет слишком большим или слишком маленьким, это снизит эффективность параллельной обработки данных.

Подключение к базе данных¶

"ConnectionStrings": {
    "DocflowConnection": {              // настройки подключения к базе данных
        "ProviderName": "string",       // имя провайдера подключения к базе данных
        "ConnectionString": "string"    // строка подключения к базе данных
    }
}

В поле ProviderName задается имя провайдера подключения к базе данных. Провайдер определяет то, какую СУБД будут использовать компоненты Продукта. Возможные значения:

Npgsql для PostgreSQL
Microsoft.Data.SqlClient для SQL Server

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

См. также:
Параметры строки подключения для Npgsql
Параметры строки подключения для Microsoft.Data.SqlClient

Примечание

Лицензия на использование компонентов Продукта привязывается к строке подключения. При изменении строки подключения требуется обновить лицензию.

Архив в базе данных¶

Archive API можно настроить так, чтобы содержимое файлов хранилось непосредственно в базе данных. В этом режиме содержимое файлов можно хранить либо в базе данных интеграционного модуля, либо в отдельной базе данных.

Если содержимое файлов должно храниться в базе данных интеграционного модуля, то в конфигурационном файле достаточно настроить единственное подключение, DocflowConnection.

Если содержимое файлов должно храниться в отдельной базе данных, то в конфигурационном файле нужно настроить два подключения:

"ConnectionStrings": {
    "DocflowConnection": {              // настройки подключения к базе данных для доступа к данным пользователей и настройкам
        "ProviderName": "string",
        "ConnectionString": "string"
    },
    "DocflowArchiveConnection": {       // настройки подключения к базе данных для чтения и записи содержимого файлов
        "ProviderName": "string",
        "ConnectionString": "string"
    }
}

Подключение DocflowConnection будет использоваться для доступа к данным пользователей и настройкам. Подключение DocflowArchiveConnection будет использоваться для чтения и записи содержимого файлов.

Примечание

Значение поля ProviderName для обоих подключений должно быть одинаковым.

См. также:

Настройки сервиса для работы с архивами

Логирование¶

"NLog": {   // настройки логирования
    // ...
}

В поле NLog задаются настройки логирования.

Компоненты Продукта используют NLog для записи логов. По умолчанию настроена запись в файлы. Расположение лог-файлов зависит от целевой операционной системы и указано в документации по установке для выбранной ОС.

См. также:
Справочное руководство по конфигурации NLog
JSON-схема для конфигурации NLog