Виджет динамических показателей: различия между версиями

Материал из SmartPlayer
Строка 13: Строка 13:
[[File:Виджеты_в_лк.png|thumb|center| Пример отображения правильной сортировки, для более удобного поиска виджета |800px]]|warn}}
[[File:Виджеты_в_лк.png|thumb|center| Пример отображения правильной сортировки, для более удобного поиска виджета |800px]]|warn}}
== '''Подготовка SFTP-сервера''' ==
== '''Подготовка SFTP-сервера''' ==
Виджет работает совместно с SFTP-сервером. SFTP-сервер может быть развёрнут заранее у заказчика или же разворачиваться специально для работы с данными виджетом.<br>
На SFTP-сервер добавляется ".xlsx"-файл с определенными заполненными полями и данными.
{{Note|Пример файла для SFTP-сервера можно загрузить по [ссылке].|warn}}
Далее серверное приложение через определенный промежуток времени просматривает наличие файла (по умолчанию раз в 10 секунд, параметр изменяемый).<br>
При наличии нужного ".xlsx"-файла читает его и записывает информацию из него в базу данных (БД). После записи сам файл удаляется из кэша.<br>
Далее виджет запрашивает данные с помощью определенного метода у БД, расположенной на сервер. Сервер должно вернуть необходимые данные конкретно в виджет.<br>
Получив информацию с сервера виджет обрабатывает её и выводит на экран устройства.
Метод используемый для получения информации:
<code>  modules: {
    dynamicData: {
      enabledQ: true,
      sftp: {
        connectionConfig: {
          host: '***.***.***.,
          port: *****,
          user: *******',
          password: '************
        },
        checkIntervalCron: '*/10 * * * * *',
        rootDirectory: '/root-directory/'
      }
    }
  }
</code>
== '''Главная страница виджета''' ==
== '''Главная страница виджета''' ==
После открытия виджета в личном кабинете SmartPlayer в разделе "Контент", пользователь увидит главную страницу виджета. На ней будет отображены нужные показатели (если SFTP сервер правильно настроен и отдаёт данные на виджет) и иконка настроек, в виде шестерёнки.
После открытия виджета в личном кабинете SmartPlayer в разделе "Контент", пользователь увидит главную страницу виджета. На ней будет отображены нужные показатели (если SFTP сервер правильно настроен и отдаёт данные на виджет) и иконка настроек, в виде шестерёнки.

Версия от 09:36, 19 марта 2025

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

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

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

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

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

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

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

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

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

Пример отображения переноса виджета с помощью drag-n-drop
Если у пользователя много различного контента в личном кабинете, то он может воспользоваться функцией сортировки и выбрать нужный тип контента "Виджет". Воспользовавшись данной функциональностью, он сможет просмотреть все добавленные в личный кабинет виджеты.
Пример отображения правильной сортировки, для более удобного поиска виджета

Подготовка SFTP-сервера

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

Пример файла для SFTP-сервера можно загрузить по [ссылке].

Далее серверное приложение через определенный промежуток времени просматривает наличие файла (по умолчанию раз в 10 секунд, параметр изменяемый).
При наличии нужного ".xlsx"-файла читает его и записывает информацию из него в базу данных (БД). После записи сам файл удаляется из кэша.
Далее виджет запрашивает данные с помощью определенного метода у БД, расположенной на сервер. Сервер должно вернуть необходимые данные конкретно в виджет.
Получив информацию с сервера виджет обрабатывает её и выводит на экран устройства. Метод используемый для получения информации: modules: {

   dynamicData: {
     enabledQ: true,
     sftp: {
       connectionConfig: {
         host: '***.***.***.,
         port: *****,
         user: *******',
         password: '************
       },
       checkIntervalCron: '*/10 * * * * *',
       rootDirectory: '/root-directory/'
     }
   }
 }

Главная страница виджета

После открытия виджета в личном кабинете SmartPlayer в разделе "Контент", пользователь увидит главную страницу виджета. На ней будет отображены нужные показатели (если SFTP сервер правильно настроен и отдаёт данные на виджет) и иконка настроек, в виде шестерёнки. Чтобы перейти в настройки виджета пользователю необходимо нажать на иконку шестеренки.

Пример отображения иконки настроек

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

Перейдя с помощью иконки в виде шестерёнки пользователю откроется страница настроек виджета. На этой странице пользователь может настроить следующие параметры:

  • Выбор языка - позволяет выбрать один из доступных языков для работы с виджетом: русский, английский, испанский, португальский, казахский
  • URL-адрес сервера - прописывается URL-адрес для подключения по API. Например: "https://develop-api.smartplayer.org/"
  • ID-устройства - указывается идентификатор устройства, который можно получить просмотреть для каждого устройства отдельно в параметрах устройства в разделе "Устройства". Пример ID-устройства: "3ac6f92191bdc4ecb96e23019202fead6cf6959131b6723eaa9b7c00c8c3a4e2"
  • Шрифт - позволяет выбрать один из доступных для виджета шрифтов: "Helvetica", "Pixeloid Sans","Dited"
  • Чекбокс(галочка) отображать на всю ширину экрана - активирует функциональность растягивания на всю ширину экрана, после создания трансляции с данным виджетом на устройстве
  • Интервал смены таблицы - указывается время (в секундах), через которое будет меняться отображаема на экране таблица
Пример отображения настроек виджета

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

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

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

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

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

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

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

Виджет контроля показателей

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

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

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

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