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

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