СУФД. АРМ внешних систем. Руководство администратора. - SUFD

УТВЕРЖДАЮ
УТВЕРЖДАЮ
Заместитель руководителя
Генеральный директор
Федерального казначейства
OOO «»
__________________ / /
________________ / /
"___" ______ 200__ г.
"___" ______ 200__ г.
ППО «АСФК-СУФД»
СУФД. АРМ ВНЕШНИХ СИСТЕМ.
Руководство администратора
Лист утверждения
Код документа: xxxxxxxxxxx- ЛУ
СОГЛАСОВАНО
СОГЛАСОВАНО
От Федерального казначейства
От компании разработчика
Руководитель подразделения
______________ / /
"___" ______ 200__ г.
________________ / /
"___" ______ 200__ г.
Москва
2010
Утвержден
xxxxxxxxxxx- ЛУ
ППО «АСФК-СУФД»
СУФД. АРМ ВНЕШНИХ СИСТЕМ.
Руководство администратора
Код документа: xxxxxxxxxx
Листов: 20
Москва
2010
Наименование ПС:
Код документа:
ППО «АСФК-СУФД»
Стр. 3
Содержание
1.
ВВЕДЕНИЕ ............................................................................................................................... 4
1.1.
1.2.
1.3.
2.
ОБЩЕЕ ОПИСАНИЕ АРМ ВС ............................................................................................ 5
2.1.
3.
НАЗНАЧЕНИЕ ДОКУМЕНТА .................................................................................................. 4
СТРУКТУРА ДОКУМЕНТА ..................................................................................................... 4
УСЛОВНЫЕ ОБОЗНАЧЕНИЯ И СОКРАЩЕНИЯ ........................................................................ 4
НАЗНАЧЕНИЕ И ОБЩИЙ ПРИНЦИП РАБОТЫ АРМ ВС .......................................................... 5
КОНФИГУРИРОВАНИЕ АРМ ВС ...................................................................................... 6
3.1. ОПИСАНИЕ ФАЙЛОВ НАСТРОЙКИ АРМ ВС ......................................................................... 6
3.2. ОПИСАНИЕ КОНФИГУРАЦИИ ИНФОРМАЦИОННЫХ ПОТОКОВ .............................................. 8
3.3. НАСТРОЙКА СБ ................................................................................................................. 11
3.3.1.
Создание функции «IMPORT_EXPORT» ............................................................... 11
3.3.2.
Создание роли и назначение пользователей ......................................................... 15
Наименование ПС:
Код документа:
ППО «АСФК-СУФД»
Стр. 4
1.
ВВЕДЕНИЕ
1.1. Назначение документа
Документ содержит описание принципов работы специализированного АРМ внешних
систем пакета программного обеспечения «Система удаленного финансового
документооборота». Документ предназначен для специалиста, в функциональные
обязанности которого входит администрирование АРМ Внешних систем. Документ актуален
для АРМ Внешних систем версии 0.9.4 и выше.
1.2. Структура документа
Документ состоит из двух основных частей:
1.
2.
В первой части документа дано общее описание принципов работы АРМ ВС.
Во второй части документа описано конфигурирование АРМ ВС.
1.3. Условные обозначения и сокращения
В данном разделе приводятся условные обозначения и сокращения, используемые в
рамках документа.
Термин
Содержание
АРМ СБ
Автоматизированное рабочее место сервера безопасности
Объект
Объекты системы: документы, значения справочников, настройки и т.д.
Параметры
Данные полей документа, справочников и т.п.
ППО СУФД
Пакет программного обеспечения «Система удаленного финансового
документооборота»
СБ СУФД
Сервер безопасности «Системы удаленного финансового документооборота»
АРМ ВС
Автоматизированное рабочее место Внешних систем
Наименование ПС:
Код документа:
ППО «АСФК-СУФД»
Стр. 5
2.
ОБЩЕЕ ОПИСАНИЕ АРМ ВС
2.1. Назначение и общий принцип работы АРМ ВС
АРМ внешних систем (АРМ ВС) предназначен для контроля файлов, импортируемых
из внешних систем, и экспортируемых во внешние системы в процессе эксплуатации ППО
СУФД.
Принцип функционирования АРМ ВС основывается на мониторинге содержания
набора «исходных» директорий, описанных в конфигурации. По факту появления нового
файла в такой директории активизируется процесс его обработки. Факт выявляется на
основании периодического считывания содержания директории или на основании получения
от операционной системы уведомления об изменении содержания директории
АРМ ВС также может принимать от внешних систем архивы с данными. Каждый архив
может содержать импортируемые в СУФД файлы различных типов. Обработка архива
состоит в том, что файлы, входящие в его состав в соответствии с их наименованиями
раскладываются по другим «исходным» директориям. В остальном обработка входящих
архивов производится так же, как и обработка входящих файлов любых других типов.
АРМ ВС осуществляет информационный обмен с подсистемами следующих основных
типов:
1.
Внешние информационные системы.
В интересах информационных систем АРМ ВС передает выгруженные СУФД файлы
данных на внешние для системы файловые ресурсы.
2.
СУФД.
В интересах СУФД АРМ ВС передает выгруженные внешними системами файлы
данных на внутренние для системы файловые ресурсы
3.
Сервер безопасности.
К серверу безопасности АРМ ВС обращается за разрешением на передачу каждого
файла. Также СБ в данном случае является средством ведения лога операций
перегрузки данных.
Общая схема работы АРМ ВС показана на Error! Reference source not found..
Рисунок 1. Общая схема работы АРМ ВС
Наименование ПС:
Код документа:
ППО «АСФК-СУФД»
Стр. 6
3.
КОНФИГУРИРОВАНИЕ АРМ ВС
Конфигурирование АРМ ВС заключается в описании настроек работы самого АРМ, а
также в описании конфигурации поддерживаемых информационных потоков. Для
корректной работы АРМ ВС, также должен быть установлен и настроен СБ СУФД.
3.1. Описание файлов настройки АРМ ВС
Конфигурирование АРМ ВС происходит путем редактирования файлов настройки
АРМ, которые находятся в каталоге resources. В этом каталоге содержатся следующие
файлы:
– tosser.properties (файл, содержащий основные настройки сервера);
– log4j.properties (файл, содержащий настройки ведения лога работы сервера).
Пример структуры файла конфигурации tosser.properties приводится ниже:
#System settings
console=com.otr.sufd.tosser.console.NullConsole
transactional.state=com.otr.sufd.tosser.state.FileTransactionalState
#таймаут остановки сервера (0 - не ограничен)
server.shutdown.time=10
server.restart.time=150
ftp.encoding = Windows-1251
config.dir=./config
config.filemask=*config.xml
##Основные настройки
#Директория карантинных файлов
quarantine.dir=./quarantine
#Максимальное кол-во одновременно обрабатываемых файлов
max.processed.files=4
#Максимальное количество потоков сканирования директорий
max.dirscan.threads=10
#Максимальное количество попыток скоировать файл повторно, после которого файл помещается
в очередь некопируемых файлов.
max.copy.retries=10
#Сессия к СБ
security.server.url=tcp://localhost:3000
security.server.login=admin
security.server.pass=amover
#разрешения, которые необходимо выставить для файла, по завершении его копирования (в
форма комманды chmod)
copied.file.permission=664
#выводить ли в лог комманды взаимодействия с ФТП сервером
#Настройки почты
mail.smtp.host=localhost
mail.from=report@localhost
ftp.log=false
ftp.pool=true
Наименование ПС:
Код документа:
ППО «АСФК-СУФД»
Стр. 7
ftp.poolsize=20
ftp.optimize=false
ftp.passive=true
В 1. приводится описание параметров, используемых в файле tosser.properties.
Таблица 1. Описание параметров файла конфигурации tosser.properties
Нзавание параметра
Описание параметра
console
Класс консоли управления
transactional.state
Класс управления транзакционным состоянием
server.shutdown.time
При остановке сервера, если сервер не завершит свою работу в течение
заданного этим параметром времени (в секундах), то он будет
принудительно остановлен
server.restart.time
Время в секундах, которое отводится потокам сканирования на
заврешение работы, после чего сервер считает что потоки повисли и
перезапускает их. Если в логе часто встречаются нижеприведенные
строки, это означает, что нужно увеличить значение параметра
server.restart.time:
Found hang/not working thread. restarting server ...
Остановка сервера
...
ftp.encoding
Кодировка, в которой tosser будет работать с FTP (значение задается в
виде UTF-8, Windows-1251 и т.д.)
config.dir
Директория с файлами конфигурации потоков (если указан
относительный путь, то директория считается относительно
директории, в которой лежит АРМ)
config.filemask
Маска имен файлов конфигурации потоков (будут загружены только
те файлы, которые соответствуют маске)
quarantine.dir
Директория карантинных файлов (файлов, не пропущенных СБ)
max.processed.files
Максимальное число файлов обрабатываемых (копируемых) за раз.
Если, при работе tosser, появляются ошибки о том, что сервер FTP
закрыл соединение, то необходимо уменьшить значение параметра
max.processed.files вплоть до 1.
max.dirscan.threads
Максимальное число потоков, сканирующих директории
одновременно
max.copy.retries
Количество повторных попыток, скопировать файл, после чего файл
отмечается как некопируемый; повторное копирование будет
предпринято только после перезапуска сервера
security.server.url
URL подключения к СБ (например tcp://localhost:3000)
security.server.login
Имя пользователя в СБ (основная сессия создается под
администратором СБ)
security.server.pass
Пароль пользователя
mail.smtp.host
Адрес почтового сервера, через который будут отправляться
уведомления в случае, если файл будет заблокирован СБ
mail.from
От кого отправляются уведомления
ftp.log
Вывод лога работы с FTP в консоль tosser
Наименование ПС:
Код документа:
ППО «АСФК-СУФД»
Стр. 8
ftp.pool
Пул подключений к FTP. Для подключения к FTP используется FTPклиент. На его создание уходит какое-то время (это именно создание, а
не подключение к FTP). Чтобы каждый раз не создавать его заново
создается пул (набор) этих клиентов, откуда они берутся по мере
надобности и куда возвращаются когда не нужны
ftp.poolsize
Размер пула подключений к FTP. Максимальное количество клиентов,
которые могут одновременно находиться в пуле
ftp.optimize
Оптимизация работы с FTP. Если указано true, то на каждый
найденный в каталоге файл не открывается отдельная FTP-сессия, а
все файлы качаются в рамках одной сессии
ftp.passive
Работа с FTP в пассивном режиме (необходимо для работы с FTPсерверами, расположенными на HP-UX, а также для некоторых других
ОС и FTP серверов)
Рекомендуемые настройки для конфигурационного файла tosser.properties:
console=com.otr.sufd.tosser.console.NullConsole
transactional.state=com.otr.sufd.tosser.state.FileTransactionalState
server.shutdown.time=10
server.restart.time=150
ftp.encoding = UTF-8
config.dir=./config
config.filemask=config*.xml
quarantine.dir=./quarantine
max.processed.files=4
max.dirscan.threads=10
max.copy.retries=10
security.server.url=tcp://localhost:3000
security.server.login=admin
#security.server.pass=password
copied.file.permission=775
mail.smtp.host=localhost
mail.from=report@localhost
ftp.log=false
ftp.pool=true
ftp.poolsize=20
ftp.optimize=false
ftp.passive=true
3.2. Описание конфигурации информационных потоков
Описание конфигурации информационных потоков, поддерживаемых АРМ ВС
содержится в файлах формата XML, расположенных в директории config. Пример структуры
такого XML файла конфигурации показан ниже:
<config>
<!-- Описание группы информационных потоков -->
<flows>
<!-- описание информационного потока -->
<!-- id - идентификатор потока
systemUserId - идентификатор служебного пользователя СБ
name - Название потока (опционально) -->
Наименование ПС:
Код документа:
ППО «АСФК-СУФД»
Стр. 9
<flow id="Поток 001" systemUserId="test" name="Тестовый поток 1">
<description>Описание тестового потока (опциональное)</description>
<!-- период активности потока с (from) по (to) -->
<period from="01.01.2007" to="01.01.2009"/>
<!-- Тип потока, экспорт или импорт -->
<export/>
<!--import /-->
<!-- описание источника документов
url - откуда берутся документы
nativeScan - использовать ли нативные библиотеки для сканирования содержимого
папки
scanInterval - интервал сканирования источника в секундах
recurseDirs – работать ли с вложенными каталогами -->
<source url="c:\\temp\test-input" name="test-input" nativeScan="false"
scanInterval="10" recurseDirs="false" >
<!-- фильтрация файлов по расширению, имени, и максимальному размеру -->
<!-- размер может быть задан в формате {число}{модификатор размера}
например 10K - 10 килобайт, 10M - 10 мегобайт, 10G - 10 гигабайт -->
<filter extensions="*" fileName="*" maximumSize="10M"/>
</source>
<destination url="c:\\temp\test-output" name="test-output"/>
<!-- Настройка оповещений -->
<failure-notify>
<e-mail>mail@localhost</e-mail>
</failure-notify>
<success-notify>
<autoproc>autoproc_name</autoproc>
<url>http://ya.ru</url>
</success-notify>
</flow>
<flow id="Поток 002" systemUserId="test2" name="Тестовый поток 2">
<import />
<source url="ftp://newuser:123@localhost" name="test-input2"
nativeScan="false" scanInterval="5" recurseDirs="false" >
<filter extensions="*"/>
</source>
<destination url="ftp://newuser:123@localhost/absd" name="test-output2"/>
</flow>
</flows>
</config>
Описание тэгов, используемых в конфигурационном файле приводится в Error!
Reference source not found..
Таблица 2. Описание тэгов, используемых в файле конфигурации
Тэг
flow
description
Описание
Атрибуты
Назначение
Служит для описания
id
информационного потока,
содержит в себе указание на
name
исходную и конечную
директории файлов, имя
systemUserId
пользователя для
подключение к СБ,
настройки оповещений,
фильтры файлов и тип
операции
Идентификатор потока (для удобства
описания)
Служит для описания
информационного потока
-
-
Наименование потока (опционально)
Имя пользователя для подключения к
СБ
Наименование ПС:
Код документа:
Тэг
period
ППО «АСФК-СУФД»
Стр. 10
Описание
(опционально)
Служит для описания
периода действия
описываемого потока
Атрибуты
Назначение
from
Начало периода действия
описываемого потока
to
Окончание периода действия
описываемого потока
export
Служит для описания
экспорта файлов (необходим
для СБ для отражения
направления дважения
файла в аудите действий
АРМ ВС)
-
import
Служит для описания
импорта файлов (необходим
для СБ для отражения
направления дважения
файла в аудите действий
АРМ ВС)
-
source
Служит для описания
url
источника файлов.
Содержит описание папки и
интервала ее сканирования
(в секундах), фильтров
файлов.
Путь, к каталогу - источнику файлов.
Если путь задан в форме ./some_dir то
путь считается относительно
директории, в которой находится
АРМ.
Путь также может быть задан как
абсолютный c:\test_dir или как URL
FTP сервера
ftp://user:pass@server:port/folder
failure-notify
Name
Наименование (опционально)
scanInterval
Интервал сканирования директории (в
секундах)
nativeScan
Использование оповещения ОС о
появлении новых файлов в
директории (не задействован)
recurseDirs
Рекурсивная работа с вложенными
каталогами. По умолчанию (если
параметр не указан в явном виде),
работа идет и с вложенными
каталогами. Для отключения
сканирования вложенных каталогов
необходимо указать значение false
Служит для описания
оповещений для
заблокированных СБ файлов
success-notify Служит для описания
оповещений для успешно
перегруженных файлов.
-
-
-
Наименование ПС:
Код документа:
Тэг
ППО «АСФК-СУФД»
Стр. 11
Описание
Описание фильтров, в
соответствии с которыми,
будут выбираться файлы из
опрашиваемой директории.
Есть возможность задать
фильтры по имени файла,
расширению или размеру
filter
destination
Атрибуты
Назначение
extensions
Список расширений файлов через
запятую, если несколько. Допускается
использование символов * и ?
fileName
Фильтр по имени файла. Допускается
использование символов * и ?
maximumSize
Фильтр по размеру файла в формате
{число}{модификатор}. Модификатор
может быть K, M, G – для килобайт,
мегабайт и гигабайт соответственно.
Например: 10K - 10 Килобайт, 10M 10 Мегабайт, 10G - 10 Гигабайт
Описание папки назначения, url
куда будет перемещен файл,
при условии
положительного ответа от
СБ.
Name
Путь, к каталогу назначения. Если
путь задан в форме ./some_dir то путь
считается относительно директории в
которой находится АРМ.
Путь также может быть задан как
абсолютный c:\test_dir или как URL
FTP сервера
ftp://user:pass@server:port/folder
Наименование (опционально)
3.3. Настройка СБ
Настройка СБ заключается в определении функции IMPORT_EXPORT, создании роли
позволяющей обращаться к СБ при работе АРМ ВС и назначении этой роли пользователям
от имени которых будет идти обращение к СБ при мониторинге информационных потоков.
3.3.1. Создание функции «IMPORT_EXPORT»
В АРМ СБ переходим в раздел «Объекты доступа», подраздел «Функции» (рис. 2).
Наименование ПС:
Код документа:
ППО «АСФК-СУФД»
Стр. 12
Рисунок 2. АРМ СБ. Раздел «Объекты доступа», подраздел «Функции»
Рисунок Для добавления новой функции используется кнопка «Добавить». После
нажатия кнопки, необходимо настроить параметры создаваемой функции. Настройка
параметров осуществляется на двух закладках: «Общие (1)» и «Наборы (2)». На
закладке «Общие», в соответствующих полях, указывается код функции
(IMPORT_EXPORT) и её наименование (например АРМ ВС) (рис. 33. Закладки для
описания параметров новой функции
).
Рисунок 3. Закладки для описания параметров новой функции
Наименование ПС:
Код документа:
ППО «АСФК-СУФД»
Стр. 13
Далее необходимо описать параметры функции. Для этого нужно нажать кнопку
«Добавить» (рис. 3), после чего на экране появляется форма «Редактирование» (рис. Error!
Reference source not found.).
Рисунок 4. Форма для описания параметров новой функции
В появившейся форме, последовательно заполняются поля «Код» и «Наименование».
Далее указывается тип данных. Выбор типа данных осуществляется из списка доступных
типов (рис. 5Error! Reference source not found.), который
вызывается при нажатии на
кнопку
Рисунок 5. Список доступных типов данных
Для нормальной работы АРМ ВС, создаваемая функция «IMPORT_EXPORT» должна
иметь параметры, указанные в 3.
Таблица 3. Описание параметров функции «IMPORT_EXPORT»
Поле
Тип
Описание
fileCreated
Дата
Дата создания файла
fileName
Строка
Имя файла
fileSize
Число
Размер файла
fileType
Строка
Тип файла (на основе расширения)
operation
Строка
Тип действия (import/export)
Наименование ПС:
Код документа:
ППО «АСФК-СУФД»
Стр. 14
Итоговый результат описания параметров функции на закладке «Общие (1)» показан на
рисунке 6. .
Рисунок 6. Результат описание параметров создаваемой функции
После описания параметров создаваемой функции, на закладке «Наборы (2)» (рис. 7)
прописываются правила.
Рисунок 7. Редактирование наборов для функции
Для добавления нового набора используется кнопка «Добавить».
После нажатия кнопки, в появившейся на экране форме (рис. 8), в соответствующих
полях, необходимо задать имя правила и записать выражение, реализующее это правило.
Наименование ПС:
Код документа:
ППО «АСФК-СУФД»
Стр. 15
Рисунок 8. Форма для определения нового набора
Для сохранения результатов редактирования наборов необходимо нажать кнопку
«Сохранить».
По окончании создания новой функции необходимо нажать кнопку «Сохранить» на
панели инструментов.
3.3.2. Создание роли и назначение пользователей
После создания функции IMPORT_EXPORT, необходимо определить роль
позволяющую подключаться к СБ при работе АРМ ВС и назначить её пользователям, от
имени которых будет происходить подключение.
Для добавления новой роли, используя панель навигации переходим в раздел АРМ СБ
«Субъекты доступа», подраздел «Роли» (рис. 9).
Рисунок 9. АРМ СБ. Раздел «Субъекты доступа». Подраздел «Роли»
Наименование ПС:
Код документа:
ППО «АСФК-СУФД»
Стр. 16
На панели инструментов нажимаем кнопку «Добавить», после
необходимо заполнить параметры определяемой роли.
чего на закладках
Закладка «Общие (1)»
На закладке «Общие (1)», последовательно заполняются следующие поля: «Код»,
«Наименование», «Описание» и «Партнерскую систему». Пример заполнения полей показан
на рисунке 10.
Рисунок 10. Закладка «Общие (1)»
Закладка «Доступ (3)»
Наименование ПС:
Код документа:
ППО «АСФК-СУФД»
Стр. 17
На закладке «Доступ к данным (3)» (рис. 11) определяется к каким объектам будет доступ у
пользователя, которому будет назначена создаваемая роль. В левой части закладки
расположено дерево объектов, разбитых по категориям, а в правой - таблица параметров,
соответствующих выбранному объекту
Рисунок 11. Закладка «Доступ к данным (3)
На закладке «Доступ к функциям (4)» (рис. 12) определяется к каким функциям будет
доступ у пользователя, которому будет назначена создаваемая роль. В левой части закладки
расположены не назначенные до текущего момента функции для роли, а в правой назначенные
Рисунок 12. Закладка «Доступ к фунциям (4)
Закладка «Доступ к данным (3)»
Наименование ПС:
Код документа:
ППО «АСФК-СУФД»
Стр. 18
Настройка доступа к данным для создаваемой роли осуществляется следующим
образом:
1. В левой части окна выбираем объект «Сессии пользователя / Сессии». В Правой
части экрана выбираем «Разрешено» (Зеленая галочка) для всех пунктов (рис.
13)
2. В левой части окна выбираем объект «Системные объекты / Роль». В Правой части
экрана выбираем «Разрешено» (Зеленая галочка) для всех пунктов (рис. 14).
3. В левой части окна выбираем объект «Системные объекты / Функция». В Правой
части экрана выбираем «Разрешено» (Зеленая галочка) для всех пунктов (рис.
15)
Рисунок 13. Назначение прав доступа к данным
Рисунок 14. Назначение прав доступа к данным
Наименование ПС:
Код документа:
ППО «АСФК-СУФД»
Стр. 19
Рисунок 15. Назначение прав доступа к данным
Закладка «Доступ к функциям (4)»
Настройка доступа к функции «IMPORT_EXPORT» осуществляется следующим
образом:
4. В левой части окна выбираем функцию, которую необходимо назначить для роли.
В данном случае это функция «IMPORT_EXPORT».
5. Выбрав функцию, ее необходимо перенести в раздел «Назначенные функции».
Для этого необходимо нажать кнопку
(рис. 16)
Рисунок 16. Назначение прав доступа к функции «IMPORT_EXPORT»
Наименование ПС:
Код документа:
ППО «АСФК-СУФД»
Стр. 20
Закладка «Пользователи (6)»
На закладке «Пользователи (6)» формируется список пользователей которым будет
назначена создаваемая роль. (рис. 17).
Рисунок 17. Закладка «Пользователи (6)
В списке «Все пользователи» выбирается пользователь, которому будет назначена
создаваемая роль и с помощью кнопки со стрелкой пользователь перемещается в список
«Назначенные пользователи».
По окончании редактирования параметров создаваемой роли, необходимо нажать
кнопку «Сохранить» на панели инструментов.
Наименование ПС:
Код документа:
ППО «АСФК-СУФД»
Стр. 21
СОСТАВИЛИ
Наименование
организации,
предприятия
Должность
исполнителя
Фамилия, имя,
отчество
Подпись
Дата
СОГЛАСОВАНО
Наименование
организации,
предприятия
Должность
исполнителя
Фамилия, имя,
отчество
Подпись
Дата
Наименование ПС:
Код документа:
ППО «АСФК-СУФД»
Стр. 22
ЛИСТ РЕГИСТРАЦИИ ИЗМЕНЕНИЙ
№
версии
док-та
Дата
изменения
0.1
10.09.2008
1.0
11.11.2008
Алексеев И.И.
Первоначальная версия документа.
1.1
06.05.2010
Андреев И.Н.
Документ актуализирован.
Автор изменений
Изменения
Черновой вариант документа.