Параметры для статического встраивания¶
Также известны как "параметры для подписанного встраивания" или "автономного встраивания".
Параметры — это данные, которые передаются между Glarus BI и вашим веб-сайтом через URL встраивания. Вы можете использовать параметры, чтобы указать, как элементы Glarus BI должны выглядеть и действовать внутри iframe на вашем веб-сайте.
Типы параметров¶
Параметры могут быть подписанными и неподписанными.
Подписанные параметры, такие как названия и значения фильтров, должны быть добавлены в ваш код сервера.
Неподписанные параметры, такие как настройки внешнего вида, должны быть добавлены непосредственно в атрибут src вашего iframe.
- Значения по умолчанию для редактируемых параметров
- Настройки видимости для редактируемых параметров
- Настройки внешнего вида
Добавление виджета-фильтра в статическое встраивание¶
Вы можете использовать редактируемые параметры, чтобы добавить виджеты фильтров во встроенные дашборды или запросы SQL.
- Перейдите на дашборд или на запрос SQL. Убедитесь, что вы настроили фильтр дашборда или переменную SQL.
- Нажмите на значок общего доступа > Встроить этот элемент в приложение.
- В разделе Параметры вы найдёте имена фильтров вашего дашборда или переменных SQL.
- Выберите Редактируемый для каждого параметра, который должен получить виджет фильтра во встраивании.
- Нажмите Опубликовать, чтобы сохранить изменения.
- Добавьте или обновите код на своём сервере, чтобы он соответствовал коду, сгенерированному Glarus BI.
Редактируемые параметры отвечают за передачу значений фильтра из встроенного виджета-фильтра (отображаемого в iframe).
Обратите внимание, что заблокированные параметры могут ограничивать значения, отображаемые во встроенном виджете фильтра.
Заполнение виджета встроенного фильтра значением по умолчанию¶
Если вы хотите установить значение по умолчанию для вашего редактируемого виджета-фильтра, вы можете передать его в соответствующее имя параметра в атрибуте src вашего iframe.
Например, если на встроенном дашборде есть фильтр "Завтрак", и вы хотите установить значение по умолчанию "омлет":
Чтобы указать значения по умолчанию для нескольких фильтров, разделите фильтры амперсандами (&):
Вы можете установить несколько значений по умолчанию для фильтра, разделив пары key=value амперсандами (&):
Скрытие виджетов фильтров из статического встраивания¶
Если у вас много редактируемых параметров (что приводит к большому количеству виджетов-фильтров), вы можете скрыть их из вашего статического встраивания, добавив #hide_parameters в конец URL в атрибуте src вашего iframe:
Например, если вы хотите скрыть фильтр «Завтрак» из вашего встроенного дашборда:
Вы можете скрыть несколько виджетов-фильтров, разделив названия параметров запятыми:
Вы можете одновременно назначить параметру значение по умолчанию и скрыть его виджет-фильтр:
Неподписанный синтаксис параметров¶
Каждый раз, когда вы добавляете параметр в URL встраивания в атрибуте src вашего iframe, обратите внимание, что:
- параметр names пишется в нижнем регистре;
- параметр values чувствителен к регистру (значения должны совпадать с вашими данными);
- пробелы должны быть заменены символами подчёркивания.
Ограничение данных в статическом встраивании¶
Если вы хотите ограничить данные, отображаемые на встроенном дашборде или в запросе SQL, вы можете настроить заблокированный параметр. Заблокированный параметр фильтрует данные на дашборде или в запросе SQL перед тем, как результаты отображаются конечному пользователю в статическом встраивании.
- Перейдите на дашборд или на запрос SQL. Убедитесь, что вы настроили фильтр дашборда или переменную SQL.
- Нажмите на значок общего доступа > Встроить этот элемент в приложение.
- В разделе Параметры вы найдёте названия фильтров вашего дашборда или переменных SQL.
- Выберите Заблокировано для каждого параметра, которым вы хотите ограничить свои данные.
- Опционально: выберите значение в разделе Предварительный просмотр заблокированных параметров, чтобы увидеть, как выглядят ограниченные данные.
- Нажмите Опубликовать, чтобы сохранить изменения.
- Добавьте или обновите код на своём сервере, чтобы он соответствовал коду, сгенерированному Glarus BI.
Вы можете использовать заблокированные параметры для отображения отфильтрованных данных на основе атрибутов, полученных вашим веб-сервером, таких как имя пользователя или идентификатор арендатора. Для получения дополнительных примеров см. репозиторий справочных приложений.
Заблокированные параметры применят выбранные значения фильтра к вашему исходному дашборду или запросу SQL, но они не будут отображаться как виджеты-фильтры в вашем встраивании. Заблокированные параметры также могут ограничить значения, отображаемые в ваших редактируемых виджетах-фильтрах.
Изменение заблокированного параметра¶
Следующие рекомендации актуальны, если вам нужно внести изменения в заблокированные параметры.
Включите все заблокированные параметры в свой код сервера¶
Как только вы опубликовали диаграмму или дашборд с заблокированным параметром, вы должны включить название заблокированного параметра в свой код сервера. Если вы забудете сделать это, в журналах появится сообщение вроде этого: You must specify a value for :parameter in the JWT.
Удостоверьтесь, что название фильтра совпадает с названием заблокированного параметра¶
Если вы изменили название фильтра, используемого в качестве заблокированного параметра, убедитесь, что вы обновили название и значение(я) параметра в коде сервера. Но это неактуально, если заблокированный параметр связан с переменной SQL.
Множественные заблокированные параметры или множественные значения¶
Значения заблокированных параметров в вашем коде сервера должны точно соответствовать значениям ваших фильтров. Лучший способ установить несколько заблокированных параметров или передать несколько значений в заблокированный параметр — это выбрать значение фильтра в разделе Предварительный просмотр заблокированных параметров и предварительный просмотр сгенерированного Glarus BI кода сервера.
Заблокированные параметры на дашбордах с запросами SQL¶
Если ваш заблокированный параметр связан с фильтром дашборда, который, в свою очередь, связан с запросом SQL, вы сможете выбрать только одно значение для заблокированного параметра.
Например, предположим, что у вас есть фильтр дашборда под названием «Завтрак» со значениями «Омлет», «Бекон» и «Вафли». Если фильтр «Завтрак» связан с любыми запросами SQL на панели инструментов, вы сможете выбрать только один из вариантов: «Омлет», «Бекон» или «Вафли» для заблокированного параметра, связанного с фильтром «Завтрак».
Настройка внешнего вида статического встраивания¶
Вы можете изменить внешний вид встроенного элемента, добавив параметры хэша в конец URL в атрибуте src вашего iframe.
Например, следующий URL встраивания будет отображать встроенный элемент в тёмном режиме, без границ и с его исходным заголовком:
Вы можете предварительно просмотреть настройки внешнего вида из настроек внешнего вида встраивания вашего запроса или дашборда.
| Название параметра | Возможные значения |
|---|---|
| bordered | true, false |
| titled | true, false |
| theme | null, transparent, night |
Максимальный размер запроса¶
Максимальная длина URL статического встраивания (включая все параметры) задаётся значением вашей переменной окружения MB_JETTY_REQUEST_HEADER_SIZE. По умолчанию это 8 192 байта.
Если ваш URL статического встраивания превышает максимальный размер заголовка, вы увидите сообщение в журнале наподобие URI too long. Вы можете изменить переменную окружения, чтобы допустить использование больших заголовков. Если вы используете прокси-сервер, вам может потребоваться настроить соответствующий параметр на сервере.