Описание технических и программных требований
Постановка задачи
Главной задачей проекта являлась разработка бизнес-приложения, которое сможет извлекать необходимую информацию, представленную в виде структурированных данных, и с помощью дальнейшего форматирования с применением специализированных языков трансформации представлять эти данные пользователю системы. Приложение должно удовлетворять ряду условий:
для функционирования системы требуется наличие локального сервера, который способен не только обеспечивать обработку действий пользователя, но и поддерживать функции интерпретации языков XSLTиXSL-FO;
исходные данные должны быть структурированы (формат XML), иметь одинаковую сущность и единообразное форматирование ввиду четких и строгих требований, предъявляемых к информации юридического характера;
информация должна представляться конечному пользователю в нескольких видах – в формате гипертекста, а также в текстовом и PDF-формате, причем их внешний вид должен быть максимально идентичным;
приложение должно предоставлять пользователю возможность переходить по различным разделам сайта и получать интересующую его информацию в любом доступном виде;
приложение должно предоставлять пользователю возможность вручную изменять путь к необходимым файлам, если это необходимо;
пользователь должен иметь возможность распечатать информацию или переслать ее по электронной почте.
Структура разрабатываемого приложения
Юридическая информация должна быть представлена в строгом виде. Любые законодательные акты и другие правовые документы должны отображаться в строгом соответствии с требованиями, предъявляемыми к ним. В этой связи появляется необходимость введения унификации исходных данных, используемых для последующего отображения пользователю. Использование структурированного типа данных позволяет использовать единый подход к хранению, пересылке информации и ее визуальному отображению. Иерархическая система структурированных данных позволяет легко получить доступ к любому необходимому элементу, получить его содержимое и в результате форматирования вывести на экран. Схема работы такой системы приведена на рисунке 1.
Рисунок 1 – Принцип работы веб-приложения
Таким образом, мы видим, что данные независимы от системы и могут изменяться. Также может подвергаться изменению и сама структура файлов, что потребует внесения изменений в обработчик исходных файлов. Пользователь может получить доступ к сайту при помощи двух способов. Первый – обращение через локальный сервер, предназначенный для аутентификации. После ввода логина и пароля (если они верны) сервер генерирует токен (уникальная последовательность цифр и букв в нашем случае) и затем при помощи AccessAPIобращается к удаленному серверу платформы для вставки сгенерированного токена. Для этого необходимо использование надежного и защищенного локального сервера, который одновременно будет выполнять функцию парсера для исходного контента. Затем пользователь перенаправляется на часть сайта платформы, доступную для всех пользователей, где происходит проверка токена из базы с токеном вGET-параметре запроса. И в зависимости от полученного результата пользователю выдается список доступных правовых документов или страница с сообщением об ошибке аутентификации. Второй способ – получение письма с заранее сгенерированной ссылкой, в которой уже прописан токен. Письмо может быть отправлено после перехода запроса на страницу с документом в новое состояние. Также пользователи могут инициировать начало процесса отправкой письма на заранее известный адрес. После перехода и идентификации на публичной части платформы пользователь может совершить разрешенные ему действия.
Рисунок 2 – Схема процесса отображения документа на сайте
Далее можно определить основные моменты жизненного цикла любого документа, который доступен пользователю веб-приложения (рисунок 2). Необходимая пользователю юридическая информация хранится в виде набора структурированных данных в заранее определенном формате, например XML. Каждый файл в заданно формате должен строго соответствовать определенному набору правил, что в данном случае регулируется наличиемDTD-схемы, которая отвечает за проверку корректности структуры исходного документа. Общее содержание отдельных элементов исходного файла также регламентируется задокументированным набором стилистических требований, которые затем находят применения при конечном отображении документов (рисунок 3). Ввиду существования различных видов правовых актов, законов и иных документов к одним и тем же структурным элементов таких данных ним могут применяться отличные друг от друга стилистические требования, что требует разделения форматирования документов, относящихся к разным юридическим группам.
Если же взглянуть на систему с точки зрения разработчика, то он увидит ее подобным образом, как представлено на рисунке 4. Если заказчик требует внесения определенных изменения, он формирует ряд запросов. Затем выясняется, каким образом их лучше всего разрешить – со стороны исходных данных или их обработчика. Для тестирования предлагаемых решений используется локальный сервер. Если варианты устранения проблемы проходят успешную апробацию, то выпускается новая версия системы.
Рисунок 3 – Применения форматирования к исходным данным
Гибкая методология разработки программного обеспечения позволяет успешно вести разработку как небольших, так и средних проектов и реализации их в рамках единой сети правовых порталов. Система реализует фундамент для отображения любой юридической информации, позволяет описывать требования любого уровня, планировать состав документов и реализовывать их обработку.
Вся информация по процессу разработки доступна в одном месте, в связи с чем существенно упрощается контроль процесса разработки участниками проекта, заказчик также может контролировать процесс разработки или даже принимать в нем участие в части формирования пожеланий и управления приоритетами реализации или исправления ошибок.
Вы можете работать над проектом в любое время суток, в любом удобном для вас месте, где есть интернет, вся информация по проекту, артефакты и сведения по ходу его выполнения у вас всегда будут под рукой. Не нужно пересылать или переносить документы с одного компьютера на другой. Используемая система управления процессом разработки повышает степень контролируемости разработки, что является одним из важных критериев для заказчика, повышает его уверенность в успехе выполнения проекта.
Система реализована в форме Web-приложения. Не нужно устанавливать какое-либо приложение, заниматься дополнительным администрированием и безопасностью. Все что нужно пользователю – это Web-браузер и доступ в интернет.
Рисунок 4 – Схема отладки системы