Документация

2NETS APP PLATFORM

(Альтернативное название - Облачная платформа Cloud2)

 

1. Общие сведения о программном продукте

2NETS APP PLATFORM – цифровая платформа для разработки и эксплуатации апплетов (мини-приложений, функционирующих в мобильных приложениях платформы) и веб-сервисов (сервисов функционирующих web-клиенте платформы).

Платформа предоставляет клиентам набор инструментов и интерфейсов программирования для создания апплетов (сервисов).

Web-приложение и мобильные приложения платформы содержат набор программных инструментов для запуска и выполнения разработанных с использованием web-технологий апплетов (сервисов).

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

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

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

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

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

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

Мобильные приложения компилируются из исходного кода специалистами разработчика и размещаются в принадлежащих заказчикам аккаунтах магазинов приложений App Store и Google Play Market. Доступ к указанным аккаунтам организуется заказчиком и обеспечивается штатными средствами магазинов приложений.

Веб-приложение поставляется в составе набора серверного ПО и инсталлируются на серверах заказчика специалистами разработчика.

В случае, если клиентом будет выбран облачный вариант поставки программного комплекса, веб-приложение будет поставлено в составе облачного ПО.

Мобильные приложения и веб-приложение обладают идентичными функциональными возможностями.

Заказать комплект ПО или облачную истанцию платформы, запросить демонстрацию работы платформы, получить консультацию специалистов можно по электронной почте  order@clouduo.ru.

Компект документации по установке и обслуживанию платформы включен в состав поставки.

В случае поставки платформы в виде набора дистрибутивов, предполагается, что эти сервисы будут развернуты заказчиком самостоятельно для организации отказоустойчивой локальной архитектуры. Все работы по настройке отказоустойчивости этих сервисов также остаются на стороне заказчика. Развертывание программного комплекса и обслуживание платформы обеспечивается специалистом DevOps с опытом администрирования операционных систем Linux и работы с ПО для автоматизации развёртывания и управления приложениями в средах с поддержкой контейнеризации Docker.

Перед установкой необходимо сконфигурировать среду, для этого нужно отредактировать конфигурационные файлы .env, .confs.tpl, .creds., входящие в состав дистрибутива.

Файлы и директории в составе дистрибутива.

bootstrap.sh <— скрипт предварительной настройки сервера/среды.

.env <— файл с переменными среды для docker-compose. Содержит в себе порты, имена хостов, адреса контейнеров.

docker-compose.yml <— файл docker compose.

git <— директория, куда клонируются репозитории узлов (если репозитории имеется).

gitless <— здесь хранятся файлы проекта, которые не имеют (или не могут иметь) репозитории.

.confs.tpl <— в этом файле собраны переменные из всех конфигурационных файлов, а также ссылки на git-репозитории для гибкого изменения. Это - файл-шаблон.

.creds <— содержит такую же информацию, как и .env, но только для узлов работающих на реальных серврерах (не в среде контейнеризации Docker).

Установка программного комплекса на одном сервере осуществляется посредством выполнения команд:

bootstrap.sh
//Запускает скрипт, который выполняет предварительную настройку сервера, скачивает репозитории кода, настраивает программные серверы, создает базы данных в СУБД и т.д.

docker-compose up 2netscmmnt-builder
//Эта команда устанавливает сервисы и компилирует набор опциональных коммуникационных модулей.

docker-compose up -d
//Команда запускает всю среду контейнеризации.

3. Базовая функциональность платформы

2NETS APP PLATFORM (далее 2NETS или платформа) – цифровая платформа для разработки и эксплуатации апплетов (мини-приложений, функционирующих в мобильных приложениях платформы) и веб-сервисов (сервисов функционирующих web-клиенте платформы).

Клиентские приложения платформы содержат набор программных инструментов для запуска и выполнения разработанных с использованием web-технологий апплетов (сервисов).

Апплеты (сервисы), а также инструменты для поиска и управления ими доступны на экране «Приложения». Апплеты (сервисы) взаимодействуют с серверной частью платформы посредством защищённого соединения и реализуют свою функциональность в мобильных приложениях посредством WebView интерфейса.

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

Запуск апплета на мобильном устройстве осуществляется нажатием соответствующей иконки на экране приложения. В веб-версии апплеты запускаются и функционируют в веб-интерфейсе.

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

Клиентское приложение программного комплекса содержит 5 основных модулей:

  • «Каналы» (опционально) – демонстрирует динамически обновляемую новостную ленту, формируемую в хронологическом порядке из контента каналов, на которые подписан пользователь;
  • «Мероприятия» – сервис планирования задач и мероприятий (опционально);
  • «Чаты» (опционально) – главный экран мессенджера, на котором также доступен список пользовательских контактов;
  • «Приложения» – экран апплетов (сервисов), содержит иконки апплетов. Иконки апплетов (сервисов), позволяют запускать апплет (сервис) в приложении платформы, при этом данный экран становится родительским для выполняемого апплета;
  • «Настройки» – экран, содержащий настройки профиля пользователя.

Платформа включает в себя веб-сервис для разработчика и набор интерфейсов программирования, которые позволяют авторизованным пользователям платформы интегрировать веб-сервисы в клиентские приложения платформы, создавать апплеты (сервисы).

3.1. Инструменты разработки и администрирования платформы

Инструменты разработчика предоставляют уполномоченному представителю заказчика, авторизованному в web-среде программного комплекса интерфейсы для управления инстанцией программного комплекса.

Так заказчик самостоятельно может следующие полномочия:

1.    В части управления апплетами (сервисами):  

  • Создавать апплеты (сервисы);
  • Управлять доступом к апплетам (сервисам);
  • Настраивать экран апплетов.

2.    В части управления мессенджером (опционально), пользователями и контентом управлять:

  • Пользователями;
  • Контактами пользователей;
  • Черными списками пользователей;
  • Персональными чатами;
  • Группами;
  • Каналами;
  • Инструментами фильтрации контента.

3.    В части управления чат-ботами (опционально) и интеграциями в сторонние сервисы:

  • Создавать чат-боты;
  • Управлять доступом чат-ботов к данным приложений и пользователей;
  • Управлять инструментами геолокации.
3.2. Апплеты (сервисы)

Апплеты (сервисы) и чат-боты апплетов платформы обеспечивают взаимодействие пользователей платформы с информационными системами заказчика.

Экран апплетов (сервисов) или экран приложений – демонстрируемый пользователям мобильных и веб-приложений набор элементов интерфейса, содержащий иконки апплетов. Иконки апплетов (сервисов), позволяют запускать апплет (сервис) в приложении платформы.

Апплет (сервис) представляет собой web-сервис с интегрированным программным компонентом, обеспечивающим авторизацию пользователей апплетов (сервисов) с учетными данными платформы. Авторизация производится по открытому протоколу OAuth.

Новый апплет (сервис) на платформе разрабатывается как web-сервис и интегрируется в платформу посредством инструментов разработчика. Действующие web-сервисы также могут быть интегрированы в платформу. Деплоймент новых версий сервисов не требует публикации обновленной версии мобильного приложения.

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

3.2. Мессенджер (опционально)

Опционально в состав поставки может быть включен мессенджер. Он обеспечивает обмен зашифрованными (AES-256) текстовыми сообщениями, фотографиями, видеороликами, аудиосообщениями и другими данными. Мессенджер предоставляет пользователям все возможности коммуникации в персональных и групповых чатах.

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

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

4. Документация

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

Ознакомиться с документацией разработчиков можно на примере демонстрационного проекта платформы - "Сообщество" по адресу http://developer.cmmnt.net.

После регистрации в демонстрационном проекте платформы "Сообщество" по адресу: https://ru.community авторизованному пользователю по адресу: http://developer.cmmnt.net предоставляется доступ в кабинет разработчика.

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

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

Руководство пользователя web-клиента платформы

5. Демонстрационный проект

Суперприложение "Сообщество" – пилотный проект платформы 2NETS. Суперприложение "Сообщество" доступно по адресу: https://ru.community, а также в магазинах приложений для операционных систем iOS – https://apps.apple.com/ru/app/id1457671987 и Android – https://play.google.com/store/apps/details?id=com.netsnets.community.

В "Сообществе" более 50 тысяч пользователей из десятков стран.

"Сообщество" предоставляет разработчикам открытый доступ к инфраструктуре платформы. Апплеты (сервисы) после их публикации в платформе будут доступны только их авторам. Публикация апплетов (сервисов) для всех пользователей или для отдельных групп пользователей возможна после модерации. Информация о механизме модерации содержится в документации для разработчиков. Дополнительную информацию о возможностях работы в демонстрационном проекте платформы можно получить, отправив заявку на электронную почту info@clouduo.ru.