dbaccess.properties

Основной конфигурационный файл приложения.

Файл находится в каталоге, путь к которому указан в параметре "-Dext.prop.dir" виртуальной машины Java (nausd4/conf).

В файле dbaccess.properties указываются не все настройки приложения. Указаны только параметры, значения которых заданы явно и значения которых переопределяют значение по умолчанию. Если параметр в файле не указан, то используется значение параметра по умолчанию.

В файле dbaccess.properties определяются настройки приложения в формате "параметр=значение". В строке "параметр=значение" после указания значения параметра в конце строки не должно быть пробелов.

Изменения любого параметра в файле конфигурации dbaccess.properties вступают в силу только после перезапуска приложения.

При указании путей к различным файлам в dbaccess.properties рекомендуется использовать прямой слеш "/" не зависимо от используемой операционной системы.
Обратный слеш "\" в сочетании с некоторыми символами может быть интерпретирован Java как управляющий символ и поэтому не рекомендуется к использованию.
Например, "\naumen.keytab" будет интерпретирован как символ перевода строки - "\n", за которым следует строка "aumen.keytab"."

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

  • ru.naumen.core.authentication.authenticators — список используемых типов аутентификаторов (разделитель ","). Недопустимые значения игнорируются.

    • INTERNAL — встроенная в приложение.
    • SPNEGO — прозрачная Kerberos аутентификация.

    • LDAP и AD — синонимы для обозначения LDAP-аутентификации.

      Настройка параметров LDAP-аутентификации осуществляется в конфигурационных файлах приложения: dbaccess.properties и ldap-settings.xml (если файла ldap-settings.xml нет, необходимо создать его вручную).

    • EXTERNAL — механизм аутентификации через провайдеров web SSO (SAML, OpenID Connect).

      Для входа в мобильное приложение будет использоваться платформенная логика аутентификации пользователя через отдельного провайдера. Если параметр ru.naumen.core.authentication.authenticators не содержит EXTERNAL, для аутентификации пользователя в мобильном приложении используется системная форма входа.

    • X.509 — механизм аутентификации по сертификату X.509.

    Аутентификация через форму входа возможна, даже если среди аутентификаторов не указан тип NTERNAL.

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

  • ru.naumen.mobile.rest.jwt:

    • true — в мобильном приложении используется аутентификация по JSON Web Token (JWT).

      JSON Web Token (JWT) — это открытый стандарт (RFC 7519) для создания токенов доступа, основанный на формате JSON. Используется для передачи данных для аутентификации. Токены создаются сервером, подписываются секретным ключом и передаются клиенту, который в дальнейшем использует данный токен для подтверждения своей личности.

      Поддерживается работа со встроенными приложениями в мобильном приложении.

    • false (по умолчанию) — используется аутентификация по Access Key (в данное время не поддерживается).

  • ru.naumen.mobile.auth.external.enabled:

    • true (по умолчанию) — SSO-аутентификация используется в мобильном приложении по умолчанию и не может быть изменена в интерфейсе.

      При условии, что параметр ru.naumen.core.authentication.authenticators содержит EXTERNAL.

    • false — SSO-аутентификация не доступна.

Карточки и формы

  • ru.naumen.mobile.trim.attribute.title:

    • true (по умолчанию) — удаляются пробелы в начале названий атрибутов при передаче их в мобильное приложение: списки, карточки, формы;
    • false — пробелы в начале названий атрибутов сохраняются.
  • encode-fqn:

    • true — включен сервис кодирования текста, который сокращает ссылку для перехода на форму, карточку или список, если ее длина превышает 2000 символов.

      Применяется для ссылок в веб-интерфейсе и в мобильном приложении;

    • false — сервис кодирования текста отключен.

Файлы

  • ru.naumen.mobile.showPreviewForPdfFiles:

    • true — в мобильном приложении файл в формате .pdf, загруженный в атрибут типа "Файл" будет отображаться как изображение;
    • false (по умолчанию) — файл в формате .pdf не отображается.
  • upload.file.max.size.bytes — максимальный размер каждого файла, загружаемого в систему (в байтах).

    Используется при загрузке файлов через мобильное приложение, через веб-интерфейс оператора, при обработке входящей почты, методами rest и api.

    При загрузке через веб-интерфейс оператора проверка происходит на сервере по факту загрузки файлов.

    Если значение параметра не задано или равно -1, то ограничений не накладывается.

  • upload.files.group.max.size.bytes — максимальный размер группы файлов, загружаемых в систему (в байтах).

    Используется при загрузке файлов через веб-интерфейс оператора, при обработке входящей почты, методами rest и api.

    Если значение параметра не задано или равно -1, то ограничений не накладывается.

  • upload.files.webserver.text.error.size.bytes — значение, использующееся в тексте сообщения об ошибке, при нарушении ограничений, установленных на размер загружаемых файлов на веб-сервере. Сам параметр никаких ограничений не накладывает.

    Значение указывается в байтах. Целое число.

    Примеры сообщений:

    • параметр задан: "Не удалось загрузить файл. Размер файла больше допустимого (%значение параметра%)".
    • параметр не задан: "Не удалось загрузить файл. Размер файла больше допустимого, обратитесь к администратору системы"
  • upload.files.acceptable.extensions — набор расширений файлов, разрешенных для загрузки в систему (через разделитель ','): jpg, jpeg, gif, png, ico, doc, docx, xls, xlsx, pdf, txt, eml, xml. Значения указываются с учетом регистра, т.е. JPEG и jpeg будут расцениваться как разные расширения.

    Если значение не задано, файлы будут загружаться без ограничений.

    Используется при загрузке файлов через мобильное приложение, через веб-интерфейс оператора, при обработке входящей почты, методами rest и api.

При загрузке файлов в систему, если они нарушают установленное ограничение на размер, возникает ошибка. В тексте ошибки заданные параметры в байтах конвертируются в мегабайты с точностью до сотых (2-го знака после запятой).

Методы api, на которые распространяются ограничения: utils.attachFile, api.mail.helper.attachMessageAttachments, api.mail.attachAllMessageAttachments.
Методы rest, на которые распространяются ограничения: add-file, create, create-m2m, edit, edit-m2m. Если в методе передаются файлы, нарушающие какие-либо ограничения, действие не выполняется (объект не создается, не редактируется, файлы не добавляются). Сервер возвращает код 500.
При обработке входящей почты, если файл из вложения к письму превысил ограничение на размер или его расширение не доступно для загрузки в систему, или вложения к письму превысили ограничение на групповой размер файлов, то ни один из файлов в систему не загружается и к объекту "письмо" не прикрепляется.

Пуш-уведомления

  • ru.naumen.push.mobile.fcmUrl — адрес сервера пушей.

    Пример:

    ru.naumen.push.mobile.fcmUrl=https://fcm.googleapis.com/fcm/send

Настройка прокси-сервера для отправки пушей

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

  • ru.naumen.push.mobile.fcm.proxyHostPort — имя сервера прокси и порт.

    Форма записи СЕРВЕР:ПОРТ. Если значение пустое, то прокси не используется. Пример: 127.0.0.1:8888.

  • ru.naumen.push.mobile.fcm.proxyUser — имя пользователя для доступа к прокси. Если значение пустое, то аутентификация не используется.

  • ru.naumen.push.mobile.fcm.proxyPassword — пароль пользователя для доступа к прокси. Если значение пустое, то аутентификация не используется.