Инструкция по работе с виджетом «Курс валют»/ru

Описание ситуации

Команда SmartPlayer разработала виджет, который позволяет пользователям добавлять файл с ценами на SFTP-сервер и передавать определённые цены на выбранные устройства. Возможность выбора конкретных устройств для передачи цен появилась в рамках доработки виджета.

Работоспособность виджета

Данный виджет работает:

• с версии серверного приложения: 2.151.1

Серверная логика

На сервер SmartPlayer пользователь загружает файл с данными по ценам с помощью SFTP. Сервер получает, хранит и обрабатывает информацию из файла. Через равные промежутки времени происходит переотправка (обновление) данных. Сервер парсит данные в виджет, который выводит их на устройства.

Примечание: доработанный виджет частично изменил свою реализацию. В файле который размещается на сервере появилось поле "department". В этом поле прописывается наименование департамента, которое впоследствии необходимо также указать в настройках устройства. Только устройства, у которых прописан департамент получают новые данные с ценами. Значение поля "department" в файле и на устройстве должны быть идентично, то есть иметь полное совпадение по написанию и регистру.

Настройка поля «Департамент»

Пользователю необходимо перенести значение поля "department" на нужные устройства, которые впоследствии будут работать в трансляции с виджетом. Для этого необходимо перейти в раздел «Устройства», выбрать нужное устройство и дважды кликнуть по нему.

Пример отображения нужного устройства в разделе «Устройства» личного кабинета

После описанных выше действий откроется страница настройки устройства. Здесь необходимо найти поле «Код филиала» и точно ввести значение, которое указано в поле "department" файла для сервера и сохранить настройки.

Пример отображения поля «Код филиала» в настройках устройства

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

Выгрузка отчёта по валютам

Пользователь может выгрузить отчёт по валютам в личном кабинете SmartPlayer. Для этого у него должна быть одна из двух ролей:

1. Администратор.
2. Администратор (трансляция с отчётом валют).

Файл:Роль пользователя для отчётов.png

Пример роли в личном кабинете

Сам отчёт можно выгрузить, перейдя в специальную категорию раздела «Отчёты» в категории «Отчёт по валютам».

Пример отображения раздела «Отчёты» и категории «Отчёт по валютам»

С работой данного раздела можно ознакомиться по ссылке здесь.

Добавление виджета в личный кабинет

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

Пример виджета в формате .zip-архива

После этого пользователь должен авторизоваться в личном кабинете и перейти в раздел «Контент».

Пример отображения раздела «Контент» в личном кабинете

В разделе «Контент» необходимо перетянуть данный виджет из локального хранилища в личный кабинет. После того, как пользователь перенесет виджет в личный кабинет, он отобразится в списке с контентом.

Пример отображения переноса виджета в личном кабинете SmartPlayer

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

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

Пример отображения главной страницы виджета

На главной странице виджета пользователю доступно две кнопки:

1. Кнопка "API".
2. Кнопка «Настройки»

Пример отображения иконки для перехода в настройки виджета

Кнопка "API"

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

Пример отображения информации в модальном окне

Основными параметрами для ресурсов являются:

• имя — указано имя ресурса;
• метод — используемый тип метода (GET);
• требует авторизации — информация об обязательности авторизации;
• адрес сервера — URL-адрес сервера, с которого берутся данные;
• адрес API — отображается название JSON-файла с данными о ценах;
• кнопка «Проверить соединение» — при нажатии проводит проверку соединения и отображает вывод с указанием числового статуса.

Закрыть данное окно можно по стандартной иконке в правом верхнем углу.

Кнопка «Настройки»

После открытия страницы с настройками пользователю необходимо настроить следующие параметры виджета:

• фон виджета — позволяет с помощью палитры настроить нужный фон для виджета;
• фоновое изображение — выбрать изображение в качестве фона для виджета из личного кабинета SmartPlayer;
• частота обновления данных от Центробанка — указать значение (в секундах), чтобы получать актуальные данные о ценах;
• логотип — выбрать изображение в качестве логотипа для виджета из личного кабинета SmartPlayer;
• текст в правой части «подвала» виджета — необходимо ввести текст сообщения;
• размер в правой части «подвала» виджета — ввести значение или сместить ползунок для настройка шрифта текста;
• форматирование отображения цен — выбрать из списка вариант форматирования;
• изображение плейсхолдера — выбрать изображение в качестве плейсхолдера (заглушки) для виджета из личного кабинета SmartPlayer;
• чекбокс «Отображать плейсхолдер» — включает/выключает плесхолдер (заглушку) в настройках виджета. При активации всегда показывается изображение плесхолдера (заглушки);
• чекбокс «Отображать плейсхолдер при отсутствии соединения с удалённым сервером» — включает/выключает работу плейсхолдера (заглушки) при отсутствии соединения с сервером.
• время, через которое скрывать цены и отображать плейсхолдер — указать время, через которое начинает работать плейсхолдер (заглушка). Время измеряется в секундах;
• чекбокс «Анимация смены котировок» — включает/выключает работу анимации при смене значений котировок;
• выбор языка — позволяет выбрать один из доступных языков — русский, английский, испанский, португальский, казахский.

Пример отображения настраиваемых параметров виджета

Завершение настройки виджета

После завершения работ по настройке виджета пользователь должен нажать на кнопку «Применить настройки» в правой нижней части экрана.

Пример отображения кнопки «Применить настройки»

Далее виджет растянется на весь экран, и пользователь должен нажать на кнопку «Сохранить», внизу по центру экрана.

Пример отображения кнопки «Сохранить»

Загрузка и скачивание настроек

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

Пример отображения иконок в настройках виджета

Добавление настроенного виджета в трансляцию

Чтобы полностью ознакомиться с работой данной функциональности, пользователю необходимо запустить трансляцию с расписанием и добавить в качестве контента данный виджет. Чтобы ознакомиться с описанными ранее шагами по созданию трансляции и расписания рекомендуется просмотреть следующие статьи из Wiki SmartPlayer:

• Раздел "Устройства"
• Раздел "Контент на устройства"
• Раздел "Трансляции"
• Раздел "Расписание"

Видеоинструкция

Инструкция по работе с виджетом «Курс валют»

Дополнительная информация

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

Пример отображения вкладки «Обсуждения» на wiki-странице

Также дополнительную информацию можно узнать на странице Как взаимодействовать пользователю с разделом "Обсуждения"