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

Редактировал(а) Александра Баруткина 2024/06/27 13:20

От версии 10.3
отредактировано Александра Баруткина
на 2024/06/05 17:55
Изменить комментарий: К данной версии нет комментариев
К версии 10.11
отредактировано Александра Баруткина
на 2024/06/18 12:25
Изменить комментарий: (Autosaved)

Сводка

Подробности

Свойства страницы
Содержимое
... ... @@ -64,6 +64,30 @@
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 +* Возможность просмотра подробного журнала уведомлений (статусы, подробные данные по уведомлению).
90 +
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"]]
916 +[[Рисунок – Схема процесса 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"]]
1170 +[[Рисунок – Схема процесса Модуля CFG «Управление конфигурацией»>>image:Схема процесса Модуля CFG «Управление конфигурацией».png||alt="1715596530574-879.png" data-xwiki-image-style-alignment="center"]]
1147 1147  
1148 1148  = Описание процессов =
1149 1149  
... ... @@ -1207,3 +1207,249 @@
1207 1207  |Настройки отключаемых элементов интерфейса на страницах модуля оценка|Администратор конфигурационных параметров|Настроен НСИ с настройкой модуля оценка
1208 1208  |Настройки отключаемых элементов интерфейса на страницах модуля целеполагание|Администратор конфигурационных параметров|Настроен НСИ с настройкой модуля целеполагания
1209 1209  
1234 += INT Модуль "Управление интеграцией" =
1235 +
1236 +**Назначение модуля** - обеспечить процесс загрузки (Load) данных в систему VKPHT.
1237 +
1238 +Задачи модуля:
1239 +
1240 +* Регистрация шаблонов, их структуры, проверок и разрешенных типов, скачивание пустого шаблона.
1241 +* Конфигурирование правил обработки шаблонов.
1242 +* Выполнения сценария интеграции данных через мастер методы:
1243 +** Создать интеграционный поток по правилу обработки шаблона.
1244 +** Создать и обработать интеграционный поток по правилу обработки шаблона.
1245 +** Создать  и обработать интеграционный поток по всем правилам обработки шаблонов.
1246 +** Создать  и обработать интеграционный поток по группе правил обработки шаблонов.
1247 +* Выполнение сценария интеграции данных пошагово:
1248 +** Создать интеграционный поток по правилу обработки шаблона.
1249 +** Забрать данные файла в буфер интеграции.
1250 +** Проверить данные без загрузки в целевую систему.
1251 +** Проверить данные и загрузить в целевую систему.
1252 +* Возможность просмотра результатов интеграции.
1253 +* Возможность выгрузки отчетной формы.
1254 +
1255 +В модуле INT предусмотрены следующие роли:
1256 +
1257 +* Специалист по конфигурированию интеграции - отвечает за создание и редактирование правил загрузки данных.
1258 +* Специалист по запуску интеграции  -  создает и обрабатывает интеграционные потоки, анализирует ошибки в переданных на загрузку данных.
1259 +
1260 +== Описание модуля INT ==
1261 +
1262 +=== INT1 "Управление шаблонами" ===
1263 +
1264 +Задачи процесса управления шаблонами, обеспечить следующие возможности:
1265 +
1266 +* Просмотр шаблонов с возможностью скачивания пустого шаблона.
1267 +* Просмотр типов файла интеграционной платформы.
1268 +* Просмотр состава данных шаблона интеграции.
1269 +* Просмотр алгоритма проверки шаблонов интеграции.
1270 +
1271 +Описание процесса "Подготовка данных":
1272 +
1273 +[[Рисунок — Подготовка данных>>image:пдготовка данных.png||alt="1713544081419-225.png" data-xwiki-image-style-alignment="center"]]
1274 +
1275 +Таблица  – Описание процесса "Подготовка данных"
1276 +
1277 +|**Описание**|**Участники**|**Результат**
1278 +|(% colspan="2" %)INT1 "Управление шаблонами"|
1279 +|(((
1280 +Ответственный за процесс оценки персонала (HR) скачивает пустой шаблон.
1281 +
1282 +Интеграционная платформа генерирует xlsx файл с заполненной шапкой в соответствии с данными в таблице template_filed (template_field.code отсортированные по template_field.index).
1283 +
1284 +Ответственный за процесс подготовки данных локально на компьютере заполняет шаблон в соответствии с руководством по заполнению шаблона.
1285 +
1286 +Ответственный за процесс подготовки данных выкладывает заполненный шаблона на SFTP.
1287 +)))|Ответственный за процесс подготовки данных|Корректно заполненный файл размещен в целевой папке для забора данных в БД Интеграции
1288 +
1289 +=== INT2 "Управление источниками и потоками" ===
1290 +
1291 +Задачи процесса управления источниками и потоками, обеспечить следующие возможности:
1292 +
1293 +* Просмотр типов источников интеграционной платформы.
1294 +* Просмотр реестра источников файлов для интеграции.
1295 +* Просмотр правил обработки данных по шаблонам.
1296 +* Просмотр правил обработки данных по шаблонам по интеграционным потокам.
1297 +* Конфигурирование правил обработки шаблонов.
1298 +* Выполнение сценария интеграции данных.
1299 +
1300 +Описание процесса:
1301 +
1302 +[[Рисунок — Конфигурация правил>>image:конфигурация правил.png||alt="1713556050423-953.png" data-xwiki-image-style-alignment="center"]]
1303 +
1304 +Таблица  – Описание процесса "Конфигурация правил"
1305 +
1306 +|**Описание**|**Участники**|**Результат**
1307 +|(% colspan="2" %)INT2 "Управление источниками и потоками"|
1308 +|(((
1309 +Специалист по конфигурированию интеграции открывает форму соответствующего правила и прописывает данные:
1310 +
1311 +* Путь, откуда забрать файл.
1312 +* Путь, куда переложить в случае успешного забора данных в БД интеграции.
1313 +* Путь, куда переложить в случае неуспешного забора данных в БД интеграции.
1314 +* Префикс, по которому файл будет определен в состав потока
1315 +* Режим отладки.
1316 +* Остановка в случае ошибки .
1317 +
1318 +
1319 +)))|Специалист по конфигурированию интеграции|(((
1320 +В соответствующем правиле обработке шаблона корректно прописаны данные:
1321 +
1322 +* Путь, откуда забрать файл.
1323 +* Путь, куда переложить в случае успешного забора данных в БД интеграции.
1324 +* Путь, куда переложить в случае неуспешного забора данных в БД интеграции.
1325 +* Префикс, по которому файл будет определен в состав потока.
1326 +* Режим отладки.
1327 +* Остановка в случае ошибки.
1328 +)))
1329 +
1330 +[[Рисунок — Прохождение базового сценария>>image:прохождение базового сценария.png||alt="1713556028395-410.png" data-xwiki-image-style-alignment="center"]]
1331 +
1332 +Таблица  – Описание процесса "Прохождение базового сценария"
1333 +
1334 +|**Описание**|**Участники**|**Результат**
1335 +|(% colspan="2" %)INT2 "Управление источниками и потоками"|
1336 +|(((
1337 +1.Начало процесса интеграции.
1338 +
1339 +2. Пользователь инициирует процесс создания потока..
1340 +
1341 +3. Вызывается метода регистрации интеграционного потока и формирования списка файлов.
1342 +
1343 +3.1 Ошибка подключения к папкам файла:
1344 +
1345 +* Неправильный логин и пароль.
1346 +* Нет прав на чтение папки.
1347 +* Неправильно указан путь.
1348 +* Прочие технические ошибки.
1349 +
1350 +При получении ошибки сценарий заканчивается как ошибочный.
1351 +
1352 +3.3 Регистрируется экземпляр интеграционного потока.
1353 +
1354 +3.4 Составляется список интеграционных файлов, исходя из настроек правил обработки данных по шаблонам.
1355 +
1356 +4. Пользователь инициирует процесс забора данных из xlsx файла в БД интеграции.
1357 +
1358 +4.1 Вызывается метод забора данных из файла в БД интеграции.
1359 +
1360 +4.2 Проверка шаблона на соответствие заданной структуры шаблона:
1361 +
1362 +* Данные файла не пусты.
1363 +* Наименование шапки корректен.
1364 +* Порядок столбцов корректен.
1365 +
1366 +При получении ошибки сценарий заканчивается как ошибочный.
1367 +
1368 +4.3.2 Регистрируются строки интеграционного файла. Строка преобразуется в json формат и записывается в БД интеграции.
1369 +
1370 +4.4 В случае ошибки пользователь может доработать шаблон 4.5 повторно разместить на SFTP ресурсе и повторить шаги начиная с п.2.
1371 +
1372 +5. Пользователь инициирует процесс проверки и загрузки или проверки без загрузки
1373 +
1374 +5.1. Вызывается метод верификации данных.
1375 +
1376 +5.2 Регистрация запуска по интеграционному файлу.
1377 +
1378 +5.3 Регистрация запуска по строкам интеграционного файла.
1379 +
1380 +5.4 Регистрация ошибок по каждой строке. Проверка на корректность формата, обязательности и размерности.
1381 +
1382 +5.5 Если пользователь нажимал проверить без загрузки, то сценарий завершается.
1383 +
1384 +5.6 Если пользователь нажимал проверить и загрузить, то сценарий продолжается.
1385 +
1386 +5.7 Если правило обработки сконфигурировано как режим отладки, то сценарий завершается.
1387 +
1388 +6. Вызывается метод формирования и отправки запроса на вставку в целевую систему.
1389 +
1390 +6.1 API целевой системы построчно обрабатывает запрос на вставку. Проверка на корректность формата, обязательности и размерности:
1391 +
1392 +6.2 Если ошибки нет, то происходит запись в БД целевой систему.
1393 +
1394 +6.3 Если есть ошибка, то ошибка регистрируется в БД интеграции.
1395 +
1396 +6.5 Если правило обработки сконфигурировано как продолжить, при получении ошибки вставке, то сценарий продолжается
1397 +
1398 +6.7. Если правило обработки сконфигурировано как остановить  при получении ошибки вставке, то сценарий останавливается и пользователь может повторить процесс подготовки данных, размещения на SFTP и прохождения сценария.
1399 +
1400 +Процесс вставки продолжается пока все строки не обработаны.
1401 +
1402 +6.6. Когда все строки обработаны, сценарий завершен.
1403 +
1404 +После завершения сценария пользователь может по необходимость вернуться к переподготовки данных и размещения их на SFTP и перезапуску процесса.
1405 +)))|Специалист по запуску интеграции |Пройден базовый сценарий загрузки данных в целевую систему
1406 +
1407 +=== INT3 "Управление миграцией данных" ===
1408 +
1409 +Задачи процесса управление миграции данных, обеспечить следующие возможности:
1410 +
1411 +* Просмотр реестр интеграционных потоков.
1412 +* Выгрузка отчетной формы.
1413 +
1414 +Описание процесса "Выгрузка отчетной формы":
1415 +
1416 +[[Рисунок — Выгрузка отчетной формы>>image:Выгрузка отчетной формы.png||alt="1713544118623-774.png" data-xwiki-image-style-alignment="center"]]
1417 +
1418 +|**Описание**|**Участники**|**Результат**
1419 +|(% colspan="2" %)INT3 "Управление миграции данных"|
1420 +|(((
1421 +Специалист по запуску интеграции инициирует процесс выгрузки отчета.
1422 +
1423 +Интеграционная платформа генерирует xlsx файл, содержащий строки, которые были в исходном документе и которые не прогрузились в целевую систему.
1424 +)))|Специалист по запуску интеграции |Выгружен xlsx файл с ошибочными строками
1425 +
1426 += AWA. Модуль "Управление нотификациями" =
1427 +
1428 +**~ Цель модуля** - администрирование уведомлений, формируемых в Системе, создание шаблонов писем, а также формирование ручных рассылок, ведение журнала отправки уведомлений.
1429 +
1430 +Задачи модуля:
1431 +
1432 +* Возможность ведения справочников системы (НСИ) через панель администрирования.
1433 +* Возможность настройки событий уведомлений.
1434 +* Возможность настройки шаблонов уведомлений с выводом динамически формируемых полей (токенов).
1435 +* Возможность настройки вычисляемых получателей уведомлений.
1436 +* Возможность настройки ручных рассылок.
1437 +* Возможность просмотра подробного журнала уведомлений (статусы, подробные данные по уведомлению).
1438 +
1439 +В модуле AWA предусмотрены следующие бизнес-роли:
1440 +
1441 +* Администратор, отвечающий за формирование и отслеживание отправки уведомлений.
1442 +* Сотрудник, регулирующий необходимость получения уведомлений.
1443 +
1444 +== Схема модуля ==
1445 +
1446 +[[image:1717686284025-944.png]]
1447 +
1448 +== Описание модуля ==
1449 +
1450 +Таблица 1 — Описание модуля
1451 +
1452 +|(((
1453 +**Описание**
1454 +)))|**Роли-участники**|**Результат**
1455 +|(% colspan="1" rowspan="1" %)(((
1456 +**AWA Администрирование уведомлений**
1457 +)))|(% colspan="1" rowspan="4" %)Администратор |(% colspan="1" rowspan="4" %)Настройка уведомлений о событиях, настройка шаблонов уведомлений
1458 +|(((
1459 +Уведомления о событиях - настройка кодов событий уведомлений:
1460 +
1461 +* системные события (числовое значение) - меняется только статус события (Активно/Неактивно)
1462 +* события "изменение статуса" (маска "statuschange") - возможность создания/редактирования/удаления события для указанного бизнес-объекта. При настройке уведомления также указывается начальный и конечный статус бизнес-объекта (при смене статуса срабатывает уведомление).
1463 +* события "бизнес-объект" (маска "taskcreate") - возможность создания/редактирования/удаления события для указанного бизнес-объекта. При настройке уведомления также указывается начальный статус бизнес-объекта, при котором срабатывает уведомление.
1464 +* события "event" (маска " eventcreate_eventtype") - возможность создания/редактирования/удаления события для определенного типа события.
1465 +)))
1466 +|**AWA Администрирование шаблонов уведомлений**
1467 +|(((
1468 +Администратор Системы может выполнить настройку шаблонов уведомлений для каждого из типов событий. При настройке шаблонов уведомлений есть возможность выбора динамически определяемых полей в теме и тексте уведомления, а также вычисляемых получателей.
1469 +
1470 +Дополнительно, можно создавать замещающие шаблоны, которые будут отрабатывать в случае, если не отработал основной шаблон.
1471 +
1472 +Есть возможность настройки нескольких шаблонов для каждого уникального типа события.
1473 +)))
1474 +|(% colspan="3" %)**AWA Ручные рассылки**
1475 +|Администратор Системы может создать и выполнить запуск уведомления при помощи ручных рассылок. Для этого через "Ручные рассылки" в администрировании управления нотификациями возможно добавление ручного события (маска "manualmailing") с указанием необходимого шаблона уведомления.|(% colspan="1" %)Администратор|(% colspan="1" %)Запуск ручного события
1476 +|(% colspan="3" %)**AWA  Журнал уведомлений**
1477 +|Администратору Системы доступен журнал уведомлений, в котором можно получить информацию о статусе отправки, теме и текста уведомления, а также списка получателей.|(% colspan="1" %)Администратор|(% colspan="1" %)Журнал уведомлений
1478 +|(% colspan="3" %)**AWA Подписки на уведомления**
1479 +|Каждый сотрудник в Системе может регулировать получение уведомлений по тем или иным событиям, либо отказаться от получения уведомлений вовсе.|(% colspan="1" %)Сотрудник|(% colspan="1" %)Подписки на уведомления
Выгрузка отчетной формы.png
Author
... ... @@ -1,0 +1,1 @@
1 +XWiki.abarutkina
Размер
... ... @@ -1,0 +1,1 @@
1 +57.7 KB
Содержимое
Рисунок – Схема процесса PM3 Оценка персонала.png
Author
... ... @@ -1,0 +1,1 @@
1 +XWiki.abarutkina
Размер
... ... @@ -1,0 +1,1 @@
1 +130.3 KB
Содержимое
Схема процесса Модуля CFG «Управление конфигурацией».png
Author
... ... @@ -1,0 +1,1 @@
1 +XWiki.abarutkina
Размер
... ... @@ -1,0 +1,1 @@
1 +500.7 KB
Содержимое
конфигурация правил.png
Author
... ... @@ -1,0 +1,1 @@
1 +XWiki.abarutkina
Размер
... ... @@ -1,0 +1,1 @@
1 +34.7 KB
Содержимое
пдготовка данных.png
Author
... ... @@ -1,0 +1,1 @@
1 +XWiki.abarutkina
Размер
... ... @@ -1,0 +1,1 @@
1 +58.5 KB
Содержимое
прохождение базового сценария.png
Author
... ... @@ -1,0 +1,1 @@
1 +XWiki.abarutkina
Размер
... ... @@ -1,0 +1,1 @@
1 +495.7 KB
Содержимое