В Directum RX администратору системы доступны возможности для изменения оформления элементов системы под индивидуальные требования компании. Для настроек фирменного стиля используйте следующие параметры:

•RELEASE_NOTES_SLIDER_FILE_PATH – путь к слайдеру о новинках системы;

•PRODUCT_NOTES_SLIDER_FILE_PATH – путь к слайдеру с описанием базовых возможностей системы. Этот слайдер отображается при первой авторизации сотрудника в системе;

•HOME_MODULE_ID – идентификатор модуля, обложка которого открывается при запуске проводника веб-клиента. Если параметр не заполнен, то по умолчанию открывается папка «Входящие». Чтобы получить ИД модуля, в веб-клиенте перейдите на обложку модуля и из адресной строки скопируйте весь текст после cover/. Например, из адресной строки модуля «Финансовый архив» https://rx.directum.ru/WebClient/#/cover/e99ae7e2-edb7-4904-a19a-4577f07609a4 нужно скопировать текст e99ae7e2-edb7-4904-a19a-4577f07609a4;

•BRAND_NAME – название организации, которое отображается в префиксе подписи к штрихкоду документа. Значение параметра по умолчанию – Directum RX. Значение можно изменить, например, на имя организации;

•PRODUCT_NAME – название системы. Отображается в заголовке вкладки браузера со страницей входа в проводник веб-клиента, в окне отправки отзыва о системе, в заголовке слайдера с информацией о новинках или базовых возможностях системы и в других элементах интерфейса. По умолчанию – Directum RX;

•PRODUCT_WEB_SITE – веб-сайт организации. Адрес по умолчанию www.directum.ru.

По умолчанию язык интерфейса веб-клиента такой же, как и в операционной системе. Иногда сотрудник подключается к системе, не обратив внимание, что выбран, например, английский язык. В результате интерфейс Directum RX отображается на английском, и сотрудник может решить, что это сбой. Он обращается к администратору, не всегда зная, что может самостоятельно разобраться с этим вопросом. Достаточно выйти из системы и войти повторно, выбрав нужный язык. В результате администратор тратит время на выяснение причины сбоя.

Чтобы избежать таких ситуаций, администратор может отключить неиспользуемые языки интерфейса. Для этого в конфигураторе Directum Launcher добавьте параметр UI_DISABLED_LANGUAGES и через разделитель «;» укажите необходимые значения:

•ru – отключить русский язык;

•en – отключить английский язык (United States и United Kingdom);

•en-US – отключить английский язык (United States);

•en-GB – отключить английский язык (United Kingdom). Значение по умолчанию.

Если указано произвольное значение или символ, то параметр игнорируется, и все языки становятся доступны. Если в параметре пустое значение, то используется по умолчанию en-GB.

Пример в config.yml:

UI_DISABLED_LANGUAGES: 'en-US'

Отключенные языки не отображаются при входе в систему.

Администратор может изменить максимальное количество записей в списке для экспорта в форматы XLSX и CSV. Для этого добавьте параметры:

•EXPORT_TO_EXCEL_MAX_RECORDS_COUNT_FOR_ADMINISTRATORS_AND_AUDITORS – максимальное количество записей, которое могут экспортировать сотрудники, входящие в роли «Администраторы» «Аудиторы». Максимальное значение 200 000. По умолчанию 50 000;

•EXPORT_TO_EXCEL_MAX_RECORDS_COUNT_FOR_USERS – максимальное количество записей, которое могут экспортировать сотрудники. Максимальное значение 50 000. По умолчанию 10 000.

Дополнительно можно ограничить количество записей для экcпорта в формат XLSX, так как при выгрузке в этот формат создается нагрузка на веб-сервер. Для ограничения используется параметр EXPORT_TO_EXCEL_MAX_RECORDS_COUNT_FOR_FORCED_CSV – максимальное количество записей, которое можно экспортировать в формат XLSX. Если записей выгружается больше, то список принудительно экспортируется в формат CSV. Настройка действует только для сотрудников, входящих в роли «Администраторы» «Аудиторы». Максимальное значение 100 000. По умолчанию 10 000.

Пример настройки параметров:

EXPORT_TO_EXCEL_MAX_RECORDS_COUNT_FOR_ADMINISTRATORS_AND_AUDITORS: 50000

EXPORT_TO_EXCEL_MAX_RECORDS_COUNT_FOR_USERS: 10000
EXPORT_TO_EXCEL_MAX_RECORDS_COUNT_FOR_FORCED_CSV: 10000

В результате после применения этих настроек:

•сотрудники могут экспортировать не более 10 000 записей в форматы XLSX или CSV;

•администраторы и аудиторы могут экспортировать не более 50 000 записей. Так как задано ограничение в параметре EXPORT_TO_EXCEL_MAX_RECORDS_COUNT_FOR_FORCED_CSV, то:

•до 10 000 записей можно выгрузить в форматы XLSX и CSV;

•от 10 000 до 50 000 можно выгрузить только в формат CSV.

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

Пример записи лог-файла:

{

 "t":"2023-09-01 15:47:21.541+04:00",

 "pid":"36628+1",

 "l":"Warn",

 "lg":"ExportToExcelSettings",

 "mt":"'EXPORT_TO_EXCEL_MAX_RECORDS_COUNT_FOR_USERS' must be positive and less or equal than 50000. The value has been set
         to 10000.",

 "v":"4.8.0.0000"

}

Чтобы изменить URI-адрес веб-справки по веб-клиенту и среде разработки Directum RX, укажите его в параметре HELP_URI.

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

В Directum RX документы можно открывать для чтения в окне предпросмотра, не запуская внешний редактор. За это отвечает настройка PREVIEW_ENABLED. Если необходимо отключить возможность предпросмотра документов, в параметре снимите флажок (false). По умолчанию флажок установлен (true).

Чтобы у всех пользователей по умолчанию документы открывались для чтения в окне предпросмотра, установите флажок (true) в параметре PREVIEW_USE_DEFAULT. В результате в меню каждого пользователя устанавливается флажок Использовать предпросмотр документов. По умолчанию флажок снят (false).

За хранение файлов предпросмотра отвечает сервис PreviewStorage. Если изменился его относительный адрес, то обновите его в параметре PREVIEW_RELATIVE_PATH. По умолчанию /Preview/.

Если нужно запретить редактирование версий документа, подписанных с результатом «Согласовано» или «Не согласовано», в параметре ENDORSING_SIGNATURE_LOCKS_SIGNED_PROPERTIES установите флажок (true). Параметр также влияет на отображение значка согласующей подписи для документов. При включенной настройке значок согласующей подписи отображается на документе в списках, вложениях к задаче и связях документа. Значение параметра должно быть одинаковым для сервера приложений, веб-сервера, сервиса асинхронных событий и сервиса выполнения блоков схем задач Workflow. По умолчанию флажок снят (false).

По умолчанию в Directum RX поддерживается работа с электронными подписями в формате CAdES-BES – основной формат ЭП, описываемый в стандарте CAdES.

Чтобы обеспечить юридическую значимость документов в течение всего срока хранения, используйте усовершенствованную электронную подпись. Для настройки автоматического усовершенствования используйте параметр ADVANCED_SIGNATURE_TIMESTAMP_AUTO_ADD_MODE. Подробнее о настройке и других параметрах см. в разделе «Настройка усовершенствованной электронной подписи».

По умолчанию выполнить задание по простой задаче за исполнителя может любой пользователь с правами на изменение карточки задачи, например руководитель подразделения или инициатор задачи. Чтобы разрешить выполнять задания только исполнителю и его замещающему, в Directum Launcher во встроенном редакторе YAML для параметра ONLY_PERFORMERS_CAN_COMPLETE_SIMPLE_ASSIGNMENTS установите значение true. По умолчанию false.

Администратор может изменить настройки автоматической разблокировки карточек объектов в параметрах:

•UNCHANGED_CARD_AUTO_UNLOCK_TIMEOUT – время, в течение которого сохраненная карточка не должна редактироваться, чтобы блокировка с нее снялась автоматически. Задается в формате ЧЧ:ММ:СС, по умолчанию 02:00:00 (2 часа);

•UNCHANGED_CARD_AUTO_UNLOCK_TIMEOUT_BY_TYPES – время, в течение которого сохраненные карточки указанных типов сущностей не должны редактироваться, чтобы блокировка с них снялась автоматически. Значения задаются в формате <Идентификатор типа сущности>=<Время> через разделитель «;». Время задается в формате ЧЧ:ММ:СС. Для задач и заданий значение по умолчанию 08:00:00 (8 часов), для документов – 02:00:00 (2 часа);

•UNCHANGED_CARD_AUTO_UNLOCK_IGNORED_TYPES – идентификаторы типов сущностей, для которых не выполняется автоматическая разблокировка карточки. Значения задаются через разделитель «;».

ПРИМЕЧАНИЕ. Если тип сущности указан в параметре UNCHANGED_CARD_AUTO_UNLOCK_IGNORED_TYPES, то значение UNCHANGED_CARD_AUTO_UNLOCK_TIMEOUT_BY_TYPES игнорируется.

Пример настройки в config.yml:

UNCHANGED_CARD_AUTO_UNLOCK_TIMEOUT: '00:15:00'

UNCHANGED_CARD_AUTO_UNLOCK_TIMEOUT_BY_TYPES: 'd795d1f6-45c1-4e5e-9677-b53fb7280c7e=08:00:00;ea683a63-273e-43ae-bcf1-7a443698008a=03:00:00'
UNCHANGED_CARD_AUTO_UNLOCK_IGNORED_TYPES: 'd0190603-b367-4b4b-ac3c-856f3e495328;09584896-81e2-4c83-8f6c-70eb8321e1d0'

Directum RX заранее оповещает всех сотрудников о том, что срок действия лицензии на использование системы или на модуль подходит к концу. По умолчанию за 14 дней до истечения срока у сотрудников при входе в систему появляется сообщение и после этого повторяется при каждом входе. При необходимости можно изменить настройку показа сообщения либо полностью отключить оповещение. Для этого в конфигураторе Directum Launcher добавьте параметры:

•LICENSE_EXPIRE_NOTIFICATION_DAYS – количество дней, за которое в системе начнет появляться сообщение о завершении срока действия ключа лицензии на использование системы и лицензий на модуль. Значение по умолчанию 14. Чтобы отключить оповещение, укажите значение 0;

•LICENSE_EXPIRE_NOTIFICATION_POSTFIX_MESSAGE – сообщение c дополнительной информацией об истечении срока лицензии. При необходимости добавьте свою дополнительную информацию в текст сообщения для пользователей.

Отследить несанкционированный доступ к системе можно с помощью уведомлений о предыдущем входе пользователя в систему. Для этого в Directum Launcher во встроенном редакторе YAML в параметре PREVIOUS_LOGON_NOTIFICATION_ENABLED установите значение true. По умолчанию уведомления отключены.

Для настройки загрузки метаданных прикладных модулей в Directum Launcher во встроенном редакторе YAML в параметре EXTRACT_METADATA_IMMEDIATELY установите значение:

•true, если нужно загружать метаданные прикладных модулей при загрузке сервера. Для продуктивного сервера значение установлено по умолчанию, чтобы заранее загрузить метаданные и не тратить на это время при обработке запросов клиента;

•false, если при каждом запросе нужно проверять, актуальность загруженных в память метаданных и необходимость считывания их с диска. Для отладочного веб-сервера значение установлено по умолчанию, потому что метаданные могут измениться без перезагрузки сервера.

Если изменился путь к файлу с настройками кэшей веб-сервера, укажите его в параметре CACHE_SETTINGS_FILE_PATH.

Для изменения настроек работы со списками используйте параметры:

•MAX_QUERY_IDS_FOR_SORTING – максимальное количество записей, выбранных для сортировки в списке;

•MAX_QUERY_IDS_SEND_TO_CLIENT – максимальное количество записей, которые отображаются при открытии большого списка. Например, в списке с 1 млн. записей откроется только указанное в параметре количество. Ограничение также распространяется на количество отображаемых групп в списке. По умолчанию 1000.

Чтобы изменить интервал периодического обновления виджетов в веб-клиенте, задайте его через конфигуратор в параметре WIDGET_REFRESH_TIMEOUT. Указывается в формате ЧЧ:ММ:СС. По умолчанию 10 минут.

Веб-сервер может обращаться к сервису хранилищ по внешнему или внутреннему адресу. Чтобы сократить потребление трафика, обращение должно происходить по внутреннему адресу. Для этого во встроенном редакторе YAML в секции storageServicesMapping задайте значения атрибутов:

•internalAddress – внутренний адрес;

•publicAddress – внешний адрес.

Если секция не заполнена, веб-сервер обращается к сервису хранилищ по внешнему адресу.

Если в системе хранится большое количество документов, задач или заданий, и наблюдается замедление работы при поиске объектов, то рекомендуется изменить способ поиска и фильтрации по объектам этого типа. Например, в системе хранится более 10 млн документов. В этом случае, чтобы ускорить поиск, для всех типов документов рекомендуется выбрать способ проверки вхождений введенного фрагмента с начала слова. Для этого в секции SEARCH_STRING_STRATEGY укажите значения в параметрах:

•typeGuid – ИД типа объектов, для которых настраивается способ поиска. Например, чтобы применить настройку для всех электронных документов, укажите 030d8d67-9b94-4f0d-bcc6-691016eb70f3;

•value – способ поиска. Возможные значения:

•Contains – поиск выполняется по любому вхождению запроса в строку;

•StartsWith – поиск выполняется по совпадению запроса с начала строки;

•Equals – поиск по полному совпадению с запросом.

По умолчанию для всех типов объектов указано значение Contains.

Пример настройки в config.yml:

SEARCH_STRING_STRATEGY:

    strategy:
        #Задания и Уведомления
        - '@typeGuid': 'ea683a63-273e-43ae-bcf1-7a443698008a'
          '@value': 'StartsWith'
        #Электронный документ
        - '@typeGuid': '030d8d67-9b94-4f0d-bcc6-691016eb70f3'
          '@value': 'Equals'
        #Задачи
        - '@typeGuid': 'd795d1f6-45c1-4e5e-9677-b53fb7280c7e'
          '@value': 'StartsWith'

Чтобы уменьшить количество запросов к веб-серверу, рекомендуется кэшировать его данные. Для настройки кэширования в Directum Launcher во встроенном редакторе YAML задаются параметры:

•CACHE_SETTINGS_FILE_PATH – путь к файлу с настройками кэшей веб-сервера. Чтобы включить кэширование переименуйте файл CacheSettings.json.example в CacheSettings.json и в параметре установите значение CacheSettings.json. Файл CacheSettings.json.example расположен в папке %<Папка веб-приложения>%\bin\, например, C:\inetpub\wwwroot\DirectumRX\bin. Если путь не заполнен, то данные не кэшируются;

•CACHE_MONITORING_ENABLE – признак того, что включен мониторинг кэшей. Установите true, чтобы включить мониторинг кэшей, false – выключить;

•CACHE_MONITORING_INTERVAL – периодичность, с которой перезапускается мониторинг кэшей, в формате ЧЧ:ММ:СС. По умолчанию 10 минут;

•CACHE_STATS_FILE_PATH – путь к папке, в которую записывается файл со статистикой кэшей.

Для смены расположения лог-файлов измените значение в параметре LOGS_REMOTE_PATH – путь к папке с лог-файлами клиентского приложения, которые отправляются на веб-сервер. В пути можно использовать макропеременную ${logs-path} для подстановки пути из параметра LOGS_PATH.

Чтобы изменить настройки обработчика гиперссылок, используйте параметры:

•HYPERLINK_INTERNAL_URI_SCHEME – URI-адрес сервера приложений;

•HYPERLINK_FILE_EXTENSION – расширение файла, который формирует обработчик гиперссылок при нажатии пользователем на ссылку в веб-клиенте. Для расширения файла в реестре на рабочем месте пользователя сопоставляется обработчик, который открывает ссылку. Значение по умолчанию изменять не рекомендуется.

Чтобы изменить относительный адрес приложения Centrifugo, укажите его в параметре CENTRIFUGO_RELATIVE_PATH.

Веб-агент предназначен для открытия и подписания документов в браузере, отправки вложением в письмо и пр.

Чтобы использовать веб-агент:

1.Разрешите всем пользователям использовать веб-агент. Для этого убедитесь, что в параметре WEB_AGENT_CAN_USE установлен флажок (true). По умолчанию флажок установлен.

2.Установите веб-агент на клиентских компьютерах. Администратор может массово установить веб-агент сразу на несколько компьютеров с операционной системой Microsoft Windows. Также пользователи могут выполнить установку самостоятельно.

3.В параметре WEB_AGENT_ENABLED_BY_DEFAULT установите флажок (true). В результате у всех пользователей в меню будет установлен флажок Использовать веб-агент. Настройка применяется при первом входе в систему. В дальнейшем пользователь может сам снять или установить флажок. По умолчанию в параметре флажок снят (false).

ВАЖНО. Если сотрудник в меню пользователя снимал или устанавливал флажок Использовать веб-агент, то при изменении значения настройка не применяется.

Чтобы запретить использование веб-агента, снимите флажок (false) в параметре WEB_AGENT_CAN_USE.

При использовании облачной электронной подписи закрытый ключ и средство криптографической защиты информации (СКЗИ) хранятся на сервере. Подписание также выполняется на сервере.

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

ПИН-код для облачного подписания хранится в cookie. Чтобы настроить время жизни cookie, используйте параметр CLOUD_SIGNING_PIN_COOKIE_LIFETIME.

Подробнее см. раздел «Настройка облачной электронной подписи».

По умолчанию SQL-запрос прерывается, если он выполняется более 120 секунд (2 минуты). Если нужно изменить тайм-аут, в параметре SQL_TIMEOUT укажите новое значение в диапазоне от 0 до 255 секунд. Если указано другое значение, то SQL-запрос будет прерываться через 120 секунд.

Для настройки комментариев к SQL-запросам используйте параметры:

•SQL_COMMENT_ENABLED – добавление комментариев к SQL-запросам. В конфигураторе установите флажок (true), чтобы включить комментарии, снимите флажок (false), чтобы отключить комментарии;

•SQL_COMMENT_LOG_ENABLED – логирование комментариев к SQL-запросам. В Directum Launcher во встроенном редакторе YAML в параметре укажите true, чтобы включить логирование, false – отключить.

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

Влияние вызовов Remote-функций на быстродействие системы можно отслеживать. Информация о них записывается в лог-файл. С ее помощью в прикладном коде можно найти обработчики, которые замедляют работу сервера, и доработать их. Чтобы отслеживать влияние вызовов Remote-функций, используйте параметр REMOTE_FUNCTION_TRACKER_LOGGING_INTERVAL. Укажите в нем промежуток времени – периодичность, с которой в лог-файлы веб-сервера записывается информация о состоянии запроса. Значение по умолчанию 00:01:00 (1 минута).

Чтобы отключить отслеживание вызовов Remote-функций в обработчиках клиентских событий, укажите значение 00:00:00.

Запросы к веб-серверу, которые возвращают большое количество записей, долго обрабатываются. К таким запросам относятся, например, LINQ-запросы с методом GetAll() и расширениями ToList() или ToArray(). Чтобы отслеживать такие запросы, используйте параметр FETCHED_RECORD_COUNT_WITHOUT_WARNING. Информация о запросе, который вернул больше записей, чем указано в параметре, записывается в лог-файлы веб-сервера. Значение по умолчанию 1000. С помощью информации из лог-файлов в прикладном коде можно найти неоптимальные запросы и доработать их.

Чтобы при возникновении внутренней ошибки сервера выводилось ее сообщение и стек вызовов, в Directum Launcher во встроенном редакторе YAML добавьте параметр SHOW_DETAILED_INTERNAL_SERVER_EXCEPTION и укажите для него значение true. В результате вместо текста «Внутренняя ошибка сервера» выведется сообщение об ошибке и появится свернутая область Подробности. Если ее раскрыть, отобразится стек. Например, это может быть полезно при анализе ошибок во время отладки прикладной разработки.

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

Если выполнение прикладного кода с веб-сервера передается сервису изолированного кода, то в секции Веб-сервер (SungeroWebServer) можно изменить настройки запуска сервиса изолированного кода.

При Like-поиске в выпадающих списках в Microsoft SQL Server используется разделитель слов. По умолчанию значение разделителя [^a-zа-я]. При необходимости для улучшения поиска его можно поменять в Directum Launcher во встроенном редакторе YAML в параметре MS_SQL_LIKE_WORD_DELIMETER_PATTERN.

Веб-сервер

Настройка блокировки IP-адресов

Проверка работоспособности сервисов