Министерство экономического развития Российской Федерации
ЗАО «Интерфакс»
|
|
УТВЕРЖДАЮ
|
|
|
Первый заместитель
генерального директора
ЗАО «Интерфакс»
|
|
|
_______________________ В.В. Герасимов
|
|
|
«_____» апреля г.
|
|
|
М.П.
|
Создание прототипа АИС «Сведения о существенных фактах деятельности юридических лиц»
Шифр темы 2125-09-11
Руководство программиста
СОГЛАСОВАНО
|
|
СОГЛАСОВАНО
|
Директор Департамента инновационного развития и корпоративного управления Минэкономразвития России
|
|
Директор Департамента государственного регулирования в экономике Минэкономразвития России
|
____________________ И. В. Осколков
|
|
____________________ А.И. Херсонцев
|
«_____» апреля 2012г.
|
|
«_____» апреля 2012 г.
|
Москва, 2012
АННОТАЦИЯ
В данном программном документе приведено руководство программиста по настройке, использованию и доработке программы АИС «Сведения о существенных фактах деятельности юридических лиц».
В данном программном документе, в разделе «Назначение и условия применения программы» указаны назначение и функции, выполняемые программой, условия, необходимые для выполнения программы (объем оперативной памяти, требования к составу и параметрам периферийных устройств, требования к программному обеспечению и т.п.).
В разделе «Характеристика программы» приведено описание основных характеристик и особенностей программы (режим работы, средства контроля правильности выполнения и самовосстанавливаемости программы и т.п.).
В данном программном документе, в разделе «Входные и выходные данные» приведено описание организации используемой входной и выходной информации.
В разделе «Сообщения» указаны тексты сообщений, выдаваемых программисту или оператору в ходе выполнения программы, описание их содержания и действий, которые необходимо предпринять по этим сообщениям.
Оформление программного документа «Руководство программиста» произведено по требованиям ЕСПД (ГОСТ 19.101-77 1), ГОСТ 19.103-77 2), ГОСТ 19.104-78* 3), ГОСТ 19.105-78* 4), ГОСТ 19.106-78* 5), ГОСТ 19.504-79* 6), ГОСТ 19.604-78* 7)).
Содержание
1 Назначение и условия применения программы 4
1.1 Назначение программы 4
1.2 Функции, выполняемые программой 4
1.3 Условия, необходимые для выполнения программы 4
1.3.1 Объем оперативной памяти 4
1.3.2 Требования к составу периферийных устройств 5
1.3.3 Требования к параметрам периферийных устройств 5
1.3.4 Требования к программному обеспечению 5
1.3.5 Требования к персоналу (программисту) 6
2 Характеристика программы 7
2.1 Описание основных характеристик программы 7
2.1.1 Режим работы программы 7
2.1.2 Средства контроля правильности выполнения программы 7
2.2 Описание основных особенностей программы 7
2.2.1 Самовосстанавливаемость программы 7
3 Обращение к программе 8
3.1 Загрузка и запуск программы 8
3.2 Выполнение программы 8
3.2.1 Выполнение функции ввода и публикации сведений в Системе 8
3.2.2 Выполнение функции предоставления прав доступа к АИС «Сведения о существенных фактах деятельности юридических лиц» 8
3.3 Завершение работы программы 8
4 Входные и выходные данные 10
4.1 Организация используемой входной информации 10
4.2 Организация используемой выходной информации 10
5 Сообщения 11
5.1 Сообщение об ошибке 11
Приложение A Состав архивов инсталляционных комплектов 14
Приложение B Состав архивов исходных кодов системы 15
1Назначение и условия применения программы
1.1Назначение программы
Программа АИС «Сведения о существенных фактах деятельности юридических лиц» предназначена для обеспечения ввода и опубликования информации в Реестре существенных фактов деятельности юридических лиц, с возможностью доступа к опубликованной информации всем заинтересованным лицам.
1.2Функции, выполняемые программой
Основной функцией программы АИС «Сведения о существенных фактах деятельности юридических лиц» является обеспечение возможности ввода пользователями системы сведений, составляющих Реестр сведений о существенных фактах деятельности юридических лиц, а также, обеспечение возможности доступа к этим сведениям пользователям Интернет.
Прочие функции программы:
предоставление прав доступа к АИС «Сведения о существенных фактах деятельности юридических лиц».
1.3Условия, необходимые для выполнения программы
1.3.1Объем оперативной памяти
Для выполнения своих функций, программе АИС «Сведения о банкротстве» достаточно:
50 Мб оперативной памяти на рабочей станции пользователя;
300 Мб оперативной памяти на сервере приложений;
2 Гб оперативной памяти на сервере на сервере БД.
Однако, поскольку часть ОЗУ неизбежно занимает операционная система, то рекомендуется использовать программу АИС «Сведения о существенных фактах деятельности юридических лиц» на оборудовании, имеющем следующие параметры:
более 512 Мб оперативной памяти на рабочей станции пользователя;
более 2 Гб оперативной памяти на сервере приложений;
более 4 Гб оперативной памяти на сервере на сервере БД.
1.3.2Требования к составу периферийных устройств
Для работы АИС «Сведения о существенных фактах деятельности юридических лиц» необходимо наличие следующих периферийных устройств:
выделенного диска объемом не менее1,5 Тб на сервере БД;
наличие подключения к локальной вычислительной сети у сервера приложений и сервера БД;
наличие подключения к сети Интернет на рабочей станции пользователя.
1.3.3Требования к параметрам периферийных устройств
Периферийные устройства, требуемые для работы программы, должны иметь следующие параметры:
выделенный диски должен иметь надежность хранения не ниже, чем у RAID-5 массива;
локальная вычислительная сеть должна иметь пропускную способность способностью не ниже 100Мб/сек;
подключение к сети Интернет на рабочей станции должно обеспечивать пропускную способность не менее 56 Кб/сек.
1.3.4Требования к программному обеспечению
Для работы программы требуются следующее программное обеспечение:
на рабочей станции пользователя
браузер Internet Explorer версии 8 или выше или браузер Mozilla Firefox версии 10 или выше;
операционная система Windows XP SP2 или более поздняя версия;
для подписи сообщений ЭЦП необходим комплект программного обеспечения криптомодуля, поддерживающего стандарт Crypto API 2.0;
операционная система Windows 2003 32-bit;
Internet Information Services версии 6 или 7;
в операционной системе должна быть установлена исполняемая среда .NET версии 4.0.
операционная система Windows 2003 Standard Edition или более поздняя версия;
Microsoft SQL Server 2008 Standard Edition.
Для доработки программы требуется следующее программное обеспечение:
среда разработки Visual Studio 2008;
библиотека и исполняемая среда .NET версии 4.0
1.3.5Требования к персоналу (программисту)
Программист должен иметь минимум среднее техническое образование, обладать знаниями языков программирования C# и Transact-SQL.
В перечень задач, выполняемых программистом, должны входить:
задача поддержания работоспособности программы АИС «Сведения о существенных фактах деятельности юридических лиц»;
доработка программы АИС «Сведения о существенных фактах деятельности юридических лиц» по требованиям пользователей системы.
2Характеристика программы
2.1Описание основных характеристик программы
2.1.1Режим работы программы
Режим работы программы АИС «Сведения о существенных фактах деятельности юридических лиц» - круглосуточный, непрерывный.
2.1.2Средства контроля правильности выполнения программы
Контроль правильности выполнения программы осуществляется через файлы логов программы. В случае возникновения исключительных ситуаций, которые не могут быть обработаны средствами системы, информация о них выводится в файлы логов (расположение файлов логов задается в конфигурационных файлах программы).
Сообщения об исключительных ситуациях также высылаются на почтовый адрес, указанный в настройках системы.
2.2Описание основных особенностей программы
Настройка программы осуществляется с помощью конфигурационных файлов. Описание конфигурационных файлов и их параметров приведено в инструкции по инсталляции системы.
2.2.1Самовосстанавливаемость программы
Серверные компоненты программы имеют возможность работы в режиме, когда не требуется их ручное восстановление после сбоев или после перезагрузки компьютера. Такой режим устанавливается настройками операционной системы (автостарт сервисов после перезагрузки и/или сбоев) и Internet Information Services.
3Обращение к программе
3.1Загрузка и запуск программы
Запуск программы зависит от типа компонент:
компоненты, исполняемые в среде Internet Information Services (сайты) загружаются и запускаются автоматически при обращении к сайтам пользователей;
компоненты, исполняемые в виде windows-сервисов, в первый раз должны быть запущены из консоли управления сервисами. Подробное описание порядка работы с консолью управления сервисами приведено в руководстве пользователя операционной системы.
3.2Выполнение программы
3.2.1Выполнение функции ввода и публикации сведений в Системе
Функция ввода осуществляется программой в непрерывном режиме, через пользовательский интерфейс системы. Публикация осуществляется по мере ввода пользователями информации, после подтверждения оплаты публикуемых сообщений в случае оплаты банковским переводом или сразу после оплаты с лицевого счета пользователя.
3.2.2Выполнение функции предоставления прав доступа к АИС «Сведения о существенных фактах деятельности юридических лиц»
Функция предоставления прав доступа пользователям осуществляется через визуальный интерфейс программы пользователями, имеющими административные права в системе. Если в программе нет ни одного пользователя, имеющего административные права, программа при первом обращении к ней предложит создать такого пользователя.
Права доступа проверяются при вводе логина и пароля пользователя. После ввода логина/пароля, пользователю будет доступен функционал, определяемый его правами доступа.
3.3Завершение работы программы
Завершение работы программы осуществляется:
остановкой сайта в консоли управления Internet Information Services;
остановкой сервера БД в консоли управления SQL Server 2008 (SQL Management Studio);
закрытием окна браузера на рабочем месте пользователя.
4Входные и выходные данные
4.1Организация используемой входной информации
Программа получает входную информацию:
в текстовом виде через визуальный интерфейс системы, при этом, в отдельных случаях допускается дополнение текстовых сведений, введенных через визуальный интерфейс, бинарными документами, которые сохраняются в БД программы «как есть», без какой-либо предварительной или последующей обработки;
4.2Организация используемой выходной информации
Программа генерирует следующую выходную информацию:
сообщения о банкротстве в формате HTML для последующего отображения в браузерах на рабочих местах пользователей.
5Сообщения
5.1Сообщение об ошибке
При возникновении ошибки (необработанного исключения) в программе, например, при ошибочной работе сервера БД, в логах системы будет следующее сообщение:
2012-02-11 17:50:29.2434 : Error : Выдано исключение типа "System.Web.HttpUnhandledException".
Method is
Interfax.SignificantEvents.Common.Logging.LogException(Logging.cs:30)
Exception is
System.Web.HttpUnhandledException (0x80004005): Выдано исключение типа "System.Web.HttpUnhandledException". ---> System.Reflection.TargetInvocationException: Адресат вызова создал исключение. ---> System.Data.SqlClient.SqlException: Истекло время ожидания (Timeout). Время ожидания истекло до завершения операции или сервер не отвечает.
в System.Data.SqlClient.SqlConnection.OnError(SqlException exception, Boolean breakConnection)
в System.Data.SqlClient.SqlInternalConnection.OnError(SqlException exception, Boolean breakConnection)
в System.Data.SqlClient.TdsParser.ThrowExceptionAndWarning()
в System.Data.SqlClient.TdsParser.Run(RunBehavior runBehavior, SqlCommand cmdHandler, SqlDataReader dataStream, BulkCopySimpleResultSet bulkCopyHandler, TdsParserStateObject stateObj)
в System.Data.SqlClient.SqlDataReader.ConsumeMetaData()
в System.Data.SqlClient.SqlDataReader.get_MetaData()
в System.Data.SqlClient.SqlCommand.FinishExecuteReader(SqlDataReader ds, RunBehavior runBehavior, String resetOptionsString)
в System.Data.SqlClient.SqlCommand.RunExecuteReaderTds(CommandBehavior cmdBehavior, RunBehavior runBehavior, Boolean returnStream, Boolean async)
в System.Data.SqlClient.SqlCommand.RunExecuteReader(CommandBehavior cmdBehavior, RunBehavior runBehavior, Boolean returnStream, String method, DbAsyncResult result)
в System.Data.SqlClient.SqlCommand.RunExecuteReader(CommandBehavior cmdBehavior, RunBehavior runBehavior, Boolean returnStream, String method)
в System.Data.SqlClient.SqlCommand.ExecuteReader(CommandBehavior behavior, String method)
в System.Data.SqlClient.SqlCommand.ExecuteDbDataReader(CommandBehavior behavior)
в System.Data.Common.DbCommand.ExecuteReader()
в System.Data.Linq.SqlClient.SqlProvider.Execute(Expression query, QueryInfo queryInfo, IObjectReaderFactory factory, Object[] parentArgs, Object[] userArgs, ICompiledSubQuery[] subQueries, Object lastResult)
в System.Data.Linq.SqlClient.SqlProvider.ExecuteAll(Expression query, QueryInfo[] queryInfos, IObjectReaderFactory factory, Object[] userArguments, ICompiledSubQuery[] subQueries)
в System.Data.Linq.SqlClient.SqlProvider.System.Data.Linq.Provider.IProvider.Execute(Expression query)
в System.Data.Linq.DataContext.ExecuteMethodCall(Object instance, MethodInfo methodInfo, Object[] parameters)
в Interfax.SignificantEvents.Dao.LinqToSql.MessageDataContext.ARM_REP_GetMessages(Nullable`1 iD_PUBLISHER, Nullable`1 iD_COMPANY_FIRM, Nullable`1 status, Nullable`1 beginDate, Nullable`1 endDate, Nullable`1 startIndex, Nullable`1 pageSize, Nullable`1& totalRowCount) в d:\Builds\7\Significant Events\ReleaseBuild\Sources\Significant Events\Prototype\Source\Interfax.SignificantEvents.Dao.LinqToSql\DataContext\MessageDataContext.designer.cs:строка 190
в Interfax.SignificantEvents.Dao.LinqToSql.MessageDao.GetMessagesRepresentative(Nullable`1 idPublisher, Nullable`1 idCompanyFirm, Int32 status, Nullable`1 fromDate, Nullable`1 toDate, Nullable`1 maximumRows, Nullable`1 startRowIndex, Nullable`1& totalMessagesCount) в d:\Builds\7\Significant Events\ReleaseBuild\Sources\Significant Events\Prototype\Source\Interfax.SignificantEvents.Dao.LinqToSql\MessageDao.cs:строка 198
в Interfax.SignificantEvents.BackOffice.Logic.Message.Service.GetMessages(Nullable`1 publisherID, Nullable`1 companyID, Int32 status, Nullable`1 fromDate, Nullable`1 toDate, Nullable`1 maximumRows, Nullable`1 startRowIndex, Nullable`1& totalMessagesCount) в d:\Builds\7\Significant Events\ReleaseBuild\Sources\Significant Events\Prototype\Source\Interfax.SignificantEvents.BackOffice.Logic.csproj\Message\Service.cs:строка 419
в Interfax.SignificantEvents.UI.Web.AppSource.Pagers.BackOffice.RepresentativeMessagesListDataPager.GetMessages(Nullable`1 publisherID, Nullable`1 companyID, Int32 status, Nullable`1 fromDate, Nullable`1 toDate, Nullable`1 maximumRows, Nullable`1 startRowIndex) в d:\Builds\7\Significant Events\ReleaseBuild\Sources\Significant Events\Prototype\Source\WEBUI\AppSource\Pagers\BackOffice\RepresentativeMessagesListDataPager.cs:строка 59
В тексте сообщения об ошибки присутствует строка «Error:», после которой идет текст ее описания. В приведенном примере это сообщение сервера БД об ошибке, возникшей при исполнении запроса: «Истекло время ожидания (Timeout)».
При получении данного сообщения, необходимо по стеку вызова, приведенному в сообщении, найти в исходном коде строку, на которой возникла исключительная ситуация, проанализировать проблему и устранить ее изменением исходного кода программы либо данных, хранящихся в БД программы.
-
Состав архивов инсталляционных комплектов
В таблице 1 приведен состав архива Site.rar.
Таблица 1—Состав архива Site.rar
Директория/файл
|
Описание
|
App_Themes
|
Варианты оформления приложения
|
BackOffice
|
Страницы и ресурсы для административной части
|
bin
|
Скомпилированный код приложения
|
Controls
|
Пользовательские элементы управления (общие для всех страниц)
|
css
|
Стили оформления HTML-страниц
|
img
|
Изображения
|
js
|
JavaScript-код, исполняемый на стороне браузера
|
OpenSite
|
Пользовательские элементы для открытого сайта
|
Global.asax
|
Обработчик событий
|
Nlog.config
|
Конфигурационный файл с настройками логирования
|
Spring.config
|
Конфигурационный файл с настройками библиотек взаимодействия компонент приложения
|
Web.config
|
Основной конфигурационный файл приложения
|
Файлы *.aspx
|
Страницы открытого сайта
|
-
Состав архивов исходных кодов системы
В таблице 2 приведен состав архива Source - SignificantEvents.rar.
Таблица 2— Состав архива Source - SignificantEvents.rar
Директория/файл
|
Описание
|
Projects - копия\Significant Events\Prototype\Source\
|
Папка основного кода приложения
|
___LogicTier
|
Бизнес логика административной части
|
Common
|
Общеиспользуемая логика
|
Interfax.SignificantEvents.BackOffice.Model
|
Классы моделей административной части
|
Interfax.SignificantEvents.Common
|
Общие классы проекта
|
Interfax.SignificantEvents.Common.Model
|
Общие классы для моделей административной и клиентской частей
|
Interfax.SignificantEvents.Dao.Common
|
Интерфейсы и классы исключений для работы с хранилищами данных
|
Interfax.SignificantEvents.Dao.LinqToSql
|
Классы работы с БД на основе технологии LinqToSql
|
Interfax.SignificantEvents.DigitalSignature
|
Базовая логика работы с подписью
|
Interfax.SignificantEvents.DigitalSignature.CryptoService
|
Логика работы с подписью через CryptoService
|
Interfax.SignificantEvents.Entity
|
Классы сущностей системы
|
Interfax.SignificantEvents.OpenSite.Model
|
Классы моделей клиентской части
|
Interfax.SignificantEvents.Security
|
Логика безопасности
|
OpenSiteLogicTier
|
Бизнес логика клиентской части
|
Tests
|
Тесты
|
WEBUI
|
Классы представления пользовательского интерфейса открытого сайта системы
|
X509CertProcessor
|
Логика для работы с атрибутами сертификата
|
X509CertTypes
|
Интерфейс для работы с атрибутами сертификата
|
Prototype.sln
|
Файл проекта
|
Prototype.vssscc
|
Файл настроек проекта
|
Projects - копия\Significant Events\ Bankruptcy\ SourcesIteration6\Common\ Interfax.Common.Logging\
|
Подпроект – функционал логирования событий и ошибок
|
Projects - копия\Significant Events\Common\NLog\
|
Подпроект – дополнительный функционал логирования событий и ошибок
|
Projects - копия\ Significant Events\Common\ Spring.NET\
|
Подпроект – функционал обеспечения унифицированного взаимодействия объектной модели приложения
|
Projects - копия\Common\Framework 4\
|
Вспомогательные проекты, содержащие исходный код повторно используемых пользовательские элементы управления и программные решения на базе ASP.NET
|
"РУКОВОДСТВО ПРОГРАММИСТА" СОСТАВИЛИ:
Наименование организации, предприятия
|
Должность исполнителя
|
Фамилия, имя, отчество
|
Подпись
|
Дата
|
ЗАО «Интерфакс»
|
Менеджер проектов
|
Малышев Сергей Геннадьевич
|
|
|
ЗАО «Интерфакс»
|
Аналитик
|
Зубарева Марина Тагировна
|
|
|
ЗАО «Интерфакс»
|
Технический писатель
|
Смирнова Юлия Ивановна
|
|
|
СОГЛАСОВАНО
Наименование организации, предприятия
|
Должность исполнителя
|
Фамилия, имя, отчество
|
Подпись
|
Дата
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
