Вы находитесь на странице: 1из 18

Автоматизированная информационно-

аналитическая система «А-СТЕК»


Модуль IT(S)
Руководство пользователя
Версия 1.9.5 01.07.2020

OOO «АЙТИУРСОФТ» www.itursoft.ru


АИАС «А-СТЕК» модуль IT(S) Руководство пользователя

1. Содержание
1. Содержание................................................................................................................................2
2. История изменений...................................................................................................................3
3. Глоссарий...................................................................................................................................4
4. Описание....................................................................................................................................8
5. Требования.................................................................................................................................9
5.1 Требования к конфигурации клиентской части (CI)........................................................9
6. Описание..................................................................................................................................10
7. Операции..................................................................................................................................11
7.1. Развертывание сервиса.....................................................................................................11
7.2. Настройка задания сервиса IT(S)....................................................................................11
7.3. Настройка задания агента IT(A)......................................................................................13
7.4. Выполнение задания........................................................................................................15
8. Решение проблем.....................................................................................................................17
8.1. Ошибки клиентской части...............................................................................................17
8.2. Ошибки CI-решения.........................................................................................................17
9. Контактная информация.........................................................................................................18

OOO «АЙТИУРСОФТ» www.itursoft.ru 2


АИАС «А-СТЕК» модуль IT(S) Руководство пользователя

2. История изменений
Версия Дата Описание
1.9.3 30.12.2019 Первоначальная редакция
1.9.4 01.04.2020 Обновление версии модуля, релиз ss-c
1.9.5 01.07.2020 Обновление версии модуля, релиз ss-s

OOO «АЙТИУРСОФТ» www.itursoft.ru 3


АИАС «А-СТЕК» модуль IT(S) Руководство пользователя

3. Глоссарий
Актив – некоторый элемент, созданный в процессе существования среды предприятия

Среда предприятия – совокупность активов различного происхождения, в результате


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

Автоматизированная информационно-аналитическая система «А-СТЕК» (АИАС) –


набор инструментов, предназначенный для решения задач учета и обслуживания среды
предприятия

Потребитель – физическое или юридическое лицо, использующее компоненты АИАС для


решения задач учета и обслуживания среды предприятия

Пользователь – лицо, непосредственно использующее компоненты АИАС – модули или


структуры БД для решения задач потребителя

Компонент АИАС (компонент решения) – подсистема, модуль или иное


дополнительное программное обеспечение, в рамках основного, специализированного или
расширяющего решений

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


совокупности механизмов взаимодействия с пользователем
 ITC – модуль для управления настройками и доступом к АИАС
 ITA – модуль для обработки данных среды предприятия средствами АИАС
 ITS – модуль для сервисной обработки АИАС и среды предприятия

Формат распространения – способ организации набора файлов (вид, состав и характер),


доступных для загрузки потребителем, в целях использования и/или адаптации
 Формат исходных файлов - исходный код приложений, библиотек, объектов БД,
скрипты для сборки
 Формат исполняемых файлов - исполняемые файлы конкретной платформы

Пакет распространения (решение) - совокупность элементов, представленная в


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

Базовый функционал – минимально достаточный набор элементов АИАС,


обеспечивающий ее запуск и функционирование, а также запуск прочих элементов АИАС

OOO «АЙТИУРСОФТ» www.itursoft.ru 4


АИАС «А-СТЕК» модуль IT(S) Руководство пользователя
Прикладная область – логически выделенная или функционально определенная часть
активов среды предприятия и процессы ее обслуживания или преобразования

Функция решения - некоторая ценность для потребителя системы, создаваемая


выполнением определенной последовательности элементов решения или определенного
элемента

Домен функции решения - область получения конечной ценности для потребителя,


ограниченная функциональностью конечного продукта некоторого вендора, технологией
или платформой

Элемент решения – логически/физически выделенный объект или группа объектов –


представленная как файл, сценарий, пакет, библиотека, компонент, приложение,
рассматриваемая для обоснованного применения в рамках АИАС
 Основные - представляют собой обязательные библиотеки, разработанные в
рамках АИАС, программные пакеты модулей АИАС, соответствующие схемы БД
(рус-О/ лат-P)
 Дополнительные - стороннее ПО и компоненты, библиотеки и утилиты,
настоятельно рекомендуемые к применению, не являющиеся разработками в
составе АИАС, значительно повышающие ее возможности, область применения
или доступный функционал (рус-Д/ лат-А)
 Расширяющие - стороннее ПО и компоненты, библиотеки и утилиты,
рекомендуемые к применению, не являющиеся разработками в составе АИАС,
расширяющие ее возможности или доступный функционал, используемые вне
интерфейса АИАС (рус-Р/ лат-Х)
 Инструментальные - прочее ПО, компоненты, библиотеки и утилиты,
разработанные в рамках АИАС, предназначенные для реализации функционала
основного, специализированного или расширяющего решения, реализующие свое
применение за счет основных элементов решения (рус-И/ лат-I)

Инструментальные элементы модуля ITA – инструментальные элементы, применяемые


в среде модуля ITA
 Агенты – модули на языке Python, необходимые объекты БД и прочие
необходимые ресурсы, предназначенные для обработки данных некоторого
фрагмента среды предприятия, для формирования структуры, сбора или расчета
необходимых показателей
 Отчеты – модули на языке Python, необходимые объекты БД и прочие
необходимые ресурсы, предназначенные для формирования некоторого описания
среды предприятия, загруженной в АИАС или представления определенных
показателей среды предприятия
 Сервисы – модули на языке Python, необходимые объекты БД и прочие
необходимые ресурсы, предназначенные для выполнения определенных действий
над элементами среды предприятия или данных АИАС

Инструментальные элементы модуля ITS – инструментальные элементы, применяемые


в среде модуля ITS
 Сервисы - модули на языке Python, необходимые объекты БД и прочие
необходимые ресурсы, предназначенные для выполнения определенных действий
над элементами среды предприятия или данных АИАС

OOO «АЙТИУРСОФТ» www.itursoft.ru 5


АИАС «А-СТЕК» модуль IT(S) Руководство пользователя
Компонент актива среды предприятия (компонент) – логическая единица
представления данных актива среды предприятия в АИАС, определяет набор базовых
артефактов – имя, тип, номер переопределения

Версия компонента актива среды предприятия (версия) – логическая единица


представления данных актива среды предприятия в АИАС, характеризующая состояние
актива в некоторый момент времени, определяет такие артефакты как время создания,
состояние и т.п.

Узел актива среды предприятия (узел) – обозначение актива среды предприятия в


АИАС в конкретный момент времени, т.е. обозначение компонента и его версии

Опорный файл узла – текстовое представление узла актива – последовательность команд


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

Соединение версий/узлов (соединение) – логическая структура, описывающая характер


взаимодействия между версиями компонентов – направление, артефакты и т.п.

Соединения структуры – набор типов соединений, описывающий позицию активов


среды предприятия – «содержит» или «родитель»-«потомок»

Соединения поведения – набор типов соединений, описывающих взаимодействие


активов среды предприятия – передача управления, упоминание, включение,
наследование

Локация – способ уникальной идентификации актива среды предприятия, представляет


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

Трек – набор идентификационных и основных данных некоторой активности,


реализуемой для модификации характеристик актива среды предприятия, ведущейся в
некоторой системе учета задач, проектов, обращений или документооборота предприятия

Трек-система – система учета задач, проектов, обращений или документооборота


предприятия

Экстрактор – набор параметров подключения и инструкций по преобразованию или


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

Домен активов среды предприятия – некоторая логическая группа активов среды


предприятия и их составных элементов, ограниченная каким либо признаком –
физическим размещением (файлы каталога), технологией или вендором (СУБД)

Каркас домена – представление в АИАС некоторого домена активов среды предприятия,


сформированное в некоторый момент времени, включающее наиболее полное количество
активов (без фильтрации), формируется агентами - менторами

Агент-ментор (ментор) – агент, предназначенный для формирования каркаса для домена


активов среды предприятия

OOO «АЙТИУРСОФТ» www.itursoft.ru 6


АИАС «А-СТЕК» модуль IT(S) Руководство пользователя

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


некоторым агентом

Патч-сет – совокупность патчей

Процесс обработки патча – процесс модификации данных АИАС в части узлов, их


соединений, артефактов или прочей информации, за счет последовательного
преобразования данных патча – позитивных соединений (создание/модификация узлов в
структуру АИАС) и негативных соединений (исключение узлов из структуры АИАС)

Позитивные соединения – вид технических соединений патча, определяющих


существование узла или связей между узлами АИАС

Негативные соединения – вид технических соединений патча, определяющих отсутствие


связей между узлами АИАС, сформированные в процессе обработки патча, или
полученные в результате работы агента (за счет использования аудита)

OOO «АЙТИУРСОФТ» www.itursoft.ru 7


АИАС «А-СТЕК» модуль IT(S) Руководство пользователя

4. Описание
Последующие разделы документа содержат описание интерфейса модуля ядра IT(C)
АИАС и основных операций выполняемых при его использовании.

Рекомендуем использовать актуальные версии решений и модулей, полученные с


официального сайта – http://www.itursoft.ru.

OOO «АЙТИУРСОФТ» www.itursoft.ru 8


АИАС «А-СТЕК» модуль IT(S) Руководство пользователя

5. Требования
5.1 Требования к конфигурации клиентской части (CI)
Компоненты решения, предназначенные для автоматической/полуавтоматической
обработки активов среды – инструментальные элементы ITS (сервисы), для корректного
функционирования требуют:
 Дополнительные компоненты – клиент или библиотеки для подключения к
основной БД установленной системы
 Память – не меньше 2 Гб
 Среда языка Python – Python 2.7
 Версия – не ниже 2.7.4
 Дополнительные библиотеки (официальный сайт - https://pypi.org ):
o cx-Oracle – библиотека для работы с БД Oracle или psycopg2 - библиотека
для работы с БД PostgreSQL
o pytkapp – пакет для реализации базовых элементов интерфейса
o pyit – пакет для реализации базовых компонентов АИАС (официальный сайт
– https://www.itursoft.ru )
o прочие библиотеки, в соответствии с файлом описания сервиса
Рекомендуется проверить desc-файл инструментального элемента (размещен в каталоге
самого элемента) на наличие уточненных требований по наличию и версиям
необходимого ПО

OOO «АЙТИУРСОФТ» www.itursoft.ru 9


АИАС «А-СТЕК» модуль IT(S) Руководство пользователя

6. Описание
Текущая версия модуля не имеет отдельного интерфейса. Все необходимые операции
выполняются в сторонних инструментах, используемых для функционирования элементов
решения.
Рекомендуемые решения:
 CI-система Hudson (hudson-ci.org)
 CI-система Jenkins (jenkins.io)

OOO «АЙТИУРСОФТ» www.itursoft.ru 10


АИАС «А-СТЕК» модуль IT(S) Руководство пользователя

7. Операции
Данный раздел предназначен для описания реализации ключевых операций модуля.

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


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

Стандартным местом для размещения файлов сервисов является подкаталог


develop\services корневого каталога пакета модуля IT(S). Как показано на иллюстрации
ниже, данный каталог содержит набор каталогов доступных сервисов:

Каталог сервиса может содержать следующие типы файлов:


 dbdeploy.sql – сценарий установки объектов БД
 its_<имя>.py – файл сервиса
 its_<имя>-desc.txt – файл описания (требования, изменения)
 its_<имя>.conf – пример файла настроек сервиса
 ITS.NNNNNN_ddl – скрипт для создания объекта БД

Ниже приведен пример доступных файлов для сервиса its_mydbstat:

Первым шагом развертывания сервиса необходимо создать необходимые для него


объекты БД. Для этого используется сценарий развертывания – dbdeploy.sql. Данный
сценарий необходимо выполнить в среде sqlplus, предварительно подключившись к БД
пользователем, имеющим необходимые права для создания объектов в схеме ITS.
После установки объектов БД, входящих в состав инструментального элемента,
необходимо выполнить выравнивание доступа к объектам БД – выполнить процедуру
ALIGN_OBJECT_ACCESS в схеме БД.

7.2. Настройка задания сервиса IT(S)


Настройка выполнения инструментального элемента модуля IT(S) будет рассмотрена на
примере использования стороннего инструмента – CI-системы Hudson (hudson-ci.org)
версии 3.3 под управлением ОС Windows.
При размещении инструментального элемента на сервере CI-системы рекомендуется
использовать следующую структуру каталогов:
 Диск С:
o Папка Hudson

OOO «АЙТИУРСОФТ» www.itursoft.ru 11


АИАС «А-СТЕК» модуль IT(S) Руководство пользователя
 Папка config – размещение конфигурационных файлов (*.conf)
инструментальных элементов модуля
 Runtime – рабочий каталог CI-системы (журналы, настройки и т.д.)
 Scripts – каталог размещения инструментальных элементов (*.py)

В рамках текущего примера рассмотрим настройку сервиса its_mydbstat,


соответствующему функции решения MS/ITSS/1 дискретные показатели. Для настройки
сервиса необходимо выполнить следующие шаги:
 Установка дополнительного прикладного или системного ПО, необходимого для
функционирования сервиса, в соответствии с файлом описания сервиса

 Настройка и размещение конфигурационного файла (параметры подключения к БД


и прочие параметры выполнения)

 Размещение инструментального элемента (сервиса)

 Создать новое задание в CI-системе

Для запуска сервиса модуля ITS необходимо настроить выполнение скрипта или команды
ОС, как показано ниже:

OOO «АЙТИУРСОФТ» www.itursoft.ru 12


АИАС «А-СТЕК» модуль IT(S) Руководство пользователя

При этом необходимо обратить внимание на использованное имя задания – MYDB-


ITS_MYDBSTAT1, которое соответствует имени .CONF файла, созданного на
предыдущем шаге. Это имя передается в команду запуска задачи CI в переменной
%JOB_NAME%.

7.3. Настройка задания агента IT(A)


В рамках текущего примера рассмотрим настройку запуска агента its_mydbinststatagent_1
соответствующего функции решения MS/ITAA/7 загрузка показателей объектов БД. Для
настройки задания необходимо выполнить следующие шаги:
 Подготовить задание модуля IT(A) для запуска агента (см. раздел Операции
Создание заданий Модуль IT(A) руководство пользователя)1. Проверить создание
задание и его код можно используя консоль заданий, как показано ниже:

 Установить модуль IT(A) на сервере CI-системы2


 Настроить модуль IT(A) для запуска в пакетном режиме:
o Выполнить запуск модуля, и подключиться к БД АИАС под пользователем,
от имени которого, будет производиться выполнение агента)

 Перейти в диалог настроек приложения используя меню Настройки/Приложение


(Preferences/Application):

1
Предполагается, что настройка задания модуля IT(A) и автоматическое выполнение будет происходить на
различных рабочих местах/серверах
2
Выполняется разово при подготовке узла CI-системы

OOO «АЙТИУРСОФТ» www.itursoft.ru 13


АИАС «А-СТЕК» модуль IT(S) Руководство пользователя

 Сохранить параметры подключения для применения в пакетном режиме, как


показано ниже:

 Создать новое задания в CI-системе

Для запуска модуля IT(A) необходимо настроить выполнение скрипта или команды ОС,
как показано ниже3:
 Этап 1 – выполнение запуска агента, формирование патч-сета и его загрузка в БД
АИАС

Рекомендуемая команда выполнения этапа:


c:\ita\ita.exe --taskid=NNN
if ERRORLEVEL 2 exit /B 0

, где NNN – код задания модуля IT(A), подготовленный в рамках настройки задания CI
3
Для запуска модуля IT(A) в пакетном режиме запуск CI-системы не должен происходить в виде сервиса
ОС. Необходимо производить запуск CI-системы как отдельного приложения.

OOO «АЙТИУРСОФТ» www.itursoft.ru 14


АИАС «А-СТЕК» модуль IT(S) Руководство пользователя

 Этап 2 – выполнение обработка патч-сета в БД АИАС

Рекомендуемая команда выполнения этапа:


c:\ita\ita.exe --taskid=MMM
if ERRORLEVEL 2 exit /B 0

, где MMM – код задания модуля IT(A) для пакетной обработки патч-сетов, который
должен быть предварительно сформирован для сниппета через консоль обработки патч-
сетов модуля IT(A):

7.4. Выполнение задания


Используя CI-систему Hudson, для выполнения заданий рекомендуется использовать
следующие варианты запуска:
 Ручной вариант – запуск задачи происходит пользователем через интерфейс CI-
системы

 Запуск по расписанию – для задачи указывается расписание запуска

OOO «АЙТИУРСОФТ» www.itursoft.ru 15


АИАС «А-СТЕК» модуль IT(S) Руководство пользователя

 Запуск по зависимости – для задачи указывается условие запуска, в зависимости от


выполнения другого задания
o Вариант запуска после указанного задания

o Вариант запуска указанного задания после выполнения текущего

Для получения подробного описания возможностей по настройке и выполнению заданий


необходимо обратиться к документации используемой CI-системы.

OOO «АЙТИУРСОФТ» www.itursoft.ru 16


АИАС «А-СТЕК» модуль IT(S) Руководство пользователя

8. Решение проблем
8.1. Ошибки клиентской части
1. Приложения не запускаются
Необходимо установить библиотеки Microsoft Visual C Redistributable – 2005, 2008
(можно скачать с официального сайта Microsoft – www.microsoft.com или с нашего
официального сайта www.itursoft.ru раздел Поддержка)
2. Приложение не может подключиться к БД
Необходимо установить соответствующий БД клиент, и прописать в переменной
окружения PATH путь до его библиотек

8.2. Ошибки CI-решения


1. Запуск заданий не происходит
Необходимо проверить доступ к указанному приложению или инструментальному
элементу
2. Не происходит вызов приложения
Необходимо проверить способ работы CI-системы, для запуска пакетного режима
приложения, CI-система не может быть установлена как сервис
3. Не происходит запуск связанных заданий
Необходимо проверить параметры заданий в части запуска при наличии ошибок и
предупреждений

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


1. Обратитесь к разделу Поддержка на официальном сайте www.itursoft.ru для поиска
актуальной версии документации или поиска решения
2. Обратитесь к нашим специалистам по электронной почте support@itursoft.ru. При
обращении к специалистам поддержки, возможно, потребуется предоставить
информацию по версии ОС и версии БД, на которую производилось
развертывание, а также журналы развертывания (формируются в каталоге пакета в
виде файлов <схема>.log)

OOO «АЙТИУРСОФТ» www.itursoft.ru 17


АИАС «А-СТЕК» модуль IT(S) Руководство пользователя

9. Контактная информация
Полное Общество с ограниченной ответственностью «АЙТИУРСОФТ»
наименование
Сокращенное ООО «АЙТИУРСОФТ»
наименование
ИНН 9715365006
КПП 771501001
ОГРН 1197746605154
Адрес 127081, г.Москва, ул.Заповедная, 14 к1 оф. 3/6
Сайт www.itursoft.ru
Почта contact@itursoft.ru

OOO «АЙТИУРСОФТ» www.itursoft.ru 18

Оценить