Документация программного обеспечения «М-Сервис»

2.1. Управление компаниями и пользователями

Программное обеспечение обеспечивает:

• создание и редактирование компаний;
• создание пользователей компаний;
• назначение ролей и управление доступами;
• привязку пользователей к компаниям;
• разграничение доступа пользователей к данным;
• восстановление пароля по электронной почте;
• просмотр активности пользователей.

Администратор программного обеспечения имеет возможность управлять всеми компаниями и пользователями.

Клиентские пользователи работают с данными и объектами своей компании в соответствии с предоставленными им правами доступа.

2.2. Управление точками вещания

Точка вещания представляет собой объект, на котором осуществляется воспроизведение аудиоконтента с использованием программного плеера «М-Сервис».

Программное обеспечение обеспечивает:

• создание, редактирование и удаление точек вещания;
• объединение точек вещания в группы;
• настройку рабочего времени;
• настройку параметров воспроизведения;
• массовое управление точками посредством групп;
• просмотр состояния точек вещания;
• просмотр истории событий;
• контроль состояния кэширования контента.

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

2.3. Управление аудиоконтентом

Программное обеспечение поддерживает следующие основные типы аудиоконтента:

• музыкальные треки;
• рекламные аудиоролики;
• информационные аудиоролики.

Для аудиоконтента предусмотрены:

• загрузка аудиофайлов;
• хранение аудиофайлов;
• редактирование информации о контенте;
• структурирование контента по группам;
• управление составом групп;
• распределение контента в соответствии с доступами компаний;
• использование контента при формировании расписаний вещания;
• удаление контента.

Аудиофайлы хранятся в S3-совместимом объектном хранилище.

2.4. Настройка задач и расписаний вещания

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

Поддерживаются музыкальные, рекламные и информационные задачи вещания.

При настройке задач могут задаваться:

• точка или группа точек вещания;
• используемый аудиоконтент;
• период активности задачи;
• дни недели;
• временные интервалы;
• дата начала и окончания действия;
• приоритет задачи.

Также поддерживаются однократные, периодические и специальные сценарии воспроизведения.

При формировании расписания учитываются рабочее время точки, действующие задачи, их параметры и приоритеты.

На основании заданных настроек программное обеспечение формирует расписание воспроизведения аудиоконтента для каждой точки вещания.

2.5. Воспроизведение аудиоконтента

Воспроизведение осуществляется программным плеером «М-Сервис», работающим на устройстве точки вещания.

Плеер обеспечивает:

• получение расписания вещания;
• загрузку необходимых аудиофайлов;
• локальное кэширование аудиофайлов;
• воспроизведение контента в соответствии с расписанием;
• применение настроек воспроизведения;
• передачу событий и технической информации серверной части программного обеспечения.

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

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

2.6. Сбор событий и журналирование

Программное обеспечение собирает информацию о работе точек вещания.

Фиксируются, в частности:

• события воспроизведения музыкального контента;
• события воспроизведения рекламного контента;
• события воспроизведения информационного контента;
• ошибки работы плеера;
• изменения параметров воспроизведения;
• события запуска и завершения вещания;
• технические события работы программного обеспечения.

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

2.7. Мониторинг

Программное обеспечение позволяет контролировать техническое состояние точек вещания.

Плееры передают информацию, необходимую для мониторинга, включая:

• состояние подключения;
• состояние кэширования контента;
• технические показатели работы;
• скорость загрузки контента;
• ошибки воспроизведения;
• состояние соединения с серверной частью.

Полученные данные доступны для контроля и диагностики работы программного обеспечения.

2.8. Отчетность

Программное обеспечение позволяет формировать отчеты о работе системы и воспроизведении аудиоконтента.

Поддерживаются:

• системные отчеты;
• отчеты по музыкальному контенту;
• отчеты по рекламному контенту;
• отчеты по информационному контенту.

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

2.9. Управление и обмен данными в реальном времени

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

Механизм используется для:

• получения информации о состоянии точек вещания;
• определения статуса подключения;
• передачи служебной информации;
• обновления данных о работе плееров;
• выполнения предусмотренных программным обеспечением управляющих операций.

3.1. Требования к серверной инфраструктуре

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

процессор

не менее 4 vCPU

оперативная память

не менее 8 ГБ

дисковое пространство

не менее 80 ГБ SSD

операционная система

Ubuntu 22.04 LTS или эквивалентная

сеть

постоянное подключение к сети Интернет

Для развертывания используются контейнерные средства.

Программное окружение включает:

• Docker;
• Kubernetes либо эквивалентную контейнерную среду;
• PostgreSQL;
• S3-совместимое объектное хранилище;
• nginx.

Фактический объем дискового пространства, необходимого для хранения пользовательского аудиоконтента, определяется количеством и объемом загруженных аудиофайлов.

3.2. Требования к клиентскому устройству

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

процессор

не менее 2 CPU

оперативная память

не менее 2 ГБ

браузер

современный веб-браузер

аудио

возможность воспроизведения аудио

сеть

подключение к сети Интернет

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

Инструкция по установке

Подробное описание требований к среде, подготовки компонентов, настройки базы данных и файлового хранилища, конфигурации, запуска программного обеспечения и проверки его работоспособности приведено в инструкции по установке.

Инструкция по установке экземпляра программного обеспечения «М-Сервис» для экспертизы (PDF)

6.1. Вход в систему

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

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

6.2. Работа с точками вещания

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

Для точки вещания могут быть настроены:

• принадлежность компании;
• рабочее время;
• параметры воспроизведения;
• используемый контент;
• задачи и расписание вещания.

Для массового управления точки могут объединяться в группы.

6.3. Работа с аудиоконтентом

Для добавления аудиоконтента необходимо:

1. Перейти в соответствующий раздел управления контентом.
2. Выбрать добавление нового трека или ролика.
3. Выбрать аудиофайл.
4. Указать необходимую информацию о контенте.
5. Сохранить изменения.

После загрузки контент становится доступен для дальнейшего использования в соответствии с установленными правами доступа.

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

6.4. Настройка вещания

Для создания задачи вещания необходимо:

1. Выбрать точку или группу точек вещания.
2. Выбрать тип задачи.
3. Выбрать необходимый аудиоконтент.
4. Установить период действия задачи.
5. Настроить дни и время воспроизведения.
6. Сохранить задачу.

На основании созданных задач программное обеспечение формирует расписание вещания.

6.5. Работа программного плеера

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

В процессе работы плеер:

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

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

После восстановления соединения взаимодействие с серверной частью возобновляется.

6.6. Контроль состояния точек вещания

Состояние точек вещания контролируется через веб-интерфейс программного обеспечения.

Доступна информация о:

• состоянии подключения;
• последней активности;
• событиях работы;
• ошибках;
• состоянии кэширования контента;
• технических показателях работы.

Эта информация используется для контроля эксплуатации и диагностики возникающих проблем.

6.7. Формирование отчетов

Для получения отчета пользователь:

1. Переходит в соответствующий раздел отчетности.
2. Выбирает необходимый тип отчета.
3. Указывает период.
4. Формирует отчет.
5. Сохраняет сформированный файл.