Инструкция по работе с виджетом «Курс валют»: различия между версиями
Нет описания правки |
Нет описания правки |
||
| (не показано 8 промежуточных версий этого же участника) | |||
| Строка 1: | Строка 1: | ||
<languages/> | |||
<translate> | |||
<!--T:1--> | |||
== '''Описание ситуации''' == | == '''Описание ситуации''' == | ||
Команда SmartPlayer разработала виджет, который позволяет пользователям | Команда SmartPlayer разработала виджет, который позволяет пользователям добавлять файл с ценами на SFTP-сервер и передавать определённые цены на выбранные устройства. Возможность выбора конкретных устройств для передачи цен появилась в рамках доработки виджета. | ||
== ''' | === '''Работоспособность виджета''' === | ||
Данный виджет работает: | Данный виджет работает: | ||
* с версии серверного приложения: 2.151.1 | |||
# С | == '''Серверная логика''' == | ||
На сервер SmartPlayer пользователь загружает файл с данными по ценам с помощью SFTP. Сервер получает, хранит и обрабатывает информацию из файла. Через равные промежутки времени происходит переотправка (обновление) данных. Сервер парсит данные в виджет, который выводит их на устройства. <br> <br> | |||
'''Примечание:''' доработанный виджет частично изменил свою реализацию. В файле который размещается на сервере появилось поле "department". В этом поле прописывается наименование департамента, которое впоследствии необходимо также указать в настройках устройства. Только устройства, у которых прописан департамент получают новые данные с ценами. Значение поля "department" в файле и на устройстве должны быть идентично, то есть иметь полное совпадение по написанию и регистру. | |||
=== '''Настройка поля «Департамент»''' === | |||
Пользователю необходимо перенести значение поля "department" на нужные устройства, которые впоследствии будут работать в трансляции с виджетом. Для этого необходимо перейти в раздел «Устройства», выбрать нужное устройство и дважды кликнуть по нему. | |||
[[File:Нужное_устройство_в_лк.png|thumb|center| Пример отображения нужного устройства в разделе «Устройства» личного кабинета|800px]] | |||
После описанных выше действий откроется страница настройки устройства. Здесь необходимо найти поле «Код филиала» и точно ввести значение, которое указано в поле "department" файла для сервера и сохранить настройки. | |||
[[File:Код_филиала.png|thumb|center| Пример отображения поля «Код филиала» в настройках устройства|800px]] | |||
Если данное устройство будет привязано к трансляции с виджетом курса валют, то оно будет получать только определенные данные для этого департамента. | |||
=== '''Выгрузка отчёта по валютам''' === | |||
Пользователь может выгрузить отчёт по валютам в личном кабинете SmartPlayer. Для этого у него должна быть одна из двух ролей: | |||
# Администратор. | |||
# Администратор (трансляция с отчётом валют). | |||
[[File:Роль пользователя для отчётов.png|thumb|center| Пример роли в личном кабинете|800px]] | |||
Сам отчёт можно выгрузить, перейдя в специальную категорию раздела «Отчёты» в категории «Отчёт по валютам». | |||
[[File:Отчет_по_валютам.png|thumb|center| Пример отображения раздела «Отчёты» и категории «Отчёт по валютам»|800px]] | |||
С работой данного раздела можно ознакомиться по ссылке [https://wiki.smartplayer.org/index.php/%D0%9E%D1%82%D1%87%D1%91%D1%82%D1%8B_%D0%B2_%D0%BB%D0%B8%D1%87%D0%BD%D0%BE%D0%BC_%D0%BA%D0%B0%D0%B1%D0%B8%D0%BD%D0%B5%D1%82%D0%B5 здесь]. | |||
== '''Добавление виджета в личный кабинет''' == | == '''Добавление виджета в личный кабинет''' == | ||
Чтобы добавить данный виджет в личный кабинет, пользователю необходимо запросить у специалиста команды технической поддержки архив с содержимым. Он будет предоставлен в формате .zip - архива. | Чтобы добавить данный виджет в личный кабинет, пользователю необходимо запросить у специалиста команды технической поддержки архив с содержимым. Он будет предоставлен в формате .zip-архива. | ||
[[File: | [[File:Виджет_курс_валют.png|thumb|center| Пример виджета в формате .zip-архива|800px]] | ||
После этого пользователь должен авторизоваться в личном кабинете и перейти в раздел «Контент». | После этого пользователь должен авторизоваться в личном кабинете и перейти в раздел «Контент». | ||
[[File:Раздел_контент_личного_кабиента.png|thumb|center| Пример отображения раздела «Контент» в личном кабинете |800px]] | [[File:Раздел_контент_личного_кабиента.png|thumb|center| Пример отображения раздела «Контент» в личном кабинете |800px]] | ||
В разделе «Контент» необходимо перетянуть данный виджет из локального хранилища в личный кабинет. После того как пользователь перенесет виджет в личный кабинет, он отобразится в списке с контентом. | В разделе «Контент» необходимо перетянуть данный виджет из локального хранилища в личный кабинет. После того, как пользователь перенесет виджет в личный кабинет, он отобразится в списке с контентом. | ||
[[File: | [[File:Виджет_в_лк.png|thumb|center| Пример отображения переноса виджета в личном кабинете SmartPlayer|800px]] | ||
== '''Настройка виджета''' == | == '''Настройка виджета''' == | ||
После переноса виджета для первичной настройки пользователю необходимо дважды кликнуть по иконке. Данное действие перенесет его на главную страницу | После переноса виджета для первичной настройки пользователю необходимо дважды кликнуть по иконке виджета. Данное действие перенесет его на главную страницу. | ||
[[File: | [[File:Главная_страница_виджета_БКС.png|thumb|center| Пример отображения главной страницы виджета|800px]] | ||
На главной странице виджета можно | На главной странице виджета пользователю доступно две кнопки: | ||
[[File: | # Кнопка "API". | ||
# Кнопка «Настройки» | |||
[[File:Кнопка_api_и_настройки.png|thumb|center| Пример отображения иконки для перехода в настройки виджета|800px]] | |||
== '''Кнопка "API"''' == | |||
Кликнув на кнопку "API" пользователю откроется модальное окно с информацией о ресурсах, которые позволяют стабильно работать виджету. В разделе также есть общее описание о его необходимости и принципах работы. | |||
[[File:Данные_в_модальном_окне.png|thumb|center| Пример отображения информации в модальном окне |800px]] | |||
Основными параметрами для ресурсов являются: | |||
* имя — указано имя ресурса; | |||
* метод — используемый тип метода (GET); | |||
* требует авторизации — информация об обязательности авторизации; | |||
* адрес сервера — URL-адрес сервера, с которого берутся данные; | |||
* адрес API — отображается название JSON-файла с данными о ценах; | |||
* кнопка «Проверить соединение» — при нажатии проводит проверку соединения и отображает вывод с указанием числового статуса. | |||
Закрыть данное окно можно по стандартной иконке в правом верхнем углу. | |||
== '''Кнопка «Настройки»''' == | |||
После открытия страницы с настройками пользователю необходимо настроить следующие параметры виджета: | |||
* фон виджета — позволяет с помощью палитры настроить нужный фон для виджета; | |||
* фоновое изображение — выбрать изображение в качестве фона для виджета из личного кабинета SmartPlayer; | |||
* частота обновления данных от Центробанка — указать значение (в секундах), чтобы получать актуальные данные о ценах; | |||
* логотип — выбрать изображение в качестве логотипа для виджета из личного кабинета SmartPlayer; | |||
* текст в правой части «подвала» виджета — необходимо ввести текст сообщения; | |||
* размер в правой части «подвала» виджета — ввести значение или сместить ползунок для настройка шрифта текста; | |||
* форматирование отображения цен — выбрать из списка вариант форматирования; | |||
* изображение плейсхолдера — выбрать изображение в качестве плейсхолдера (заглушки) для виджета из личного кабинета SmartPlayer; | |||
* чекбокс «Отображать плейсхолдер» — включает/выключает плесхолдер (заглушку) в настройках виджета. При активации всегда показывается изображение плесхолдера (заглушки); | |||
* чекбокс «Отображать плейсхолдер при отсутствии соединения с удалённым сервером» — включает/выключает работу плейсхолдера (заглушки) при отсутствии соединения с сервером. | |||
* время, через которое скрывать цены и отображать плейсхолдер — указать время, через которое начинает работать плейсхолдер (заглушка). Время измеряется в секундах; | |||
* чекбокс «Анимация смены котировок» — включает/выключает работу анимации при смене значений котировок; | |||
* выбор языка — позволяет выбрать один из доступных языков — русский, английский, испанский, португальский, казахский. | |||
[[File:Настраиваемые_параметры_видежта.png|thumb|center| Пример отображения настраиваемых параметров виджета|800px]] | |||
== '''Завершение настройки виджета''' == | |||
После завершения работ по настройке виджета пользователь должен нажать на кнопку «Применить настройки» в правой нижней части экрана. | |||
[[File:Применение_настрок.png|thumb|center| Пример отображения кнопки «Применить настройки»|800px]] | |||
Далее виджет растянется на весь экран, и пользователь должен нажать на кнопку «Сохранить», внизу по центру экрана. | |||
[[File:Сохран.png|thumb|center| Пример отображения кнопки «Сохранить»|800px]] | |||
== '''Загрузка и скачивание настроек''' == | |||
В процессе взаимодействия с настройками виджета пользователь может загрузить или выгрузить настройки виджета. Каждое из указанных действий работает с помощью отдельных иконок в интерфейсе виджета. Иконки расположены в виджете снизу по центру. | |||
[[File:Иконки_загрузки.png|thumb|center| Пример отображения иконок в настройках виджета |800px]] | |||
== '''Добавление настроенного виджета в трансляцию''' == | |||
Чтобы полностью ознакомиться с работой данной функциональности, пользователю необходимо запустить трансляцию с расписанием и добавить в качестве контента данный виджет. Чтобы ознакомиться с описанными ранее шагами по созданию трансляции и расписания рекомендуется просмотреть следующие статьи из Wiki SmartPlayer: | |||
* [[Раздел "Устройства"]] | |||
* [[Раздел "Контент на устройства"]] | |||
* [[Раздел "Трансляции"]] | |||
* [[Раздел "Расписание"]] | |||
== '''Видеоинструкция''' == | == '''Видеоинструкция''' == | ||
[https://vk.com/video- | [https://vk.com/video-227547238_456239100 Инструкция по работе с виджетом «Курс валют»] | ||
== '''Дополнительная информация''' == | == '''Дополнительная информация''' == | ||
Если данная статья не помогает использовать функционал по назначению или после её прочтения остаются вопросы, их можно озвучить в разделе "Обсуждения" вверху страницы. | Если данная статья не помогает использовать функционал по назначению или после её прочтения остаются вопросы, их можно озвучить в разделе "Обсуждения" вверху страницы. | ||
[[File: | [[File:Обсуждение_виджета_курсы_валют.png|thumb|center| Пример отображения вкладки «Обсуждения» на wiki-странице |800px]] | ||
Также дополнительную информацию можно узнать на странице [[Как взаимодействовать пользователю с разделом "Обсуждения"]] | Также дополнительную информацию можно узнать на странице [[Как взаимодействовать пользователю с разделом "Обсуждения"]] | ||
</translate> | |||
Текущая версия от 22:03, 11 ноября 2025
Описание ситуации
Команда SmartPlayer разработала виджет, который позволяет пользователям добавлять файл с ценами на SFTP-сервер и передавать определённые цены на выбранные устройства. Возможность выбора конкретных устройств для передачи цен появилась в рамках доработки виджета.
Работоспособность виджета
Данный виджет работает:
- с версии серверного приложения: 2.151.1
Серверная логика
На сервер SmartPlayer пользователь загружает файл с данными по ценам с помощью SFTP. Сервер получает, хранит и обрабатывает информацию из файла. Через равные промежутки времени происходит переотправка (обновление) данных. Сервер парсит данные в виджет, который выводит их на устройства.
Примечание: доработанный виджет частично изменил свою реализацию. В файле который размещается на сервере появилось поле "department". В этом поле прописывается наименование департамента, которое впоследствии необходимо также указать в настройках устройства. Только устройства, у которых прописан департамент получают новые данные с ценами. Значение поля "department" в файле и на устройстве должны быть идентично, то есть иметь полное совпадение по написанию и регистру.
Настройка поля «Департамент»
Пользователю необходимо перенести значение поля "department" на нужные устройства, которые впоследствии будут работать в трансляции с виджетом. Для этого необходимо перейти в раздел «Устройства», выбрать нужное устройство и дважды кликнуть по нему.
После описанных выше действий откроется страница настройки устройства. Здесь необходимо найти поле «Код филиала» и точно ввести значение, которое указано в поле "department" файла для сервера и сохранить настройки.
Если данное устройство будет привязано к трансляции с виджетом курса валют, то оно будет получать только определенные данные для этого департамента.
Выгрузка отчёта по валютам
Пользователь может выгрузить отчёт по валютам в личном кабинете SmartPlayer. Для этого у него должна быть одна из двух ролей:
- Администратор.
- Администратор (трансляция с отчётом валют).
Сам отчёт можно выгрузить, перейдя в специальную категорию раздела «Отчёты» в категории «Отчёт по валютам».
С работой данного раздела можно ознакомиться по ссылке здесь.
Добавление виджета в личный кабинет
Чтобы добавить данный виджет в личный кабинет, пользователю необходимо запросить у специалиста команды технической поддержки архив с содержимым. Он будет предоставлен в формате .zip-архива.
После этого пользователь должен авторизоваться в личном кабинете и перейти в раздел «Контент».
В разделе «Контент» необходимо перетянуть данный виджет из локального хранилища в личный кабинет. После того, как пользователь перенесет виджет в личный кабинет, он отобразится в списке с контентом.
Настройка виджета
После переноса виджета для первичной настройки пользователю необходимо дважды кликнуть по иконке виджета. Данное действие перенесет его на главную страницу.
На главной странице виджета пользователю доступно две кнопки:
- Кнопка "API".
- Кнопка «Настройки»
Кнопка "API"
Кликнув на кнопку "API" пользователю откроется модальное окно с информацией о ресурсах, которые позволяют стабильно работать виджету. В разделе также есть общее описание о его необходимости и принципах работы.
Основными параметрами для ресурсов являются:
- имя — указано имя ресурса;
- метод — используемый тип метода (GET);
- требует авторизации — информация об обязательности авторизации;
- адрес сервера — URL-адрес сервера, с которого берутся данные;
- адрес API — отображается название JSON-файла с данными о ценах;
- кнопка «Проверить соединение» — при нажатии проводит проверку соединения и отображает вывод с указанием числового статуса.
Закрыть данное окно можно по стандартной иконке в правом верхнем углу.
Кнопка «Настройки»
После открытия страницы с настройками пользователю необходимо настроить следующие параметры виджета:
- фон виджета — позволяет с помощью палитры настроить нужный фон для виджета;
- фоновое изображение — выбрать изображение в качестве фона для виджета из личного кабинета SmartPlayer;
- частота обновления данных от Центробанка — указать значение (в секундах), чтобы получать актуальные данные о ценах;
- логотип — выбрать изображение в качестве логотипа для виджета из личного кабинета SmartPlayer;
- текст в правой части «подвала» виджета — необходимо ввести текст сообщения;
- размер в правой части «подвала» виджета — ввести значение или сместить ползунок для настройка шрифта текста;
- форматирование отображения цен — выбрать из списка вариант форматирования;
- изображение плейсхолдера — выбрать изображение в качестве плейсхолдера (заглушки) для виджета из личного кабинета SmartPlayer;
- чекбокс «Отображать плейсхолдер» — включает/выключает плесхолдер (заглушку) в настройках виджета. При активации всегда показывается изображение плесхолдера (заглушки);
- чекбокс «Отображать плейсхолдер при отсутствии соединения с удалённым сервером» — включает/выключает работу плейсхолдера (заглушки) при отсутствии соединения с сервером.
- время, через которое скрывать цены и отображать плейсхолдер — указать время, через которое начинает работать плейсхолдер (заглушка). Время измеряется в секундах;
- чекбокс «Анимация смены котировок» — включает/выключает работу анимации при смене значений котировок;
- выбор языка — позволяет выбрать один из доступных языков — русский, английский, испанский, португальский, казахский.
Завершение настройки виджета
После завершения работ по настройке виджета пользователь должен нажать на кнопку «Применить настройки» в правой нижней части экрана.
Далее виджет растянется на весь экран, и пользователь должен нажать на кнопку «Сохранить», внизу по центру экрана.
Загрузка и скачивание настроек
В процессе взаимодействия с настройками виджета пользователь может загрузить или выгрузить настройки виджета. Каждое из указанных действий работает с помощью отдельных иконок в интерфейсе виджета. Иконки расположены в виджете снизу по центру.
Добавление настроенного виджета в трансляцию
Чтобы полностью ознакомиться с работой данной функциональности, пользователю необходимо запустить трансляцию с расписанием и добавить в качестве контента данный виджет. Чтобы ознакомиться с описанными ранее шагами по созданию трансляции и расписания рекомендуется просмотреть следующие статьи из Wiki SmartPlayer:
Видеоинструкция
Инструкция по работе с виджетом «Курс валют»
Дополнительная информация
Если данная статья не помогает использовать функционал по назначению или после её прочтения остаются вопросы, их можно озвучить в разделе "Обсуждения" вверху страницы.
Также дополнительную информацию можно узнать на странице Как взаимодействовать пользователю с разделом "Обсуждения"
