Инструкция по работе с виджетом «Курс валют»
Описание ситуации
Команда SmartPlayer разработала виджет, который позволяет пользователям добавлять файл с ценами на sftp-сервер и передавать определённые цены на выбранные устройства. Возможность выбора конкретных устройств для передачи цен появилась в рамках доработки виджета.
Работоспособность виджета
Данный виджет работает:
- с версии серверного приложения: 2.151.1
- с версии клиентского приложения:
- на устройствах под управлением:
Серверная логика
На сервер SmartPlayer пользователь подгружает файл с данными по ценам с помощью sftp. Сервер получает, хранит и обрабатывает информацию из файла. Через равные промежутки времени происходит переотправка (обновление) данных. Сервер парсит (распространяет) данные в виджет, который выводит их на устройства.
Примечание: доработанный виджет частично изменил свою реализацию. В файле которые подкладывается на сервер появилось поле "department" В этом поле прописывается наименование департамента, которое впоследствии необходимо также указать в настройках устройства. Только устройства у которых прописан департамент получают новые данные с ценами. Значение поля "department" в файле и на устройстве должны быть идентичны, то есть иметь полное совпадение по написанию и регистру.
Настройка поля департамент
Пользователю необходимо перенести значение поля "department" на нужные устройства, которые впоследствии будут работать в трансляции с виджетом. Для этого необходимо перейти в раздел «Устройства», выбрать нужное и дважды кликнуть по этому устройству.
После описанных выше действий откроется страница настройки устройства. Здесь необходимо найти поле «Код филиала» и точно ввести значение, которое указано в поле "department" файла для сервера и сохранить настройки.
Если данное устройство будет привязано к трансляции с виджетом валют, то оно будет получать только определенные данные для этого департамента.
Выгрузка отчета по валютам
Пользователь может выгрузить отчёт по валютам в личном кабинете SmartPlayer. Для этого у него должна быть одна из двух ролей:
- Администратор.
- Администратор (трансляция с отчетом валют).
Сам отчет можно выгрузить перейдя в специальную категорию раздела «Отчёты» в категории «Отчёт по валютам».
С работой данного раздела можно ознакомиться по ссылке здесь.
Добавление виджета в личный кабинет
Чтобы добавить данный виджет в личный кабинет, пользователю необходимо запросить у специалиста команды технической поддержки архив с содержимым. Он будет предоставлен в формате .zip - архива.
После этого пользователь должен авторизоваться в личном кабинете и перейти в раздел «Контент».
В разделе «Контент» необходимо перетянуть данный виджет из локального хранилища в личный кабинет. После того как пользователь перенесет виджет в личный кабинет, он отобразится в списке с контентом.
Настройка виджета
После переноса виджета для первичной настройки пользователю необходимо дважды кликнуть по иконке виджета. Данное действие перенесет его на главную страницу.
На главной странице виджета пользователю доступно две кнопки:
- Кнопка "API".
- Кнопка «Настройки»
Кнопка "API"
Кликнув на кнопку "API" пользователю откроется модальное окно с информацией о ресурсах, которые позволяют стабильно работать виджету. В разделе также есть общее описание о его необходимости и принципах работы.
Основными параметры для ресурсов:
- имя — указано имя ресурса;
- метод — используемы тип метода (GET);
- требует авторизации — информации об обязательности авторизации;
- адрес сервера — URL-адрес сервера с которого берутся данные;
- адрес API — отображается название файла json с данными о ценах;
- кнопка «Проверить соединение» — при нажатии проводит проверку соединения и отображает вывод с указанием числового статуса.
Закрыть данное окно можно по стандартной иконке в правом верхнем углу.
Кнопка «Настройки»
После открытия страницы с настройками пользователю необходимо настроить следующие параметры виджета:
- фон виджета — позволяет с помощью палитры настроить нужный фон для виджета;
- фоновое изображение — выбрать изображение в качестве фона для виджета из личного кабинета SmartPlayer;
- частота обновления данных от Центробанка — указать значение (в секундах) чтобы получать актуальные данные о ценах;
- логотип — выбрать изображение в качестве логотипа для виджета из личного кабинета SmartPlayer;
- текст в правой части «подвала» виджета — необходимо ввести текст сообщения;
- размер в правой части «подвала» виджета — ввести значение или сместить ползунок для настройка размер шрифта текста;
- форматирование отображения цен — выбрать из списка вариант форматирования;
- изображение плейсхолдера — выбрать изображение в качестве плейсхолдера (заглушки) для виджета из личного кабинета SmartPlayer;
- чекбокс «Отображать плейсхолдер» — включает/выключает плесхолдер (заглушку) в настройках виджетах. При активации всегда показывается изображение плесхолдера (заглушки);
- чекбокс «Отображать плейсхолдер при отсутствии соединения с удаленным сервером» — включает/выключает работу плейсхолдера (заглушки) при отсутствии соединения с сервером.
- время, через которое скрывать цены и отображать плейсхолдер — указать время через которое начинает работать плейсхолдер (заглушка). Время измеряется в секундах;
- чекбокс «анимация смены котировок» — включает/выключает работу анимации при смене значений котировок;
- выбор языка — позволяет выбрать один из доступных языков - русский, английский, испанский, португальский, казахский.
Завершение настройки виджета
После завершения работ по настройке виджета пользователь должен нажать на кнопку «Применить настройки» в правой нижней части экрана.
Далее виджет растянется на весь экран и пользователь должен нажать на кнопку «Сохранить», внизу по центру экрана.
Загрузка и скачивание настроек
В процессе взаимодействия с настройками виджета пользователь может загрузить или выгрузить настройки виджета. Каждое из указанных действий можно сделать с помощью отдельных иконок в интерфейсе виджета. Иконки расположены в виджете снизу по центру.
Добавление настроенного виджета в трансляцию
Чтобы полностью ознакомиться с работой данной функциональности, пользователю необходимо запустить трансляцию с расписанием и добавить в качестве контента данный виджет. Чтобы ознакомиться с описанными ранее шагами по созданию трансляции и расписания рекомендуется просмотреть следующие статьи из Wikipedia:
Видеоинструкция
Инструкция по работе с виджетом «Курс валют»
Дополнительная информация
Если данная статья не помогает использовать функционал по назначению или после её прочтения остаются вопросы, их можно озвучить в разделе "Обсуждения" вверху страницы.
Также дополнительную информацию можно узнать на странице Как взаимодействовать пользователю с разделом "Обсуждения"
