Конфигурационный файл «settings.json»

Параметры конфигурационного файла «settings.json» представлены в таблице.

Параметры конфигурационного файла «settings.json»

Параметр Описание Значение по умолчанию На API
Web-клиента		 На API
Web-администратора		 Примечание
RedisWhen Настройка параметра команды Redis Set. Варианты:
· записывать всегда;
· записывать только при отсутствии ключа;
· записывать только при наличии ключа		 Always + + Значения: Always, Exists, NotExists
RedisCommandFlags Настройка параметра команды Redis Set None, FireAndForget + +
SSOAuthorizationCookieName Имя файла cookie, используемого сервером для SSO-авторизации в Web-сервисе Системы "LDSSOAuth" +
CollectPerformanceMetrics Сборка данных о времени выполнения запросов false + + Значения:
· true;
· false
CookieDomain Домен, с которым связан файл cookie + + Сетевое имя локального компьтера, где установлен backend. Пример:
· "dsud-webtst-373" – рекомендуемое значение;
· "" – использовать только для тестирования/отладки
CookieManipulatorSettings_HttpOnly Параметры файла cookie false + + Значения:
· true;
· false
CookieManipulatorSettings_Secure Параметры файла cookie false + + Значения:
· true;
· false
CookieManipulatorSettings_Path Параметры файла cookie "/" + +
UseScheduler Необходим для корректной работы подсистемы «Планировщик заданий» Может отсутствовать Значения:
· true;
· false.
Актуально с версии Системы 3.8.2
Redis_Host Определение настройки подключения к Redis. Адрес сервера, на котором установлен Redis Localhost + +
Redis_Port Определение настройки подключения к Redis. Порт, на котором установлен Redis 6379 + + Обязательно должен совпадать с портом, указанным при установке Redis
SupportedVersion Версия модели данных для совместимости с Web-сервисами Системы "3.5.0.42" +
EnableTemplating Использование шаблонов для генерации текста сообщения true + Значения:
· true;
· false
RedisExpiry_StaticData Время хранения в кэше статичных данных 01:00:00 + +
RedisExpiry_DynamicData Время хранения в кэше быстро устаревающих данных 00:10:00 + +
WBListEnable Включение и отключение функционала списков разрешенных/запрещенных получателей false + Для работы требуется патч репозитория на создание объекта LISTRECEIVERWC
IncludeBuildVersionHeader Включить в заголовки номер версии WebAPI true + + Значения:
· true;
· false
VocabularyNoCache Список некэшируемых справочников через ";", всегда читаются из Системы "" + Пример значений: "VOC1;VOC2"
VocabularyLocal Список локальных справочников через ";" "" + Пример значений: "VOC1;VOC2"
CookieDomain Домен, с которым связан файл cookie "" + + Имя хоста, где развернут backend. Например, "dsud-webbox-tst";
"" – использовать только для отладки
IsUseNewTree Алгоритм построения дерева сообщений true + Значения:
· true;
· false
IsUseTreeV2 Настройка алгоритма построения дерева сообщений true + Значения:
· true;
· false
InstructionFavoriteReceiverCount Количество сохраняемых последних получателей сообщений 2 +
InactiveTimeout Таймаут бездействия, применяемый в Web-клиенте "00:10:00" +
SameSiteMode Атрибут SameSite файла cookie Lax + Примеры значений: Lax, None, Strict, Unspecified
ConvertApiPath Адрес сервиса конвертации файлов в формате PDF Не задан + + Пример значения: http://localhost/LanDocs.Convert.Api/api/v1/
RepositoryVersion Версия репозитория, используется для выбора алгоритма обработки репозитория "3.51" + "3.51", любое иное значение игнорируется
IgnoreCaseSearch Использовать регистронезависимый поиск по сообщениям и документам false + + Значения:
· true;
· false
VocabularyUser Список справочников, которые считаются индивидуальными (пользователь просматривает и редактирует только свои записи) "" + Значение через «;». Пример значения: TYPERESOLUTION
IsDocOperationReset Сбросить лист согласования при добавлении версии или файла true + · true – сбросить лист согласования при добавлении версии или файла, но оставить лист согласования несброшенным, если пользователь создает файл с помощью функционала [Создать PDF/A] (в том числе при добавлении новых версий к данному файлу);
· false – не сбрасывать лист согласования
ServiceUserName Служебный пользователь (логин), используемый для получения данных при авторизации по сертификату. Получение справочников под служебной учетной записью. Примечание: не работает под системными учетными записями (ограничение Системы) Не задан + + Пример значения: dba
IsCertRevoked
Check		 Отключение проверки на отозванные сертификаты + · false – проверка на отозванные сертификаты отключена;
· true – проверка на отозванные сертификаты включена

Отсутствие в конфигурационном файле приравнено к значению false
ActionScriptName Имя скрипта на С#, который будет исполняться после отправки отчета по сообщению (для дополнительного расширения функционала Web-клиента и возможностей кастомизации) "" +
IsReceiverLicTypeIgnore Проверка лицензии пользователя + Если параметр имеет значение true, то при получении списка получателей Система не ставит каких-либо ограничений на тип лицензии сотрудника.
Отсутствие в конфигурационном файле приравнено к значению false
DomainID Переключение домена пользователя Отсутствует в конфигурационном файле + ? 1, 2, 3 – ID домена пользователя
IsPostgres Доработка для «ускорения» загрузки дерева сообщений (для PostgreSQL) false + Если значение true, то при загрузке дерева сообщений, а именно методы получения объектов INSTRUCTION и INSTRUCTIONSHEAF в constraint добавляется hints="join"
UseNegotiate Управление доменной авторизацией для версии Системы 3.7.3 true + + Значения:
· true – если нужна win-авторизация, тогда в IIS нужно указать true;
· false – если win-авторизация не нужна, тогда в файле «settings.json» нужно добавить параметр UseNegotiate=false
RedisExpiry_Vocabularies Время жизни справочников Отсутствует в конфигурационном файле: TTL по умолчанию 12 часов. Указано значение: время жизни + "RedisExpiry_Vocabularies": "00:15:00" (это 15 мин)
PathToGhostscript Путь до GhostScript + "PathToGhostscript": "C:\Program Files\gs\gs9.54.0\bin\gswin64.exe", начиная с версии backend-3.8.3.59 данный параметр исключили
FileCacheApiPath Адрес приложения кэширования Не задано + "FileCacheApiPath": http://localhost/LanDocs.FileCache.Api/api/v1/ начиная с версии 3.8.0.3
BufferSize Установить размер буфера (только при включенном параметре FileCacheApiPath) "ExtraSettings": {"BufferSize": 65536} + Только для версии Системы 3.8
Azure auth Параметры для подключения к Azure. Метод api/v1/auth/azure принимает на вход токен, полученный от Azure, проверяет его и запускает сессию "Azure": {
"ClientId": "e7af34f2-93a4-425c-9534-45b4bd1aecc0",
"TenantId": "d2ca5847-aeb0-4b67-83ff-57422c27fa54",
"UserClaimType": "preferred_username"
}		 + Начиная с версии Системы 3.8.0.33
CheckReport
Rights		 Отображение списка раздела Отчеты с учетом прав Не задано + Значения:
· true – отображаются отчеты, UID которых из ядра совпадает с UID отчетов, указанных при backend;
· false или параметр отсутствует в конфигурационном файле – права на отчеты не проверяются
UseTokenAuth Авторизация по токенам Отсутствует в сборке + + Для включения необходимо добавить параметр в конфигурационный файл «settings.json»:
"AuthSettings": {"UseTokenAuth": true}
ParallelDownloadMode Параметры для скачивания файлов + "FileSettings": {"ParallelDownloadMode": 1}
UseInboxCache Кэширование папки «Входящая» Отсутствует в сборке, что равносильно true + Возможные значения:
· true – включено кэширование;
· false – кэширование выключено
TemplatePrintApiPath Адрес приложения сервиса печати + "http://print_api/api/v1/" пример для docker, где print_api – имя контейнера Сервиса печати. "http://localhost/LanDocs.Print.Api/api/v1/" пример для IIS, где Landocs.Print.Api – имя приложения
AppBasePath Путь до контейнера backend (для работы Р7-Офис из docker) + "AppBasePath": "http://85.8.186.160:1923/landocs.webapi_ client"
WebApiUrlLinux Путь до контейнера backend (для работы конвертации и FastReport) + "WebApiUrlLinux": "http://172.29.17.219/landocs.webapi_client/", где:
· landocs.webapi_client – имя контейнера с backend;
· 172.29.17.219 – внешний адрес и порт, на котором развернут backend (порт по умолчанию 80 можно не указывать)
LDAP Параметры LDAP. Позволяет получить список пользователей AD из API на Linux-платформе для NET 10.0 + "Ldap": {"IsEnabled": true, “Port”: 389, "User": "user@REALM.COM", "Password": ""} где:
· IsEnabled – параметр, определяющий доступность получения логинов;
· Port – порт: 389, 636 (по умолчанию 389);
· User – пользователь AD в UPN-формате user@REALM.COM (user@lan.lanit.ru);
· Password – пароль
ContentStorage Хранилище контента Отсутствует + "ContentStorage": {"ServiceUrl": "http://dsud-webdev-381.lanit:6789", "Key": "CS_Admin_secret_key" }, где key должен совпадать с secret сервера ХК
UseServerSignVerify Проверка всех подписей на сервере Отсутствует в конфигурационном файле, равносильно false + · true – проверка на сервере;
· false – проверка на клиенте
CloudSignSettings Подписание через Сервис НЭП Отсутствует + Пример: "CloudSignSettings": {"BaseUrl": "http://dsud-webdev-381.lanit/LanDocs.CloudSign2/api/v1", UseSSO": true, "RedirectUri":"http://dsud-webdev-381/redirectnep", "AuthUrl": "http://dsud-webdev-381/redirectnep", "LDInstId": 1, "SecretKey": 7Y/ss7HZ7yS4BqYK49xNm9cIG5VRYPEojavk9j+6lpgwecLc7UQ0EDZTOAnF20KOr1UVLfySWEyLm8ToR5gaYQ==" } Начиная с backend версии 3.8.1.116
DepartmentFilter Фильтр по департаменту. Изменяет область видимости контекстного поиска, отображается подразделение текущего логического пользователя (включая все белые (разрешенные) подразделения департамента текущего логического пользователя) Отсутствует в конфигурационном файле, поиск осуществляется по всем подразделениям (обычный режим) + "DepartmentFilter": 1 – включен поиск только внутри подразделения пользователя. Начиная с backend 3.8.1.119
FilterStampsByJournal Фильтрация штампов ЭП с учетом журналов регистрации. Журнал регистрации указывается для конкретного штампа Отсутствует в конфигурационном файле, false "FilterStampsByJournal": true
SearchType Определяет тип поиска при использовании модуля RediSearch {Contains (default), StartWith} + Реализует возможность указывать режим поиска Contains или startWith на уровне метода получения данных из справочника с использованием RediSearch (методы /api/v2). Пример /api/v2/vocabulary/VOCABULARIESLIST.ORGANIZATIONS/search. Параметр не обязательный. Если параметр не передают, то используется настройка из конфигурационного файла
VocabularyBufferSize Количество записей, загружаемых из СК при чтении справочников Отсутствует в конфигурационном файле, без ограничения + "ExtraSettings": {"VocabularyBufferSize": 40000}
MaxPreviewFileSize Ограничение на размер отчета, который может отображается для превью. В случае отсутствия в settings-задается по умолчанию. Нельзя установить ограничение больше чем 2147483647 байт (2 ГБ) Параметр задается в байтах. По умолчанию размер 50 МB (52428800 байт) "FastReport": {"MaxPreviewFileSize": 1000}
MaxJsonDepth Ограничение вложенности ответов backend для JSON "MaxJsonDepth": 500 По умолчанию в конфигурационном файле отсутствует. Для версии Системы 3.8.1 и старше отсутствие = 128, для младших версий = 32
UseKeycloak Использовать токен Keycloak для авторизации при интеграции с ЛДМ. Управление файлами + Начиная с backend-3.9.0.78. Пример: "AuthSettings": {"UseKeycloak": true}, "Keycloak": {"realm": "DH", "auth-server-url": "http://172.19.91.151:8080/", "ssl-required": "none", "resource": "account", "public-client": true, "verify-token-audience": true, "confidential-port": 0}
LocalDocTemplate Переопределение пути для добавления шаблонов файлов, указанного в справочнике Параметры (параметр DocTemplateDir) По умолчанию отсутствует, т.е. переопределение не активно Пример: "LocalDocTemplate": "/srv/landocs/WebApi/templates/test"
Раздел SDK
UseSdk Использовать SDK false + + Значения:
· true – для подключения к Серверу контента через SDK;
· false –необязательный параметр, если не задан, то равнозначно true
Host Адрес Сервера контента localhost + + В зависимости от конфигурации
Port Порт для взаимодействия с СК 5777 + + Любой другой, который взаимодействует с СК
ProtocolType Протокол взаимодействия с СК Wcf + + · Wcf – для backend приложений, развернутых на серверах с ОС Windows;
· Grpc – для backend приложений, развернутых на серверах с ОС Unix + на серверах с ОС Windows
Раздел поиск Search
UseSdkSearch Использовать поиск + true/false
SearchApiUrl Адрес сервисов поиска + url. Пример: http://< ip>:< port>
UserName Логин системного пользователя для поиска +
Password Пароль системного пользователя для поиска +
Раздел ЭП SecurityProvider
ProviderClass Класс криптопровайдера +
CryptoProviderType Тип криптопровайдера +
ServerAddress Адрес сервиса безопасности + Пример: test-domen-name:port
Раздел отчетов FastReport
ServiceUrl Адрес сервиса FastReport Пример: http://localhost:80/FastReport.API +
Конфигурация приложения LanDocsFastApi
RedisConfiguration + localhost:6
ConnectionString Подключение к БД + Пример PostgreSQL: ConnectionString="Host=dsud-webbox-tst;Username=dbo;Password=dbo;Database=landocs"
LastReportsCount Количество отчетов в истории 30 +
ThreadCountMax Максимальное количество потоков 10 + Рекомендуется оставить по умолчанию
QueueMaxLength Максимальная длина очереди 10 + Рекомендуется оставить по умолчанию
FrxPath Путь до шаблонов отчетов "~/FRXs/" + Путь от корня FastApi
ReadyPath Путь к уже сформированным отчетам (история запросов) "~/FPXs/" + Путь от корня FastApi
UseHangfireServer Использовать очереди true + Установить значение true