Перейти к содержанию

ecosoft-lexema8-config#

Mеханизм конфигурирования lexema 8.4 "ara" представлен отдельным пакетом с названием ecosoft-lexema8-config, поставляющимся вместе с пакетом ecosoft-lexema8@4.x.x.

ecosoft-lexema8-config основывается на популярном пакете config, используя его политику организации наследования и расширения конфигурационных файлов.

Дополнительная информация в статье Конфигурирование

db#

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

  • main - профиль подключения к основной базе данных по умолчанию. Обязателен к заполнению, если не указывается свойство applications.data.db
    • host - имя хоста
    • database - имя базы данных
    • dialect - диалект СУБД ("mssql", "postgres")
    • instanceName - имя экземпляра
    • port - порт сервера бд
    • user - логин
    • password - пароль
    • encrypt - позволяет установить зашифрованное соединение с sql-сервером (по умолчанию false - шифрование выключено). Настройка доступна, если свойство dialect='mssql'.
    • isolationLevel - уровень изоляции транзакций. Доступные значения: 'READ_UNCOMMITTED', 'READ_COMMITTED', 'REPEATABLE_READ', 'SERIALIZABLE'. По умолчанию 'READ_UNCOMMITTED'.
    • requestTimeout - время таймаута запросов в миллисекундах. По умолчанию 15000.
    • applicationName - значение строки подключения для ведения журнала сервера БД. По умолчанию ''ara''.
    • pool - настройки пула соединений:
      • max - максимальное количество соединений в пуле. По умолчанию 20.
      • min - минимальное количество соединений в пуле. По умолчанию 0.
      • idleTimeoutMillis - максимальное время в миллисекундах, которое будет простаивать соединение в пуле, прежде чем будет освобождено. По умолчанию 10000.
    • mirror - настройки подключения к зеркалу
      • host - имя хоста
      • port - порт сервера бд
      • database - имя базы данных
      • user - логин
      • password - пароль
  • radio - "in-memory" режим локальной базы данных sqlite с отключённым логированием, используется персистором для хранения недоставленных сообщений (см. статью Система взаимодействия реального времени (8.4)).
  • session - настройки подключения к локальному экземпляру redis для хранения сессии.
    • host - имя хоста (по умолчанию 'localhost').
    • port - порт для запуска (по умолчанию 6379).
    • db - идентификатор базы для Redis (по умолчанию 0).

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

common#

"Общие" настройки, описывающие пути и шаблоны расположения объектов бизнес-логики.

  • enableLicense - позволяет включить проверку лицензии, если установлено значение ''true'' (по умолчанию - false). Это временная настройка, которая необходима для тестирования функционала.
  • context - путь к каталогу, который является "контекстом" для разрешения относительных путей (по умолчанию - 'source'). Если путь является относительным, то будет добавлен к текущему рабочему каталогу.
  • defaultLanguage - язык по умолчанию (по умолчанию - 'ru').
  • external - объект, задающий пути к файлам с описанием внешних зависимостей.
    • manual - файл, заполняемый вручную (по умолчанию - 'external-manual.json').
    • auto - файл, заполняемый автоматически при сборке (по умолчанию - 'external-auto.json').
  • logging - настройки логирования.
    • allowSilent - включить/выключить логирование (по умолчанию false).
    • level - задает минимальный уровень логируемых событий. Доступные значения в порядке возрастания значимости: ''silly'',''debug'', ''verbose'', ''info'', ''warn'', ''error''.
    • elasticStack - настройки логирования в файлы (для Elastic Stack).
      • elasticLevel -задает минимальный уровень событий, логируемых в файлы . Доступные значения в порядке возрастания значимости: ''silly'',''debug'', ''verbose'', ''info'', ''warn'', ''error''.
      • suppress -включить/выключить логирование в файлы.
      • file - настройки файлов, в которые пишут логи.
        • maxsize - максимальный размер файла с логами (в байтах).
    • syslog - настройки логирования в syslog. В syslog будут передаваться логи сервиса collector, если задать уровень логирования info или ниже.
      • host - хост сервера для подключения.
      • port - порт сервера для подключения.
      • protocol - используемый протокол ('tcp4', 'udp4', 'tls4').
      • silent - если зазадть true, то выключает логирование (по умолчанию false).
      • level - задает минимальный уровень событий, логируемых в файлы . Доступные значения в порядке возрастания значимости: ''silly'',''debug'', ''verbose'', ''info'', ''warn'', ''error''.
  • webpack - настройки для webpack.
    • plugins - подключаемые плагины.
    • module - настройки модулей.
      • rules - правила загрузки модулей.
  • models - glob, описывающий расположение моделей (по умолчанию - 'models//*.js').
  • output - может быть как строкой, так и объектом.
    • если строка: путь к каталогу для размещения сборок документации, а также клиентской и серверной части (по умолчанию - 'build'). Если путь является относительным, то будет добавлен к каталогу, в котором расположен каталог context.
    • если объект: может содержать свойства client, server и docs, представляющие собой пути к расположению каталогов для вывода файлов клиента, сервера и документации. Если пути относительные - то будут добавлены к каталогу, в котором расположен каталог context.
  • queries - glob, описывающий расположение запросов (по умолчанию - 'queries//*.js').
  • reports - glob, описывающий расположение отчётов в контексте каталога отчётов (по умолчанию - '*.report').
  • externalReportsDir - Название папки внешних отчетов проекта jsreport. По умолчанию external.
  • internalReportsDir - Название папки внутренних отчетов проекта jsreport. По умолчанию internal.
  • jsreports - glob, описывающий расположение отчетов (jsreport) (по умолчанию - '/!(*.*)').
  • reportsDir - путь к каталогу с отчётами (по умолчанию - 'reports').
  • stimulsoftReports - glob, описывающий расположение отчетов (stimulsoft) (по умолчанию - '*.mrt').
  • stimulsoftReportsDir - путь к каталогу с отчётами (stimulsoft) (по умолчанию - 'stimulsoftReports').
  • sqlObjects - glob, описывающий расположение sql-объектов в контексте каталога sql-объектов (по умолчанию - '*.sql').
  • sqlObjectsDir - путь к каталогу с объектами sql-сервера (по умолчанию - 'sqlObjects').
  • units - путь к файлу с описанием юнитов (по умолчанию - 'units.json').
  • dashboardTemplates - путь к каталогу с шаблонами дашборда (по умолчанию - 'dashboardTemplates')

bus#

Настройки "Шины" для взаимодействия между сервисами.

  • protocol - используемый протокол (по умолчанию 'amqp').
  • hostname - имя хоста (по умолчанию 'localhost').
  • port - порт для запуска (по умолчанию 5672).
  • username - логин.
  • password - пароль.
  • requestTimeout - время ожидания ответа от слушателя в миллисекундах.

front#

Настройки клиентской части. Можно добавлять свой раздел с настройками (запрещено добавлять конфиденциальную информацию) для дальнейшего получения их на клиенте (см. свойство ApplicationService)

core#

Раздел с настройками ядра

  • theme - имя пакета, содержащего тему оформления (по умолчанию - 'ecosoft-lexema8-main-theme').
  • controls - перечень наборов контролов (по умолчанию - ['ecosoft-lexema8']).
    • если элемент массива - строка, то она будет использована как путь для импорта конструктора контрола, относящемуся к данному набору. Манифест набора будет загружен по пути {module_path}/lib/controls.manifest.json.
    • если элемент массива - объект, то в качестве пути для импорта конструктора контрола будет использовано значение свойства modulePath, а в качестве пути для загрузки манифеста будет использовано значение свойства manifestPath.
  • publicPath - настройка "публичного пути" для производственной сборки клиента (по умолчанию - '/client/').
  • sourcemap - флаг, обозначающий необходимость генерации карт кода (по умолчанию - true).
  • es - настройки используемой версии ECMAScript (по умолчанию - 'legacy'). Перекрывается опцией "ie" интерфейса командной строки.
    • legacy - с поддержкой IE11.
    • modern - без поддержки IE11.
  • helpUrl - "базовая" ссылка для кнопки "Справка".
  • autoLogin - если значение true, то клиент автоматически авторизуется под аккаунтом, который указан в сервисе gate (по умолчанию false).
  • enableSSO - флаг, обозначающий доступность sso аутентификации на клиенте (автоматический вход на странице логина).
  • adfsAuthType - Устанавливает тип авторизации через портал сервера федерации. Доступные значения: ''saml'', ''openid''. (по умолчанию отключено).
  • pingOneAuthType - Устанавливает тип авторизации через портал PingOne. Доступные значения: ''openid''. (по умолчанию отключено).
  • esiaAuthType - Устанавливает тип авторизации через портал Авторизация через портал ЕСИА. Доступные значения: ''openid''. (по умолчанию отключено).
  • disableMiddleNameValidation - позволяет отключить проверку заполнения отчества при создании нового пользователя и в личном кабинете (по умолчанию ''false'').
  • browserTabTitle - заголовок вкладки браузера (по умолчанию - 'lexema').
  • disabledPersonalDataFields - массив, который содержит список атрибутов пользователя, которые необходимо запретить для редактирования в личном кабинете (По умолчанию - []). Доступные атрибуты: ''LastName'' - фамилия, ''FirstName'' - имя, ''MiddleName'' - отчество, ''PhoneNumber'' - номер телефона.
  • googleMaps - настройки контрола GoogleMaps (по умолчанию undefined).
    • key - ключ для работы с Google Maps API, способ получения описан в статье Интеграция Google Maps (Разработка)
    • version - версия Google Maps, рекомендуется ставить квартальное обновление "quarterly"
    • language - язык интерфейса. Для русского языка необходимо указать "ru". Поддерживаемые языки.
    • region - регион использования. Для России необходимо указать "RU"
  • allowRegistration - задает отображение кнопки регистрации на странице входа (используется для внешней регистрации пользователей).
  • registration - настройки для внешней регистрации.
    • url - хост регистрационного сайта.
    • urlPath - дополнение к url с путем к форме заявки на регистрацию (по умолчанию пустая строка).
    • login - логин пользователя с доступом к форме заявки на регистрационном сайте.
    • password - пароль пользователя с доступом к форме заявки на регистрационном сайте.
  • hintLength - максимальное количество символов для всплывающей подсказки (по умолчанию не задан). Настройка будет применяться для всплывающих подсказок, в которых отображаются значения контролов (включая хинты в ячейках грида). Если свойство hint у контрола задается разработчиком, то для них эта настройка не будет применяться.
  • dialog - объект с настройками сервиса dialog.
    • errorDelay - время отображения сообщения с ошибкой в миллисекундах (по умолчанию - 0). Если 0, то сообщение не будет скрываться.
    • infoDelay - время отображения сообщения с информацией в миллисекундах (по умолчанию - 1800). Если 0, то сообщение не будет скрываться.
  • loginPageInfo - позволяет вывести произвольный текст (поддерживает HTML-теги) на странице входа (по умолчанию не задан).
  • companyInfo - информация о компании, которая отображается в окне "О системе".
    • show - скрыть/отобразить информацию о компании (по умолчанию - true).
    • link - ссылка на сайт компании (по умолчанию - 'http://lexema.ru').
    • linkTitle - заголовок ссылки (по умолчанию - 'Lexema.ru').
    • name - имя компании (по умолчанию - 'ООО Лексема'),
    • beginDate - начальная дата (год) (по умолчанию - '1995').
  • releaseInfo - настройки оповещения пользователя о новом релизе.
    • enable - включает/выключает оповещение (по умолчанию ''false'').
    • releaseLink - ссылка на сайт, в котором описана информация о новом релизе (по умолчанию ''null''). Пример: '/help/releaseList#{release}'. {release} - это необязательный параметр, в который подставится версия текущего релиза.
    • releaseMessage - текст отображаемый пользователю (по умолчанию 'Сайт обновлен до новой версии {release}.'). {release} - это необязательный параметр, в который подставится версия текущего релиза.
  • applicationTab - настройки вкладок приложения.
    • maxWidth - максимальный размер ширины вкладки. По умолчанию null (если значение null, то максимальная ширина не ограничена). Пример - '200px'. Задается в пикселях (px).
    • minWidth - минимальный размер ширины вкладки. По умолчанию '90px' (если значение null, то минимальная ширина не ограничена). Пример - '200px'. Задается в пикселях (px).
  • memo - настройки memo.
    • font - параметр font для всех memo по умолчанию.
    • fontSize - параметр fontSize для всех memo по умолчанию. По умолчанию '13px'. Задается в пикселях (px).
  • technicalWorksMessage - текст показываемый пользователю во время технических работ.
  • filePreview - настройки контрола FilePreview .
    • emptyContentText - текст в FilePreview при отсутствии вложения. По умолчанию 'Отсутствует вложение к документу'.

lib#

Настройки библиотеки.

  • aliases - словарь дополнительных псевдонимов. По умолчанию перед тестированием демо приложения необходимо выполнить предварительную сборку библиотеки. Чтобы избежать этого, можно прописать псевдоним, который позволит использовать исходные файлы. Пропишите в качестве ключа имя библиотеки, в качестве значения укажите путь к папке, где находятся исходные файлы относительно конфигурационного файла.
  • copying - настройки copy-webpack-plugin для публикации дополнительных файлов.
  • externals - список внешних зависимостей, которые будут исключены из бэндла библиотеки (по умолчанию - []),
  • name - имя библиотеки (в качестве него выступает название пакета; использование имён, отличных от названий пакета в данный момент не поддерживается).
  • source - путь к каталогу с исходниками библиотеки относительно корня проекта (по умолчанию - 'source').
  • manifests - используемые файлы манифеста из различных библиотек (по умолчанию ['ecosoft-lexema8']).

moxie#

Настройки сервера разработки.

  • port - порт для запуска (по умолчанию - 3333).

jsreportEditor#

Настройка редактора отчётов Jsreport.

  • port - порт для запуска (по умолчанию - 3069).
  • protocol - протокол (по умолчанию - http).

applications#

Настройки веб-сервисов.

config#

Настройки сервиса конфигурирования.

  • protocol - используемый веб-протокол (по умолчанию 'http').
  • host - имя хоста (по умолчанию 'localhost').
  • port - порт для запуска (по умолчанию 3071).
  • timeout - количество миллисекунд бездействия, после которого считается, что время ожидания истекло (по умолчанию 120000).
  • script - путь к модулю, запускающему сервис (по умолчанию 'ecosoft-lexema8-configuration-service').
  • noProxify - настройка проксирования сервиса (по умолчанию true).
  • useCredentialVault - флаг использовать хранилища учетных записей windows (по умолчанию false).
  • keys - используемые ключи хранилища учетных записей windows (по умолчанию []).

logic#

Настройки сервиса логики.

  • protocol - используемый веб-протокол (по умолчанию 'http').
  • host - имя хоста (по умолчанию 'localhost').
  • port - порт для запуска (по умолчанию 3072).
  • timeout - количество миллисекунд бездействия, после которого считается, что время ожидания истекло (по умолчанию 120000).
  • script - путь к модулю, запускающему сервис (по умолчанию 'ecosoft-lexema8-logic-service').
  • noProxify - настройка проксирования сервиса (по умолчанию true).

gate#

Настройки сервиса входа.

  • protocol - используемый веб-протокол (по умолчанию 'http').
  • host - имя хоста (по умолчанию 'localhost').
  • port - порт для запуска (по умолчанию 3061).
  • route - используемый маршрут (по умолчанию '/api/v2.0/gate').
  • timeout - количество миллисекунд бездействия, после которого считается, что время ожидания истекло (по умолчанию 120000). В режиме продакшена может потребоваться дополнительно настроить таймаут для веб-сервера (nginx).
  • script - путь к модулю, запускающему сервис (по умолчанию 'ecosoft-lexema8/gate').
  • allowUserToChangePassword - разрешить/запретить пользователю изменять (восстанавливать) пароль (по умолчанию true). Для администратора компании настройка игнорируется (всегда доступно изменение пароля).
  • passwordExpiration - задает срок действия пароля пользователя в днях, значение 0 отключает проверку (по умолчанию значение 0).
  • enableChangePasswordOnFirstLogin - включение необходимости смены пароля при первом входе пользователя после регистрации.
  • unifyPasswordResetResponses - если true, то унифицирует ответы API при восстановлении или смене пароля для защиты от перебора учётных записей. При возникновении ошибки (например, если email не найден) клиент получит стандартный успешный ответ, что может запутать легитимного пользователя, но является нормой для данного режима безопасности. По умолчанию false.
  • oauth2 - настройки oauth2-сервера.
    • multipleSessions - включает/выключает поддержку множественных сессий для пользователя (по умолчанию true).
  • maxSessions - максимальное количество допустимых сессий для пользователя (по умолчанию 0). Если значение ''0'', то ограничение отсутствует.
  • sessionLifeTime - время жизни сессии в минутах (по умолчанию 10).
  • refreshTokenLifeTime - cрок действия токена обновления в днях (по умолчанию 15).
  • userTokenLifeTime - устанавливает время действия токена восстановления пароля или кода входа при двухфакторной аутентификации в часах (по умолчанию 1). Можно задавать дробные числа, чтобы указать минуты и/или секунды.
  • failedPasswordAttemptsInterval - Время в секундах, через которое пользователь может повторить вход в приложение при неудачной попытке ввода пароля (по умолчанию 0 - без ограничений по времени).
  • failedPasswordAttemptsLimit - Количество попыток ввода пароля (по умолчанию 3). В случае превышения попыток вход пользователя в систему блокируется на время, которое указано в настройке failedPasswordAttemptsInterval.
  • textErrorInChangePassword - Текст, который выводится при вводе неправильного логина на странице восстановления пароля(По умолчанию "Не удалось отправить код для смены пароля").
  • textErrorInLogin - Текст, который выводится при вводе неправильного логина или пароля на начальной странице (По умолчанию "Неверный логин или пароль.").
  • attemptsLimitForConfirmCode - количество попыток ввода токена восстановления пароля или кода входа при двухфакторной аутентификации (по умолчанию 0). Если значение равно 0, то количество попыток не ограничено.
  • timeLimitForResendingConfirmCode - лимит времени (в секундах) для возможности повторной отправки токена восстановления пароля или кода входа при двухфакторной аутентификации (по умолчанию 0 - без ограничений по времени). Настройка влияет на доступность кнопки отправки кода. На сервере проверка не осуществляется.
  • userTokenProvider - имя провайдера восстановления пароля (по умолчанию 'email'). Доступные значения: 'email', 'phone', 'flashCall', либо имя провайдера из раздела tokenProviders.
  • twoFactorProvider - провайдер двухфакторной аутентификации. Доступные значения: 'none', 'email', 'phone', 'flashCall', либо имя провайдера из раздела tokenProviders.. В случае установки значения 'none' - считается выключенной. (по умолчанию 'none').
  • alternativeTwoFactorProvider - настройки альтернативного провайдера двухфакторной аутентификации.
    • name - имя провайдера (доступные значения как в настройке twoFactorProvider).
    • requestsCountBeforeUse - количество запросов кода для переключения на альтернативного провайдера (переключение не будет работать для пользователей, у которых задан свой провайдер).
  • tokenProviders - словарь с описанием используемых провайдеров для 2fa и восстановления пароля. Ключом является уникальное имя провайдера, а значением - объект со свойствами:
    • titles - содежрит описание заголовкой, которые будут использованы на форме подтверждения кода.
      • form - заголовок формы. По умолчанию 'Введите код, который был Вам выслан'
      • sendCodeButton - заголовок кнопки отправки кода. По умолчанию 'Выслать код повторно'
      • resendCodeTimer - заголовок таймерта, который отображает время для разрешения повторной отправки кода. По умолчанию 'Выслать код повторно можно через'
    • models - список подключаемых моделей (эти модели будут загружены через сервис logic).
    • module - путь к модулю, который будет импортирован через require, либо объект со свойствами: path - путь к модулю, key - имя свойства для импорта. См. пример реализации. В режиме продакшен необхдимо собрать свой образ сервиса gate c установкой библиотеки этого модуля. В docker-compose.yml указать свой образ.
  • secret - уникальный секретный ключ, на основе которого шифруется сессия.
  • validation - настройки валидации пароля и логина пользователя.
    • passwordRegularExpression - регулярное выражения для проверки пароля (по умолчанию /^(?=.*[0-9])(?=.*[a-z])(?=.*[A-Z])[a-zA-Z0-9]{8,}$/).
    • invalidPasswordMessage - сообщение отображаемое пользователю при вводе невалидного пароля (по умолчанию 'Пароль должен содержать строчные и прописные буквы, а также цифры. Минимальная длина 8 символов').
    • userNameRegularExpression - регулярное выражения для проверки логина (по умолчанию /^(?=.{8,20}$)[a-zA-Z0-9]+(?:[._][a-zA-Z0-9]+)*$/).
    • invalidUserNameMessage - сообщение отображаемое пользователю при вводе невалидного логина (по умолчанию 'Логин должен содержать только латинские буквы или цифры. Минимальная длина 8 символов').
  • cookieName - задает имя cookie для хранения идентификатора сессии (по умолчанию 'ara-session').
  • externalRegistrationHost - указывается адрес основного сайта, если текущий сайт используется для регистрации пользователей.
  • autoLogin - настройки для автоматической авторизации клиента.
    • userName - login пользователя, под которым произойдет вход в приложение.
  • ldap - раздел, содержащий настройки доменной авторизации (с проверкой логина/пароля на контроллере домена).
    • url - адрес контроллера домена. Пример: 'ldap(s)://domain:port'.
    • bindDN - логин пользователя домена. В случае пустой строки будет произведена попытка анонимного подключения. Пример для Active Directory: 'CN=ldap_user,CN=Users,DC=univers,DC=local'. Пример для FreeIPA: 'uid=admin,cn=users,cn=accounts,DC=dev,DC=lan'.
    • bindCredentials - пароль пользователя домена.
    • searchBase - описание базового имени откуда начинается поиск пользователей. Примеры: 'ou=users,dc=example,dc=org', 'cn=users,cn=accounts,DC=dev,DC=lan' . Можно задавать в виде массива строк, если требуется выполнять поиск в разных каталогах. Пример: ['ou=users,dc=example1,dc=org', 'ou=users,dc=example2,dc=org'].
    • searchFilter - описание фильтра ldap для поиска пользователей. Пример для Active Directory: '(&(objectclass=person)(sAMAccountName={{username}}))', Пример для FreeIPA: '(&(objectclass=person)(uid={{username}}))'.
    • searchAttributes - список атрибутов, возвращаемых контроллером домена при удачном поиске. Пример: ['sn', 'givenName', 'mobile', 'middleName', 'mail', 'uid', 'memberOf'].
    • import - настройки, которые используются при импорте пользователей.
      • searchFilter - описание фильтра ldap для поиска пользователей. Пример фильтра для Active Directory: '&(objectClass=user)(objectCategory=person)'. Пример фильтра для FreeIPA: '&(objectClass=person)'.
      • roles - словарь сопоставления групп c ролями в лексеме. Ключ - путь к группе, значение - массив ролей. Пример: "{ 'CN=owncloud_admin,OU=Access Groups,OU=EcoSoft, DC=univers,DC=local': ['admin', 'role1'], 'CN=owncloud_users,OU=Access Groups,OU=EcoSoft,DC=univers,DC=local': ['role2'], 'CN=gogs_users,OU=EcoSoft,DC=univers,DC=local': ['role3'] }". Для корректной работы необходимо в searchAttributes добавить атрибут, в котором перечисляются все группы пользователя (атрибут memberOf), в ldapSchemeDictionary добавить привязку для этого атрибута (memberOf: 'memberOf').
    • updateUserAttributes - включает/выключает автоматическое обновление атрибутов пользователя (которые получены из контроллера домена) в лексеме (по умолчанию true). Не влияет на обновление ролей.
    • updateRoles - включает/выключает автоматическое обновление ролей (которые получены из контроллера домена) в лексеме (по умолчанию false). Недостающие роли добавляются, а лишние роли удаляются. При включении обновления ролей необходимо правильно настроить словарь сопоставления групп c ролями в лексеме (настройка roles).
    • tlsOptions - дополнительные параметры, передаваемые на уровень подключения TLS при подключении через ldaps.
      • rejectUnauthorized - включает/выключает проверку сертификата. По умолчанию true.
  • ldapSchemeDictionary - словарь сопоставления атрибутов пользователя лексемы с полями, которые возвращаются контроллером домена после поиска пользователя. Используются для обновления данных в таблице пользователей, при получении списка пользователей из контроллера домена. Доступные атрибуты для сопоставления: login, firstName, lastName, middleName, email, phoneNumber, memberOf. Пример: "ldapSchemeDictionary: { login: 'sAMAccountName', email: 'mail', phoneNumber: 'mobile', memberOf: 'memberOf' }". Можно добавить дополнительные поля для привязки, если необходимо, чтобы сервис их возвращал при обращении по Web API.
  • adfs - раздел, содержащий настройки авторизации через портал Авторизация через портал adfs (8.4):
    • openid - раздел, содержащий настройки для авторизации по схеме openid:
      • configurationURL - url с OpenId конфигурацией федерации. (чаще всего выглядит так)
      • clientID - уникальный идентификатор клиентского приложения, зарегистрированного в федерации.
      • callbackURL - url возврата приложения после авторизации на портале. Для приложения на 8.4 должно выглядеть так: ''http(s)://[адрес сайта]/api/v2.0/gate/adfs/openid/callback''. (Вводится при регистрации приложения в федерации)
      • strictSSL - устанавливает необходимо ли валидировать ssl сертификат при запросах к адресам федерации. (по умолчанию ''true'')
      • userNameField - поле, по которому будет проводится аутентификация пользователя. Зависит от схемы используемой в доменах федерации. (по умолчанию ''upn'')
    • saml - раздел, содержащий настройки для авторизации по схеме saml:
      • metadata - url для загрузки метаданных в формате xml. (чаще всего выглядит так)
      • callbackUrl - url возврата приложения после авторизации на портале. Для приложения на 8.4 должно выглядеть так: 'https://[адрес сайта]/api/v2.0/gate/adfs/saml/callback'. (Вводится при регистрации Relying Party Trusts в федерации)
      • issuer - идентификатор зарегистрированного Relying Party Trusts. (Вводится при регистрации Relying Party Trusts в федерации)
      • entryPoint - точка входа в портал. Пример.
      • upnName - имя запрашиваемых данных из adfs. Пример.
      • cert - сертификат подписи(signing) формата X.509, декодированный в Base-64.
      • disableRequestedAuthnContext - флаг отключения проверки контекста авторизации. Позволяет пройти авторизацию из сети другого домена. Ошибка с текстом ''SAML provider returned Responder error: NoAuthnContext'' говорит о том, что контекст неверен или отсутствует и необходимо включить данную настройку при необходимости. (по умолчанию false)
  • ssoAuthDC - адрес контроллера домена. Пример: ldap(s)://domain:port.
  • pingOne - раздел, содержащий настройки авторизации через портал PingOne
    • openid - раздел, содержащий настройки для авторизации по схеме openid
      • clientId - уникальный идентификатор клиентского приложения.
      • clientSecret - client_secret клиентского приложения.
      • scope - список передаваемых scope (пример: 'openid profile email').
      • callbackUrl - url возврата приложения после авторизации на портале. Для приложения на 8.4 должно выглядеть так: ''http(s)://[адрес сайта]/api/v2.0/gate/pingone/openid/callback''
      • authorizationUrl - адрес на который перенаправляется пользователь для ввода логина и пароля
      • jwksEndPoint - адрес JWKS endpoint
      • tokenEndpoint - адрес token endpoint
      • prompt - указывает, будет ли сервер авторизации запрашивать у конечного пользователя повторную аутентификацию (по умолчанию ''none''). Доступные значения: ''none'', ''login''.
  • esia - раздел, содержащий настройки авторизации через портал Авторизация через портал ЕСИА.
  • webApiRoles - настройка ролей для доступа к Web API.
    • createUser - массив ролей для доступа к методу создания пользователей.
    • loadActiveDirectoryUsers - массив ролей для доступа к методу загрузки пользователей из Active Directory.
  • enableLocalRoutes - если true, то включает маршруты, которые должны быть доступны внутри локальной сети (например аутентификация). Этот параметр можно включить, если для внешней сети нужно использовать второй фактор для аутентификации, а для внутренней сети необходимо отключить. Доступ к маршрутам нужно настраивать в конфигурационном файле Отключение двухфакторной аутентификации только для пользователей внутренней сети. По умолчанию выключено.

radio#

Настройки сервиса взаимодействия реального времени.

  • protocol - используемый веб-протокол (по умолчанию 'http').
  • host - имя хоста (по умолчанию 'localhost').
  • ws - поддержка проксирования по веб-сокетам (по умолчанию true).
  • port - порт для запуска (по умолчанию 3062).
  • route - используемый маршрут (по умолчанию '/api/v2.0/radio').
  • timeout - количество миллисекунд бездействия, после которого считается, что время ожидания истекло (по умолчанию 120000). В режиме продакшена может потребоваться дополнительно настроить таймаут для веб-сервера (nginx).
  • script - путь к модулю, запускающему сервис (по умолчанию 'ecosoft-lexema8/radio').
  • channels - словарь используемых каналов. (по умолчанию 'ecosoft-lexema8': ['legacy', 'notify']). Ключом является идентификатор канала, значением - массив имен типов сообщений.
  • persistance - параметры хранения отложенных сообщений.
    • provider - класс, обеспечивающий хранение отложенных сообщений.
    • options - опции.
      • db - имя профиля подключения к базе данных (по умолчанию 'radio').
      • ttl - время хранения недоставленных сообщений в минутах. (по умолчанию используется значение applications.gate.sessionLifeTime)

data#

Настройки сервиса данных.

  • protocol - используемый веб-протокол (по умолчанию 'http').
  • host - имя хоста (по умолчанию - 'localhost').
  • db - имя профиля подключения к базе данных (по умолчанию - 'main').
  • dbProfiles - массив с именами дополнительных профилей (из раздела db), которые могут быть использованы для выполнения запросов.
  • port - порт для запуска (по умолчанию 3063).
  • route - используемый маршрут (по умолчанию '/api/v2.0/data').
  • timeout - настройка таймаута всегда берется из настроек подключения к БД (свойство requestTimeout из профиля подключения к базе данных в разделе db).
  • script - путь к модулю, запускающему сервис (по умолчанию 'ecosoft-lexema8/data').
  • dataSizeLimit - максимальный размер передаваемых данных в теле запроса, которые принимает сервис (по умолчанию '1mb').
  • cube - настройки интеграции с cubejs.
    • url - адрес для подклбчения к cubejs.

lock#

Настройки сервиса блокировок.

  • protocol - используемый веб-протокол (по умолчанию 'http').
  • host - имя хоста (по умолчанию 'localhost').
  • port - порт для запуска (по умолчанию - 3064).
  • route - используемый маршрут (по умолчанию '/api/v2.0/lock').
  • timeout - количество миллисекунд бездействия, после которого считается, что время ожидания истекло (по умолчанию 120000). В режиме продакшена может потребоваться дополнительно настроить таймаут для веб-сервера (nginx).
  • script - путь к модулю, запускающему сервис (по умолчанию 'ecosoft-lexema8/lock').

file#

Настройки сервиса файлов.

  • protocol - используемый веб-протокол (по умолчанию 'http').
  • host - имя хоста (по умолчанию 'localhost').
  • port - порт для запуска (по умолчанию 3065).
  • route - используемый маршрут (по умолчанию '/api/v2.0/content').
  • script - путь к модулю, запускающему сервис (по умолчанию 'ecosoft-lexema8/file').
  • maxSize - максимальный размер загружаемого файла на сервер (по умолчанию - '30mb').
  • timeout - количество миллисекунд бездействия, после которого считается, что время ожидания истекло (по умолчанию 120000). В режиме продакшена может потребоваться дополнительно настроить таймаут для веб-сервера (nginx).
  • checksumValidation - включает/выключает проверку хеша фала при скачивании (по умолчанию false). Примечания: если значение false, то хеш в БД не пишется. Если значение true, то файлы, у которых нет хеша в БД должны скачиваться без проверки хеша. Для коректной работы укажите хеш функцию в настройке hashAlgorithm.
  • hashAlgorithm - используемая хеш функция. Неоходмо указывать, если checksumValidation = true. Доступные значения: 'sha256'.
  • enablePreviewPageCount - флаг, отвечающий за вычисление количества страниц (cохраняется в таблице lex.File в колонке PreviewPageCount) для файлов пердпросмотра (по умолчанию - false).
  • enablePreviewFiles - флаг, отвечающий за генерацию файлов предпросмотра при загрузке на сервер и выгрузке (по умолчанию - false).
  • convertingWithUpload - флаг, отвечающий за генерацию файлов предпросмотра при загрузке (значение true) или только при попытке доступа к ним (значение false). (по умолчанию - 'true').
  • usePathForOrganization - флаг, отвечающий за использование каталога файлового хранилища, указанного для организации (по умолчанию - false).
  • checkFileRights - если true, то при скачивании файла вызывается прикладная функция для проверки прав доступа на файл (по умолчанию - false).
  • internalPort - порт для взаимодействия с сервисом файлов (по умолчанию - 3083). Используется другими сервисами (например сервисом preview).
  • conversionQueue - настройки очереди конвертирования
    • maxLength - максимальный размер очереди (по умолчанию - 1000).
    • storeFile - если true, то файл будет храниться в очереди, если false, то будет скачиваться из базы (по умолчанию - false).
  • conversionTask - настройки для задачи конвертации. Задача находит файлы, которые зависли в состоянии конвертирования (ищет файлы со статусом inProcess) и добавляет их в очередь на повторное конвертирование.
    • enable - включить/выключить задачу (по умолчанию - true). Включить задачу можно только в том случае, если настройки convertingWithUpload и enablePreviewFiles имеют значение ''true''.
    • interval - через сколько минут повторно запустить задачу, когда завершится предыдущая (по умолчанию - 1). Первый запуск осуществляется сразу после старта сервиса.
    • loadOptions - настройки загрузки файла (настройки запроса, который ищет файлы в состоянии конвертирования).
      • interval - через сколько миллисекунд выполнить запрос на загрузку следующих файлов после того, как предыдущие добавятся в очередь (по умолчанию - 10000).
      • limit - сколько файлов загружать одним запросом (по умолчанию - 50).
      • period - за какой период загружать файлы (загрузка по дате создания файла за последние n минут , где n - указанное значение). Указывается в минутах (по умолчанию - 4320).
  • storage - Настройка для выбора хранилища файлов. Доступные значения: db - хранение файлов в базе, ftp - хранение файлов на ftp-сервере, smb - хранение файлов на smb-сервере. По умолчанию db.
  • sftp - настройки ftp-сервера.
    • host - имя хоста (пример: 'localhost').
    • port - порт.
    • connectionTimeout - таймаут подключения в миллисекундах.
    • rootFolder - путь к папке на ftp-сервере, в которую будут сохраняться файлы (пример: 'myFolder/test'). Если необходимо сохранять в корневую папку, то следует задать пустую строку.
    • grouping - Массив с именами атирибутов (порядок добавления влияет на название папки) для группировоки фалов по папкам. Доступные атрибуты: 'year' - год создания файла, 'month' - месяц создаия файла. По умолчанию не задано. Пример: ['year', 'month'].
    • login - логин для подключения к ftp-серверу.
    • password - пароль для подключения к ftp-серверу.
  • ftp - настройки ftp-сервера.
    • host - имя хоста (пример: 'localhost').
    • port - порт.
    • connectionTimeout - таймаут подключения в миллисекундах.
    • rootFolder - путь к папке на ftp-сервере, в которую будут сохраняться файлы (пример: 'myFolder/test'). Если необходимо сохранять в корневую папку, то следует задать пустую строку.
    • grouping - Массив с именами атирибутов (порядок добавления влияет на название папки) для группировоки фалов по папкам. Доступные атрибуты: 'year' - год создания файла, 'month' - месяц создаия файла. По умолчанию не задано. Пример: ['year', 'month'].
    • login - логин для подключения к ftp-серверу.
    • password - пароль для подключения к ftp-серверу.
    • secure - если true, то обеспечивается зашифрованное ssl/tls соединение (для корректной работы должно поддерживаться и ftp-сервером) (по умолчанию false).
    • secureOptions - дополнительные настройки при включении настройки secure.
      • rejectUnauthorized - включает/выключает проверку сертификата. По умолчанию true.
  • smb - настройки smb-сервера.
    • host - имя хоста.
    • port - порт
    • rootFolder - путь к папке на smb-сервере, в которую будут сохраняться файлы. Если необходимо сохранять в корневую папку, то следует задать пустую строку или не задавать это свойство.
    • grouping - Массив с именами атирибутов (порядок добавления влияет на название папки) для группировоки фалов по папкам. Доступные атрибуты: 'year' - год создания файла, 'month' - месяц создаия файла. Настройка доступна только в ОС Linux. По умолчанию не задано. Пример: ['year', 'month'].
    • login - логин для подключения к smb-серверу.
    • password - пароль для подключения к smb-серверу.
    • domain - домен для подключения к smb-серверу.
  • storages - позволяет задать дополнительные хранилища файлов. Это объект, свойством которого является имя хранилища.
    • storageName - уникальное имя хранилища.
      • type - тип хранилища. Доступные значения 'db', 'ftp', 'smb'.
      • connection - настройки подключения.
        • для tpye='ftp' аналогично разделу ftp
        • для tpye='sftp' аналогично разделу ftp
        • для tpye='smb' аналогично разделу smb
        • для tpye='db':
          • model - путь к собственной модели для хранения файла. Эта модель должна быть унаследована от модели 'ecosoft-lexema8/lib/models/fileStorage.model.json'. У модели необходимо переопределить свойства ''db'' и ''schema''.
          • db - профиль БД. На данный момент свойство можно не задавать. Будет всегда использоваться профиль по умолчанию.

Внимание: При включении параметра enablePreviewFiles - убедитесь что подключен сервис preview - и установлены: Python, LibreOffice и Unoconv. В случае их отсутствия будет возникать ошибка при загрузке файлов.

preview#

Настройки сервиса превью.

  • protocol - используемый веб-протокол (по умолчанию 'http').
  • host - имя хоста (по умолчанию 'localhost').
  • port - порт для запуска (по умолчанию - 3074).
  • timeout - количество миллисекунд бездействия, после которого считается, что время ожидания истекло (по умолчанию 120000). В режиме продакшена может потребоваться дополнительно настроить таймаут для веб-сервера (nginx).
  • script - путь к модулю, запускающему сервис (рекомендуемое 'ecosoft-lexema8-preview-creator-service').
  • conversionApp - приложение, которое будет использоваться для конвертирования офисных файлов (docx, xlsx и т.д.). Доступные значения: 'r7office', 'libreoffice'. По умолчанию libreoffice. При использовании 'r7office' необходимо подключить сервис r7office-service.
  • fileSizeLimit - максимальный размер конвертируемого файла (по умолчанию '30mb').
  • maxRetry - кол-во попыток сконвертировать файл, после которых возникнет ошибка (по умолчанию - 3).
  • resultTTL - время хранения готового результата (файла или ошибки) в миллисекундах, в случае отсутствия соединения для ответа (socket) (по умолчанию - 10 - 60 - 1000).
  • disablePdfConversion - позволяет выключить конвертирование pdf-файлов (в этом случае сервис вернет исходный pdf-файл). По умолчанию - true (конвертирование выключено).
  • maxImageHeight - задает ограничение на максимальню высоту изображения. Если высота картинки превышает заданное значение, то будет выполнено сжатие картинки по высоте. Тип number. По умолчанию не задано.
  • maxImageWidth - задает ограничение на максимальню ширину изображения. Если ширина картинки превышает заданное значение, то будет выполнено сжатие картинки по ширине. Тип number. По умолчанию не задано.
  • conversionTimeout - задает таймаут конвертирования файла в миллисекундах (по умолчанию 20000).
  • conversionFormats - массив строк с форматами файлов (указывается MIME-тип), для которых необходимо создавать preview. По умолчанию включены все форматы ( 'image/jpeg', 'image/png', 'application/pdf', 'application/vnd.openxmlformats-officedocument.presentationml.presentation', 'application/vnd.oasis.opendocument.text', 'application/vnd.oasis.opendocument.spreadsheet', 'application/msword', 'application/vnd.openxmlformats-officedocument.wordprocessingml.document', 'application/vnd.ms-excel', 'application/vnd.openxmlformats-officedocument.spreadsheetml.sheet')

post#

Настройки сервиса электронной почты и смс сообщений.

  • protocol - используемый веб-протокол (по умолчанию 'http').
  • host - имя хоста (по умолчанию 'localhost').
  • port - порт для запуска (по умолчанию - 3066).
  • route - используемый маршрут (по умолчанию '/api/v2.0/post').
  • timeout - количество миллисекунд бездействия, после которого считается, что время ожидания истекло (по умолчанию 120000). В режиме продакшена может потребоваться дополнительно настроить таймаут для веб-сервера (nginx).
  • script - путь к модулю, запускающему сервис (по умолчанию 'ecosoft-lexema8/post').
  • attachmentRequestTimeout - максимальное время ожидания загрузки файла в миллисекундах (по умолчанию 1000).
  • defaultEmailId - идентификатор почтового ящика, который используется по умолчанию.
  • emails - словарь с описанием используемых почтовых ящиков. Ключом является уникальный идентификатор почтового ящика, а значением - объект со свойствами:
    • host - имя хоста smtp-сервера.
    • port - порт smtp-сервера.
    • secure - включить/выключить доставку по электронной почте с использованием TLS/STARTTLS (по умолчанию false). Доступные значение true, false. (Для 'smtp.yandex.ru' значение должно быть true)
    • rejectUnauthorized - включает/выключает проверку сертификата. По умолчанию true (проверка включена).
    • user - логин.
    • pass - пароль.
    • userName - имя отображаемое при отправке почты.(Устаревшее свойство. Необязательное свойство)
    • from - адрес электронной почты отправителя для исходящих сообщений. Задается в формате:'<почта отправителя>' или '"Отображаемое имя отправителя" <почта отправителя>'. Если свойство from не задано, то формируется автоматически на основе заданных параметров userName и user.
    • dsn - настройки DSN (требуется поддержка smtp-сервером).
      • notify - Условия, при которых должно быть отправлено уведомление о доставке. Доступные значения (можно комбинировать): 'success', 'failure', 'delay'. Используйте значение 'never' - для отключения уведомлений. Примеры: ['failure', 'delay'], 'failure', 'never'
      • recipient - почта получателя сообщения с уведомлением о доставке
  • sms - настройки сервиса для отправки смс (можно не описывать, если код для восстановления пароля не отправляется через смс).
    • provider - имя провайдера, реализующий отправку смс сообщений (по умолчанию ''undefined''). Доступные значения:
      • prostor
      • mts
      • либо путь к своему собственному классу
    • login - логин.
    • password - пароль.
    • sender - имя отправителя.
  • flashCall - настройки для сервисов Flash Call (авторизация по звонку).
    • provider - имя провайдера, реализующий отправку кода (по умолчанию ''undefined''). Доступные значения:
      • путь к своему собственному классу (наследник класса BaseFlashCall).
    • enableCustomValidation - Включает собственную реализацию проверки кода на валидность.
  • pushNotification - настройки для интеграции с сервисом firebase для отправки push-уведомлений. Настройки необходимо получить в личном кабинете firebase. Перейдите в настройки вашего приложения (Project settings). В разделе Service accounts нажмите кнопку Generate new private key. Содержимое файла необходимо добавить в этот раздел.

dxreport-iis-application#

Настройки web-приложения для работы с devexpress-отчетами.

  • protocol - используемый веб-протокол (по умолчанию 'http').
  • host - имя хоста (по умолчанию 'localhost').
  • port - порт для запуска (по умолчанию - 3067).
  • route - используемый маршрут (по умолчанию '/api/v2.0/report').
  • xtraReport - использование DevExpress отчетов (по умолчанию true).

jsreport#

Настройки сервиса отчетов jsreport.

  • protocol - используемый веб-протокол (рекомендуемое 'http').
  • host - имя хоста (рекомендуемое 'localhost').
  • port - порт для запуска (рекомендуемое - 3070).
  • route - используемый маршрут (по умолчанию '/api/v2.0/jsreport').
  • timeout - количество миллисекунд бездействия, после которого считается, что время ожидания истекло (по умолчанию 120000). В режиме продакшена может потребоваться дополнительно настроить таймаут для веб-сервера (nginx).
  • script - путь к модулю, запускающему сервис (рекомендуемое 'ecosoft-lexema8-jsreport-service').
  • editor - настройки редактора отчета.
    • port - порт для запуска (по умолчанию 3069).
    • protocol - протокол (по умолчанию 'http').
  • core - настройки библиотеки jsreport-core для сервиса отчетов. Редактор отчетов использует только настройки раздела extensions.
    • reportTimeout - время таймаута построения отчета в миллисекундах.
    • store - настройки для хранения отчетов.
      • provider - задает один из возможных вариантов для хранения отчетов. Доступно только значение 'fs' (хранение в файловой системе).
    • extensions - словарь используемых модулей для сервиса отчетов и редактора (редактор некоторые модули может подключать со своими настройками). Ключом является имя модуля, значением - объект с настройками (если необходимо использовать настройки по умолчанию, то необходимо передать пустой объект). При подключении модуля необходимо установить соответствующий пакет. Имя пакета формируется из имени модуля, с добавлением префикса '@jsreport/jsreport-' (например, при подключении модуля jsrender имя пакета будет '@jsreport/jsreport-jsrender'). Чтобы отключить модуль укажите в его настройках свойство enabled со значением false (Пример: ''xlsx: {enabled: false}'') и удалите соответствующий пакет в package.json.
      • fs-store - хранение отчетов в файловой системе.
        • syncModifications - сброс кэша при изменении отчета (по умолчанию false). В редакторе отчетов эта настройка всегда передается со значением false.
      • chrome-pdf - создание pdf-отчетов с использованием ''headless chrome''. Для этого модуля требуется установка пакета puppeteer (убедитесь, что в package.json в разделе dependencies прописан пакет puppeteer. Пропишите, если он отсутствует. В проекте прикладной библиотеки пакет puppeteer должен быть прописан в разделе devDependencies).
        • launchOptions - настройки запуска.
          • args - массив аргументов (по умолчанию ['--no-sandbox']).
      • handlebars - движок для описания макета шаблона (по умолчанию {}).
      • text - создание текстовых отчетов (по умолчанию {}).
      • xlsx - создание excel-отчетов (по умолчанию {}).
      • html-to-xlsx - создание excel-отчетов из html (по умолчанию {}).
      • templates - хранение и поиск шаблонов (по умолчанию {}).
      • child-templates - использование вложенных шаблонов (по умолчанию {}).
      • assets - встраивание статических ресурсов, такие как стили, шрифты или HTML (по умолчанию {}).
      • data - возможность привязки данных к шаблону (по умолчанию {}).

Значения для параметров protocol, host, port, script - не определены по умолчанию, для работы с сервисом jsreport их необходимо установить в конфигурационном файле конечного приложения.

scheduler#

Настройка сервиса задач по расписанию.

  • protocol - используемый веб-протокол (рекомендуемое 'http').
  • host - имя хоста (рекомендуемое 'localhost').
  • port - порт для запуска (рекомендуемое - 3075).
  • route - используемый маршрут (по умолчанию '/api/v2.0/scheduler').
  • timeout - количество миллисекунд бездействия, после которого считается, что время ожидания истекло (по умолчанию 120000). В режиме продакшена может потребоваться дополнительно настроить таймаут для веб-сервера (nginx).
  • script - путь к модулю, запускающему сервис (рекомендуемое 'ecosoft-lexema8-scheduler-service').
  • clientInfo - Объект содержащий данные для получения токенов для работы с приложением.
    • clientId - id стороннего приложения. Указанный id не рекомендуется использовать для других сторонних приложений.
    • clientSecret - секретный ключ стороннего приложения.
    • defaultUser - ключ пользователя из объекта ''users'' для работы с приложением.
    • users - объект содержащий данные о пользователях для работы с приложением. Пример: 
      1
2
3
4
      default: { // default - ключ пользователя
  userName: %Имя пользователя%,
  password: %Пароль пользователя%
}
  • functions - массив названий подключаемых к сервису пакетов функций.
  • attemptsLimit - количество попыток инициализации сервиса (по умолчанию 6)
  • beginTimeout - таймаут между попыток инициализации сервиса (по умолчанию 1000)

dss#

Настройки сервиса ОЭЦП.

  • protocol - используемый веб-протокол (по умолчанию 'http').
  • host - имя хоста (по умолчанию 'localhost').
  • port - порт для запуска (по умолчанию - 3076).
  • route - используемый маршрут (по умолчанию '/api/v2.0/dss').
  • timeout - количество миллисекунд бездействия, после которого считается, что время ожидания истекло (по умолчанию 120000). В режиме продакшена может потребоваться дополнительно настроить таймаут для веб-сервера (nginx).
  • script - путь к модулю, запускающему сервис (рекомендуемое 'ecosoft-lexema8-dss-service').
  • kontur - настройки для интеграции с СКБ Контур.
    • key - ключ для доступа к тестовой площадке контура по http или https, а также для доступа к боевой площадке по https. При работе с тестовой и боевой плащадками по https можнл использовать эту настройку, либо сертификат совместно с stunnel-msspi, либо оба варианта.
    • cryptoApiUrl - адрес, по которому доступно Crypto API контура. При работе с тестовой площадкой по http указывается 'http://cloudtest.kontur-ca.ru/v3'. При работе с тестовой или боевой площадками по https указывается адрес, по которому доступен stunnel-msspi. Если stunnel-msspi не используется (в случаях, когда необходимо использовать ключ (свойство key), вместо сертификата для аутентификации), то указывается адрес по которому доступен Wep API контура.
    • certificateReleasingUrl - адрес, по которому доступно Certificate Releasing API контура. При работе с тестовой площадкой по http указывается 'http://test.kontur-ca.ru/CC'. При работе с боевой площадкой по https указывается адрес, по которому доступен stunnel-msspi.
    • cryptoApiHost - добавляет http-заголовок host для запросов, которые обращаются к Crypto API. Свойство задается, если сервис работает в связке с stunnel-msspi. При работе с тестовой площадкой указывается 'cloudtest.kontur-ca.ru:443', при работе с боевой площадкой 'cloud.kontur-ca.ru:443'.
    • certificateReleasingHost - добавляет http-заголовок host для запросов, которые обращаются к Сertificate Releasing API. Свойство задается, если сервис работает в связке с stunnel-msspi. При работе с боевой площадкой указывается 'reg.kontur-ca.ru:443'.
    • callbackUrl - полный адрес к маршруту, на который придет POST-запрос с результатом операции от СКБ Контур. Шаблон адреса: [protocol]://[domain]/api/v2.0/kontur/dss/response.
    • taskId - идентификатор задачи, который выполнится сервисом shceduler после обработки POST-запроса от СКБ Контур маршрутом callbackUrl (по умолчанию null).
    • disableConfirmOperation - отключает подтверждение операции по смс для сертификатов НЭП по умолчанию false. Если настройка включена, то работа с сертификатами КЭП становится невозможной.
  • lexema - Настройки для подключения ОЭП от Лексемы. Для подключения достаточно указать пустой объект {}, если не используются дополнительные настройки.
    • certificateValidityPeriod - Задает срок действия сертификата в днях (по умолчанию 1825).
    • loadUserAttributesQuery - путь к запросу, который возвращает атрибуты, используемые для заполнения поля Subject (информация о владельце) сертификата.
    • confirmCodeLifeTime - время действия кода для подтверждения операции в секундах (по умолчанию 60).
    • attemptsLimitForConfirmCode - лимит попыток ввода кода для подтверждения операции (по умолчанию 3). Если указано 0, то количество попыток неограниченно.
    • disableConfirmOperation - отключает подтверждение операции по коду (по умолчанию false).
    • tsaUrl - адрес службы штампов времени. Используетсядля создания CAdES-A подписи.
    • containerStorage - тип хранилища данных для контейнера закрытого ключа (по умолчанию REGISTRY). Настройка используется для ОС Windows. Доступные значения: REGISTRY, HDIMAGE.
    • rootCertificate - Задает настройки корневого сертификата, который используются для выпуска пользовательских сертификатов. Этот сертификат будет игнорироваться, если к организации привязан свой сертификат. В режиме разработки сертификаты рекомендуется устанавливать в корневые доверенные сертификаты пользователя, а в режиме производства в корневые доверенные сертификаты компьютера. Если корневые сертификаты не используются, то это свойство не нужно задавать.
      • thumbprint - отпечаток корневого сертификата, который будет использоваться по умолчанию. Имеет меньший приоритет, чем сертификат, который привязан к организации. Можно не задавать.
      • store - хранилище для корневых сертификатов (рекомендуемое значение в режиме разработки'uRoot' - поиск в корневых доверенных сертификатах пользователя, рекомендуемое значение в режиме производства'mRoot' - поиск в корневых доверенных сертификатах компьютера).
    • keyContainers - словарь, содержащий имена контейнеров закрытых ключей для корневых сертификатов. Ключ - отпечаток (thumbprint) сертификата, значение - имя контейнера. Пример имени контейнера с экранированием спецсимволов: '\\\\.\\HDIMAGE\\MyContainerName'. Нужно прописать имена контейнеров для всех используемых корневых сертификатов, а не только из раздела rootCertificate (так как сертификаты могут быть привязаны к конкретной организации). Свойство используется исключительно для подписания ответов службы OCSP.

collector#

Настройки сервиса сбора информации о системе.

  • protocol - используемый веб-протокол (по умолчанию 'http').
  • host - имя хоста (по умолчанию - 'localhost').
  • port - порт для запуска (по умолчанию 3077).
  • route - используемый маршрут (по умолчанию '/api/v2.0/collector').
  • timeout - количество миллисекунд бездействия, после которого считается, что время ожидания истекло (по умолчанию 120000). В режиме продакшена может потребоваться дополнительно настроить таймаут для веб-сервера (nginx).
  • script - путь к модулю, запускающему сервис (рекомендуемое 'ecosoft-lexema8-collector-service').
  • model - модель, используемая для записи информации (по умолчанию 'ecosoft-lexema8/lib/models/collector.model.json').
  • enable - включить/выключить сбор информации о системе(по умолчанию false).
  • authentication - настройки сбора информации о сессиях пользователей.
    • enable - включить/выключить сбор информации об сессиях(по умолчанию false).
  • reports - настройки сбора информации об отчетах.
    • enable - включить/выключить сбор информации об отчетах(по умолчанию false).
    • exceptions - массив отчетов, игнорирующих параметр enable раздела reports - (по умолчанию []).
  • forms - настройки сбора информации об открытии/закрытии форм приложения.
    • enable - включить/выключить сбор информации об открытии/закрытии форм(по умолчанию false).
    • exceptions - массив ключей форм из units.json, игнорирующих параметр enable раздела forms - (по умолчанию []).
  • data - настройки сбора информации о работе с данными.
    • enable - включить/выключить сбор информации о работе с данными(по умолчанию false).
    • exceptions - массив идентификаторов моделей и запросов (путей к файлам относительно "контекста"), игнорирующих параметр enable раздела data - (по умолчанию []).
  • file - настройки сбора информации о работе с файлами.
    • enable - включить/выключить сбор информации о работе с файлами(по умолчанию false).
  • db - имя профиля подключения к базе данных, соответствует профилю в разделе db (по умолчанию main).

dev#

Настройки сервиса, предоставляющего интерфейс разработчика.

  • protocol - используемый веб-протокол (по умолчанию 'http').
  • host - имя хоста (по умолчанию 'localhost').
  • port - порт для запуска (по умолчанию - 3078).
  • route - используемый маршрут (по умолчанию '/dev').
  • timeout - количество миллисекунд бездействия, после которого считается, что время ожидания истекло (по умолчанию 120000). В режиме продакшена может потребоваться дополнительно настроить таймаут для веб-сервера (nginx).
  • script - путь к модулю, запускающему сервис (по умолчанию 'ecosoft-lexema8-dev-service').

excel#

Настройки сервиса экспотра данных в excel (используется для серверного грида).

  • protocol - используемый веб-протокол (по умолчанию 'http').
  • host - имя хоста (по умолчанию 'localhost').
  • port - порт для запуска (по умолчанию - 3079).
  • route - используемый маршрут (по умолчанию '/api/v2.0/excel').
  • timeout - количество миллисекунд бездействия, после которого считается, что время ожидания истекло (по умолчанию 120000). В режиме продакшена может потребоваться дополнительно настроить таймаут для веб-сервера (nginx).
  • script - путь к модулю, запускающему сервис (рекомендуемое 'ecosoft-lexema8-excel-service').

stimulsoftReport#

Настройки сервиса отчётов stimulsoftReport.

  • editor - настройки редактора отчета.
  • port - порт для запуска (по умолчанию 3081).
  • protocol - используемый веб-протокол (по умолчанию 'http').
  • host - имя хоста (по умолчанию 'localhost').
  • port - порт для запуска (по умолчанию - 3080).
  • route - используемый маршрут (по умолчанию '/api/v2.0/stimulsoft').
  • timeout - количество миллисекунд бездействия, после которого считается, что время ожидания истекло (по умолчанию 120000). В режиме продакшена может потребоваться дополнительно настроить таймаут для веб-сервера (nginx).
  • script - путь к модулю, запускающему сервис (рекомендуемое 'ecosoft-lexema8-stimulsoft-report-service').

pdf#

Настройка сервиса работы с pdf.

  • protocol - используемый веб-протокол (по умолчанию 'http').
  • host - имя хоста (по умолчанию 'localhost').
  • port - порт для запуска (по умолчанию 3082).
  • script - путь к модулю, запускающему сервис (рекомендуемое 'ecosoft-lexema8-pdf-service').
  • route - используемый маршрут (по умолчанию '/api/v2.0/pdf').
  • functions - словарь прикладных функций для обработки pdf файлов. Ключом является имя функции, значением - путь до функции.

r7office#

Настройка сервиса интеграции с r7office.

  • protocol - используемый веб-протокол (по умолчанию 'http').
  • host - имя хоста (по умолчанию 'localhost').
  • port - порт для запуска (по умолчанию 3084).
  • script - путь к модулю, запускающему сервис (рекомендуемое 'ecosoft-lexema8-r7office-service').
  • route - используемый маршрут (по умолчанию '/api/v2.0/r7office').
  • connection - настройки подключение к приложению r7office.
    • url - адрес, по которому достпуно приложение r7office (образ с установленным приложением можно скачать с локального репозитория: dhub.lex.lan:5000/admin/r7office). Пример: 'http://nix4.dev.lan:5050'.
    • callbackUrl - адрес, по которому доступен ядерный сервис r7office (этот адрес должен быть доступен для приложения r7office). Пример: 'http://172.17.0.1:3084'.
    • secret - настройки ключей
      • inbox - секретный ключ для входящих запросов
        • string - значение ключа
      • outbox - секретный ключ для исходящих запросов
        • string - значение ключа