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

Редактировал(а) Александра Баруткина 2024/06/27 13:20
От версии 10.3
отредактировано Александра Баруткина
на 2024/06/05 17:55
Изменить комментарий: К данной версии нет комментариев
К версии 14.2
отредактировано Александра Баруткина
на 2024/06/25 02:35
Изменить комментарий: Update document after refactoring.

Сводка

Подробности

Свойства страницы
Название
... ... @@ -1,1 +1,1 @@
1 -VKPHT. Описание системы
1 +VKPHT. Описание системы R4 (24Q1)
Родительский документ
... ... @@ -1,1 +1,1 @@
1 -Сведённая документация (внешняя).Release 4.Внешняя документация по продукту.WebHome
1 +Release 4 (24Q1).R4 (24Q1) Общая информация о системе.WebHome
Содержимое
... ... @@ -64,6 +64,37 @@
64 64  * Автоматизировать процессы управления конфигурацией Системы.
65 65  * Вести справочники системы (НСИ) через панель администрирования.
66 66  
67 +**~ INT Модуль "Управление интеграцией"**
68 +
69 +Модуль позволяет:
70 +
71 +* Регистрировать шаблоны, их структуру, проверки и разрешенные типы, скачивать пустые шаблоны.
72 +* Конфигурировать правила обработки шаблонов.
73 +* Выполнять сценарий интеграции данных через мастер методы: поток по группе правил обработки шаблонов.
74 +* Выполнять сценарий интеграции данных пошагово.
75 +* Просматривать результаты интеграции.
76 +* Выгружать отчетные формы.
77 +
78 +**AWA. Модуль "Управление нотификациями"**
79 +
80 +Модуль позволяет:
81 +
82 +* Вести справочники системы (НСИ) через панель администрирования.
83 +* Настраивать события уведомлений.
84 +* Настраивать шаблоны уведомлений, с выводом динамически формируемых полей (токенов).
85 +* Настраивать вычисляемых получателей уведомлений.
86 +* Настраивать ручные рассылки.
87 +* Просматривать подробный журнал уведомлений (статусы, подробные данные по уведомлению).
88 +
89 +**BPS. Модуль "Управление фоновыми программами"**
90 +
91 +Модуль позволяет:
92 +
93 +* Настраивать запуск фоновых программ (периодичность).
94 +* Вручную запускать фоновых программ.
95 +* Отменять ручной запуск фоновых программ.
96 +* Просматривать подробный журнал фоновых программ (статусы, данные о результатах работы фоновой программы).
97 +
67 67  = Глоссарий =
68 68  
69 69  **Адаптация** – это оказание помощи вновь принятому работнику в усвоении и принятии норм и правил, существующих в компании, создание позитивного образа компании и приобщение к корпоративной культуре.
... ... @@ -889,7 +889,7 @@
889 889  
890 890  === Схема процесса ===
891 891  
892 -[[Рисунок – Схема процесса PM3 Оценка персонала>>image:схема пм 3.png||data-xwiki-image-style-alignment="center"]]
923 +[[Рисунок – Схема процесса PM3 Оценка персонала>>image:Рисунок – Схема процесса PM3 Оценка персонала.png||alt="схема пм 3.png" data-xwiki-image-style-alignment="center"]]
893 893  
894 894  Таблица – Описание процесса
895 895  
... ... @@ -1143,7 +1143,7 @@
1143 1143  
1144 1144  Схема процесса Модуля CFG «Управление конфигурацией» соответствует рисунку.
1145 1145  
1146 -[[Рисунок – Схема процесса Модуля CFG «Управление конфигурацией»>>image:1715596530574-879.png||data-xwiki-image-style-alignment="center"]]
1177 +[[Рисунок – Схема процесса Модуля CFG «Управление конфигурацией»>>image:Схема процесса Модуля CFG «Управление конфигурацией».png||alt="1715596530574-879.png" data-xwiki-image-style-alignment="center"]]
1147 1147  
1148 1148  = Описание процессов =
1149 1149  
... ... @@ -1207,3 +1207,289 @@
1207 1207  |Настройки отключаемых элементов интерфейса на страницах модуля оценка|Администратор конфигурационных параметров|Настроен НСИ с настройкой модуля оценка
1208 1208  |Настройки отключаемых элементов интерфейса на страницах модуля целеполагание|Администратор конфигурационных параметров|Настроен НСИ с настройкой модуля целеполагания
1209 1209  
1241 += INT Модуль "Управление интеграцией" =
1242 +
1243 +**Назначение модуля** - обеспечить процесс загрузки (Load) данных в систему VKPHT.
1244 +
1245 +Задачи модуля:
1246 +
1247 +* Регистрация шаблонов, их структуры, проверок и разрешенных типов, скачивание пустого шаблона.
1248 +* Конфигурирование правил обработки шаблонов.
1249 +* Выполнения сценария интеграции данных через мастер методы:
1250 +** Создать интеграционный поток по правилу обработки шаблона.
1251 +** Создать и обработать интеграционный поток по правилу обработки шаблона.
1252 +** Создать  и обработать интеграционный поток по всем правилам обработки шаблонов.
1253 +** Создать  и обработать интеграционный поток по группе правил обработки шаблонов.
1254 +* Выполнение сценария интеграции данных пошагово:
1255 +** Создать интеграционный поток по правилу обработки шаблона.
1256 +** Забрать данные файла в буфер интеграции.
1257 +** Проверить данные без загрузки в целевую систему.
1258 +** Проверить данные и загрузить в целевую систему.
1259 +* Возможность просмотра результатов интеграции.
1260 +* Возможность выгрузки отчетной формы.
1261 +
1262 +В модуле INT предусмотрены следующие роли:
1263 +
1264 +* Специалист по конфигурированию интеграции - отвечает за создание и редактирование правил загрузки данных.
1265 +* Специалист по запуску интеграции  -  создает и обрабатывает интеграционные потоки, анализирует ошибки в переданных на загрузку данных.
1266 +
1267 +== Описание модуля INT ==
1268 +
1269 +=== INT1 "Управление шаблонами" ===
1270 +
1271 +Задачи процесса управления шаблонами, обеспечить следующие возможности:
1272 +
1273 +* Просмотр шаблонов с возможностью скачивания пустого шаблона.
1274 +* Просмотр типов файла интеграционной платформы.
1275 +* Просмотр состава данных шаблона интеграции.
1276 +* Просмотр алгоритма проверки шаблонов интеграции.
1277 +
1278 +Описание процесса "Подготовка данных":
1279 +
1280 +[[Рисунок — Подготовка данных>>image:пдготовка данных.png||alt="1713544081419-225.png" data-xwiki-image-style-alignment="center"]]
1281 +
1282 +Таблица  – Описание процесса "Подготовка данных"
1283 +
1284 +|**Описание**|**Участники**|**Результат**
1285 +|(% colspan="2" %)INT1 "Управление шаблонами"|
1286 +|(((
1287 +Ответственный за процесс оценки персонала (HR) скачивает пустой шаблон.
1288 +
1289 +Интеграционная платформа генерирует xlsx файл с заполненной шапкой в соответствии с данными в таблице template_filed (template_field.code отсортированные по template_field.index).
1290 +
1291 +Ответственный за процесс подготовки данных локально на компьютере заполняет шаблон в соответствии с руководством по заполнению шаблона.
1292 +
1293 +Ответственный за процесс подготовки данных выкладывает заполненный шаблона на SFTP.
1294 +)))|Ответственный за процесс подготовки данных|Корректно заполненный файл размещен в целевой папке для забора данных в БД Интеграции
1295 +
1296 +=== INT2 "Управление источниками и потоками" ===
1297 +
1298 +Задачи процесса управления источниками и потоками, обеспечить следующие возможности:
1299 +
1300 +* Просмотр типов источников интеграционной платформы.
1301 +* Просмотр реестра источников файлов для интеграции.
1302 +* Просмотр правил обработки данных по шаблонам.
1303 +* Просмотр правил обработки данных по шаблонам по интеграционным потокам.
1304 +* Конфигурирование правил обработки шаблонов.
1305 +* Выполнение сценария интеграции данных.
1306 +
1307 +Описание процесса:
1308 +
1309 +[[Рисунок — Конфигурация правил>>image:конфигурация правил.png||alt="1713556050423-953.png" data-xwiki-image-style-alignment="center"]]
1310 +
1311 +Таблица  – Описание процесса "Конфигурация правил"
1312 +
1313 +|**Описание**|**Участники**|**Результат**
1314 +|(% colspan="2" %)INT2 "Управление источниками и потоками"|
1315 +|(((
1316 +Специалист по конфигурированию интеграции открывает форму соответствующего правила и прописывает данные:
1317 +
1318 +* Путь, откуда забрать файл.
1319 +* Путь, куда переложить в случае успешного забора данных в БД интеграции.
1320 +* Путь, куда переложить в случае неуспешного забора данных в БД интеграции.
1321 +* Префикс, по которому файл будет определен в состав потока
1322 +* Режим отладки.
1323 +* Остановка в случае ошибки .
1324 +
1325 +
1326 +)))|Специалист по конфигурированию интеграции|(((
1327 +В соответствующем правиле обработке шаблона корректно прописаны данные:
1328 +
1329 +* Путь, откуда забрать файл.
1330 +* Путь, куда переложить в случае успешного забора данных в БД интеграции.
1331 +* Путь, куда переложить в случае неуспешного забора данных в БД интеграции.
1332 +* Префикс, по которому файл будет определен в состав потока.
1333 +* Режим отладки.
1334 +* Остановка в случае ошибки.
1335 +)))
1336 +
1337 +[[Рисунок — Прохождение базового сценария>>image:прохождение базового сценария.png||alt="1713556028395-410.png" data-xwiki-image-style-alignment="center"]]
1338 +
1339 +Таблица  – Описание процесса "Прохождение базового сценария"
1340 +
1341 +|**Описание**|**Участники**|**Результат**
1342 +|(% colspan="2" %)INT2 "Управление источниками и потоками"|
1343 +|(((
1344 +1.Начало процесса интеграции.
1345 +
1346 +2. Пользователь инициирует процесс создания потока..
1347 +
1348 +3. Вызывается метода регистрации интеграционного потока и формирования списка файлов.
1349 +
1350 +3.1 Ошибка подключения к папкам файла:
1351 +
1352 +* Неправильный логин и пароль.
1353 +* Нет прав на чтение папки.
1354 +* Неправильно указан путь.
1355 +* Прочие технические ошибки.
1356 +
1357 +При получении ошибки сценарий заканчивается как ошибочный.
1358 +
1359 +3.3 Регистрируется экземпляр интеграционного потока.
1360 +
1361 +3.4 Составляется список интеграционных файлов, исходя из настроек правил обработки данных по шаблонам.
1362 +
1363 +4. Пользователь инициирует процесс забора данных из xlsx файла в БД интеграции.
1364 +
1365 +4.1 Вызывается метод забора данных из файла в БД интеграции.
1366 +
1367 +4.2 Проверка шаблона на соответствие заданной структуры шаблона:
1368 +
1369 +* Данные файла не пусты.
1370 +* Наименование шапки корректен.
1371 +* Порядок столбцов корректен.
1372 +
1373 +При получении ошибки сценарий заканчивается как ошибочный.
1374 +
1375 +4.3.2 Регистрируются строки интеграционного файла. Строка преобразуется в json формат и записывается в БД интеграции.
1376 +
1377 +4.4 В случае ошибки пользователь может доработать шаблон 4.5 повторно разместить на SFTP ресурсе и повторить шаги начиная с п.2.
1378 +
1379 +5. Пользователь инициирует процесс проверки и загрузки или проверки без загрузки
1380 +
1381 +5.1. Вызывается метод верификации данных.
1382 +
1383 +5.2 Регистрация запуска по интеграционному файлу.
1384 +
1385 +5.3 Регистрация запуска по строкам интеграционного файла.
1386 +
1387 +5.4 Регистрация ошибок по каждой строке. Проверка на корректность формата, обязательности и размерности.
1388 +
1389 +5.5 Если пользователь нажимал проверить без загрузки, то сценарий завершается.
1390 +
1391 +5.6 Если пользователь нажимал проверить и загрузить, то сценарий продолжается.
1392 +
1393 +5.7 Если правило обработки сконфигурировано как режим отладки, то сценарий завершается.
1394 +
1395 +6. Вызывается метод формирования и отправки запроса на вставку в целевую систему.
1396 +
1397 +6.1 API целевой системы построчно обрабатывает запрос на вставку. Проверка на корректность формата, обязательности и размерности:
1398 +
1399 +6.2 Если ошибки нет, то происходит запись в БД целевой систему.
1400 +
1401 +6.3 Если есть ошибка, то ошибка регистрируется в БД интеграции.
1402 +
1403 +6.5 Если правило обработки сконфигурировано как продолжить, при получении ошибки вставке, то сценарий продолжается
1404 +
1405 +6.7. Если правило обработки сконфигурировано как остановить  при получении ошибки вставке, то сценарий останавливается и пользователь может повторить процесс подготовки данных, размещения на SFTP и прохождения сценария.
1406 +
1407 +Процесс вставки продолжается пока все строки не обработаны.
1408 +
1409 +6.6. Когда все строки обработаны, сценарий завершен.
1410 +
1411 +После завершения сценария пользователь может по необходимость вернуться к переподготовки данных и размещения их на SFTP и перезапуску процесса.
1412 +)))|Специалист по запуску интеграции |Пройден базовый сценарий загрузки данных в целевую систему
1413 +
1414 +=== INT3 "Управление миграцией данных" ===
1415 +
1416 +Задачи процесса управление миграции данных, обеспечить следующие возможности:
1417 +
1418 +* Просмотр реестр интеграционных потоков.
1419 +* Выгрузка отчетной формы.
1420 +
1421 +Описание процесса "Выгрузка отчетной формы":
1422 +
1423 +[[Рисунок — Выгрузка отчетной формы>>image:Выгрузка отчетной формы.png||alt="1713544118623-774.png" data-xwiki-image-style-alignment="center"]]
1424 +
1425 +|**Описание**|**Участники**|**Результат**
1426 +|(% colspan="2" %)INT3 "Управление миграции данных"|
1427 +|(((
1428 +Специалист по запуску интеграции инициирует процесс выгрузки отчета.
1429 +
1430 +Интеграционная платформа генерирует xlsx файл, содержащий строки, которые были в исходном документе и которые не прогрузились в целевую систему.
1431 +)))|Специалист по запуску интеграции |Выгружен xlsx файл с ошибочными строками
1432 +
1433 += AWA. Модуль "Управление нотификациями" =
1434 +
1435 +**~ Цель модуля** - администрирование уведомлений, формируемых в Системе, создание шаблонов писем, а также формирование ручных рассылок, ведение журнала отправки уведомлений.
1436 +
1437 +Задачи модуля:
1438 +
1439 +* Возможность ведения справочников системы (НСИ) через панель администрирования.
1440 +* Возможность настройки событий уведомлений.
1441 +* Возможность настройки шаблонов уведомлений с выводом динамически формируемых полей (токенов).
1442 +* Возможность настройки вычисляемых получателей уведомлений.
1443 +* Возможность настройки ручных рассылок.
1444 +* Возможность просмотра подробного журнала уведомлений (статусы, подробные данные по уведомлению).
1445 +
1446 +В модуле AWA предусмотрены следующие бизнес-роли:
1447 +
1448 +* Администратор, отвечающий за формирование и отслеживание отправки уведомлений.
1449 +* Сотрудник, регулирующий необходимость получения уведомлений.
1450 +
1451 +== Схема модуля ==
1452 +
1453 +[[Рисунок - Схема модуля AWA "Управление нотификациями">>image:1717686284025-944.png||data-xwiki-image-style-alignment="center"]]
1454 +
1455 +
1456 +== Описание модуля ==
1457 +
1458 +Таблица — Описание модуля
1459 +
1460 +|(((
1461 +**Описание**
1462 +)))|**Роли-участники**|**Результат**
1463 +|(% colspan="1" rowspan="1" %)(((
1464 +**AWA Администрирование уведомлений**
1465 +)))|(% colspan="1" rowspan="4" %)Администратор |(% colspan="1" rowspan="4" %)Настройка уведомлений о событиях, настройка шаблонов уведомлений
1466 +|(((
1467 +Уведомления о событиях - настройка кодов событий уведомлений:
1468 +
1469 +* системные события (числовое значение) - меняется только статус события (Активно/Неактивно)
1470 +* события "изменение статуса" (маска "statuschange") - возможность создания/редактирования/удаления события для указанного бизнес-объекта. При настройке уведомления также указывается начальный и конечный статус бизнес-объекта (при смене статуса срабатывает уведомление).
1471 +* события "бизнес-объект" (маска "taskcreate") - возможность создания/редактирования/удаления события для указанного бизнес-объекта. При настройке уведомления также указывается начальный статус бизнес-объекта, при котором срабатывает уведомление.
1472 +* события "event" (маска " eventcreate_eventtype") - возможность создания/редактирования/удаления события для определенного типа события.
1473 +)))
1474 +|**AWA Администрирование шаблонов уведомлений**
1475 +|(((
1476 +Администратор Системы может выполнить настройку шаблонов уведомлений для каждого из типов событий. При настройке шаблонов уведомлений есть возможность выбора динамически определяемых полей в теме и тексте уведомления, а также вычисляемых получателей.
1477 +
1478 +Дополнительно, можно создавать замещающие шаблоны, которые будут отрабатывать в случае, если не отработал основной шаблон.
1479 +
1480 +Есть возможность настройки нескольких шаблонов для каждого уникального типа события.
1481 +)))
1482 +|(% colspan="3" %)**AWA Ручные рассылки**
1483 +|Администратор Системы может создать и выполнить запуск уведомления при помощи ручных рассылок. Для этого через "Ручные рассылки" в администрировании управления нотификациями возможно добавление ручного события (маска "manualmailing") с указанием необходимого шаблона уведомления.|(% colspan="1" %)Администратор|(% colspan="1" %)Запуск ручного события
1484 +|(% colspan="3" %)**AWA  Журнал уведомлений**
1485 +|Администратору Системы доступен журнал уведомлений, в котором можно получить информацию о статусе отправки, теме и текста уведомления, а также списка получателей.|(% colspan="1" %)Администратор|(% colspan="1" %)Журнал уведомлений
1486 +|(% colspan="3" %)**AWA Подписки на уведомления**
1487 +|Каждый сотрудник в Системе может регулировать получение уведомлений по тем или иным событиям, либо отказаться от получения уведомлений вовсе.|(% colspan="1" %)Сотрудник|(% colspan="1" %)Подписки на уведомления
1488 +
1489 += BPS. Модуль "Управление фоновыми программами" =
1490 +
1491 +**Цель модуля** - запуск/отмена фоновых программ, просмотр журнала отправки уведомлений.
1492 +
1493 +Задачи модуля:
1494 +
1495 +* Возможность настройки запуска фоновых программ (периодичность).
1496 +* Возможность ручного запуска фоновых программ.
1497 +* Возможность отмены ручного запуска фоновых программ.
1498 +* Возможность просмотра подробного журнала фоновых программ (статусы, данные о результатах работы фоновой программы).
1499 +
1500 +В модуле BPS предусмотрены следующие бизнес-роли:
1501 +
1502 +* Администратор, отвечающий за запуск/отмену фоновых программ.
1503 +
1504 +== Схема модуля ==
1505 +
1506 +[[Рисунок - Схема модуля BPS "Управление фоновыми программами">>image:1717686208342-302.png||data-xwiki-image-style-alignment="center"]]
1507 +
1508 +== Описание модуля ==
1509 +
1510 +Таблица 1 — Описание модуля
1511 +
1512 +|(((
1513 +**Описание**
1514 +)))|**Роли-участники**|**Результат**
1515 +|(% colspan="1" rowspan="1" %)(((
1516 +**BPS Администрирование фоновых программ**
1517 +)))|(% colspan="1" rowspan="4" %)Администратор |(% colspan="1" rowspan="4" %)Планирование ручной запуск/отмена выполнения фоновых программ, просмотр журнал фоновых программ.
1518 +|(((
1519 +Администратор осуществляет настройку по планированию, запуску и отмене фоновых программ.
1520 +
1521 +Есть возможность настройки автоматического и ручного запуска программ.
1522 +)))
1523 +|**BPS Журнал фоновых программ**
1524 +|(((
1525 +Администратор может отслеживать журнал фоновых программ и просмотреть статус, текст ошибки в случае их возникновения.
1526 +)))
1717686208342-302.png
Author
... ... @@ -1,0 +1,1 @@
1 +xwiki:XWiki.abarutkina
Размер
... ... @@ -1,0 +1,1 @@
1 +9.3 KB
Содержимое
1717686284025-944.png
Author
... ... @@ -1,0 +1,1 @@
1 +xwiki:XWiki.abarutkina
Размер
... ... @@ -1,0 +1,1 @@
1 +15.0 KB
Содержимое
Выгрузка отчетной формы.png
Author
... ... @@ -1,0 +1,1 @@
1 +xwiki:XWiki.abarutkina
Размер
... ... @@ -1,0 +1,1 @@
1 +57.7 KB
Содержимое
Рисунок – Схема процесса PM3 Оценка персонала.png
Author
... ... @@ -1,0 +1,1 @@
1 +xwiki:XWiki.abarutkina
Размер
... ... @@ -1,0 +1,1 @@
1 +130.3 KB
Содержимое
Схема процесса Модуля CFG «Управление конфигурацией».png
Author
... ... @@ -1,0 +1,1 @@
1 +xwiki:XWiki.abarutkina
Размер
... ... @@ -1,0 +1,1 @@
1 +500.7 KB
Содержимое
конфигурация правил.png
Author
... ... @@ -1,0 +1,1 @@
1 +xwiki:XWiki.abarutkina
Размер
... ... @@ -1,0 +1,1 @@
1 +34.7 KB
Содержимое
пдготовка данных.png
Author
... ... @@ -1,0 +1,1 @@
1 +xwiki:XWiki.abarutkina
Размер
... ... @@ -1,0 +1,1 @@
1 +58.5 KB
Содержимое
прохождение базового сценария.png
Author
... ... @@ -1,0 +1,1 @@
1 +xwiki:XWiki.abarutkina
Размер
... ... @@ -1,0 +1,1 @@
1 +495.7 KB
Содержимое