Параметры конфигурационного файла Web-клиента

Конфигурационный файл Web-клиента располагается по адресу Каталог-установки-Web-клиента\5.5\Site\web.config.

Если какая-либо настройка отсутствует в конфигурационном файле, создайте её самостоятельно.

Настройки не сохраняются при обновлении версии Web-клиента.

После изменения параметров необходимо перезапустить пул Web-клиента.

Общие настройки

Настройка сервера после установки Web-клиента

  1. Если компьютер, на который установлен Web-клиент, работает под управлением Microsoft Windows Server 2016, нужно отключить компонент WEBDAVModule одним из двух способов:

    1. Удалить компонент WebDAV Publishing feature в ролях сервера:

      1. Откройте раздел Programs and Features в Диспетчере серверов.

      2. Снимите флаг с компонента Internet Information Services  World Wide Web Services  Common HTTP Features  WebDAV Publishing.

      3. Сохраните изменения.

      4. Перезагрузите IIS для применения изменений.

    2. Добавить команду удаления компонента "WebDAV" в конфигурационный файл Web-клиента:

      1. Откройте конфигурационный файл Каталог-установки-Web-клиента\5.5\Site\web.config .

      2. Перейдите к разделу system.webServer  modules.

      3. Добавьте строку <remove name="WebDAVModule" />:

        <system.webServer>
 <modules>
  <remove name="WebDAVModule" />
 </modules>
</system.webServer>

Подробнее см. "Действия после установки Web-клиента".

Параметры меню создания карточек

Чтобы изменить настройки меню создания карточек:

  1. Откройте конфигурационный файл Каталог-установки-Web-клиента\5.5\Site\web.config.

  2. Перейдите к элементу Docsvision  WebClient  CardTypes.

  3. Измените конфигурацию:

    • Чтобы изменить порядок кнопок создания типов карточек, измените порядок строк в CardTypes.

    • Чтобы добавить новый тип карточек, добавьте в секцию CardTypes строку следующего формата:

      <CardType CardTypeId="<>" /> (1)
      1 CardTypeId — GUID идентификатор типа карточки.

Подробнее см. "Настройка меню создания карточек".

Отключить создание типа карточек

Чтобы скрыть тип карточки из меню создания:

  1. Откройте конфигурационный файл Каталог-установки-Web-клиента\5.5\Site\web.config.

  2. Перейдите к элементу configuration  Docsvision  WebClient  CardTypes  CardType.

    В элементе CardTypes перечислены типы карточек, с которыми работает Web-клиент:

    • [CardTypeId="b9f7bfd7-7429-455e-a3f1-94ffb569c794"] — Документ.

    • [CardTypeId="c7b36f33-cdd4-4da9-8444-600fe14111e4"] — Задание.

    • [CardTypeId="2182e2a5-22a9-471f-9d65-e45deeae1c73"] — Группа заданий.

  3. Создайте или измените параметр DisableCreateFlags в элементе нужного типа карточек.

    Значение параметра DisableCreateFlags является суммой цифр, каждая из которых определяет один из вариантов скрытия типа карточки:

    • 0 — не скрывать.

    • 1 — скрывать тип из списка типов при создании карточки при нажатии кнопки + Создать на панели управления.

    • 2 — скрывать тип из списка типов при создании карточки с добавлением ссылки из карточек Документ и Задание, а также при создании карточки в качестве отчёта к Заданию.

    • 4 — скрывать тип из списка типов при создании связанного задания карточки Документ.

    • 8 — скрывать тип из списка типов при создании подчиненного задания карточки Задание.

    Пример 1. Изменение параметра "DisableCreateFlags"
    <configuration>
  <Docsvision>
    <WebClient>
      <CardTypes>
        <CardType CardTypeId="b9f7bfd7-7429-455e-a3f1-94ffb569c794" CssClass="document" SaveInFolder="true"
                  DisableCreateFlags="13" /> (1)
        <CardType CardTypeId="c7b36f33-cdd4-4da9-8444-600fe14111e4" />
        <CardType CardTypeId="2182e2a5-22a9-471f-9d65-e45deeae1c73" />
      </CardTypes>
    </WebClient>
  </Docsvision>
</configuration>
    1 Чтобы отключить любую возможность создания карточки Документ из Web-клиента, укажите значение 15 (= 1+2+4+8). Чтобы скрыть тип карточки Документ из списка типов при создании новой карточки, укажите значение 1.
    Параметр DisableCreateFlags не действует, когда меню создания карточки вызывается из настраиваемой разметки.

Подробнее см. "Отключить создание карточек определённого типа".

Удаление карточек и папок в корзину или навсегда

  1. Откройте конфигурационный файл Каталог-установки-Web-клиента\5.5\Site\web.config.

  2. Перейдите к секции configuration  Docsvision > WebClient > SettingGroups > SettingGroup[Name="WebClient"].

  3. Измените значение параметра DeletePermanently:

    • true — отключает использование корзины, папки и карточки удаляются безвозвратно.

    • false — удалённые карточки помещаются в корзину, папки удаляются временно (значение по умолчанию).

      Пример 2. Удалённые карточки будут помещаться в корзину, папки будут удаляться временно
      <Setting Name="DeletePermanently" Value="false" />

Подробнее см. "Изменить способ удаления карточек и папок".

Разрешённые для добавления файлы

Чтобы изменить список разрешённых для добавления файлов:

  1. Откройте конфигурационный файл Каталог-установки-Web-клиента\5.5\Site\web.config.

  2. Перейдите к секции configuration  Docsvision > WebClient > SettingGroups > SettingGroup[Name="WebClient"].

  3. Измените значение параметра AcceptableFileExtensions. Значение содержит строку регулярного выражения. Новые расширения файлов нужно добавлять во вторые скобки, через символ |.

    Пример 3. Список разрешённых файлов и добавление .dwg в допустимые расширения:
    <Setting Name="AcceptableFileExtensions" Value="(.|/)(rtf|dot|doc|dotx|ods|docx|odt|csv|xlt|xls|xltx|xlsx|xlsb|pdf|jpg|jpeg|gif|png|bmp|tiff|tif|emf|wmf|xslt|xsl|xml|htm|html|txt|log|cs|asmx|ascx|aspx|js|cpp|h|css|idl|ini|java|rc|rc2|shtm|shtml|sql|zip|rar|7z|vsd|vsdx|msg|one|pptx|ppt|avi|wav|docm|xltm|dotm|xlsm|p7s|sign|sig|sgn|pem|crt|cer|key|der|pkcs|pfx|dwg)$" />

Подробнее см. "Изменить список разрешённых для добавления файлов".

Максимальный размер прикладываемых файлов

Чтобы изменить ограничение для максимального размера единичного файла:

  1. Откройте конфигурационный файл Каталог-установки-Web-клиента\5.5\Site\web.config.

  2. Перейдите к элементу configuration  Docsvision > WebClient > SettingGroups  Setting [Name="MaxUploadFileItemSize"].

  3. Укажите новое ограничение в параметре Value. Тип int, значение в байтах, но не более 2147483647.

  4. Сохраните изменения конфигурационного файла.

Чтобы изменить ограничение для максимального общего размера всех добавляемых файлов карточки:

  1. Перейдите к элементу configuration  system.webServer  security  requestFiltering  requestLimits.

  2. Укажите новое ограничение в параметре maxAllowedContentLength. Тип uint и значение в байтах, но не более 4294967295.

  3. Установите аналогичное значение в параметре maxRequestLength, тип int, значение в байтах не более 2147483647 в элементах:

    • configuration  location[path="api/DocumentCardApi"]  system.web  httpRuntime.

    • configuration  location[path="api/LayoutFileApi"]  system.web  httpRuntime.

      Указанные параметры ограничивают общий размер файлов только для элемента управления Список файлов. Для элемента управления Файл данные ограничения действуют на единичный файл.

      Значения указанных параметров должны быть не меньше, чем значение параметра MaxUploadFileItemSize (см. выше).

Подробнее см. "Ограничить размер прикладываемых файлов".

Максимальный размер файлов для предпросмотра

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

  1. Откройте конифгурационный файл Web-клиента: Каталог-установки-Web-клиента\5.5\Site\web.config.

  2. В категории настроек <SettingGroup Name="System"> измените настройку MaxPreviewFileSize.

  3. Укажите значение в байтах, по умолчанию значение составляет 104857600 байт (100 Мб).

    Увеличение значения повысит нагрузку на сервер и время открытия файла на предпросмотр.

Подробнее см. "Ограничить максимальный размер файла для предпросмотра".

Настройки внешнего вида

Стандартный порядок кнопок "ОК/Отмена"

Порядок кнопок ОК/Сохранить и Отмена, отображаемых в диалоговых окнах и разметках Web-клиента, может быть настроен. Пользователь может настроить схему расположения в меню Профиль. Администратор может установить порядок расположения по умолчанию, который будет действовать до выбора нового значения пользователем.

  1. Откройте конфигурационный файл Каталог-установки-Web-клиента\5.5\Site\web.config.

  2. Перейдите к секции configuration  Docsvision > WebClient > SettingGroups > SettingGroup[Name="WebClient"].

  3. Измените значение параметра DefaultButtonPosition:

    Таблица 1. Значение параметра "DefaultButtonPosition"

    Auto

    Значение по умолчанию — порядок отображения кнопок определяется типом ОС пользователя:

    Для ОС MacOS: Отмена/OK

    Для ОС Windows, Android и др. — ОК/Отмена

    OkCancel

    ОК/Отмена

    CancelOk

    Отмена/ОК
    Пример 4. Включение режима "Отмена/ОК"
    <Setting Name="DefaultButtonPosition" Value="CancelOk" />

Подробнее см. "Порядок кнопок "ОК/Отмена" по умолчанию".

Закрепление основного меню

Чтобы изменить режим закрепления основного меню:

  1. Откройте конфигурационный файл Каталог-установки-Web-клиента\5.5\Site\web.config.

  2. Перейдите к секции configuration  Docsvision > WebClient > SettingGroups > SettingGroup[Name="WebClient"].

  3. Измените значение параметра UXMainMenuBehavior.

    <SettingGroup Name="WebClient">
   <Setting Name="UXMainMenuBehavior" Value="0" />
</SettingGroup>

    В Value укажите:

    • 0 — для использования режима переключения кнопками Закрепить меню/Открепить меню;

    • 1 — для использования режима переключения кнопкой Открыть меню.

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

Подробнее см. "Режим закрепления основного меню".

Скрытие боковой панели в карточках

Чтобы изменить режим скрытия панели:

  1. Откройте конфигурационный файл Каталог-установки-Web-клиента\5.5\Site\web.config.

  2. Перейдите к секции configuration  Docsvision > WebClient > SettingGroups > SettingGroup[Name="WebClient"].

  3. Измените значение параметра HideSidebarOnPageClick:

    • false (значение по умолчанию) — панель должна скрываться только при нажатии кнопки ОК/Отмена и пр.

    • true — панель также должна скрываться при щелчке вне боковой панели.

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

      <Setting Name="HideSidebarOnPageClick" Value="true" />

Подробнее см. "Режим скрытия правой боковой панели".

Настройки DVWebtool

Поведение DVWebtool

Поведение DVWebTool при запуске настраивается в конфигурационном файле Web-клиента:

  • DvWebToolAppShutDown — закрывать DVWebTool после выполнения действия. Значение по умолчанию: false — не закрывать.

  • DvWebToolStartUpLaunch — отвечает за автоматический запуск DVWebTool. Значение по умолчанию: true — утилита запускается автоматически при загрузке системы.

Подробнее см. "Настройки запуска программы DVWebTool".

Порт подключения к DVWebTool

Веб-браузер пользователя подключается к программе DVWebTool по адресу http://localhost:5413. Администратор может изменить стандартный порт подключения.

Чтобы изменить стандартный порт подключения:

  1. Откройте конфигурационный файл Каталог-установки-Web-клиента\5.5\Site\web.config.

  2. Перейдите к секции configuration  Docsvision > WebClient > SettingGroups > SettingGroup[Name="System"].

  3. Измените значение параметра WebServicesPort, указав новый номер порта подключения к программе DVWebTool.

    <SettingGroup Name="System">
    <Setting Name="WebServicesPort" Value="5413" />
</SettingGroup>

Подробнее см. "Изменить порт подключения к DVWebTool".

Настройки аутентификации

Web-клиент в сети без Active Directory

Если в организации не используется Active Directory, администратор должен внести изменения в конфигурацию Web-клиента:

  1. Откройте конфигурационный файл Каталог-установки-Web-клиента\5.5\Site\web.config.

  2. Перейдите к элементу configuration  Docsvision  WebClient  Authentication.

  3. Введите название локального компьютера в значение параметра DefaultDomain.

  4. Сохраните изменения конфигурационного файла.

Подробнее см. "Настройка Web-клиента в сети без Active Directory".

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

  1. Настройте Service Principal Names для учетной записи пула приложений Web-клиента. Для этого от имени администратора домена выполните команды:

    Setspn /s HTTP/webc company\webuser (1) (2)
Setspn /s HTTP/webc.company.com company\webuser (3) (2)

    Замените:

    1 webc — имя сервера Web-клиента.
    2 company\webuser — имя учётной записи, под которой работает пул приложений Web-клиента.
    3 webc.company.com — полное сетевое имя сервера Web-клиента.
    Учетная запись пула должна быть доменной учётной записью, входить в группу локальных администраторов на сервере Web-клиента — DocsVision Administrators и в группу Администраторы.

  2. Включите аутентификацию Kerberos в конфигурационном файле Web-клиента:

    1. Откройте конфигурационный файл Каталог-установки-Web-клиента\5.5\Site\web.config в режиме редактирования.

    2. Перейдите к секции configuration  location path="Account/LoginWindows".

    3. Измените секцию следующим образом:

      Пример 5. Включение аутентификации Kerberos
      <location path="Account/LoginWindows">
    <system.web>
      <authorization>
        <deny users="?" />
        <allow users="*" />
      </authorization>
    </system.web>
    <system.webServer>
      <security>
        <authentication>
          <anonymousAuthentication enabled="false" />
          <windowsAuthentication enabled="true" useKernelMode="false" useAppPoolCredentials="true">
            <providers>
              <clear />
              <add value="Negotiate:Kerberos" />
            </providers>
          </windowsAuthentication>
          <basicAuthentication enabled="false" />
        </authentication>
      </security>
    </system.webServer>
</location>

Подробнее см. "Включить аутентификацию Kerberos".

Настройки сессии

Настройки пользовательской сессии

Если в решении использовался метод HttpContext.Current.Session, возникнет ошибка Session = null. В случае появления ошибки можно вернуть значение в конфигурационном файле Web-клиента по адресу Каталог-установки-Web-клиента\5.5\Site\web.config:

sessionState mode="InProc"

Подробнее см. "Особенности работы сессии в Web-клиенте".

Таймаут пользовательской сессии

Администратор может изменить максимальное время ожидания ответа (таймаут) от сервера Docsvision. Время ожидания устанавливается в миллисекундах.

Чтобы изменить таймаут пользовательской сессии:

  1. Откройте конфигурационный файл Каталог-установки-Web-клиента\5.5\Site\web.config.

  2. Перейдите к секции configuration  Docsvision > WebClient > SettingGroups > SettingGroup[Name="System"].

  3. Измените значение параметра ConnectionTimeout.

    Время ожидания задаётся в миллисекундах.
    Пример 6. Время ожидания пользовательской сессии равное 1 часу
    <SettingGroup Name="System">
    <Setting Name="ConnectionTimeout" Value="3600000" />
</SettingGroup>

Подробнее см. "Изменить время ожидания пользовательской сессии".

Очистка пользовательских сессий

Чтобы отключить очистку кэша закрытых сессий:

  1. Откройте конфигурационный файл Каталог-установки-Web-клиента\5.5\Site\web.config.

  2. Перейдите к секции configuration  Docsvision > WebClient > SettingGroups > SettingGroup[Name="WebClient"].

  3. Измените значение параметра DisableClearSession с false на true.

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

Подробнее см. "Настройки очистки данных пользовательских сессий".

Закрытие неактивных сессии

Чтобы изменить стандартные настройки сессии пользователей:

  1. Откройте конфигурационный файл Каталог-установки-Web-клиента\5.5\Site\web.config.

  2. Перейдите к секции configuration  Docsvision > WebClient > SettingGroups > SettingGroup[Name="WebClient"].

  3. Измените значение параметра:

    SessionSuspendTimeout

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

    SessionCloseTimeout

    Время неактивности пользователя в минутах, через которое сессия будет закрыта. Значение по умолчанию — 300 минут.

    SessionInactiveMessageHide

    Отключает показ сообщения "Подключение остановлено в связи с отсутствием активности".

    Значение true Сообщение не отображается, сессия восстанавливается при нажатии курсором мыши в любой области окна Web-клиент;

    Значение false Сообщение отображается, сессия восстанавливается при нажатии курсором мыши на сообщение или в любой области окна Web-клиент (значение по умолчанию).

    Чтобы отключить перевод неактивной сессии в офлайн-режим, установите SessionSuspendTimeout в значение 0.

    Чтобы отключить закрытие неактивных сессий, установите SessionCloseTimeout в значение 0.

Подробнее см. "Автоматически закрывать неактивные сессии пользователей".

Настройки электронной подписи

Чтобы изменить логотип для штампа ЭП:

  1. Откройте конфигурационный файл Каталог-установки-Web-клиента\5.5\Site\web.config.

  2. Перейдите к секции configuration  Docsvision > WebClient > SettingGroups  SettingGroup[Name="DefaultESImageGenerator"].

    По умолчанию данной секции нет — её нужно создать самостоятельно.

  3. Измените значение параметра LogoImagePath, указав путь к PNG файлу нового логотипа (относительно каталога \%WebCinstallDir%\5.5\Site\ или абсолютный).

    <SettingGroup Name="DefaultESImageGenerator">
   <Setting Name="LogoImagePath" Value="Content/logo.png" />
</SettingGroup>

Подробнее см. "Изменить логотип для штампа ЭП".

Включение облачной подписи

Запросы к облачному сервису электронной подписи отправляются через сервер Web-клиента. Это означает, что Web-клиент должен иметь доступ к сервису ЭП для отправки запросов на проверку подписи и для авторизации.

Проверка подлинности подписи может осуществляться локально или через облачный сервис электронной подписи. Способ проверки подписи зависит от настроек в файле конфигурации Web-клиента.

Чтобы изменить способ проверки подлинности подписи:

  1. Откройте файл конфигурации Web-клиента по адресу Каталог-установки-Web-клиента\5.5\Site\web.config.

  2. Найдите следующие настройки:

    <SettingGroup Name="CloudSignature">
    <Setting Name="Address" Value="https://адрес-облачного-сервиса-DSS" /> (1)
    <Setting Name="ClientId" Value="" /> (2)
    <Setting Name="SignServerAppName" Value="" />
    <Setting Name="STSAppName" Value="" />
    <Setting Name="DocumentStoreAppName" Value="" /> (3)
    <Setting Name="VerifyUrl" Value="https://dss.cryptopro.ru/verify/rest/api/signatures" /> (4)
    <Setting Name="TSPServiceAddress" Value="" /> (5)
    <Setting Name="SignatureType" Value="BES" /> (6)
    <Setting Name="AuthorizeRedirectUrl" Value="http://адрес-Web-клиента-Docsvision/api/CryptoProDss/AcceptAuthorization" /> (7)
    <Setting Name="TokenStorageMode" Value="InMemory" /> (8)
</SettingGroup>
    1 Адрес сервиса облачной подписи.
    2 Идентификатор клиента. Настраивается в сервисе облачной подписи КриптоПро.
    3 SignServerAppName, STSAppName и DocumentStoreAppName — имена сайтов в IIS на сервере КриптоПро DSS. Настраиваются при установке сервиса электронной подписи КриптоПро DSS.
    4 URL для проверки подлинности подписи.
    5 Адрес сервиса штампа времени для XLT1.
    6 Тип подписи:

    • BES — будет использоваться CAdES-BES.

    • XLT1 — будет использоваться CAdES-XLT1.

    • T — будет использоваться CAdES-T.
    7 URL, на который будет переадресован пользователь после авторизации в сервисе электронной подписи. Настраивается в сервисе электронной подписи.
    8 Режим хранения токена авторизации.
    Возможные значения:

    • Disabled — авторизация будет запрашиваться каждый раз.

    • InSessionCache — авторизация будет повторно запрошена по окончании сессии.

    • InMemory — авторизация будет запрошена при перезапуске IIS.

    • InUserProfileEncrypted — авторизация будет запрошена по истечении срока действия токена.

Подробнее см. "Настройка компонентов КриптоПро".

Настройки представлений

Интервал обновления агрегации

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

Чтобы настроить автоматическое применение по таймеру:

  1. Откройте файл Каталог-установки-Web-клиента\5.5\Site\web.config.

  2. Измените значение параметра, заданное по умолчанию:

    <SettingGroup Name="Grid">
        <Setting Name="ApplyAggregatesTimeout" Value="1000" /> (1)
        <Setting Name="ApplyAggregatesButton " Value="True" /> (2)
</SettingGroup>
    1 По истечении указанного количества миллисекунд будут автоматически обновлены список карточек и доступные агрегаты.
    2 Флаг определяет, будет ли список карточек обновляться автоматически или перестраиваться по нажатию кнопки Применить.

    Доступные агрегаты обновляются согласно настройке ApplyAggregatesTimeout.

Подробнее см. "Настройки агрегации".

Настройки кэширования

Клиентское кэширование

Чтобы отключить кэширование настроек:

  1. Откройте конфигурационный файл Каталог-установки-Web-клиента\5.5\Site\web.config.

  2. Перейдите к секции configuration  WebClient  SettingGroups  SettingGroup[Name="DirectoryCache"].

  3. Измените на false значение параметра:

    AdvancedLayouts

    Отключает кэширование разметок.

    Folders

    Отключает кэширование настроек папок.

    SearchCard

    Отключает кэширование сохранённых поисковых запросов.

Подробнее см. "Настройки клиентского кэширования".

Время обновления кэша представлений

Чтобы изменить период обновления кэша:

  1. Откройте конфигурационный файл Каталог-установки-Web-клиента\5.5\Site\web.config.

  2. Перейдите к секции configuration  Docsvision > WebClient > SettingGroups > SettingGroup[Name="System"].

  3. Измените значение параметра MinCheckDirectoryTimestampsInterval. Время ожидания задаётся в миллисекундах.

    Пример 7. Интервал обновления кэша представлений

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

    <SettingGroup Name="System">
    <Setting Name="MinCheckDirectoryTimestampsInterval" Value="1000" />
</SettingGroup>

Подробнее см. "Изменить время обновления кэша настроек представлений".

Кэширование разметок фильтров данных

Чтобы отключить кэширование разметок:

  1. Откройте конфигурационный файл Каталог-установки-Web-клиента\5.5\Site\web.config.

  2. Перейдите к секции configuration  Docsvision > WebClient > SettingGroups > SettingGroup[Name="WebClient"].

  3. Установите значение параметра GridFilterCache в false:

    <SettingGroup Name="WebClient">
    <Setting Name="GridFilterCache" Value="false" />
</SettingGroup>

Подробнее см. "Отключить кэширование разметок фильтров данных".

Управление кэшем папок

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

  1. Создайте новую группу в справочнике сотрудников.

  2. Скопируйте RowID группы в утилите DVExplorer.

  3. Добавьте в конфигурационный файл Каталог-установки-Web-клиента\5.5\Site\web.config настройку <Setting Name="DisableUnreadCountersGroup" Value="RowID" />.

  4. Перезапустите IIS.

Подробнее см. "Управление кэшем папок".

Кэширование обращений к объектам

Чтобы настроить период обновления, укажите значения в секундах:
<SettingGroup Name="System">
  <Setting Name="ShortCacheRefreshPeriod" Value="600" /> (1)
  <Setting Name="LongCacheRefreshPeriod" Value="14400" /> (2)
1 Короткий период обновления кэша и данных в разметке профиля пользователя.
2 Длительный период обновления кэша и данных в разметке профиля пользователя.

Для папок используется ShortCacheRefreshPeriod. LongCacheRefreshPeriod — пока не используется.

Подробнее см. "Кэширование обращений к справочникам и карточкам".

Обновление справочников в режиме "только чтение"

Чтобы изменить способ обновления справочников:

  1. Откройте конфигурационный файл Каталог-установки-Web-клиента\5.5\Site\web.config.

  2. Перейдите к секции configuration  Docsvision > WebClient > SettingGroups > SettingGroup[Name="System"].

  3. Измените значение параметра SharedDictionaryRefreshMode. Параметр определяет способ обновления справочников.

    Таблица 2. Возможные значения:

    0

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

    1

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

    2

    Если в одной из сессий данные справочника в режиме только чтение были изменены, обновление будет выполнено сразу после изменения (значение по умолчанию).
    Пример 8. Задать период обновления справочника равный 2 минутам

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

    <Setting Name="SharedDictionaryRefreshMode" Value="0" />
<Setting Name="SharedDictionaryRefreshPeriod" Value="120" />
    Настройки обновления справочников влияют также на обновление разметок. На период разработки разметок рекомендуется установить меньший период обновления.

Подробнее см. "Функциональность "Общие справочники"".

Настройки журналирования

Настройка уровня журналирования

Базовые настройки журналирования представлены в панели управления (Раздел "WebClient"). Расширенные настройки осуществляются в конфигурационном файле Web-клиента.

  1. Откройте конфигурационный файл Каталог-установки-Web-клиента\5.5\Site\web.config.

  2. Перейдите к секции configuration  nlog.

  3. Измените параметры журналирования.

    Измените значение атрибута fileName элемента targets  target  target, чтобы настроить путь для сохранения журнала работы.

    В fileName можно использовать допустимые для Nlog переменные (https://github.com/nlog/NLog/wiki/File-target), например: C:\Logs\${level}\WebClient_${shortdate}.log.

    Измените значение атрибута level элемента rules  logger, например, на trace, чтобы включить протоколирование всех типов событий.

    Допустимые уровни протоколирования приведены на странице https://github.com/nlog/NLog/wiki/Configuration-file#log-levels.

    Для получения дополнительной информации о других настройках NLog обратитесь к документации по данной платформе.

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

Включить журнал событий навигации

Чтобы включить протоколирование:

  1. Откройте конфигурационный файл Каталог-установки-Web-клиента\5.5\Site\web.config.

  2. Перейдите к секции configuration  Docsvision > WebClient > SettingGroups > SettingGroup[Name="WebClient"].

  3. Измените значение параметра EnableRouterLogging на True:

    Пример 9. Включение протоколирования событий навигации

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

    <SettingGroup Name="WebClient">
 <Setting Name="EnableRouterLogging" Value="True" />
</SettingGroup>

Подробнее см. "Включить журнал событий навигации".

Настройки аналитических счётчиков

Активация счетчиков производительности

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

Чтобы включить счетчики:

  1. Откройте конфигурационный файл Каталог-установки-Web-клиента\5.5\Site\web.config.

  2. Перейдите к секции configuration  Docsvision > WebClient > SettingGroups > SettingGroup[Name="WebClient"].

  3. Измените значение параметра EnablePerformanceCounters на True :

    Пример 10. Включение счетчиков производительности

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

    <SettingGroup Name="WebClient">
 <Setting Name="EnablePerformanceCounters" Value="True" />
</SettingGroup>

Подробнее см. "Включить счетчики производительности".

Проверка счётчиков производительности

Параметры:

  • UnreadCountersHealthCheckInterval

  • UnreadCountersMonitoringSettings

  • UnreadCountersMonitoring

  • WarnTimeout

  • AlertTimeout

  • AutoDiagnosticLogTime

  • AutoDiagnosticLogEnableMinInterval

Подробнее см. "Система отслеживания работоспособности счётчиков".

Прочие настройки

Настройка отпечатка сертификата кластера Web-клиент

Пример 11. Отпечаток сертификата в конфигурационном файле web.config
<?xml version="1.0" encoding="UTF-8"?>
<configuration>
 <microsoft.identityModel>
  <service>
   <serviceCertificate>
    <certificateReference x509FindType="FindByThumbprint" findValue="B4369FA8D1B0A1B502CB916509317E9C6077CC69" />(1)
   </serviceCertificate>
  </service>
 </microsoft.identityModel>
</configuration>
1 Отпечаток сертификата

Подробнее см. "Особенности настройки кластера Web-клиент".

Определение типа клиентского устройства

Пользовательский интерфейс Web-клиента адаптируется под тип клиентского устройства, который определяется по User Agent, передаваемому веб-браузером клиента. Если User Agent не сопоставляется или некорректно сопоставляется с типом устройства, нужно изменить шаблон, по которому выполняется сопоставление:

  1. Откройте конфигурационный файл Каталог-установки-Web-клиента\5.5\Site\web.config.

  2. Перейдите к элементу configuration  Docsvision  WebClient  SettingGroups  SettingGroup [Name="WebClient"].

  3. Измените значение параметра:

    MobileRegExpString

    Шаблон определения мобильных устройств нового поколения.

    MobileRegExpPart2String

    Шаблон определения старых мобильных устройств.

    TabletRegExpString

    Шаблон определения планшетов.

    В значении параметра через символ | нужно указать User Agent соответствующего устройства.

    Пример 12. Определять устройство с User Agent NEWPAD как планшет
    <Setting Name="TabletRegExpString" Value=" … |SM-T355|MediaPad|NEWPAD" />

Подробнее см. "Шаблоны для определения типа клиентского устройства".

Предпросмотр с помощью Р7-Офис/OnlyOffice

"Р7-Офис. Сервер документов"/OnlyOffice расширяет стандартную функциональность, позволяя отображать документ напрямую и копировать данные непосредственно из файла.

Секция "configuration  Docsvision > WebClient > SettingGroups > SettingGroup[Name="WebClient"]":

  • <Setting Name="ServerR7ConnectionAddress" Value="http://domain.company.com:8083" /> — url сервера документов Р7-Офис/OnlyOffice. Настройка обязательна для заполнения. Если url сервера документов Р7 не указан, вторая настройка будет проигнорирована и будет использоваться стандартный инструмент предварительного просмотра pdf.js.

  • <Setting Name="FilePreviewMode" Value="1" /> — определяет, какой компонент используется для предпросмотра. Значения: 0 — стандартный pdf.js, 1 — новый Р7.

Подробнее см. "Включить предпросмотр файлов при помощи Р7-Офис/OnlyOffice".