Show/Hide Toolbars

Руководство по тех. обслуживанию

Описание ключей appsettings.json

Ссылки Назад Вверх Вперед

term_icon Файл appsettings.json в веб-сервере .NET Core - это файл конфигурации приложения, используемый для хранения параметров конфигурации, таких как строки подключения к базе данных, любые глобальные переменные области приложения и т. д.

Ключ

Описание и примеры

Logging

LogLevel

Настройки логирования по уровням. Возможные варианты:

Trace

Debug

Information

Warning

Error

Critical

None

"Logging": {

         "LogLevel": {

         "Default": "Information",

         "Microsoft": "Warning",

         "Microsoft.Hosting.Lifetime": "Information",

         "UniForm.Api.Authentication.JwtAuthenticationHandler": "None"

         }

 }

ConnectionStrings

TCConnectionString

Соединение с БД

SignalRedisConnectionString

Соединение с Redis для работы сервиса сигналинга (SignalR)

ActiveDirectoryAuthenticationMode

Для аутентификации через ActiveDirectory может быть установлен ключ ActiveDirectoryAuthenticationMode. Возможные значения: DirectoryServices, ldap, PrincipalContext. Значение по умолчанию - ldap.

DirectoryServices - библиотека "system.directoryservices" (только для AD).

PrincipalContext - "System.DirectoryServices.AccountManagement", более высокоуровневая библиотека (только для AD). Необходимо выбрать значением для ActiveDirectoryAuthenticationMode,, если в лесе ActiveDirectory используются одноименные учетные записи.

ldap - "Novell.Directory.Ldap" - библиотека, работающая по протоколу LDAP. Работает как с AD, так и для других LDAP-серверов (к примеру, OpenLDAP).

AllowedHosts

В качестве значения указывается список имен хостов, разделенных точкой с запятой, без номеров. Символ "*" позволяет разрешить все хосты.

"AllowedHosts": "*"

AppLogoPathSPAHorizontalDark,

Путь к логотипу (SPA) горизонтальная панель, темная тема

AppLogoPathSPAVerticalDark

Путь к логотипу (SPA) вертикальная панель, темная тема

Auth

AuthTokenLoginUrl

Токен авторизации

WinAuthHost

Включение win-аутентификации

"WinAuthHost": "IIS"

AuthTokenExpiresInMinutes

Срок жизни access-токена в минутах. Значение по умолчанию - 25 часов.

warning_icon В интерфейсе SPA спустя указанное время потребуется повторная авторизация в системе.

AuthRefreshTokenExpiresInMinutes

Срок жизни refresh-токена в минутах. Если значение не задано, время жизни refresh-токена составляет 30 дней.

AuthTokenRefreshStrateg

Стратегия обновления токенов. Возможные значения:

SlidingExpiration - автоматическое обновление токенов с периодичностью в зависимости от времени жизни.

None - обновление не предусмотрено, при истечении времени access-токена требуется повторная авторизация.

RefreshToken - используются refresh-токены (обновление токенов с помощью api-метода api/auth/token/refresh). По умолчанию время жизни refresh-токена -  30 дней, если не задано иное в ключе AuthRefreshTokenExpiresInMinutes.

Пример включения refresh-токенов:

"AuthTokenRefreshStrateg": "RefreshToken"

Application

ApplicationInstanceId

Название очереди. Необходимо уникальное название для корректной работы с шиной сообщений

MessageBus

Провайдер сообщений. Возможные значения:

None

Redis

RebusSQL

RebusPostgre

"Application": {

         "MessageBus": "RebusSQL"

 }

DefaultIsolationLevel

Указание IsolationLevel для приложения. Возможные значения:

Serializable = 0

RepeatableRead = 1

ReadCommitted = 2

Snapshot = 4

Chaos = 5

Unspecified = 6

"Application": {

         "DefaultIsolationLevel": 4

 }

CreateTasksForAppointments

Если календарная встреча создается в "Первой Форме", создается задача в календарной категории и запись в таблице Appointments.

Если календарная встреча создается в Exchange, то в "Первой Форме" создается запись в таблице Appointments, а соответствующая задача в системной календарной категории может создаваться или не создаваться. Будет ли создаваться такая задача, определяет ключ CreateTasksForAppointments – если он имеет значение false, задача в системном календаре не создается, если true - создается. По умолчанию задача в "Первой Форме" создается, но чтобы ускорить синхронизацию, этот режим можно отключить.

DisableSqlShell

В интерфейсе администрирования "Первой Формы" можно отключить возможность работы напрямую с SQL. Это определяет ключ disableSQLShell. Если ключ имеет значение true, то в разделе Сервисы не доступен пункт Выполнить SQL-запрос, а в редакторе смарт-выражений не отображается кнопка В TSQL. При попытке отредактировать хранимую процедуру будет возникать ошибка 403.

DontUseGetMachineIPForLog

Не использовать IP-адрес в журнале. Возможные значения: true/false.

EnableRemovalOfUnusedFiles

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

warning_icon Если тестовый сервер использует рабочие ("боевые") файловые провайдеры, то включать данный ключ в web.config на тестовом сервере не рекомендуется. В противном случае файлы, удаленные в тестовом приложении в процессе тестирования, будут удалены также и в рабочем приложении.

ExcludeAdSubdomains

Исключенные поддомены. Могут использоваться, например, для построения дерева поддоменов, синхронизации с AD, поиска и тд.

ExchangeTraceListenerFlags

Флаги должны быть заданы в конфиге, если их нет, то трейсы от запросов к Exchange не собираем (см. enum TraceFlags - множество возможных вариантов)

FilesExtensionsToNotCache

Чтобы задать типы файлов, которые не следует  кэшировать, нужно использовать ключ FilesCacheSize. Расширения файлов указываются в строку через запятую.

LicenseKey

Принудительная установка ключа лицензии

InvalidateUsersCacheByEvent

Чтобы включить обновление UsersCache по сигналу от мастер сервера, ключ InvalidateUsersCacheByEvent должен быть установлен в значение true.

warning_icon По умолчанию выключен, не рекомендуется к использованию

IsDevelopmentMode

Значение true отключает кодовые миграции.

IsExchangeSyncServer

Синхронизации встреч из Exchange. Принимает значение true или false. Ключ определяет сервер, который будет устанавливать соединения с Exchange и принимать от него уведомления.

Use404Logger

Логирование ошбки 404  в лог автоматизации. Принимает значение true или false.

"Use404Logger": true

LDAPSearchBase

 База поиска LDAP, должна быть конифгурируема

DisableAQB

Отключение AQB.

"DisableAQB": false

AppEngine

Движок приложения. Возможные значения: TC (если приложение на TaskCenter), Uniform.

"AppEngine": "TC"

MaxRequestLength

Длина запроса (ограничение размер загружаемых файлов)

"MaxRequestLength": "650000000"

Если ключ не задан, значение по умолчанию = int.MaxValue (2147483647) = 2 Гб

MultipartBodyLengthLimit

Ограничение длины составного тела. Ограничивает размер каждой части multipart POST-запроса.

Если ключ не задан, значение по умолчанию = int.MaxValue (2147483647) = 2 Гб

OpenLDAPProtocolVersion

 Версия протокола LDAP. Если не задана, значение по умолчанию - 3.

FilesCasheSize

Кэш для файлов.

"FilesCasheSize": "500"

PhoneProfileLocation

Идентификатор локации телефонии. Необязательный параметр, используется только у клиентов с несколькими разными контурами "Первой формы".

ProviderType

Тип провайдера

"ProviderType": "SAML",

   "Name": "1forma.net (ADFS)",

   "Id": {providerId}

R7

SecretKey

Ключ для работы с Р7 сервером. Минимальная длина ключа - 16 символов.

"R7": {

       "SecretKey": "yourSecretKey"

   }

RemovalOfUnusedFilesBatchCount

Задания по удалению неиспользуемых файлов. Чтобы ограничить время выполнения самого длительного задания (RemovePreparedFileStorageFilesJob), можно указать максимальное число файлов, которое оно может обработать за один запуск:

"RemovalOfUnusedFilesBatchCount": "300000"

где 300 000 - это максимальное число файлов.

warning_icon  Перед внесением изменений рекомендуется сделать резервную копию всех файловых провайдеров и основной БД.

RestrictAbsenceMessageForAll

Ограничить сообщение об отсутствии для всех.

SetCookieForUpperLevelDomain

Ключ SetCookieForUpperLevelDomain определяет, для какого домена будет задана cookie 1FormaAuth - для домена верхнего уровня (значение true) либо для полного доменного имени (false).

Если ключ не указан в приложении, то по умолчанию считается, что для cookie задается полный домен.

Имеет смысл, если настроены несколько серверов, например, https://win.myDomain.ru и https://forms.myDomain.ru.

См. Настройка аутентификации по токенам.

 

Urls

Адреса приложения

UseClassicEncodeInComments

Использовать классическоую кодировку в комментариях.  Возможные значения: true/false.

UseDevexpressDocToPdfConverter

Использовать DevExpress для конвертации doc-файлов в pdf.  Возможные значения: true/false.

UseExchangeAutodiscover

Использовать службу автообнаружения Exchange Server.  Возможные значения: true/false.

UseHacksForMailSending

Использование хаков при отправке писем. Например: проверка, нужно ли кодировать тему письма и т.д. Возможные значения: true/false.

UseTransactionOnTaskSynchronization

Использовать транзакцию при синхронизации задач. Возможные значения: true/false.

UseSecureLDAP

Использование SSL при аутентификации через LDAP. По умолчанию включено.

warning_icon Актуально, если ActiveDirectoryAuthenticationMode не указан, т.е. LDAP является значением по умолчанию

UseSpaPortals

Чтобы включить использование новых порталов в старом фронте, нужно установить ключ UseSpaPortals в значение true

WinToFormsRedirectFormsUrl

Настройка редиректа с Windows на forms приложение.

Значение ключа "WinToFormsRedirectFormsUrl": базовый адрес приложения с forms-аутентификацией.

Значение ключа "WinToFormsRedirectWinUrl": базовый адрес win-приложения.

"WinToFormsRedirectFormsUrl": "https://forms.myDomain.ru"

"WinToFormsRedirectWinUrl": "https://win.myDomain.ru"

WinToFormsRedirectWinUrl

Полезные ссылки