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

Конфигурация модуля может выполняться при помощи конфигурационного файла Web-клиента, расположенного по адресу /usr/lib/docsvision/webclient/appsettings.json в Linux и C:\Program Files\Docsvision\WebClient\appsettings.json в Windows, однако следует помнить, что настройки конфигурационного файла не сохраняются при обновлении версии Web-клиента.

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

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

Рекомендуемый способ конфигурации Web-клиента — при помощи Консоли управления Docsvision, дополнительные сведения приведены в разделах соответствующих параметров по ссылкам.

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

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

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

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

  1. Откройте конфигурационный файл /usr/lib/docsvision/webclient/appsettings.json в Linux и C:\Program Files\Docsvision\WebClient\appsettings.json в Windows.

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

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

    Web-клиент поддерживает работу только с карточками, созданными на основе Базовых объектов. 
    {
  "Docsvision": {
    "WebClient": {
      "CardTypes": [
        {
          "CardTypeId": "b9f7bfd7-7429-455e-a3f1-94ffb569c794", (1)
          "CssClass": "document", (2)
          "SaveInFolder": "true" (3)
        },
        {
          "CardTypeId": "c7b36f33-cdd4-4da9-8444-600fe14111e4",
          "CssClass": "task",
          "SaveInFolder": "true"
        }
      ]
    }
  }
}
    1 "CardTypeId": "GUID-идентификатор типа карточки".
    Чтобы изменить порядок кнопок создания типов карточек, измените порядок следования GUID-идентификаторов (CardTypeId) в CardTypes.
    2 Чтобы изменить цвет строки типа карточки в меню создания карточек, добавьте в элемент CardType параметр CssClass с названием класса CSS в значении.
    3 Чтобы новые карточки выбранного типа сохранялись в текущей открытой папке, добавьте в элемент CardType параметр SaveInFolder со значением true.
    Если SaveInFolder имеет значение false (или отсутствует), ярлыки карточек не будут добавляться в текущую папку.
Подробнее см.:

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

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

  1. Откройте конфигурационный файл /usr/lib/docsvision/webclient/appsettings.json в Linux и C:\Program Files\Docsvision\WebClient\appsettings.json в Windows.

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

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

    {
  "Docsvision": {
    "WebClient": {
      "CardTypes": [
        {
          "CardTypeId": "b9f7bfd7-7429-455e-a3f1-94ffb569c794", (1)
          "CssClass": "document",
          "SaveInFolder": "true"
        },
        {
          "CardTypeId": "c7b36f33-cdd4-4da9-8444-600fe14111e4", (2)
          "CssClass": "task",
          "SaveInFolder": "true"
        },
        {
          "CardTypeId": "c7b36f33-cdd4-4da9-8444-600fe14111e4", (3)
          "CssClass": "task",
          "SaveInFolder": "true",
          "DisableCreateFlags": "0" (4)
        }
      ]
    }
  }
}
    1 Документ.
    2 Задание.
    3 Группа заданий.
    4 Создайте или измените параметр DisableCreateFlags в элементе нужного типа карточек.
    Значение параметра DisableCreateFlags является суммой цифр, каждая из которых определяет один из вариантов скрытия типа карточки:

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

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

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

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

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

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

  1. Откройте конфигурационный файл /usr/lib/docsvision/webclient/appsettings.json в Linux и C:\Program Files\Docsvision\WebClient\appsettings.json в Windows.

  2. Перейдите к секции "Docsvision"  "WebClient" > "SettingGroups" > "WebClient".

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

    Удалённые карточки будут помещаться в корзину, папки будут удаляться временно
    {
  "Docsvision": {
    "WebClient": {
      "SettingGroups": {
        "WebClient": {
          "DeletePermanently": "false" (1)
        }
      }
    }
  }
}
    1 Возможные значения:

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

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

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

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

  1. Откройте конфигурационный файл /usr/lib/docsvision/webclient/appsettings.json в Linux и C:\Program Files\Docsvision\WebClient\appsettings.json в Windows.

  2. Перейдите к секции "Docsvision"  "WebClient" > "SettingGroups" > "WebClient".

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

    Список разрешённых файлов и добавление .dwg в допустимые расширения:
    {
  "Docsvision": {
    "WebClient": {
      "SettingGroups": {
        "WebClient": {
          "AcceptableFileExtensions": "(\\b)(rtf|dot|doc|dotx|ods|docx|odt|csv|xlt|xls|xltx|xlsx|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|dwg)$"
        }
      }
    }
  }
}
    Обратите внимание, двойной обратный слэш необходим для экранирования, если указывается значение в конфигурационном файле Web-клиента. При указании значения в Консоли управления Docsvision используется одиночный обратный слэш.
Подробнее см.:

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

  1. Чтобы изменить ограничение для максимального размера единичного файла, в конфигурационном файле /usr/lib/docsvision/webclient/appsettings.json в Linux и C:\Program Files\Docsvision\WebClient\appsettings.json в Windows перейдите к параметру "Docsvision"  "WebClient"  View  MaxUploadFileItemSize".

    {
  "Docsvision": {
    "SettingGroups": {
      "WebClient": {
        "View": {
          "MaxUploadFileItemSize": "0" (1)
        },
      },
    },
  },
}
    1 Укажите новое ограничение для максимального размера единичного файла в байтах, не превышающее 2147483647.
Подробнее см.:

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

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

  1. Откройте конифгурационный файл Web-клиента: /usr/lib/docsvision/webclient/appsettings.json в Linux и C:\Program Files\Docsvision\WebClient\appsettings.json в Windows.

  2. В категории настроек "Docsvision"  "WebClient" > "SettingGroups" > "WebClient" измените параметр MaxPreviewFileSize.

    {
  "Docsvision": {
    "WebClient": {
      "SettingGroups": {
        "WebClient": {
          "MaxPreviewFileSize": "0" (1)
        }
      }
    }
  }
}
    1 Укажите значение в байтах.
    Увеличение значения повысит нагрузку на сервер и время открытия файла на предпросмотр.
Подробнее см.:

Открытие файлов на редактирование

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

  1. Откройте конфигурационный файл Web-клиента по адресу /usr/lib/docsvision/webclient/appsettings.json в Linux и C:\Program Files\Docsvision\WebClient\appsettings.json в Windows.

  2. В параметре "Docsvision"  "WebClient" > "SettingGroups" > "WebClient"  "AcceptableFileExtensionsForEditing" измените список доступных файлов. Новые расширения файлов нужно добавлять через символ | в виде регулярного выражения:

    {
  "Docsvision": {
    "WebClient": {
      "SettingGroups": {
        "WebClient": {
          "AcceptableFileExtensionsForEditing": "(\\b)(doc|docx|docm|xls|xlsx|xlsm|ppt|pptx|odt|ods|xodt|xods|xodp)$" (1)
        }
      }
    }
  }
}
    1 Перечислите поддерживаемые форматы в значении параметра.
    Обратите внимание, двойной обратный слэш необходим для экранирования, если указывается значение в конфигурационном файле Web-клиента. При указании значения в Консоли управления Docsvision используется одиночный обратный слэш.

  3. Если параметр "AcceptableFileExtensionsForEditing" не указан, по умолчанию на редактирование открываются только файлы форматов .doc, .docx, .docm, .xls, .xlsx, .xlsm, .ppt, .pptx, .odt и .ods.

Подробнее см.:

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

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

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

  1. Откройте конфигурационный файл /usr/lib/docsvision/webclient/appsettings.json в Linux и C:\Program Files\Docsvision\WebClient\appsettings.json в Windows.

  2. Перейдите к секции "Docsvision"  "WebClient" > "SettingGroups" > "WebClient".

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

    Включение режима "Отмена/ОК"
    {
  "Docsvision": {
    "WebClient": {
      "SettingGroups": {
        "WebClient": {
          "DefaultButtonPosition": "Auto" (1)
        }
      }
    }
  }
}
    1 Возможные значения:

    • Auto — значение по умолчанию — порядок отображения кнопок определяется типом ОС пользователя.
      Для ОС MacOS: Отмена/OK.
      Для ОС Windows, Linux, Android и др. — ОК/Отмена

    • OkCancel — ОК/Отмена

    • CancelOk — Отмена/ОК
Подробнее см.:

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

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

  1. Откройте конфигурационный файл /usr/lib/docsvision/webclient/appsettings.json в Linux и C:\Program Files\Docsvision\WebClient\appsettings.json в Windows.

  2. Перейдите к секции "Docsvision"  "WebClient" > "SettingGroups" > "WebClient".

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

    {
  "Docsvision": {
    "WebClient": {
      "SettingGroups": {
        "WebClient": {
          "UXMainMenuBehavior": "0" (1)
        }
      }
    }
  }
}
    1 Возможные значения:

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

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

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

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

  1. Откройте конфигурационный файл /usr/lib/docsvision/webclient/appsettings.json в Linux и C:\Program Files\Docsvision\WebClient\appsettings.json в Windows.

  2. Перейдите к секции "Docsvision"  "WebClient" > "SettingGroups" > "WebClient".

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

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

    {
  "Docsvision": {
    "WebClient": {
      "SettingGroups": {
        "WebClient": {
          "HideSidebarOnPageClick": "True" (1)
        }
      }
    }
  }
}
    1 Возможные значения:

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

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

Настройки инструментов

Поведение DVWebtool

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

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

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

Подробнее см.:

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

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

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

  1. Откройте конфигурационный файл /usr/lib/docsvision/webclient/appsettings.json в Linux и C:\Program Files\Docsvision\WebClient\appsettings.json в Windows.

  2. Перейдите к секции "Docsvision"  "WebClient" > "SettingGroups"  System.

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

    {
  "Docsvision": {
    "WebClient": {
      "SettingGroups": {
        "System": {
          "WebServicesPort": 5413 (1)
        }
      }
    }
  }
}
    1 Порт подключения к утилите DVWebTool, значение в диапазоне от 1 до 65535.
Подробнее см.:

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

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

В конфигурационном файле Web-клиента укажите следующие параметры:

{
  "SystemUserAccount": "account@domain.com", (1)
  "SystemUserPassword": "password", (2)
  "Docsvision": {
    "WebClient": {
      "Server": {
        "SessionManagerConnection": {
          "ConnectionAddress": "http://dvserver.domain.com:5000", (3)
          "BaseName": "alias" (4)
        }
      }
    }
  }
}
1 Учётная запись из каталога ALD Pro для подключения к серверу Docsvision.
2 Пароль УЗ из каталога ALD Pro для подключения к серверу Docsvision.
3 Адрес сервера Docsvision.
4 Псевдоним БД, от имени которой будет запускаться программа Панель управления Web-клиентом.

Использовать капчу

Администратор настраивает количество неудачных попыток ввода пароля, после которых срабатывает капча, а также время до сброса счётчика неудачных попыток.

Обратите внимание, капча срабатывает только если сервер Web-клиент работает по HTTPS, см. "Настроить работу Web-клиента по HTTPS".

  "Docsvision": {
    "WebClient": {
        "SettingGroups": {
          "WebClient": {
            "MaxFailedLoginAttempts": 3, (1)
            "FailedLoginAttemptsTTL":  300 (2)
          },
        }
    },
  }
1 Количество неудачных попыток ввода пароля.
2 Время в секундах, после которого счётчик неудачных попыток будет сброшен.

Неудачные попытки входа и срабатывания капчи попадают в журнал Web-клиента. Попытки входа будут записаны в журнал при уровне журналирования как Error и серьёзнее, срабатывания капчи будут записаны в журнал при уровне Warn и серьёзнее.

Подробнее см.:

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

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

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

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

  1. Откройте конфигурационный файл /usr/lib/docsvision/webclient/appsettings.json в Linux и C:\Program Files\Docsvision\WebClient\appsettings.json в Windows.

  2. Перейдите к секции "Docsvision"  "WebClient" > "SettingGroups"  System.

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

    {
  "Docsvision": {
    "WebClient": {
      "SettingGroups": {
        "System": {
          "ConnectionTimeout": 3600000 (1)
        }
      }
    }
  }
}
    1 Время ожидания пользовательской сессии равное 1 часу. Значение задаётся в секундах.
Подробнее см.:

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

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

  1. Откройте конфигурационный файл /usr/lib/docsvision/webclient/appsettings.json в Linux и C:\Program Files\Docsvision\WebClient\appsettings.json в Windows.

  2. Перейдите к секции menu:"Docsvision"["WebClient" > "SettingGroups" > "WebClient".

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

    {
  "Docsvision": {
    "WebClient": {
      "SettingGroups": {
        "WebClient": {
          "SessionSuspendTimeout": 10, (1)
          "SessionCloseTimeout": 300, (2)
          "SessionInactiveMessageHide": true (3)
        }
      }
    }
  }
}
    1 SessionSuspendTimeout — время неактивности пользователя в минутах, через которое сессия будет переведена в офлайн-режим. Значение по умолчанию — 10 минут.
    2 SessionCloseTimeout — время неактивности пользователя в минутах, через которое сессия будет закрыта. Значение по умолчанию — 300 минут.
    3 SessionInactiveMessageHide — отключает показ сообщения "Подключение остановлено в связи с отсутствием активности".

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

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

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

    Сервер Web-клиента проверяет неактивность пользователей через промежуток времени SessionSuspendTimeout * 0.5, поэтому перевод пользовательской сессии в офлайн-режим может быть выполнен в промежутке времени до SessionSuspendTimeout * 1.5.

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

Подробнее см.:

Время жизни пользовательских cookie

{
  "Docsvision": {
    "WebClient": {
      "SettingGroups": {
        "WebClient": {
          "AuthCookieLifetime": 120, (1)
          "MobileAuthCookieLifetime": 120 (2)
        }
      }
    }
  }
}
1 AuthCookieLifetime — период действия пользовательской сессии.
2 MobileAuthCookieLifetime — период действия пользовательской сессии на мобильных устройствах.
Подробнее см.:

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

Чтобы изменить логотип для штампа ЭП из конфигурационного файла:

  1. Откройте конфигурационный файл /usr/lib/docsvision/webclient/appsettings.json в Linux и C:\Program Files\Docsvision\WebClient\appsettings.json в Windows.

  2. Перейдите к секции "Docsvision"  "WebClient" > "SettingGroups"  "DefaultESImageGenerator".

  3. Измените значение параметра LogoImagePath, указав путь к PNG файлу нового логотипа (относительно каталога /lib/docsvision/webclient/ или абсолютный).

    {
  "Docsvision": {
    "WebClient": {
      "SettingGroups": {
        "DefaultESImageGenerator": {
          "LogoImagePath": "Content/logo.png"
        }
      }
    }
  }
}
Подробнее см.:

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

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

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

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

  1. Откройте файл конфигурации Web-клиента по адресу /usr/lib/docsvision/webclient/appsettings.json в Linux и C:\Program Files\Docsvision\WebClient\appsettings.json в Windows.

  2. Перейдите к параметру menu:"Docsvision"["WebClient" > "SettingGroups" и выполните следующие настройки:

    {
  "Docsvision": {
    "WebClient": {
      "SettingGroups": {
        "CloudSignature": {
          "Address": "https://адрес-облачного-сервиса-DSS", (1)
          "ClientId": null, (2)
          "SignServerAppName": null, (3)
          "STSAppName": null, (4)
          "DocumentStoreAppName": null, (5)
          "VerifyUrl": "https://dss.cryptopro.ru/verify/rest/api/signatures", (6)
          "TSPServiceAddress": null, (7)
          "SignatureType": "BES", (8)
          "AuthorizeRedirectUrl": "http://адрес-Web-клиента-Docsvision/api/CryptoProDss/AcceptAuthorization", (9)
          "TokenStorageMode": "InMemory" (10)
        }
      }
    }
  }
}
    1 Адрес сервиса облачной подписи.
    2 Идентификатор клиента. Настраивается в сервисе облачной подписи КриптоПро.
    3 Сервис подписи, обрабатывающий создание транзакций и получение результатов, подтвержденной операции.
    4 Сервис аутентификации, ответственный за аутентификацию пользователей для возможности обращений к сервису подписи и подтверждение транзакций.
    5 SignServerAppName, STSAppName и DocumentStoreAppName — имена сайтов на сервере КриптоПро DSS. Настраиваются при установке сервиса электронной подписи КриптоПро DSS.
    6 URL для проверки подлинности подписи.
    7 Адрес сервиса штампа времени для XLT1.
    8 Тип подписи:

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

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

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

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

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

    • InMemory — авторизация будет запрошена при перезапуске службы Сервера Web-клиента.

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

Скачивание файла в браузер

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

  1. Откройте конфигурационный файл, расположенный по адресу /usr/lib/docsvision/webclient/appsettings.json в Linux и C:\Program Files\Docsvision\WebClient\appsettings.json в Windows.

  2. Перейдите к разделу "Docsvision"  "WebClient" > "SettingGroups" > "WebClient".

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

    {
  "Docsvision": {
    "WebClient": {
      "SettingGroups": {
        "WebClient": {
          "CalculateSignatureHashOnServer": true (1)
        }
      }
    }
  }
}
    1 true — скачивается только хэш подписываемого файла (значение по умолчанию), false — будет скачиваться полностью подписываемый файл (устаревшее поведение).

    • Если алгоритм подписания не поддерживается, действует стандартная логика подписания со скачиванием файла в браузер.

    • В данный момент подписание без скачивания файла не действует с облачной подписью.

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

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

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

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

  1. Откройте файл /usr/lib/docsvision/webclient/appsettings.json в Linux и C:\Program Files\Docsvision\WebClient\appsettings.json в Windows.

  2. В секции "Docsvision"  "WebClient" > "SettingGroups" > "WebClient" измените значение параметра Grid:

    {
  "Docsvision": {
    "WebClient": {
      "SettingGroups": {
        "WebClient": {
          "Grid": {
          "ApplyAggregatesTimeout": "1000", (1)
          "ApplyAggregatesButton": "True" (2)
        }
      }
    }
  }
}
    1 По истечении указанного количества миллисекунд будет автоматически обновлён список карточек и доступные агрегаты.
    2 Флаг определяет, будет ли список карточек обновляться автоматически или перестраиваться по нажатию кнопки Применить.
    Доступные агрегаты обновляются согласно настройке ApplyAggregatesTimeout.
Подробнее см.:

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

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

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

  1. Откройте конфигурационный файл /usr/lib/docsvision/webclient/appsettings.json в Linux и C:\Program Files\Docsvision\WebClient\appsettings.json в Windows.

  2. Перейдите к секции "Docsvision"  "WebClient" > "SettingGroups"  "DirectoryCache".

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

    {
  "Docsvision": {
    "WebClient": {
      "SettingGroups": {
        "DirectoryCache": {
          "AdvancedLayouts": "False", (1)
          "Folders": "True", (2)
          "SearchCard": "True" (3)
        }
      }
    }
  }
}
    1 AdvancedLayouts — отключает кэширование разметок.
    2 Folders — отключает кэширование настроек папок.
    3 SearchCard — отключает кэширование сохранённых поисковых запросов.

    Параметр AdvancedLayouts не используется, рекомендуется использовать актуальную настройку SharedDictionaryRefreshPeriod, см. подробнее в разделе "Функциональность "Общие справочники"".

    Параметр Folders является дублирующим для параметра ShortCacheRefreshPeriod, см. подробнее в разделе "Кэширование обращений к справочникам и карточкам".
Подробнее см.:

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

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

  1. Откройте конфигурационный файл /usr/lib/docsvision/webclient/appsettings.json в Linux и C:\Program Files\Docsvision\WebClient\appsettings.json в Windows.

  2. Перейдите к секции "Docsvision"  "WebClient" > "SettingGroups"  System.

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

    {
  "Docsvision": {
    "WebClient": {
      "SettingGroups": {
        "System": {
          "MinCheckDirectoryTimestampsInterval": "1000" (1)
        }
      }
    }
  }
}
    1 Время ожидания задаётся в миллисекундах.
Подробнее см.:

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

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

  1. Откройте конфигурационный файл /usr/lib/docsvision/webclient/appsettings.json в Linux и C:\Program Files\Docsvision\WebClient\appsettings.json в Windows.

  2. Перейдите к секции "Docsvision"  "WebClient" > "SettingGroups" > "WebClient".

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

    {
  "Docsvision": {
    "WebClient": {
      "SettingGroups": {
        "WebClient": {
          "GridFilterCache": "False" (1)
        }
      }
    }
  }
}
    1 Возможные значения:

    • False — кэширование разметок фильтров будет отключено.

    • True — значение по умолчанию, кэширование включено.
Подробнее см.:

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

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

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

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

  3. Добавьте в конфигурационный файл /usr/lib/docsvision/webclient/appsettings.json в Linux и C:\Program Files\Docsvision\WebClient\appsettings.json в Windows настройку DisableUnreadCountersGroup:

    {
  "Docsvision": {
    "WebClient": {
      "SettingGroups": {
        "WebClient": {
          "DisableUnreadCountersGroup": "RowID" (1)
        }
      }
    }
  }
}
    1 RowID группы, скопированный в утилите DVExplorer.

  4. Перезапустите dvwebclient для Linux и Docsvision Web-client для Windows.

Подробнее см.:

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

Чтобы настроить период обновления из конфигурационного файла, укажите значения в секундах:
{
  "Docsvision": {
    "WebClient": {
      "SettingGroups": {
        "System": {
          "ShortCacheRefreshPeriod": "600", (1)
          "LongCacheRefreshPeriod": "14400" (2)
        }
      }
    }
  }
}
1 Короткий период обновления кэша и данных в разметке профиля пользователя.
2 Длительный период обновления кэша и данных в разметке профиля пользователя.
Настройка ShortCacheRefreshPeriod используется для:

  • Карточки папок

  • Справочника видов

  • Конструктора справочников

  • Справочника сотрудников

  • Справочника контрагентов

  • Справочника категорий

Настройка LongCacheRefreshPeriod используется для:

  • Всего остального, включая справочник разметок

Подробнее см.:

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

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

  1. Откройте конфигурационный файл /usr/lib/docsvision/webclient/appsettings.json в Linux и C:\Program Files\Docsvision\WebClient\appsettings.json в Windows.

  2. Перейдите к секции "Docsvision"  "WebClient" > "SettingGroups"  "System".

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

    {
  "Docsvision": {
    "WebClient": {
      "SettingGroups": {
        "System": {
          "SharedDictionaryRefreshMode": "0", (1)
          "SharedDictionaryRefreshPeriod": "120" (2)
        }
      }
    }
  }
}
    1 .Возможные значения:

    • 0 — обновление выполняется с интервалом, указанным в параметре SharedDictionaryRefreshPeriod.

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

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

  4. Настройки обновления справочников влияют также на обновление разметок. На период разработки разметок рекомендуется установить меньший период обновления, а также уменьшить значения параметров ShortCacheRefreshPeriod и LongCacheRefreshPeriod, см. подробнее "Кэширование обращений к справочникам и карточкам".

Подробнее см.:

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

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

  1. Откройте конфигурационный файл /usr/lib/docsvision/webclient/appsettings.json в Linux и C:\Program Files\Docsvision\WebClient\appsettings.json в Windows.

  2. Измените параметры журналирования в параметрах targets и rules.

    {
 "NLog": {
     "throwConfigExceptions": false,
     "extensions": [
         { "assembly": "NLog.Extensions.Logging" },
         { "assembly": "NLog.Web.AspNetCore" }
     ],
     "targets": {
         "async": true,
         "logFile": {
             "type": "File",
             "fileName": "${basedir}/../Logs/WebClient${event-properties:item=Tenant} PID ${processId} ${shortdate}.log", (1)
             "layout": "[${longdate}][${level}][${callsite}] ${message} ${onexception:${newline}${exception:maxInnerExceptionLevel=10:format=shortType,message,stacktrace:separator=*:innerExceptionSeparator=
	}}"
         },
         "logConsole": {
             "type": "Console"
         }
     },
     "rules": [ (2)
         {
             "logger": "Microsoft.*",
             "maxLevel": "Info",
             "final": true
         },
         {
             "logger": "*",
             "minLevel": "Error",
             "writeTo": "logFile" (3)
         },
         {
             "logger": "*",
             "minLevel": "Trace",
             "writeTo": "logConsole" (4)
         }
     ]
 }
}
    1 Измените значение параметра fileName, чтобы настроить путь для сохранения журнала работы:
    В fileName можно использовать допустимые для NLog переменные, например: \Logs\${level}\WebClient_${shortdate}.log.
    2 Измените значение параметров minLevel и maxLevel, например, на trace, чтобы включить протоколирование всех типов событий.
    Допустимые уровни протоколирования приведены на странице NLog в GitHub.
    Для получения дополнительной информации о других настройках NLog обратитесь к документации по данной платформе.
    3 Настройки журнала Web-клиента.
    4 Настройки журнала Панель управления Web-клиентом.
Подробнее см.:

  • Настройки не вынесены в Консоль управления Docsvision и выполняются только через конфигурационный файл — "Настройка журналирования".

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

Чтобы включить протоколирование из конфигурационного файла:

  1. Откройте конфигурационный файл /usr/lib/docsvision/webclient/appsettings.json в Linux и C:\Program Files\Docsvision\WebClient\appsettings.json в Windows.

  2. Перейдите к секции menu:"Docsvision"["WebClient" > "SettingGroups" > "WebClient".

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

    Включение протоколирования событий навигации
    {
  "Docsvision": {
    "WebClient": {
      "SettingGroups": {
        "WebClient": {
          "EnableRouterLogging": "True" (1)
        }
      }
    }
  }
}
    1 Возможные значения:

    • True — протоколирование событий навигации включено.

    • False — значение по умолчанию, протоколирование событий навигации отключено.
Подробнее см.:

Включить протоколирование запросов сервера Web-клиента

Протоколирование запросов сервера Web-клиента настраивается в конфигурационном файле модуля по адресу /usr/lib/docsvision/webclient/appsettings.json в Linux и C:\Program Files\Docsvision\WebClient\appsettings.json в Windows, за настройку отвечает параметр W3CLogging:

{
"W3CLogging": {
	"IsEnabled": true, (1)
	"LogDirectory": "/var/log/docsvision/webclient/", (2)
	"LoggingFields": "Date,Time,ServerName,Method,UriStem,UriQuery,ProtocolStatus,TimeTaken,ProtocolVersion,Host,UserAgent,Referer,ConnectionInfoFields", (3)
	"FileSizeLimit": 10485760, (4)
	"RetainedFileCountLimit": 4, (5)
	"FileName": "webclient-w3c-" (6)
}
}
1 Включение/отключение протоколирования событий. Значение по умолчанию: false, в стандартной конфигурации остальные настройки отсутствуют.
2 Путь к журналу.
3 Журналируемые поля. По умолчанию указываются запросы, ответы, заголовки, дата/время (записывается в формате UTC) и имя сервера. Со всеми допустимыми значениями можно ознакомиться в документации Microsoft.
4 Максимальный размер файла журнала, после которого будет создаваться новый. Значение в байтах, по умолчанию 10485760 байт (10 Мб). Цифра 0 означает отсутствие ограничения по размеру.
5 Количество сохраняемых файлов журнала. Допустимые значения от 1 до 10000, по умолчанию используется 4.
6 Префикс имени файла журнала.

Запросы будут записаны в файл /var/log/docsvision/webclient/webclient-w3c-{YYYYMMDD.X}.txt. Настройка альтернативного расширения поддерживается только при протоколировании с NLog, см. подробнее ниже.

Не удаляйте папку /var/log/docsvision/ после установки Web-клиента, т.к. у службы Сервера Web-клиента отсутствуют права на создание новой папки.
Подробнее см.:

Протоколирование запросов с помощью NLog

Чтобы активировать протоколирование запросов с помощью NLog, измените параметры журналирования в параметре: NLog  targets:
{
"NLog": {
   "extensions": [
    { "assembly": "DocsVision.WebClient" } (1)
   ],
   "targets": {
    "w3cFile": {
      "type": "File",
      "fileName": "${gdc:baseLogFolder}/docsvision/webclient/webclient-w3c-${date:format=yyyyMMdd}.${processId}.log",
      "layout": {
        "type": "W3CLoggingLayout",
        "columns": [ (2)
		{ "column": "date" },
		{ "column": "time", "layout": "${longdate}" }, (3)
		{ "column": "c-ip" },
	    ]
      }
    }
   },
   "rules": [
    {
      "logger": "*",
      "minLevel": "Debug",
      "writeTo": "w3cFile"
    }
   ]
}
}
1 Обязательный параметр, если он не указан, NLog не будет записывать обычные сообщения в журнал.
2 Секция задаёт собственный набор колонок. Если список колонок не указан, в журнал будут включены только колонки по умолчанию date, time, c-ip, s-ip, cs-username, s-computername, cs-method, cs-uri-stem, cs-uri-query, sc-statuscode, sc-bytes, cs-bytes, time-taken, cs-host, cs(User-Agent).
3 Формат представления данных колонки может быть изменён. Если формат не указан, будут использоваться значения по умолчанию. В layout можно использовать любые переменные NLog, подробнее см. в документации NLog.

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

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

  1. Если Web-клиент использует HTTPS, создайте сертификат с помощью OpenSSL. Пример использования утилиты приведён в разделе администрирования модуля Консоль управления Docsvision: "Создание доверенного сертификата для подключения к БД".

  2. Установите и настройте Web-клиент на втором компьютере кластера (далее — УЗЕЛ 2).

    Экземпляр Web-клиента, установленный на втором и последующих узлах кластера, должен быть настроен на работу с теми же сервером и базой данных Docsvision, что и УЗЕЛ 1.

  3. В конфигурационном файле /usr/lib/docsvision/webclient/appsettings.json в Linux и C:\Program Files\Docsvision\WebClient\appsettings.json в Windows на УЗЛЕ 1 укажите путь к полученному сертификату в элементе "Https": ("Http":, если используется незащищённое соединение). Фрагмент конфигурационного файла приведён ниже:

    {
"Https": {
  "Url": "https://*:5005",
  "Certificate": {
    "Path": "/home/user/certificate.pfx", (1)
    "Password": "password" (2)
    }
  }
}
    1 Путь к сертификату
    2 Пароль от сертификата

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

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

  4. Сгенерируйте сертификат на втором узле.

  5. Откройте конфигурационный файл /usr/lib/docsvision/webclient/appsettings.json в Linux и C:\Program Files\Docsvision\WebClient\appsettings.json в Windows на УЗЛЕ 2 и укажите путь к полученному сертификату.

  6. Повторите шаги инструкции для третьего и последующих узлов кластера Web-клиента.

Подробнее см.:

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

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

  1. Откройте конфигурационный файл /usr/lib/docsvision/webclient/appsettings.json в Linux и C:\Program Files\Docsvision\WebClient\appsettings.json в Windows.

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

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

    Определять устройство с User Agent "NEWPAD" как планшет:
    {
  "Docsvision": {
    "WebClient": {
      "SettingGroups": {
        "WebClient": {
          "TabletRegExpString": "SM-T355|MediaPad|NEWPAD" (1)
        }
      }
    }
  }
}
    1 В значении параметра через символ | нужно указать User Agent соответствующего устройства.

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

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

    • TabletRegExpString — шаблон определения планшетов.
Подробнее см.:

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

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

  1. Откройте конфигурационный файл Web-клиента по адресу /usr/lib/docsvision/webclient/appsettings.json в Linux и C:\Program Files\Docsvision\WebClient\appsettings.json в Windows в любом текстовом редакторе и отредактируйте следующие параметры:

    {
  "Kestrel": {
    "Endpoints": {
      "Http": {
        "Url": "https://*:5004", (1)
        "Certificate": {
        "Path": "/path/to/your.crt", (2)
        "KeyPath": "/path/to/your.key" (3)
      }
    }
  }
}
    1 Адрес, по которому будет доступен Web-клиент.
    2 Путь к сертификату.
    3 Путь к закрытому ключу сертификата.

  2. Следующим шагом в том же конфигурационном файле необходимо указать адрес сервера документов Р7 и определить режим предварительного просмотра:

    Для корректной работы предварительного просмотра убедитесь, что URL сервера документов Р7-Офис/OnlyOffice доступен с клиентских рабочих мест. 
    {
  "Docsvision": {
    "WebClient": {
      "SettingGroups": {
        "WebClient": {
          "ServerR7ConnectionAddress": "https://dvserver.preview.com", (1)
          "ServerR7UploadDirectory": "/tmp/upload", (2)
          "FilePreviewMode": "2", (3)
        }
      }
    }
  }
}
    1 ServerR7ConnectionAddress — URL сервера документов Р7-Офис/OnlyOffice. Настройка обязательна для заполнения. Если URL сервера документов Р7 не указан, остальные настройки будет проигнорированы.
    2 ServerR7UploadDirectory — каталог загрузки консолидируемых файлов.
    3 FilePreviewMode — определяет, какой компонент используется для предпросмотра. Значения: 0 — предпросмотр отключен, 2 — предпросмотр с помощью Р7.
Подробнее см.: