Изменения документа VKPHT. Описание системы R4 (24Q1)

Редактировал(а) Александра Баруткина 2024/06/27 13:20
От версии 10.3
отредактировано Александра Баруткина
на 2024/06/05 17:55
Изменить комментарий: К данной версии нет комментариев
К версии 10.4
отредактировано Александра Баруткина
на 2024/06/05 18:03
Изменить комментарий: (Autosaved)

Сводка

Подробности

Свойства страницы
Содержимое
... ... @@ -64,6 +64,17 @@
64 64  * Автоматизировать процессы управления конфигурацией Системы.
65 65  * Вести справочники системы (НСИ) через панель администрирования.
66 66  
67 +**~ INT Модуль "Управление интеграцией"**
68 +
69 +Модуль позволяет:
70 +
71 +* Регистрировать шаблоны, их структуру, проверки и разрешенные типы, скачивать пустые шаблоны.
72 +* Конфигурировать правила обработки шаблонов.
73 +* Выполнять сценарий интеграции данных через мастер методы: поток по группе правил обработки шаблонов.
74 +* Выполнять сценарий интеграции данных пошагово.
75 +* Просматривать результаты интеграции.
76 +* Выгружать отчетные формы.
77 +
67 67  = Глоссарий =
68 68  
69 69  **Адаптация** – это оказание помощи вновь принятому работнику в усвоении и принятии норм и правил, существующих в компании, создание позитивного образа компании и приобщение к корпоративной культуре.
... ... @@ -1207,3 +1207,195 @@
1207 1207  |Настройки отключаемых элементов интерфейса на страницах модуля оценка|Администратор конфигурационных параметров|Настроен НСИ с настройкой модуля оценка
1208 1208  |Настройки отключаемых элементов интерфейса на страницах модуля целеполагание|Администратор конфигурационных параметров|Настроен НСИ с настройкой модуля целеполагания
1209 1209  
1221 +
1222 += INT Модуль "Управление интеграцией" =
1223 +
1224 +**Назначение модуля** - обеспечить процесс загрузки (Load) данных в систему VKPHT.
1225 +
1226 +Задачи модуля:
1227 +
1228 +* Регистрация шаблонов, их структуры, проверок и разрешенных типов, скачивание пустого шаблона.
1229 +* Конфигурирование правил обработки шаблонов.
1230 +* Выполнения сценария интеграции данных через мастер методы:
1231 +** Создать интеграционный поток по правилу обработки шаблона.
1232 +** Создать и обработать интеграционный поток по правилу обработки шаблона.
1233 +** Создать  и обработать интеграционный поток по всем правилам обработки шаблонов.
1234 +** Создать  и обработать интеграционный поток по группе правил обработки шаблонов.
1235 +* Выполнение сценария интеграции данных пошагово:
1236 +** Создать интеграционный поток по правилу обработки шаблона.
1237 +** Забрать данные файла в буфер интеграции.
1238 +** Проверить данные без загрузки в целевую систему.
1239 +** Проверить данные и загрузить в целевую систему.
1240 +* Возможность просмотра результатов интеграции.
1241 +* Возможность выгрузки отчетной формы.
1242 +
1243 +В модуле INT предусмотрены следующие роли:
1244 +
1245 +* Специалист по конфигурированию интеграции - отвечает за создание и редактирование правил загрузки данных.
1246 +* Специалист по запуску интеграции  -  создает и обрабатывает интеграционные потоки, анализирует ошибки в переданных на загрузку данных.
1247 +
1248 +== Описание модуля INT ==
1249 +
1250 +=== INT1 "Управление шаблонами" ===
1251 +
1252 +Задачи процесса управления шаблонами, обеспечить следующие возможности:
1253 +
1254 +* Просмотр шаблонов с возможностью скачивания пустого шаблона.
1255 +* Просмотр типов файла интеграционной платформы.
1256 +* Просмотр состава данных шаблона интеграции.
1257 +* Просмотр алгоритма проверки шаблонов интеграции.
1258 +
1259 +Описание процесса "Подготовка данных":
1260 +
1261 +[[Рисунок 1 — Подготовка данных>>image:1713544081419-225.png||data-xwiki-image-style-alignment="center"]]
1262 +
1263 +Таблица  – Описание процесса "Подготовка данных"
1264 +
1265 +|**Описание**|**Участники**|**Результат**
1266 +|(% colspan="2" %)INT1 "Управление шаблонами"|
1267 +|(((
1268 +Ответственный за процесс оценки персонала (HR) скачивает пустой шаблон.
1269 +
1270 +Интеграционная платформа генерирует xlsx файл с заполненной шапкой в соответствии с данными в таблице template_filed (template_field.code отсортированные по template_field.index).
1271 +
1272 +Ответственный за процесс подготовки данных локально на компьютере заполняет шаблон в соответствии с руководством по заполнению шаблона.
1273 +
1274 +Ответственный за процесс подготовки данных выкладывает заполненный шаблона на SFTP.
1275 +)))|Ответственный за процесс подготовки данных|Корректно заполненный файл размещен в целевой папке для забора данных в БД Интеграции
1276 +
1277 +=== INT2 "Управление источниками и потоками" ===
1278 +
1279 +Задачи процесса управления источниками и потоками, обеспечить следующие возможности:
1280 +
1281 +* Просмотр типов источников интеграционной платформы.
1282 +* Просмотр реестра источников файлов для интеграции.
1283 +* Просмотр правил обработки данных по шаблонам.
1284 +* Просмотр правил обработки данных по шаблонам по интеграционным потокам.
1285 +* Конфигурирование правил обработки шаблонов.
1286 +* Выполнение сценария интеграции данных.
1287 +
1288 +Описание процесса:
1289 +
1290 +[[Рисунок 2 — Конфигурация правил>>image:1713556050423-953.png||data-xwiki-image-style-alignment="center"]]
1291 +
1292 +Таблица  – Описание процесса "Конфигурация правил"
1293 +
1294 +|**Описание**|**Участники**|**Результат**
1295 +|(% colspan="2" %)INT2 "Управление источниками и потоками"|
1296 +|(((
1297 +Специалист по конфигурированию интеграции открывает форму соответствующего правила и прописывает данные:
1298 +
1299 +* Путь, откуда забрать файл.
1300 +* Путь, куда переложить в случае успешного забора данных в БД интеграции.
1301 +* Путь, куда переложить в случае неуспешного забора данных в БД интеграции.
1302 +* Префикс, по которому файл будет определен в состав потока
1303 +* Режим отладки.
1304 +* Остановка в случае ошибки .
1305 +
1306 +
1307 +)))|Специалист по конфигурированию интеграции|(((
1308 +В соответствующем правиле обработке шаблона корректно прописаны данные:
1309 +
1310 +* Путь, откуда забрать файл.
1311 +* Путь, куда переложить в случае успешного забора данных в БД интеграции.
1312 +* Путь, куда переложить в случае неуспешного забора данных в БД интеграции.
1313 +* Префикс, по которому файл будет определен в состав потока.
1314 +* Режим отладки.
1315 +* Остановка в случае ошибки.
1316 +)))
1317 +
1318 +[[Рисунок 3— Прохождение базового сценария>>image:1713556028395-410.png||data-xwiki-image-style-alignment="center"]]
1319 +
1320 +Таблица  – Описание процесса "Прохождение базового сценария"
1321 +
1322 +|**Описание**|**Участники**|**Результат**
1323 +|(% colspan="2" %)INT2 "Управление источниками и потоками"|
1324 +|(((
1325 +1.Начало процесса интеграции.
1326 +
1327 +2. Пользователь инициирует процесс создания потока..
1328 +
1329 +3. Вызывается метода регистрации интеграционного потока и формирования списка файлов.
1330 +
1331 +3.1 Ошибка подключения к папкам файла:
1332 +
1333 +* Неправильный логин и пароль.
1334 +* Нет прав на чтение папки.
1335 +* Неправильно указан путь.
1336 +* Прочие технические ошибки.
1337 +
1338 +При получении ошибки сценарий заканчивается как ошибочный.
1339 +
1340 +3.3 Регистрируется экземпляр интеграционного потока.
1341 +
1342 +3.4 Составляется список интеграционных файлов, исходя из настроек правил обработки данных по шаблонам.
1343 +
1344 +4. Пользователь инициирует процесс забора данных из xlsx файла в БД интеграции.
1345 +
1346 +4.1 Вызывается метод забора данных из файла в БД интеграции.
1347 +
1348 +4.2 Проверка шаблона на соответствие заданной структуры шаблона:
1349 +
1350 +* Данные файла не пусты.
1351 +* Наименование шапки корректен.
1352 +* Порядок столбцов корректен.
1353 +
1354 +При получении ошибки сценарий заканчивается как ошибочный.
1355 +
1356 +4.3.2 Регистрируются строки интеграционного файла. Строка преобразуется в json формат и записывается в БД интеграции.
1357 +
1358 +4.4 В случае ошибки пользователь может доработать шаблон 4.5 повторно разместить на SFTP ресурсе и повторить шаги начиная с п.2.
1359 +
1360 +5. Пользователь инициирует процесс проверки и загрузки или проверки без загрузки
1361 +
1362 +5.1. Вызывается метод верификации данных.
1363 +
1364 +5.2 Регистрация запуска по интеграционному файлу.
1365 +
1366 +5.3 Регистрация запуска по строкам интеграционного файла.
1367 +
1368 +5.4 Регистрация ошибок по каждой строке. Проверка на корректность формата, обязательности и размерности.
1369 +
1370 +5.5 Если пользователь нажимал проверить без загрузки, то сценарий завершается.
1371 +
1372 +5.6 Если пользователь нажимал проверить и загрузить, то сценарий продолжается.
1373 +
1374 +5.7 Если правило обработки сконфигурировано как режим отладки, то сценарий завершается.
1375 +
1376 +6. Вызывается метод формирования и отправки запроса на вставку в целевую систему.
1377 +
1378 +6.1 API целевой системы построчно обрабатывает запрос на вставку. Проверка на корректность формата, обязательности и размерности:
1379 +
1380 +6.2 Если ошибки нет, то происходит запись в БД целевой систему.
1381 +
1382 +6.3 Если есть ошибка, то ошибка регистрируется в БД интеграции.
1383 +
1384 +6.5 Если правило обработки сконфигурировано как продолжить, при получении ошибки вставке, то сценарий продолжается
1385 +
1386 +6.7. Если правило обработки сконфигурировано как остановить  при получении ошибки вставке, то сценарий останавливается и пользователь может повторить процесс подготовки данных, размещения на SFTP и прохождения сценария.
1387 +
1388 +Процесс вставки продолжается пока все строки не обработаны.
1389 +
1390 +6.6. Когда все строки обработаны, сценарий завершен.
1391 +
1392 +После завершения сценария пользователь может по необходимость вернуться к переподготовки данных и размещения их на SFTP и перезапуску процесса.
1393 +)))|Специалист по запуску интеграции |Пройден базовый сценарий загрузки данных в целевую систему
1394 +
1395 +=== INT3 "Управление миграцией данных" ===
1396 +
1397 +Задачи процесса управление миграции данных, обеспечить следующие возможности:
1398 +
1399 +* Просмотр реестр интеграционных потоков.
1400 +* Выгрузка отчетной формы.
1401 +
1402 +Описание процесса "Выгрузка отчетной формы":
1403 +
1404 +[[Рисунок 3 — Выгрузка отчетной формы>>image:1713544118623-774.png||data-xwiki-image-style-alignment="center"]]
1405 +
1406 +|**Описание**|**Участники**|**Результат**
1407 +|(% colspan="2" %)INT3 "Управление миграции данных"|
1408 +|(((
1409 +Специалист по запуску интеграции инициирует процесс выгрузки отчета.
1410 +
1411 +Интеграционная платформа генерирует xlsx файл, содержащий строки, которые были в исходном документе и которые не прогрузились в целевую систему.
1412 +)))|Специалист по запуску интеграции |Выгружен xlsx файл с ошибочными строками