ОБЩЕСТВО С ОГРАНИЧЕННОЙ ОТВЕТСТВЕННОСТЬЮ
105064, г. Москва, пер. Подсосенский, д. 13, ИНН 7709735865, КПП 770901001,
тел. (964) 729-82-08, e-mail: abc-consult@qip.ru
ТЕХНИЧЕСКАЯ И ЭКСПЛУАТАЦИОННАЯ ДОКУМЕНТАЦИЯ НА
МОДЕРНИЗИРОВАННУЮ АИС МРС МФЦ
РУКОВОДСТВО ПРОГРАММИСТА
Государственный контракт № ГК-179-ОФ/Д21 от 22 декабря 2014 года
Москва 2015
АННОТАЦИЯ
В данном программном документе приведено руководство программиста по настройке, использованию и доработке программы АИС МРС МФЦ.
В данном программном документе, в разделе «Назначение и условия применения программы» указаны назначение и функции, выполняемые программой, условия, необходимые для выполнения программы (объем оперативной памяти, требования к составу и параметрам периферийных устройств, требования к программному обеспечению и т.п.).
В разделе «Характеристика программы» приведено описание основных характеристик и особенностей программы (режим работы, средства контроля правильности выполнения и самовосстанавливаемости программы и т.п.).
В данном программном документе, в разделе «Входные и выходные данные» приведено описание организации используемой входной и выходной информации.
В разделе «Сообщения» указаны тексты сообщений, выдаваемых программисту или оператору в ходе выполнения программы, описание их содержания и действий, которые необходимо предпринять по этим сообщениям.
-
НАЗНАЧЕНИЕ И УСЛОВИЯ ПРИМЕНЕНИЯ ПРОГРАММЫ
-
Назначение системы
АИС МРС МФЦ призвана обеспечить Министерству экономического развития Российской Федерации условия для эффективной реализации функции по мониторингу создания многофункциональных центров, в том числе на основе получения качественной и оперативной информации о создании многофункциональных центров на территории Российской Федерации и о достижении целевого показателя по охвату населения предоставлением государственных и муниципальных услуг по принципу «одного окна» с целью принятия управленческих решений в указанной сфере.
-
Функции, выполняемые программой
Основной функцией программы является обеспечение просмотра, ввода и редактирования сведений о развитии сети МФЦ РФ, подготовки аналитических отчетов, на основании накопленной информации. Доступ пользователей к просмотру и редактированию данных разграничивается на уровне ролевой модели прав, реализованной в АИС МРС МФЦ.
-
Условия, необходимые для выполнения программы
1.Объем оперативной памяти
Для выполнения своих функций, программе достаточно:
256 Мб оперативной памяти на рабочей станции пользователя;
2048 Мб оперативной памяти на сервере приложений;
3 Гб оперативной памяти на сервере БД.
Однако, поскольку часть ОЗУ неизбежно занимает операционная система, то рекомендуется использовать программу на оборудовании, имеющем следующие параметры:
более 512 Мб оперативной памяти на рабочей станции пользователя;
более 3 Гб оперативной памяти на сервере приложений;
более 4 Гб оперативной памяти на сервере БД.
2.Требования к составу периферийных устройств
Для работы необходимо наличие следующих периферийных устройств:
выделенного объема дискового пространства не менее 2 Тб на сервере БД;
наличие подключения к локальной вычислительной сети и сети Интернет у сервера приложений и сервера БД;
наличие подключения к сети Интернет на рабочей станции пользователя.
3.Требования к параметрам периферийных устройств
Периферийные устройства, требуемые для работы программы, должны иметь следующие параметры:
выделенное дисковое пространство должно быть размещено на дисковом RAID массиве не ниже уровня 5 (RAID-5);
локальная вычислительная сеть должна иметь пропускную способность способностью не ниже 100Мб/сек;
подключение к сети Интернет на рабочей станции должно обеспечивать пропускную способность не менее 100 Кб/сек.
4.Требования к программному обеспечению
АИС МРС МФЦ рассчитана на функционирование в следующей программной среде:
-
серверная часть:
базовая ОС – операционная система на базе Linux (Centos, Ubuntu, Debian и пр.) с версией ядра не ниже 2.6;
система управления базами данных – MongoDB версия не ниже 2.4.10;
JRE/JDK версии 7.21 и выше;
сервер приложений Apache Tomcat 7
-
клиентская часть:
базовая ОС – Windows XP/Vista/7/8; Linux; Android; iOS, MacOS;
браузеры – Chrome Desktop 28 и выше, Safari Desktop 5 и выше, Firefox Desktop 25 и выше, Internet Explorer 9 и выше.
Для доработки программы рекомендуется использовать следующее программное обеспечение:
Интегрированная среда разработки: Intellij IDEA или Eclipse
Клиент доступа к базе данных: Robomongo
Допускается использование иного программного обеспечения, позволяющего редактировать программный код приложения и обеспечивающего доступ к базе данных по усмотрению разработчика.
5.Требования к программисту
Программист должен иметь минимум среднее техническое образование и обладать всеми необходимыми навыками для решения следующих задач:
задача поддержания работоспособности программы;
доработка программы по требованиям пользователей системы.
В минимальный набор знаний и навыков программиста должны входить следующий набор технологий:
знание языков программирования: JAVA, JavaScript,
знание основ работы с нереляционными (No SQL) базами данных
-
ХАРАКТЕРИСТИКА ПРОГРАММЫ
-
Описание основных характеристик программы
6.Режим работы программы
Режим работы программы - круглосуточный, непрерывный.
7.Средства контроля правильности выполнения программы
Контроль правильности выполнения программы осуществляется через файлы логов программы и компонентов системы, обеспечивающих функционирование программного обеспечения на стороне сервера. В случае возникновения исключительных ситуаций, которые не могут быть обработаны средствами системы, информация о них выводится в файлы логов (расположение файлов логов задается в конфигурационных файлах программы и зависит от версии используемой операционной системы и настроек конкретного сервера).
-
Самовосстанавливаемость программы
Серверные компоненты программы имеют возможность работы в режиме, когда не требуется их ручное восстановление после сбоев или после перезагрузки компьютера. Такой режим функционирования системы обеспечивается конфигурацией операционной системы в целом, и всех ее компонентов в частности (автостарт сервисов после перезагрузки и/или сбоев).
-
ОБРАЩЕНИЕ К ПРОГРАММЕ
-
Загрузка и запуск программы
Поскольку на сервере, содержащем код программы, настроен и протестирован автозапуск всех технологических компонент: веб-сервер, сервер БД, сервер приложений и др., то для запуска программы необходимо лишь включить сервер (виртуальную машину) и дождаться полного запуска операционной системы.
В случае, если требуется осуществить запуск компонент в ручном режиме, необходимо пользоваться следующими командами:
/opt/apache-tomcat-7.0.56/bin/startup.sh
#запуск сервера приложений *
service mongod status
#запуск сервера БД *
* механизм запуска службы может отличаться в зависимости от версии операционной системы, версии приложения и настроек конкретного сервера.
-
Выполнение программы
8.Выполнение функции ввода, редактирования и публикации сведений в Системе
Система функционирует в непрерывном режиме.
Функция ввода данных осуществляется как пользователями в ручном режиме, на основании прав доступа пользователя, в зависимости от принадлежности к той или иной группе пользователей, так и в автоматическом режиме в рамках расчета и подготовки аналитических данных. Публикация осуществляется по мере ввода пользователями информации, после подтверждения корректности внесенной информации по некоторым объектам учета.
Также возможно осуществление импорта больших объемов данных в Систему с использованием прав администратора АИС МРС МФЦ
9.Выполнение функции предоставления прав доступа к АИС МРС МФЦ
Функция предоставления прав доступа пользователям осуществляется через визуальный интерфейс программы пользователями, имеющими административные права в системе. Если в программе нет ни одного пользователя, имеющего административные права, программа при первом обращении к ней предложит создать такого пользователя.
Права доступа проверяются при вводе логина и пароля пользователя. После ввода логина/пароля, пользователю будет доступен функционал, определяемый его правами доступа.
-
Завершение работы программы
Завершение работы серверной части программного обеспечения осуществляется остановкой сервера приложений (Apache Tomcat). Остановка со стороны сервера только приложения Базы данных недопустимо (т.к. непосредственно приложение продолжит свою работу, но не сможет корректно функционировать в виду отсутствия доступа к массиву данных приложения). Завершение работы серверной части программного обеспечения приводит к невозможности доступа всех пользователей в АИС МРС МФЦ до момента восстановления полной рабостпособности приложения.
Закрытие окна браузера пользователем приводит к завершению работы клиентской части приложения на компьютере конкретного пользователя. В таком случае серверная часть приложения остается функционировать в непрерывном режиме и продолжает обеспечивать доступ всем остальным пользователям к данным и функциям АИС МРС МФЦ в полном объеме.
-
ВХОДНЫЕ И ВЫХОДНЫЕ ДАННЫЕ
-
Организация используемой входной информации
Программа получает входную информацию:
в текстовом виде через визуальный интерфейс системы, при этом, в отдельных случаях допускается дополнение текстовых сведений, введенных через визуальный интерфейс, бинарными документами, которые сохраняются в БД программы «как есть», без какой-либо предварительной или последующей обработки;
посредством импорта данных (для больших массивов данных).
-
Организация используемой выходной информации
Программа предоставляет выходные данные пользователям посредствам визуального интерфейса, а также через возможность генерации типовых отчетов по заложенным в системе алгоритмам и гибких отчетов по заданным пользователем параметрам в формате pdf, doc, docx, xls, xlsx.
-
СООБЩЕНИЯ
-
Сообщение об ошибке
При возникновении ошибки (необработанного исключения) в программе, например, при ошибочной работе сервера БД, в логах системы будет следующее сообщение:
SEVERE: Servlet.service() for servlet [dispatcher] in context with path [/AisRestApp] threw exception [Request processing failed; nested exception is java.lang.NullPointerException] with root cause
java.lang.NullPointerException
at ais.spring.web.utils.DomainVOConverter.convertToFormVO(DomainVOConverter.java:60)
at ais.spring.web.utils.DomainVOConverter.convertToVO(DomainVOConverter.java:35)
at ais.spring.web.service.impl.FormServiceImpl.getFormById(FormServiceImpl.java:62)
at ais.spring.web.controller.BaseController.getForm(BaseController.java:79)
at sun.reflect.GeneratedMethodAccessor26.invoke(Unknown Source)
В тексте сообщения об ошибки присутствует строка «Exception», после которой идет текст ее описания.
При получении данного сообщения, необходимо по стеку вызова, приведенному в сообщении, найти в исходном коде строку, на которой возникла исключительная ситуация, проанализировать проблему и устранить ее изменением исходного кода программы либо данных, хранящихся в БД программы.
Сообщение о неуспешной авторизации
При неуспешной авторизации пользователя в логах системы появится следующее сообщение:
Jun 05, 2014 2:43:22 PM org.springframework.web.context.support.ApplicationContext doLogin
WARN: Authorization failed
Сообщение об успешной авторизации
При успешной авторизации пользователя в логах системы появится следующее сообщение:
Jun 05, 2014 2:43:22 PM org.springframework.web.context.support.ApplicationContext doLogin
INFO: Authorization. Username = “name”
|
