Конфигурация Web-приложения

Модель клиентской конфигурации представляет некоторые параметры конфигурации Web-приложения, которые может изменить пользователь с правами manage-configuration через REST API.

Поле Тип Описание

agentInstallerUrl

String

URL для скачивания инсталляционного скрипта агента.

authEnabled

Boolean

Включает самостоятельную регистрацию для пользователей.

authentication

Object

Параметры аутентификации пользователей.

authentication.availableMethods

Array<String>

Cписок доступных методов аутентификации. Возможные значения: native и keycloak. По умолчанию — native.

authentication.methodByDefault

String

Метод аутентификации, который используется по умолчанию. По умолчанию — native.

authentication.services

String

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

authentication.services.keycloak

String

Секция с настройками аутентификации через реквизиты учетной записи в Keycloak.

authentication.services.keycloak.configUri

String

Имя файла настроек соединения, сгенерированного Keycloak-сервером для web-приложения.

authentication.services.keycloak.legacySupport

Boolean

Включает поддержку работы с Keycloak-сервером версии ниже 19.

comet

Object

Конфигурация Web Socket.

comet.port

Integer

Порт Web Socket.

contactEmail

String

Email-адрес, отображаемый при недоступности сервера.

collapseSections

Boolean

Возможность сворачивания секций в Подробном Виде и Окне Информации.

canEditObjectStyle

Boolean

Возможность изменения CSS-стилей объекта.

defaultClassImage

Object

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

defaultClassImage.<class_id>.img

String

Путь к изображению на сервере.

defaultClassImage.<class_id>.dim

Array<Integer>

Размер изображения (в пикселях, [width, height]).

defaultPieChartColors

Array<String>

Набор цветов по умолчанию для отображения круговой диаграммы. Значение задаются в формате HEX, например — #9868B8

disabledSections

Array<String>

Название отключенных секций.

defaultEmbeddableLink

Object

Настройки ссылки под встраиваемым виджетом, которая генерируется по умолчанию.

defaultEmbeddableLink.url

String

URL ссылки.

defaultEmbeddableLink.name

String

Имя ссылки.

documentation

Object

Объект, который содержит набор ссылок на документацию. Каждая ссылка представляет собой объект, содержащий ссылки на документацию на разных языках. Ссылка на каждую версию хранится в переменной, имя которое соответствует коду языка, представленному виде двух символов.

documentation.main

Object

Ссылки на пользовательскую документацию. По умолчанию - https://docs.cpult.ru.

documentation.notificationTemplates

Object

Ссылки на описание для шаблонов уведомлений. По умолчанию https://docs.cpult.ru/web-interface/system-configuration-window/notification-templates.html.

documentation.restApi

Object

Ссылка на документацию по REST API. По умолчанию – https://api.cpult.ru.

enableSmsTrigger

Boolean

Возможность отправки SMS-уведомлений.

enableVoiceCallTrigger

Boolean

Возможность уведомлений с помощью голосовых вызовов.

enableConditionalIncidents

Boolean

Отображение секции Условия генерации аварий в веб-интерфейсе.

enableAnalytics

Boolean

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

enableExtensions

Boolean

Включает пункт расширений в меню пользователя.

enableSnmpTranslate

Boolean

Включает трансляцию SNMP OID в текстовый формат.

forceEmptyStandardView

Array<Integer>

Список классов, для которых применяется Стандартный Вид, даже если объект не имеет дочерних объектов.

geoMap

Object

Конфигурация отображения гео-карты.

geoMap.serverName

String

Имя гео-сервера. По умолчанию .

geoMap.initialPosition

Array<Integer>

Начальная геопозиция для отображения карты (в формате [longitude, latitude]).

geoMap.initialZoom

Integer

Начальный масштаб отображения карты.

grid

Object

Настройки сетки для расстановки объектов.

grid.dim

Integer

Размер сетки в пикселях.

grid.color

Color

Цвет сетки в формате RGBA, например — rgba(128, 128, 128, 0.3).

grid.border

Integer

Максимальное расстояние между объектами и границей сетки (в пикселях).

gridView

Object

Параметры отображения объектов в виде сетки.

gridView.cols

Integer

Количество объектов в строке сетки. При 0 используется значение параметра gridView.colWidth.

gridView.colWidth

Integer

Ширина объектов. Количество объектов в строке сетки подстраивается под ширину экрана. Данный параметр игнорируется, если gridView.cols > 0

gridView.rowHeight

Integer

Высота объектов (в пикселях).

gridView.gutterSize

Integer

Величина отступа между объектами (в пикселях).

history

Object

Параметры отображения истории метрик.

history.slider

Boolean

Отображение слайдера для графиков.

history.downsampling

Array

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

history.modelChangeAnnotations

Boolean

Включение аннотации на графиках.

hideConnectionStatusNotifications

Boolean

Скрытие уведомлений о статусе подключения.

hideResponseErrorNotifications

Boolean

Скрытие уведомлений об ошибках запросов.

incidents

Object

Настройка дополнительных полей для списков активных аварий и исторических аварий.

incidents.additionalFields

Array<String>

Источники данных для дополнительных полей.

incidents.additionalFieldNames

Array<String>

Имена дополнительных полей, отображаемые в интерфейсе.

languages

Object

Список языков интерфейса.

languages.<id>.short

Object

Код языка, состоящий из двух букв.

languages.<id>.long

Object

Имя языка.

mediaUrlFields

Array<String>

Имена полей в истории состояний, которые интерпретируются как внешние ссылки и отображаются под данными в таблице истории.

millisecondMonitoring

Boolean

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

monitoring

Object

В этом разделе настраивается скрытие стандартных мониторинговых сенсоров из интерфейса.

monitoring.standardTasks

Array<String>

Список идентификаторов отображаемых стандартных сенсоров.

pollIntervalSocket

Integer

Интервал получения объектной модели при доступности Web Socket.

pollInterval

Integer

Интервал получения объектной модели при недоступности Web Socket.

regionColor

Object

JSON-объект со списком состояний и цветов для заливки графиков (в формате "1": rgba(206, 134, 247, 0.1))

title

String

Имя компании.

themes

Object

Настройки темы. По умолчанию используется тема Light. CSS-файлы с темами находятся в директории $SAYMON_ROOT/target/client/css.

themes.<id>.name

String

Название темы.

tree

Object

Настройки для дерева объектов.

tree.filterSubmit

Boolean

Включает кнопку применения фильтра и отключает его автоматическое применение при вводе символов.

useNaturalSort

Boolean

Включает сортировку объектов с помощью библиотеки javascript-natural-sort.