Описание ПО (описание функциональных характеристик)

Описание ПО (описание функциональных характеристик)

1. Общие сведения.

1.1. Наименование программы.

1.1.1. Полное наименование программы: «IDGOS».

1.1.2. Программное обеспечение «IDGOS», является российской разработкой, организация-разработчик: ООО «СИНТЕГРА».

1.1.3. Сайт разработчика-правообладателя: «https://idgos.ru».

1.2. Назначение и область применения.

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

1.3. Основные функции.

1.3.1. Основной функцией «IDGOS» является подписание документов через авторизацию на ГосУслугах. Основная функция обеспечивается следующим набором функциональных возможностей:

- загрузка различных документов для подписи;

- выбор только тех документов, которые необходимо отправить клиенту для подписания;

- создание документа внутри сервиса;

- предпросмотр полученного результата;

- имеется опция по добавлению специальных переменных, которые будут заменены на данные клиента после авторизации на ГосУслугах;

- просмотр списка подписываемых документов (сторона подписывающего);

- просмотр подписанных документов (сторона подписывающего);

- скачивание подписанных документов на устройство (сторона подписывающего);

- идентификация клиента. Подтверждение клиента через портал ГосУслуг. Данные получаются и автоматически вставляются в шаблон подготовленного документа.

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

1.4. Требования к составу и параметрам технических средств.

1.4.1. Минимальные требования к аппаратной платформе.

1.4.1.1. Требования к аппаратной платформе не предъявляются. «IDGOS» построено на MVVM-архитектуре, обращается к серверу и не имеет аппаратной платформы.

1.4.2. Минимальные требования к пользовательской платформе.

1.4.2.1. Для бесперебойной работы «IDGOS» требуется любое устройство с доступом в глобальную сеть интернет и минимальными техническими требованиями:

- центральный процессор (должен иметь достаточную вычислительную мощность для выполнения задач);

- 1 ГБ оперативной памяти;

- 1 ГБ свободной постоянной памяти для установки и функционирования приложения;

- цветной сенсорный экран размером от 4.5 дюймов, разрешением HD и выше;

1.5. Требования к установленному общесистемному программному обеспечению.

1.5.1. Для обеспечения корректного функционирования приложение «IDGOS» на пользовательской платформе должно быть установлено следующее общесистемное программное обеспечение:

- допустима операционная система на базе Android версии 5.0 и выше (для обеспечения лучшей совместимости и доступа рекомендуем операционную систему на базе Android версии 6.0 и выше);

- операционная система как минимум на базе iOS 12 или выше;

- операционная система на базе Windows (для обеспечения лучшего доступа, рекомендуем использовать более современные версии);

- операционная система на базе macOS.

1.6. Разработка приложения.

1.6.1. Приложение «IDGOS» было разработано на языках программирования JavaScript и PHP в среде разработки VsCode, при разработке использовались React 18.2.0, MariaDB. 

2. Описание программы.

2.1. Структура программы.

2.1.1. Приложение «IDGOS» построено на MVVM-архитектуре с использованием шаблонов проектирования Interactor/Команда. MVVM является одним из архитектурных шаблонов, которые улучшают разделение задач и позволяет отделить логику пользовательского интерфейса от серверной логики. Архитектурный шаблон MVVM состоит из следующих компонентов:

- модельный слой (Model);

- представляет логику работы с данными и описание фундаментальных данных, необходимых для работы приложения;

- слой представления (View);

- представляет графический интерфейс (окна, списки, кнопки и пр.), выступает подписчиком на событие изменения значений свойств или команд, которые предоставляет слой модели представления. Если в модели представления меняется какое-либо свойство, она оповещает всех подписчиков об этом, и слой представления запрашивает обновлённое значение свойства из слоя модели представления. В случае, если пользователь воздействует на какой-либо элемент интерфейса, слой представления вызывает соответствующую команду, предоставленную слоем модели представления;

- слой модели представления (ViewModel);

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

2.2. Обобщённый алгоритм функционирования программы.

2.2.1. Сервис «IDGOS» построен на MVVM-архитектуре с использованием шаблонов проектирования Interactor/Команда. Все пользовательские данные для отображения хранятся на сервере. Наиболее часто используемые данные кэшируются в локальной базе данных.

2.2.2. Доступ к данным с сервера осуществляется через REST HTTP API.

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

2.2.4. При нажатии на такой компонент, возникает событие и запускаются различные сценарии работы приложения. Сценарии работы приложения обрабатываются в слое модели представления (ViewModel). При обработке запускаются соответствующие команды (Interactor), которые отправляют запрос на получение/изменение данных через API.

2.2.5. После обработки запроса, API возвращает данные и уведомляет об изменениях в Interactor, при этом создается API Callback. При получении ответа данные из него обрабатываются для сохранения в локальной базе данных и передаются в локальный репозиторий СУБД.

2.2.6. Слой модели представления (ViewModel) подписан на зависимые данные из базы данных, их значения опубликованы для подписки в слое представления (View). Слой представления (View), в свою очередь подписан на обновление данных для отображения. Таким образом, данные в слое представления (View) обновляются.

3.Вызов и загрузка.

3.1. Запуск в режиме постоянной эксплуатации.

3.1.1. Для запуска «IDGOS» необходимо зарегистрироваться и пройти авторизацию в личном кабинете во вкладках «Личный кабинет –> Регистрация» и «Личный кабинет –> Авторизация», после успешной авторизации вам будет доступен следующий функционал (Рисунок 1).

(Рис. 1)

3.1.2. Подписывающему для запуска «IDGOS» необходимо перейти по ссылке из смс и дождаться открытия программы. Если при открытии возникли неполадки, закройте и перейдите по ссылке повторно (Рисунок 2).

(Рис. 2)

3.2. Проверка функционирования программы.

3.2.1. Для проверки функционирования «IDGOS» необходимо выполнить несколько операций:

  1. зарегистрироваться и выполнить вход в личный кабинет;
  2. создать основной шаблон документа;
  3. сгенерировать документ на основе шаблона документа;
  4. отправить документы на подпись.

3.2.2. Подписывающему для проверки функционирования «IDGOS» достаточно:

  1. перейти по ссылке из смс;
  2. пройти авторизацию через ГосУслуги;
  3. ознакомится с документами в предпросмотре;
  4. ввести код подтверждения подписи из смс;
  5. проверить список подписанных документов.

4. Входные данные.

4.1. Входные данные.

4.1.1. Входными данными для приложения «IDGOS» являются данные:

- введённые пользователем при авторизации в личный кабинет;

- введённые при создании шаблона документа.

4.2. Выходные данные.

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