Как использовать локальную конфигурацию с EloView WebApps и WebViewController?

В этой статье объясняется, как использовать Local Config с EloView® WebApps и WebViewController (WVC) для применения расширенных настроек браузера и киоска непосредственно на устройстве Android от Elo.

Local Config позволяет WebViewController (WVC) использовать настройки конфигурации, сохраненные локально на устройстве Android от Elo, когда запускается WVC. Эти настройки могут предоставить дополнительные параметры конфигурации, недоступные через портал EloView.

⚠ Важно

Включение Local Config в EloView говорит WebViewController искать локальный файл конфигурации. Это не создает, не загружает и не копирует файл конфигурации на устройство. Клиент или администратор должен создать файл конфигурации и разместить его в поддерживаемом месте на физическом устройстве Android от Elo.

Обзор

WebViewController может получать информацию о конфигурации двумя способами:

Локальный файл конфигурации – WVC считывает поддерживаемый файл конфигурации, сохраненный в корневом /sdcard/ каталоге на устройстве.
Android Intents – Пользовательское Android-приложение может запускать WVC и предоставлять информацию о конфигурации программным образом.

Boolean-значение readLocalConfig определяет, будет ли WebViewController пытаться использовать локальный файл конфигурации вместо настроек Intent launchContentSetting.

readLocalConfig	Поведение
`true`	Запрашивает, чтобы WVC использовала поддерживаемый локальный файл конфигурации и игнорировала `launchContentSetting`.
`false`	WVC может получать свою конфигурацию запуска через `launchContentSetting`.

Перед началом

ℹ Перед началом

Определите, какие настройки WebViewController необходимы для вашего развертывания, прежде чем создавать файл конфигурации.

Компания Elo рекомендует включать только те настройки, которые вы намеренно хотите изменить. Оставьте другие настройки со существующим или стандартным поведением.

Включите Local Config в EloView

При конфигурировании контента WebApp в EloView включите Local Config в свойствах контента:

В портале EloView откройте соответствующий элемент контента WebApp.
Перейдите в раздел Детали контента > Свойства контента.
В разделе Настройки браузера найдите Local Config.
Установите Local Config в Включено (Активно).
Сохраните или примените конфигурацию.

⚠ Важно

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

Создание и размещение локального файла конфигурации

WebViewController поддерживает свойства Java и файлы конфигурации JSON. Разместите файл конфигурации непосредственно в корневом /sdcard/ каталоге, используя одно из поддерживаемых имен файлов приведенных ниже.

Приоритет	Поддерживаемый путь файла	Формат
1 – Высший	`/sdcard/wvc_config.properties`	Java Properties
2	`/sdcard/wvc_config.prop`	Java Properties
3 – Низший	`/sdcard/wvc_config.json`	JSON

ℹ Приоритет файлов

Если на устройстве существует больше одного поддерживаемого файла конфигурации, WebViewController использует файл с самым высоким приоритетом. Например, wvc_config.properties имеет приоритет над wvc_config.prop и wvc_config.json.

⚠ Требование к пути хранения

Файл должен быть размещен непосредственно под /sdcard/. Файл, хранящийся в подпапке, такой как /sdcard/Download/, имеет другой путь и не является одним из поддерживаемых мест, описанных для Local Config.

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

Local Config поддерживает ряд настроек WebViewController. Boolean-значения используют true или false. Строковые значения заключаются в кавычки в JSON и вводятся как текстовые значения в файле свойств Java.

Настройки браузера и сессии

Настройка	Тип	Описание
`viewMode`	Строка	Используйте `Full View` для полноэкранного режима. Другие значения используют режим Формы.
`layerType`	Строка	`HW` включает аппаратное ускорение. Другие значения используют `SW`. Аппаратное ускорение рекомендуется в документации для разработчиков при воспроизведении видео.
`pinchZoom`	Boolean	Включает функцию "сжатия для увеличения".
`homePageTimeout`	Строка	Количество минут бездействия, после которого происходит возврат на домашнюю страницу. `0`, `никогда` или опущенное значение означает отсутствие таймаута.
`clearUserDataOnTimeout`	Boolean	Очищает данные пользователя при наступлении таймаута на домашней странице.
`clearCookiesOnTimeout`	Boolean	Очищает файлы cookie при наступлении таймаута на домашней странице.
`ssl`	Boolean	Включает SSL.
`userAgent`	Строка	Устанавливает строку User-Agent.
`virtualKeyboard`	Boolean	Установите `false`, чтобы отключить виртуальную клавиатуру.
`disableDownload`	Boolean	Установите `true`, чтобы отключить загрузки. Это также отключает PDF.
`showLoadingBar`	Boolean	Показывает полосу загрузки в верхней части экрана.

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

Настройка	Тип	Описание
`showNavBar`	Boolean	Показывает панель навигации для домашней, назад и вперед внизу экрана.
`navBarBackgroundColor`	Строка	Цвет панели навигации в формате `#RRGGBB` или `#AARRGGBB`.
`navBarAccentColor`	Строка	Цвет акцента панели навигации.

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

Настройка	Тип	Описание
`showActionBar`	Boolean	Показывает панель действий в верхней части экрана.
`actionBarBackgroundColor`	Строка	Цвет фона панели действий.
`actionBarBackgroundUrl`	Строка	URL изображения, используемого в качестве фона панели действий.
`actionBarAccentColor`	Строка	Цвет акцента панели действий.
`showActionBarLogo`	Boolean	Показывает логотип с левой стороны панели действий.
`actionBarLogoIconUrl`	Строка*	URL изображения, используемого в качестве значка панели действий.
`showActionBarTitle`	Boolean	Показывает заголовок веб-страницы на панели действий.
`showActionBarSubtitle`	Boolean	Показывает подзаголовок веб-страницы на панели действий.
`showActionBarPrintBtn`	Boolean	Показывает кнопку Печати.
`showActionBarShareBtn`	Boolean	Показывает кнопку Поделиться.
`showActionBarInfoBtn`	Boolean	Показывает кнопку Информация.

ℹ Примечание к документации

Документация разработчика описывает actionBarLogoIconUrl как URL, хотя таблица, откуда он взят, сообщает, что этот ключ является Boolean. Поскольку настройка представляет собой URL, в этой статье она показана как Строка. Проверьте поведение в пакете WebViewController, используемом на целевом устройстве.

Настройки PDF

Настройка	Тип	Описание
`pdfSupport`	Boolean	Включает просмотр PDF.
`pdfHyperlinkSupport`	Boolean	Включает гиперссылки внутри PDF-документов.
`pdfSwipeHorizontal`	Boolean	Включает горизонтальную прокрутку PDF, если установлено `true`.
`pdfShowScrollHandle`	Boolean	Показывает ручку прокрутки при пролистывании PDF-документов.
`pdfFitToHeight`	Boolean	Подгоняет PDF к высоте дисплея вместо ширины.

Пример конфигурации JSON

Следующий сокращенный пример демонстрирует структуру файла wvc_config.json. Выберите только настройки и значения, соответствующие вашему развертыванию.

{
  "contentpath": "https://example.com",
  "viewMode": "Full View",
  "layerType": "HW",
  "pinchZoom": true,
  "homePageTimeout": "0",
  "showNavBar": true,
  "pdfSupport": true
}

Сохраните файл, используя одно из поддерживаемых имен файлов, непосредственно под /sdcard/. При использовании локального файла конфигурации запустите WebViewController с readLocalConfig, установленным в true.

Настройка WebViewController с помощью Android Intents

WebViewController также может быть запущен и настроен программным образом через Android Intents. Это предоставляет альтернативу использованию файла конфигурации, сохраненного на устройстве.

Например, после установки WebViewController пользовательское приложение-агент устройства может отправлять соответствующие Intents для управления WVC как частью рабочего процесса устройства.

Intent Extra	Тип	Цель
`contentPath`	Строка	URL домашней страницы, начинающийся с `http://`, `https://` или `file://`.
`readLocalConfig`	Boolean	При `true` запрашивает, чтобы WVC игнорировала `launchContentSetting` и использовала поддерживаемый локальный файл конфигурации.
`launchContentSetting`	Строка	JSON-объект, содержащий параметры запуска, такие как режим просмотра, панели навигации, поведение таймаута, поведение PDF и другие поддерживаемые настройки.

⚠ Важно – Имена параметров Intent

Документация разработчика указывает дополнительный параметр Intent как contentPath, в то время как в его примерной команде используется contentpath в нижнем регистре.

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

Устранение неполадок

Проблема	Что проверить
Локальная конфигурация не применяется	Проверьте, что Local Config включен и что файл конфигурации использует поддерживаемое имя файла и место.
JSON-конфигурация, похоже, игнорируется	Проверьте наличие `wvc_config.properties` или `wvc_config.prop`. Оба имеют более высокий приоритет, чем `wvc_config.json`.
Файл конфигурации не обнаружен	Подтвердите, что файл находится непосредственно под `/sdcard/`. Файлы в таких местах, как `/sdcard/Download/`, не являются одним из зарегистрированных путей Local Config.
`launchContentSetting` настройки не применяются	Проверьте `readLocalConfig`. Когда установлено в `true`, WVC пытается использовать локальный файл конфигурации вместо этого.
Загрузки или PDF недоступны	Проверьте, установлено ли `disableDownload` в `true`. Документированное поведение утверждает, что включение этой опции также отключает PDF.

Контрольный список настройки Local Config

Определите только те настройки WebViewController, которые необходимы для развертывания.
Создайте действительный файл конфигурации JSON или Java properties, используя задокументированные имена настроек и типы значений.
Сохраните файл, используя одно из поддерживаемых имен файлов.
Скопируйте файл непосредственно в корневую папку /sdcard/ на физическом устройстве Android от Elo.
Включите Local Config для соответствующего WebApp в EloView.
При запуске WVC с использованием локального файла конфигурации установите readLocalConfig в true.
Для программного управления сначала установите WebViewController, а затем пусть приложение-агент устройства отправляет соответствующие Android Intents.
Проверьте конфигурацию на целевом устройстве и подтвердите, что WebViewController работает как ожидается.

💡 Советы

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

Please report any broken links by emailing elo.support@zebra.com and include a link to the knowledge article

Поиск

Добро пожаловать в службу поддержки Elo