Интеграция с бакетом через S3 в рамках SmartPlayer

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

В платформе SmartPlayer появилась возможность настраивать синхронизацию папок с S3-бакетом с помощью правил smartFolder. После активации правила папка становится smart-папкой, и система начинает считывать файлы из указанного бакета, копируя их на серверное приложение SmartPlayer.

Логика работы

После активации правила S3 выбранная папка становится smart-папкой. С этого момента серверное приложение SmartPlayer начинает обращаться к указанному S3-бакету, считывать хранящиеся в нём файлы и копировать их на сервер SmartPlayer.
При синхронизации из каждой папки скачиваются все доступные файлы. При копировании сохраняется название папки, указанное со стороны клиента. Если в скачиваемой папке находится, например, файл `led_order_mate.json`, он не загружается как отдельный файл, а используется как описание к папке, так как серверное приложение SmartPlayer не выгружает JSON-файлы как самостоятельный контент.
Настроенное правило S3 можно отредактировать или удалить. При удалении правила синхронизация smart-папки с S3-бакетом отключается.

Алгоритм действий

Для того чтобы воспользоваться функционалом, пользователю необходимо зарегистрироваться или авторизоваться в личном кабинете SmartPlayer.
Следующим шагом ему необходимо перейти в раздел «Контент» и выбрать строку «Создать папку».

Пример отображения раздела «Контент» и строки «Создать папку»

В процессе создания папки будет отображено модальное окно, в котором необходимо ввести название папки. Завершить создание папки можно по нажатию на кнопку «Создать».

Пример отображения модального окна для создания папки

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

Пример отображения выделения папки и панели управления

В панели управления пользователю необходимо нажать на строку «Правила» и открыть модальное окно для создания правил.

Пример отображения строки «Правила»

Чтобы создать новое правило, пользователь должен нажать на иконку «+» в модальном окне.

Пример отображения выделения папки и панели управления

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

Пример отображения страницы создания правил и параметра «Название правила»

Данную страницу необходимо прокрутить почти до конца, найти раздел «Хранилище S3» и активировать его с помощью переключателя.

Пример отображения выделения папки и панели управления

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

• интервал обновления — указывается числовое значение периода поиска файлов внутри хранилища. Измеряется в минутах;
• путь в папке хранилища — путь в рамках хранилища. Можно использовать символ «/». В таком случае система будет искать файлы по всем папкам в хранилище;
• ключ доступа — прописать или вставить ключ доступа, необходимый для работы системы, который пользователь получает после регистрации на платформе S3;
• секретный ключ доступа — прописать или вставить секретный ключ доступа, необходимый для работы системы, который пользователь получает после регистрации на платформе S3;
• регион — прописать название региона. Информация о регионе также доступна при регистрации на S3;
• бакет — указать идентификатор бакета в виде уникальной ссылки с расположением бакета, которую можно получить при регистрации на S3;
• адрес хоста — прописать или вставить URL-адрес хоста, где расположен бакет.

Пример отображения включённого переключателя для настроек S3 и активных полей для заполнения

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

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

После сохранения правила пользователя вернёт к модальному окну со списком правил. Созданное правило можно отредактировать или удалить по иконкам, которые отображаются при наведении на правило.

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

Чтобы выйти из модального окна и продолжить взаимодействие, необходимо нажать на кнопку «Закрыть».

Папка с правилами для загрузки файлов с S3

После того как пользователь выполнит все описанные выше действия, его вернёт на страницу со списком папок. Папка с правилом получит подпись «Smart» и станет «Smart-папкой».

Подробнее о «Smart-папке» можно узнать в разделе «Полезная информация».

Пример отображения «Smart-папки» в личном кабинете

По истечении времени, указанного в параметре «Интервал обновления», система начнёт загрузку данных из S3-бакета и отобразит их внутри загруженной папки.

Пример отображения загруженных файлов в папке

Загрузка JSON в папку

Серверное приложение SmartPlayer не поддерживает прямую загрузку JSON-файлов, поэтому все скачанные из бакета JSON-файлы будут отображаться в описании папки. Его можно открыть, нажав на иконку «Редактировать». Таким образом откроются параметры папки.

Пример отображения JSON-файла, отображаемого в описании папки

Полезная информация

В этом разделе будут представлены статьи, с которыми рекомендуется ознакомиться, чтобы лучше понимать возможности, предоставляемые платформой:

• Смарт папка

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

Интеграция с бакетом и скачивание файлов

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

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

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

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