Характеристики программы руководство программиста

УФИМСКИЙ ГОСУДАРСТВЕННЫЙ
АВИАЦИОННЫЙ ТЕХНИЧЕСКИЙ УНИВЕРСИТЕТ

КАФЕДРА ВЫЧИСЛИТЕЛЬНОЙ
МАТЕМАТИКИ И КИБЕРНЕТИКИ

Прикладное
программное обеспечение для учета
заявок и контроля их исполнения на
примере ООО «Интегрированная транспортная
сеть».

1. Руководство программиста

Листов
14

УФА
2013

1. Аннотация

Приводится
руководство программиста программного
обеспечения для учета заявок и контроля
их исполнения на примере ООО «Интегрированная
транспортная сеть».

Программный
продукт должен быть разработан для
организации,
предназначенное для автоматизации
стратегий взаимодействия с клиентами,
в частности, для повышения уровня продаж,
улучшения обслуживания клиентов путём
сохранения информации о клиентах и
их персональных данных. Так же должна
быть реализована email-рассылка
пользователям данного продукта,
статистика, где показано какое количество
заявок завел пользователь за день, за
месяц.

В
руководстве программиста рассматриваются
назначение, характеристики, условия,
необходимые для выполнения программы

1. Назначение программы

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

1. 2. Условия, необходимые для выполнения программы

Для
работы программного продукта необходима
следующая программно-аппаратная
конфигурация:

• Windows
  7,Windows Server 2003 Service Pack 2,Windows Server 2008,Windows
  Server 2008 R2,Windows Vista, Windows Vista Service Pack 1,Windows
  XP Service Pack 2,Windows XP Service Pack 3;

• 32-разрядные
  системы: компьютер, оборудованный
  процессором Intel
  или совместимым процессором с тактовой
  частотой 1 ГГц или выше (рекомендуется
  2 ГГц или выше, поддерживается только
  один процессор);

• 64-разрядные
  системы: процессор с тактовой частотой
  1,4 ГГц или выше (рекомендуется 2 ГГц или
  выше, поддерживается только один
  процессор);

• минимальный
  объем ОЗУ 512 МБ (рекомендуется 1 ГБ или
  более);

• 1
  ГБ свободного места на диске;

• наличие
  СУБД:
  MS SQL 2008;

1. 3. Характеристики программы

2. 3.1.
   Режим работы программы

Диалоговый.
Web-интерфейс
в браузере (с поддержкой HTML5).

1. 3.2.Средства
   проверки правильности выполнения
   программы

Проверка
правильности работы программы
осуществляется при выполнении конкретных
примеров. Программа
выдает сообщение при вводе некорректных
данных (Рис. 2.20):

Рис. 2.20.
Некорректный ввод номера телефона

1. 3.3.
   Функционирование программы после сбоев

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

1. Обращение
   к программе

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

• Запустить
  программу на ПК, с поддержкой Microsoft
  .NET
  Framework
  (или на удаленном сервере), если он еще
  не запущен;

• Откройте
  ваш любимый браузер (на пример chrome,
  internet
  explorer,
  mozilla
  firefox);

• Введите
  в адресную строку IP-адрес
  сервера, с заранее определенным портом;

• Откроется
  страница домашняя страница;

• Начать
  работу
  с клиентами.

Не
авторизованный (не зарегистрированный)
пользователь не может просматривать
какую либо вкладку.

Соседние файлы в предмете [НЕСОРТИРОВАННОЕ]

• #
• #
• #
• #
• #
• #
• #
• #
• #
• #
• #

«Шифрование
данных»

Программа

Руководство программиста

643.02069436.41NNN—01
33 01-1

Листов 6

---

АННОТАЦИЯ

Приводится руководство
программиста программы «Шифрование
данных».

Программа предназначена
для шифрования и дешифрования данных,
с применением алгоритма шифрования
«Шифр-Гост 28147-89».

Ограничения программы: программа
аварийно завершается при загрузке
файлов с размером более 500 МБ.

Условия эксплуатации программы:

возможность применения в локальной
сети;

на персональных компьютерах
с процессором не ниже 300МГц, минимум
оперативной памяти 16 MБ и операционная
система не ниже Windows 95.

Распространяется на дискетах.

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

---

СОДЕРЖАНИЕ

стр.

---

1 Назначение и условия применения
программы

1.1 Назначение программы

Описываемая программа предназначена
для шифрования и дешифрования
данных, хранящихся в файлах.

1.2 Функции программы

• Функция
  открытия и чтения файла “LoadFile”
  вызывается путем нажатия
  Файл->Открыть и
  загрузка данных из файла при выборе
  файла в диалоговом окне.
  

• При нажатии Шифрование->Зашифровать
  программа вызывает процедуру “Coding”,
  которая зашифровывает данные и выводит
  результат в окно для ввода текста.

• При выборе в меню
  Шифрование->Расшифровать
  – программа вызывает процедуру
  “Recoding”,
  которая расшифровывает данные с выводом
  в результата в текстовое окно.

• Запись данных в файл
  происходит путем нажатия Файл->Сохранить
  — вызове функции
  “SaveFile”и
  выборе в диалоговом окне документа для
  записи данных.

1.3 Использование оперативной памяти

Количество необходимой оперативной
памяти определяется размером обрабатываемых
данных, плюс к этому 1 МБ для загрузки
самой программы и создания всех
необходимых переменных и структур.

1.4 Требования к программному обеспечению

Операционная система Windows95
и выше.

2.1 Средства проверки правильности
выполнения программы

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

2.2 Функционирование программы после
сбоев

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

3.1 Способы вызова программы с различных
носителей данных

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

3.2 Входные точки в программу

Исполняемым файлом программы является
файл «CodingGost.exe«.

3.3 Способы передачи управления и
параметров данных

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

3.4 Обращение к программе – приложению

С помощью программ файл — менеджеров
зайти в каталог, в который установлена
программа и запустить файл «CodingGost.exe».

4.1 Формат, характер и организация входных
данных

Загрузка данных в виде текста или файла
любого формата для (рас)зашифровывания.

4.2 Формат, характер и организация выходных
данных

Cохранение (рас)зашифрованных
данных в файл любого формата, либо
простым отражением в текстовом поле.

5.1 Сообщения программисту и действия
по ним

№ п/п	Сообщение	Описание	Действия
1	2	3	4
1.	“Отсутствуют данные для обработки!”	Системное окно сообщения с информацией, о том, что файл не открыт.	Загрузить файл.
2.	“Не задан ключ!”	Системное окно сообщения с информацией, о том, что ключ не задан.	Ввести ключ для шифрования в соответствующее поле.

---

6.1 Примеры

Производится
открытие файлов путем
нажатия Файл->Открыть и
загрузка данных из файла при выборе
файла в диалоговом окне.

Возможен ввод текста для шифрования в
окно и его загрузка из него.

При нажатии Шифрование->Зашифровать
программа зашифровывает данные и выводит
результат в окно для ввода текста.

При выборе в меню Шифрование->Расшифровать
– происходит расшифровка данных с
выводом в результата в текстовое окно.

Запись данных в файл происходит путем
нажатия Файл->Сохранить и выборе
в диалоговом окне документа для записи
данных.

Можно изменить параметры шифрования –
ключ шифрования, “S
— блоки”.

6.2 Иллюстрации

Основная форма

Окно ввода
(отображения) Ключ Окно
вывода (отображения)

Главное меню
Строка состояния
процесса

---

Если кроме использования и настройки, программное обеспечение предоставляет возможность написания, редактирования или использования программного кода. Какой документ необходим в этом случае?

Назначение руководства программиста

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

Примерами могут служить:

– библиотека функций;

– платформа или среда для разработки ПО;

– ПО с открытым кодом.

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

– назначение, структуру входных и выходных данных программных функций;

– возможности по созданию программного кода, особенности его интерпретации и компиляции;

– синтаксические особенности используемого языка программирования;

– возможные правила и ограничения при работе с программным кодом;

– различные инструкции по работе с программой.

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

Состав типового руководства программиста

В соответствии с требованиями ГОСТ руководство программиста должно содержать следующие разделы:

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

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

– Обращение к программе, где указывают способы и параметры запуска программы;

– Входные и выходные данные, где описывают формат, способ организации и другие требования к входным и выходным данным;

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

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

Стандарты для руководства программиста

ГОСТы регламентируют и этот документ, в данном случае это ГОСТ 19.504. В соответствии с ним определяется структура и содержание Руководства программиста.

Стоимость разработки руководства программиста

Наименование документа	Наименование стандарта	Стоимость разработки
Руководство программиста на ПО	ГОСТ 19.504	100 тыс. р.

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

Возможно, вас также заинтересует:

– разработка руководства администратора;
– создание руководства пользователя;
– разработка руководства оператора.

---

СОГЛАСОВАНО		УТВЕРЖДАЮ
Директор Департамента инновационного развития Министерства экономического развития Российской Федерации		Генеральный директор ЗАО«Госбук»
________________ А.Е. Шадрин		_______________ С.И. Холкин
«____»_______________ 2014 г.		«____»________________ 2014 г.
М.П.		М.П.

РАЗВИТИЕ И СОПРОВОЖДЕНИЕ ЕДИНОГО ИНФОРМАЦИОННО-АНАЛИТИЧЕСКОГО ПОРТАЛА ГОСУДАРСТВЕННОЙ ПОДДЕРЖКИ ИННОВАЦИОННОГО РАЗВИТИЯ БИЗНЕСА

№ГК-139-ОФ/Д21 от 17.11.2014

РУКОВОДСТВО ПРОГРАММИСТА

Москва 2014 год

АННОТАЦИЯ

В настоящем документе приведено руководство программиста, содержащее назначение АИС «Инновации» (далее – Программы, Системы), ее характеристики, а также входные и выходные данные и сообщения, выдаваемые системой программисту.

Документ разработан в соответствии с Техническим заданием и согласно требованиям ЕСПД (ГОСТ 19.101-77 Виды программ и программных документов; ГОСТ 19.105-78 Общие требования к программным документам; ГОСТ 19.504-79 Руководство программиста. Требования к содержанию и оформлению).

СОДЕРЖАНИЕ

Назначение и условия применения программы

Назначение Программы

АИС «Инновации» предназначена для автоматизации следующих процессов инновационного развития бизнеса:

1. Публичное освещение хода реализации Стратегии инновационного развития Российской Федерации на период до 2020 года.
2. Формирование единой базы знаний по всем государственным инициативам по поддержке инновационного развития бизнеса с возможностью обмена опытом, получения ответов на интересующие вопросы и публикации лучших практик по предоставлению государственной поддержки.
3. Обеспечение единой коммуникативной площадки для стимулирования обмена накопленным профессиональным опытом в рамках проектной деятельности, направленной на поддержку инновационного развития бизнеса между сотрудниками федеральных ведомств, органов местного самоуправления и государственных организаций, являющихся субъектами стимулирования инновационной активности.
4. Обеспечение доступа для представителей бизнес сообщества к информации по возможным вариантам и способам получения государственной поддержки реализуемых инновационных программ, соответствующих конкретным параметрам модели конкретного бизнеса.
5. Интерактивная подача заявок для бизнеса на получение государственной поддержки инновационных проектов и программ.
6. Мониторинг в режиме реального времени реализации всех государственных инициатив по инновационному развитию бизнеса.

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

1. Блок «Новости» отвечает за выведение новостной информации на страницах Системы. Содержит в себе информацию о заголовке, дате и содержании новости, а также прикрепляемые изображения;
2. Блок «Мероприятия» отвечает за выведение информации по мероприятиям (событиям) добавляемым в систему и привязываемую к конкретным субъектам инновационной деятельности. В состав информации входит заголовок, дата, описание мероприятия;
3. Блок «Справочник субъектов инновационной деятельности» предназначен для сбора, хранения и публикации информации по различным субъектам инновационной деятельности с возможностью указания типа субъекта;
4. Модуль «Инновационная политика в регионах» содержит информацию об инновациях в регионах и информацию об инновационных регионах;
5. Модуль «Международное сотрудничество» содержит общую информацию о международном сотрудничестве в рамках инновационного развития;
6. Модуль «Инфраструктура инноваций» содержит в себе общую структуру субъектов инновационной деятельности с возможностью переходов на разделы конкретного субъекта и просмотра информации по нему;
7. Модуль «Инновационные институты развития» содержит информацию об институтах развития и включает в себя настраиваемый профиль каждого из институтов;
8. Модуль «Технологические платформы» содержит информацию об технологических платформах и включает в себя настраиваемый профиль каждой из платформ;
9. Модуль «Территориальные кластеры» содержит информацию о территориальных кластерах и включает в себя настраиваемый профиль каждого из кластеров;
10. Модуль «Крупнейшие госкомпании» содержит информацию о компаниях с государственным участием и включает в себя настраиваемый профиль каждой из компаний и другую информацию;
11. Модуль «Справочные ресурсы» содержит ссылки на полезные справочные ресурсы, связанные с реализацией стратегии инновационного развития.
12. Подсистема «База знаний» предназначена для агрегации, размещения, категоризации, хранения и чтения методической и нормативно-справочной информации по всей государственной политике в области развития инноваций с возможностью обмена опытом и получения ответов на наиболее часто задаваемые вопросы. Данная подсистема должна размещаться в контуре персонифицированного доступа.
13. Подсистема «Навигатор господдержки» предназначена для расширенного поиска информации, соответствующей конкретным параметрам бизнеса, возможным вариантам государственной поддержки его инновационного развития. Подсистема должна размещаться в контуре персонифицированного доступа.
14. Подсистема «Мониторинг государственных инициатив по инновационному развитию бизнеса и визуализация результатов» предназначена для проведения анализа и осуществления контроля за результатами реализации государственных инициатив по инновационному развитию бизнеса, а также обеспечения открытости, доступности и наглядности информации о результатах деятельности государственных субъектов инновационной активности. Данная подсистема должна размещаться в контуре ограниченного доступа.
15. Подсистема администрирования АИС «Инновации» предназначена для предоставления возможностей управлению доступом к информационным ресурсам системы, обеспечению поддержки системы, резервному копированию и восстановлению, анализу использования, а также для определения порядка хранения плоских данных, формирования маршрутных листов связи плоских данных, формирования из плоских данных многомерного массива с использованием пользовательских фильтров и расширенных настроек, обеспечения единства таксономий в рамках реализации проекта.
16. Модуль личных кабинетов – Позволяет представителям субъектов инновационной деятельности редактировать информацию в профилях субъекта. Кроме того инструмент кабинета позволяет управлять публикацией новостей и событий в рамках субъекта инновационной деятельности, а также заполнять специальные информационные разделы
17. Модуль автоматического обновления информации – Позволяет автоматически публиковать новостную информацию из внешних источников в привязке к конкретному субъекту инновационной инфраструктуры или же к общей новостной ленте.

Функции, выполняемые программой

Функции, выполняемые АИС «Инновации»:

• Функции ведения новостного блока;
• Функции управления блоком мероприятия;
• Функция публикации открытой отчётности;
• Функции взаимодействия с пользователями;
• Функция консультативной поддержки пользователей;
• Функции ведения форума;
• Функции формирования «Библиотеки»;
• Функция ведения Навигации;
• Функции Экспертного сопровождения реализуемых программ и проектов;
• Функции управления экспертной группы;
• Функции личного профиля зарегистрированного пользователя;
• Специальные функции личного профиля Эксперта;
• Функции администрирования и управления содержанием АИС «Инновации»;
• Функция Навигатора господдержки;
• Функция подачи он-лайн заявки.

Необходимые условия для выполнения программы

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

АИС «Инновации» должна эксплуатироваться на операционных системах Microsoft Windows XP, Microsoft Windows Vista, Microsoft Windows 7, Linux, на которых установлен бразуер Google Chrome, Mozilla Firefox, Internet Explorer или Opera последних версий.

Серверная часть АИС «Инновации» должна работать на серверах под управлением ОС Linux, с установленным веб-сервером apache с поддержкой php, а также СУБД MySQL.

Требования к аппаратному обеспечению серверов и АРМ, на которых эксплуатируется программа, представлены в таблице 1, таблице 2 и таблице 3.

Таблица — Требования к аппаратному обеспечению веб-сервера АИС «Инновации»

Веб-сервер
Компонент	Конфигурация
Центральный процессор	Intel® Xeon® Quad Core E5420 | 2.50GHz | Socket 771 | 12MB | 1333MHz
Оперативная память	Не менее 8Гб (рекомендуется 16)
Дисковая подсистема	1 TB, SAS RAID 10
Устройство резервного копирования	DVD-RW
Видеоадаптер	присутствует
Дисковод 1.44 Мб	присутствует
Клавиатура	присутствует
Мышь	присутствует
Монитор	SVGA 1024×768
Сетевая плата	Ethernet 100 Мбит

Таблица — Требования аппаратному обеспечению сервера СУБД Системы

Сервер СУБД
Компонент	Конфигурация
Центральный процессор	Intel® Xeon® Quad Core E5420 | 2.50GHz | Socket 771 | 12MB | 1333MHz
Оперативная память	Не менее 4Гб (рекомендуется 8Гб)
Дисковая подсистема	1 TB, SAS RAID 5
Устройство резервного копирования	DVD-RW
Видеоадаптер	присутствует
Дисковод 1.44 Мб	присутствует
Клавиатура	присутствует
Мышь	присутствует
Монитор	SVGA 1024×768
Сетевая плата	Ethernet 1 Гбит

Таблица — Требования к аппаратному обеспечению АРМ Системы

АРМ процессной системы (по количеству сотрудников)
Компонент	Конфигурация
Центральный процессор	Intel Core 2 Duo 5200
Оперативная память	1Гб
Дисковая подсистема	40 Gb
Видеоадаптер	присутствует
Дисковод 1.44 Мб	присутствует
Клавиатура	присутствует
Мышь	присутствует
Монитор	SVGA 1024×768
Сетевая плата	Ethernet 100 Мбит
Браузер	Internet Explorer версии 9 или более поздней Mozilla Firefox версии 5 или более поздней Google Chrome версии 13 или более поздней Opera версии 11 или более поздней

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

• Языки программирования и разметки данных: PHP, HTML, JavaScript;
• Настройка и диагностирование работы подсистем АИС «Инновации»;
• Обслуживание технического и системного программного обеспечения АИС «Инновации»;

Характеристика программы

Режимы работы программы

Система имеет возможность функционировать в следующих режимах:

• Штатный режим;
• Режим технических работ;
• Аварийный режим.

Штатный режим — основной режим функционирования, обеспечивающий выполнение задач Системы.

Режим технических работ — технологический режим, используемый для проведения технических работ по сопровождению Системы. Режим включается обслуживающим персоналом Системы вручную с целью проведения технических работ. В момент активации режима обязательно указываются временные рамки проведения работ – это необходимо для информирования пользователей Системы. Режим предполагает обработку запросов, поступающих от пользователей и внешних систем, и при этом ответом Системы на запросы являются корректные ответы веб-сервера:

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

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

В случае программных или аппаратных сбоев работы Системы считается, что система перешла в аварийный режим функционирования. Аварийный режим является форс-мажорным обстоятельством.

Средства контроля правильности выполнения Программы

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

Показатели назначения Программы

• Количество пользовательских запросов в день (количество пользовательских посещений АИС «Инновации») – 200 000;
• Количество параллельных запросов (количество пользователей одновременно обратившихся к АИС «Инновации») – 50;
• Время отклика страницы (время загрузки полной информации на выбранной страницы АИС «Инновации») – менее 3 секунд.

Самовосстанавливаемость программы

Системой предусмотрено автоматическое создание резервных копий содержимого программы и данных. В ручном режиме возможно восстановление состояния программы из этих резервных копий на момент их снятия.

Обращение к программе

Запуск и загрузка Системы

1. Настройки PHP

Настройки PHP имеют следующий вид:

max_execution_time = 180

max_input_time = 120

post_max_size = 80M

upload_max_filesize = 80M

memory_limit = 256M

1. Развертывание системы

Развёртывание системы производится в следующей последовательности:

1. Разворачивание контента:

1. Разархивирование контента в корневую директорию хоста веб-сервера:

tar xzf domain.com.tar.gz —strip-components=1 -C /var/www/domain.com/

1. Изменить владельца папки на пользователя web-сервера:

chown -R apache:apache /var/www/domain.com

1. Разворачивание БД:

а) Создание новой БД:

mysql -e «create database domain;»

б) Создание пользователя

, наделение его правами на управление созданной базой данных и установление ему пароля
:

mysql -e «grant all privileges on `domain`.* to ‘user’@’localhost’ identified by ‘password’;»

в) Разархивирование архива БД и импорт его в созданную БД

:

gunzip -c domain.com.sql.gz | mysql domain

3) Корректировка файла-настроек. Изменение реквизитов доступа к БД.

Необходимо изменить в файле название БД, пользователя, пароль и хост на такие, которые были созданы в момент разворачивания БД. Файл находится в корневой папке хоста web-сервера. Используйте любой редактор (vi, vim, mc, nano и т.п.):

nano /var/www/domain/sites/default/settings.php

Находим и меняем директиву:

array (

‘database’ => ‘domain’,

‘username’ => ‘user’,

‘password’ => ‘password’,

‘host’ => ‘localhost’,

‘port’ => »,

‘driver’ => ‘mysql’,

‘prefix’ => »,

)

4) Перезапуск (перечитываем конфигурацию) web-сервера:

/etc/init.d/httpd restart

5) Проверка работоспособности сайта.

Выполнение Программы

Выполнение всех функций Программы подробно описано в документе «Регламент функционирования».

Завершение работы программы

Завершение работы программы осуществляется:

• Остановкой сервера базы данных;
• Завершением работы веб-сервера;
• Остановкой сервера поисковой машины.

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

Входные и выходные данные

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

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

Рисунок – Интерфейс ввода входных данных

Рисунок – Пример интерфейса представления выходных данных

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

Сообщения

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

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

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

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

Примеры системных сообщений

1. Уведомление о сохранении материала

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

Рисунок – Уведомление о добавлении материала

1. Сообщение об ошибке при заполнении обязательных полей

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

Рисунок – Ошибка заполнения обязательных полей

1. Сообщения из системного журнала

При возникновении системных ошибок они отображаются в системном журнале.

1. Обращение к странице, которой не существует:

Cтраница не найдена sites/default/files/documents/2013/7219/2788.doc

Запись в системном журнале выглядит в соответствии с рисунком 5.

Рисунок – Запись о несерьезной ошибке в системном журнале

1. Процедура не может быть выполнена из-за ошибки в ее конфигурации:

The action Установить значение () fails the integrity check and cannot be executed. Error: Data selector entity-is-validate for parameter data is invalid.

Запись в системном журнале выглядит в соответствии с рисунком 6.

Рисунок – Запись о серьезной ошибке в системном журнале

ЛИСТ РЕГИСТРАЦИИ ИЗМЕНЕНИЙ

Таблица – Лист регистрации изменений

Номера листов (страниц)	Всего листов (страниц) в докум.	№ документа	Входящий № сопроводительного докум. и дата	Подп.	Дата
Изм.	измененных	замененных	новых	аннулированных