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

Настройки в Constance

Constance — хранилище настроек аккаунта Webim в базе данных. Здесь заданы ограничения, тайм-ауты, правила распределения диалогов, параметры каналов и интеграций и другие настройки, которые действуют для всего аккаунта.

Изменения применяются без перезапуска сервера: новое значение начинает действовать во всех процессах Webim в течение 30 секунд.

Кто может менять настройки

Большую часть настроек администратор аккаунта меняет в Панели управления Webim (Agent Frontend по URL https://<account domain>/agent/): «Настройки» → «Общие». Для таких настроек в описании указан путь к вкладке после слов «В интерфейсе», например «Настройки» → «Общие» → «Тайм-ауты».

Остальные настройки доступны только в интерфейсе Администрирование Django (по URL https://<account URL>/admin/), на странице редактирования Constance: «Начало» → «Constance» → «Настройки».

  • в облаке Webim интерфейс Администрирование Django используют только сотрудники компании Webim. Чтобы изменить настройку, которой нет в интерфейсе, обратитесь в техническую поддержку (support@webim.ru);

  • у hosted-клиентов интерфейс Администрирование Django открывает технический специалист клиента (см. Страница настроек Constance).

Изменение в Панели управления Webim

  1. Войдите в Панель управления Webim под учётной записью администратора.

  2. Откройте «Настройки» → «Общие».

  3. Выберите вкладку, измените значения и сохраните изменения.

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

Страница настроек Constance

Страница открывается по адресу https://<домен Webim>/admin/constance/config/. Вход выполняется по адресу электронной почты и паролю учётной записи администратора.

Учётная запись для входа

Учётной записи нужен доступ к интерфейсу Администрирование Django (признак is_staff) и право constance.change_config. У суперпользователя есть все права, включая эти. Учётная запись администратора, которая создаётся при установке Webim, доступа к административному интерфейсу не имеет.

Создать суперпользователя можно CLI-командой createsuperuser. Команда запросит адрес электронной почты, имя и пароль.

При установке на сервер выполните команду на сервере Webim:

sudo -u www-data PYTHONPATH=/opt/webim/django-chat/django-chat \
  /opt/webim/django-chat/venv/bin/python /opt/webim/django-chat/django-chat/manage.py createsuperuser

При установке в Kubernetes выполните команду в контейнере веб-сервера:

kubectl -n chatback exec -it deploy/chatback-web -c web -- python manage.py createsuperuser

Работа с Constance

  • Настройки в Constance сгруппированы так же, как в Базе знаний: заголовки разделов на страницах справочника совпадают с названиями групп в Constance.

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

  • Значения секретов (паролей, токенов и ключей) в Constance скрыты. Чтобы сохранить прежнее значение, не меняйте такое поле. В справочнике такие настройки отмечены: «Значение скрыто в форме редактирования».

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

Таблицы справочника содержат столбцы:

  • «Параметр» — имя настройки;

  • «Тип» — тип значения и формат ввода (см. ниже);

  • «По умолчанию» — значение, которое действует, пока настройку не меняли;

  • «Описание» — назначение, допустимые значения и особенности настройки.

Все настройки необязательные: у каждой есть значение по умолчанию. При этом поля с типами «Целое число», «Дробное число» и «Длительность, не менее 1 с» в форме нельзя оставить пустыми.

Тип Как ввести значение в форме
Логический Флажок.
Целое число Число без пробелов, например 30.
Целое число или пусто Число или пустое поле. Пустое поле означает, что значение не задано.
Дробное число Число с точкой в качестве десятичного разделителя, например 0.5.
Строка Текст. Пустое поле — пустая строка.
Длительность ЧЧ:ММ:СС или Д ЧЧ:ММ:СС, например 00:05:00 (5 минут) или 1 00:00:00 (1 день). Можно указать число секунд, например 300.
Длительность, не менее 1 с То же, что «Длительность», но поле обязательное и значение должно быть не меньше одной секунды.
Список строк, список целых чисел Редактор списка: элементы добавляются и удаляются кнопками. В справочнике значения по умолчанию показаны в формате JSON.
Список ролей Выбор одной или нескольких ролей сотрудников.
Выбор из списка Выпадающий список. Допустимые значения перечислены в описании настройки.
JSON-объект, JSON-массив Текст в формате JSON. Форма проверяет только синтаксис JSON, поэтому структуру значения сверяйте со справочником.
Строка (JSON), строка (JSON-массив) Строка, которая содержит JSON.

Для тайм-аутов значение 00:00:00, как правило, отключает тайм-аут. Особенности отдельных тайм-аутов указаны в их описаниях и в разделе Таймауты диалогов.

Тарифные возможности

Часть настроек действует, только если в тарифный план аккаунта входит определённая возможность. Если возможности нет, значение настройки не учитывается и действует фиксированное поведение. В описании таких настроек указано: «Зависит от тарифной возможности …: без неё …».

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

Часть настроек можно переопределить для выбранного отдела. Для диалогов этого отдела значение из настроек отдела имеет приоритет над значением из Constance. В описании таких настроек указано: «Можно переопределить в настройках отдела».

Разделы справочника

Группы настроек распределены по страницам справочника в том же порядке, что и на странице настроек Constance:

Неиспользуемые настройки

В Constance есть настройки, которые в Webim 11.0 отображаются, но ни на что не влияют (deprecated): они сохранены для совместимости с предыдущими версиями. Менять их не нужно.

Параметр Группа в Constance
ACTION_ON_CHATS_IF_ALL_OPERATORS_DISCONNECTED Разное
AINVITE_AVATAR Разное
ALLOWED_DOMAINS Безопасность и авторизация
AMOCRM Интеграции
ANALYTICS_V2_SERVICE_DASHBOARD_REPORTS Аналитика и статистика
ANALYTICS_V2_SERVICE_METRICS Аналитика и статистика
ANALYTICS_V2_SERVICE_REPORT_CONFIGS Аналитика и статистика
ANALYTICS_V2_SERVICE_REPORT_GROUPS Аналитика и статистика
ANSWERS Разное
API_CHATS_SINCE_AS_TIMESTAMP Аналитика и статистика
APPLE_CHAT_CUSTOM_EXTENSION_SETTINGS Apple Chat
APPLE_CHAT_PAYMENT_MERCHANT_SESSION_GATEWAY Apple Chat
APPLE_CHAT_TEMPLATES Apple Chat
AUTH_TOKEN_COOKIE_FORCE_SECURE Безопасность и авторизация
BACKGROUND_TASKS Фоновые задачи
BI_DEPARTMENT_STATS_INTERVAL Аналитика и статистика
BI_GENERAL_STATS_INTERVAL Аналитика и статистика
BOT_BYPASS_TIMEOUT Боты
CANNED_RESPONSE_LIST_PAGING_LIMIT Шаблоны ответов
CHANNELS Каналы
CHAT_STATES_FOR_COUNT_PER_OPERATOR Диалоги
CLEAR_URL_FOR_DEMO Разное
CLOSED_BY_OPERATOR_CHATS_HIDING_TIMEOUT Таймауты диалогов
CLOSE_CHATS_SLEEP_INTERVAL Диалоги
COMPANY_PHONE Общие
CUSTOM_ROUTER_SCHEMA_URL Интеграции
CUSTOM_TYPING_RL_SEC Набор текста
FAKE_ZENDESK_REQUESTER Интеграции
FORCE_ANSWERS_FORMAT Разное
HIDE_GEO РМО (рабочее место оператора)
HIDE_INVITED_BY_ME РМО (рабочее место оператора)
HIDE_INVITED_BY_OTHERS РМО (рабочее место оператора)
HTTP_ONLY Безопасность и авторизация
HUAWEI_PUSH_KIT_SETTINGS Пуш-уведомления
IMAP_CHECK_PERIOD Разное
INCLUDE_DVIGUS_JS Разное
INVOICEBOX_FORM_URL Разное
LICENSE_KEY_ACCOUNT_NAME Разное
LICENSE_KEY_VERSION Разное
LOGO Общие
LOG_OLD_STAT_QUERIES Аналитика и статистика
LOW_BALANCE_EMAIL Email
LOW_BALANCE_WARNING_THRESHOLD Email
MAIL_SIGNATURE Email
MESSAGE_SUBKINDS_TO_HIDE_FROM_OPERATOR Тексты и сообщения
META_VISITORS_ENABLED Посетители
MOBILE_APPS_VERSIONS_FEATURES_SUPPORT_DEPENDENCIES Мобильные приложения
MOBILE_APP_VERSION_REGEXPS Мобильные приложения
NEW_STATS_MODE Аналитика и статистика
OFFLINE_CHAT_ACCEPTED_TEXT Диалоги
OLD_SESSION_REMOVING_TIMEOUT Таймауты диалогов
OPERATORS_REDIRECT_SEARCH_FIELD РМО (рабочее место оператора)
OUTGOING_HTTP_REQUEST_SETTINGS Прокси и сеть
POCHTA_PUSH_URL Пуш-уведомления
POST_NUMBER_IN_QUEUE_MESSAGE_TO_VISITOR Разное
ROBOTS Боты
SCENARIO_ROBOT_INSTANT_FIRST_RESPONSE Боты
SEND_DEV_IOS_PUSHES Пуш-уведомления
SEND_DIST_IOS_PUSHES Пуш-уведомления
SEND_MONTHLY_STATS Email
SEND_VISITOR_ACCEPTED_NOTIFICATION_TO_ALL_OPERATORS Пуш-уведомления
SEND_WEEKLY_STATS Email
SHOWN_CLOSED_CHATS_LIMIT РМО (рабочее место оператора)
SHOW_PREVIOUS_CHATS_TO_OPERATOR Посетители
SKIP_CATEGORIES_IN_ALL_STATS Аналитика и статистика
SLA_POLICY_LIST_PAGING_LIMIT Политики SLA
SMART_POLLING_PERIOD_LOGIC Поллинг
SMART_POLLING_PERIOD_SETTINGS Поллинг
SMTP_SERVER Email
STATISTICS_MIN_PERIOD Аналитика и статистика
STATS_DISPLAY_ONLY Аналитика и статистика
STATS_FIELDS_EXCLUDE Аналитика и статистика
STATS_FIELDS_INCLUDE Аналитика и статистика
STATS_REPORTS_EXCLUDE Аналитика и статистика
STATS_REPORTS_INCLUDE Аналитика и статистика
STATS_V3 Аналитика и статистика
STATS_W_CHATS Аналитика и статистика
STORE_NEW_CHATS_IMMEDIATELY Email
STORE_VISITOR_OFFLINE_MESSAGE_IMMEDIATELY Email
TIMEOUT_FOR_CHAT_AUTO_CLOSE_IF_VISITOR_LEFT_FOR_MOBILE Таймауты диалогов
TRACK_EVERY_VISITOR_DEPARTMENT Разное
UNISENDER Интеграции
USE_S3_STORAGE Файлы
USE_WHATSAPP_MEDIA_ID Мобильные приложения
VISIBLE_VISITORS_LIMIT Посетители
VISITOR_EMAIL_CHANGING_PER_CHAT_LIMIT Посетители
VISITOR_ID_LOCK_SETTINGS Разное
VISITOR_PUSH_SETTINGS Пуш-уведомления
WINDOWS_PHONE_NOTIFICATION_SETTINGS Пуш-уведомления