Excerpt

Info

title	О чём раздел

Под сценариями работы Сотрудника с Заявлениями понимаем:

Подачу заявления (из файла или по шаблону) и подписание его УНЭП
Получение данных по Заявлению, в т.ч. архив КЭДО
Обработка заявления - Согласование или Отклонение

Table of Contents

Сценарии работы Сотрудника с Заявлениями

1. Сотрудник подает заявление из файла и подписывает его УНЭП

Tip

title	Цель

Цель - предоставить Предоставить Сотруднику возможность направить заявление, оформленное произвольным образом или по заранее подготовленному файлу.

Предусловия

авторизация произведена
Получены типы Заявлений (для использования идентификатора заявления из файладальнейшего использования id типа "Загрузка из файла" и id участников по этому маршруту)
1. GET /api/v1/applicationTypes
Определён список сотрудников, для Согласования
1. GET /api/v1v2/clients/:clientId/colleagues

API-метод

Примечания

1) Получены типы Заявлений и маршрут подписания

Status

subtle	true
colour	Green
title	REDOC

GET /api/v1/applicationTypes

Данный метод предоставляет список типов заявлений, доступных для подачи, а также маршруты подписания по этим типам. Для подачи заявления из файла необходимо выбрать соответствующий тип Заявления - для стандартного типа "Загрузка из файла" всегда указан "templatable": false, для всех остальных типов "templatable": true, поскольку для таких типов существует шаблон.

В ответе метода указаны id участников маршрута Заявления (applicationTypes[].signingRouteTemplate{}.stages[].participants[].id), которые необходимо в дальнейшем указывать при создании группы Заявлений (см. п 4)

Типы заявления могут быть стандартными от HRlink, могут быть пользовательскими. Клиент может создать свой тип Заявления и настроить свои заполняемые поля со стороны Заявителя. Также возможно привязать стандартный маршрут от HRlink или создать свой. Создание типа с маршрутом доступно Администратору HRlink. Подробнее про Создание новых типов заявлений.

2) Сотрудник загружает файл для подачи заявления

Status

subtle	true
colour	Green
title	REDOC

POST /api/v1/files

Сотрудник заранее создает файл и прикладывает его при оформлении Заявления в системе. После загрузки файла, будет получен идентификатор загруженного файла

, данный

. Данный идентификатор надо передать в методе создания

заявления.2)

группы заявлений. (см. п 4)

3) Сотрудник выбирает кто будет согласовывать заявление

На основании метода

GET /api/

v1

v2/clients/:clientId/colleagues

из

Определить Согласующих возможно несколькими способами:

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

, подробнее о метод

Возможно указать participants[].employeeExternalId - идентификатор сотрудника внешней системы, в качестве участника маршрута при подаче заявления (см. п 4). На момент подачи Заявления employeeExternalId сотрудников должны быть переданы в HRlink.

4

Подробнее о методе см. раздел https://hr-link.atlassian.net/wiki/spaces/HRLIN/pages/666075304/04.#3.1.-%D0%9F%D0%BE%D0%BB%D1%83%D1%87%D0%B5%D0%BD%D0%B8%D0%B5-%D1%81%D0%BF%D0%B8%D1%81%D0%BA%D0%B0-%D0%A1%D0%BE%D1%82%D1%80%D1%83%D0%B4%D0%BD%D0%B8%D0%BA%D0%BE%D0%B2-%D0%B4%D0%BB%D1%8F-%D0%B2%D1%8B%D0%B1%D0%BE%D1%80%D0%B0-%D0%A1%D0%BE%D0%B3%D0%BB%D0%B0%D1%81%D1%83%D1%8E%D1%89%D0%B5%D0%B3%D0%BE

3

) Сотрудник подаёт заявление из загруженного файла

Status

subtle	true
colour	Green
title	REDOC

POST /api/v1/clients/:clientId/applicationGroups

Необходимо указать id типа заявления и id участников маршрута подписания (см.п.1).

Система сама сконвертирует загруженный файл в pdf/a формат для дальнейшего подписания.

В ответе будет получен идентификатор заявления, его можно использовать при завершении процесса для отображения формы заявления

4

5) Запуск подписания Заявления УНЭП - запрос сообщения с кодом

Status

subtle	true
colour	Green
title	REDOC

POST /api/v1/clients/:clientId/applicationGroups/:applicationGroupId/sign/nqes

На активный канал получения кода подписания Сотрудника будет выслан код для подписания УНЭП. После - сотруднику необходимо ввести код и передан его для проверки, поэтому по итогу вызова данного метода требуется отобразить форму ввода кода

, метод аналогичен методу запроса кода для Документа

.

Канал получения кода подписания устанавливается при выпуске УНЭП Сотруднику.

6

5

) Завершение подписания Заявления УНЭП - подтверждение кода из сообщения

Status

subtle	true
colour	Green
title	REDOC

PUT /api/v1/clients/:clientId/applicationGroups/:applicationGroupId/sign/nqes

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

Передача кода для проверки в УЦ.

Результат проверки кода не возвращается в ответе метода, т.к. процесс асинхронный. Требуется опрашивать статус Заявления для продолжения процесса. Подробнее про состояния Заявления.

7

6

) Получение данных Заявления

Status

subtle	true
colour	Green
title	REDOC

GET /api/

v1

v2/clients/:clientId/applicationGroups/:applicationGroupId

подписание заявления - ассинхронный процесс, в рамках которого

В рамках процесса подписания Заявления, кроме самого подписания, ещё формируется новая печатная форма с оттиском, поэтому рекомендуется запрашивать состояние заявления, чтобы:

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

7

8) Получение печатной формы заявления с оттиском

Status

subtle	true
colour	Green
title	REDOC

GET /api/v1/clients/:clientId/applications/:applicationId/printFormFile

2. Сотрудник подаёт заявление по шаблону и подписывает его УНЭП

Tip

title	Цель

Цель - предоставить Предоставить Сотруднику возможность направить заявление, по заранее определённому шаблону, ожидающему заполнения заданных полей.

Предусловия

Шаблон типа заявления создан, активен и доступен для отдела Сотрудника
Status
subtle true
colour Green
title REDOC
Подробнее про работу с типами Заявлений
1. POST /api/v1/applicationTypes
2. PUT /api/v4/applicationTypes/{applicationTypeId}
Получены системные поля
Status
subtle true
colour Green
title REDOC
Получены системные поля
1. GET /api/v1/applicationTypeFields/system
Определён список сотрудников, для Согласования
Status
subtle true
colour Green
title REDOC
1. GET /api/v1v2/clients/:clientId/colleagues

API-метод

Примечания

1) Получены типы Заявлений и маршрут подписания

Status

subtle	true
colour	Green
title	REDOC

GET /api/v1/applicationTypes

Данный метод предоставляет

сотруднику

список

шаблонов2)

типов заявлений, доступных для подачи

- необходим, чтобы сотрудник выбрал заявление по какому шаблону будет подано.

, а также маршруты подписания по этим типам. Для подачи заявления из файла необходимо выбрать соответствующий тип Заявления.

Типы заявления могут быть стандартными от HRlink, могут быть пользовательскими. Клиент может создать свой тип Заявления и настроить свои заполняемые поля со стороны Заявителя. Также возможно привязать стандартный маршрут от HRlink или создать свой. Создание типа с маршрутом доступно Администратору HRlink. Подробнее про Создание новых типов заявлений.

Во всех типах с флагом "templatable": true указаны параметры заполняемых, пользовательских полей, в том числе и идентификаторы этих полей applicationTypes[].templateFields[].id. Эти id необходимо в дальнейшем указывать при создании группы Заявлений (см. п 4) вместе с данными, которые заполнил Заявитель.

В ответе метода указаны id участников маршрута Заявления (applicationTypes[].signingRouteTemplate{}.stages[].participants[].id), которые необходимо в дальнейшем указывать при создании группы Заявлений (см. п 4)

2) Получен справочник системных полей

Status

subtle	true
colour	Green
title	REDOC

GET /api/v1/applicationTypeFields/system

Данный метод возвращает перечень системный полей, которые могут предзаполняться в шаблоне Заявления. Например, ФИО Сотрудника (Заявителя), наименования юр.лица, отдела, должности, текущая дата и т.д.

Каждое системное поле имеет свой идентификатор. Эти id необходимо в дальнейшем передать при создании группы Заявлений (см. п 4) вместе с данными, которые автоматически заполнились системой. Заполнить поля возможно, использовав метод Получения информации о текущем пользователе, например.

Подробнее про системные поля.

3)

Сотрудник выбирает кто будет согласовывать заявление

На основании метода

Status

subtle	true
colour	Green
title	REDOC

GET /api/

v1

v2/clients/:clientId/colleagues

из

Определить Согласующих возможно несколькими способами:

Из полученного списка выбирается тот, кто будет передан в метод создания Заявления как

Согласующий

Подробнее о методе см. раздел https://hr-link.atlassian.net/wiki/spaces/HRLIN/pages/666075304/04.#3.1.-%D0%9F%D0%BE%D0%BB%D1%83%D1%87%D0%B5%D0%BD%D0%B8%D0%B5-%D1%81%D0%BF%D0%B8%D1%81%D0%BA%D0%B0-%D0%A1%D0%BE%D1%82%D1%80%D1%83%D0%B4%D0%BD%D0%B8%D0%BA%D0%BE%D0%B2-%D0%B4%D0%BB%D1%8F-%D0%B2%D1%8B%D0%B1%D0%BE%D1%80%D0%B0-%D0%A1%D0%BE%D0%B3%D0%BB%D0%B0%D1%81%D1%83%D1%8E%D1%89%D0%B5%D0%B3%D0%BE

Согласующий
Возможно указать participants[].employeeExternalId - идентификатор сотрудника внешней системы, в качестве участника маршрута при подаче заявления (см. п 4). На момент подачи Заявления employeeExternalId сотрудников должны быть переданы в HRlink.

4

3

) Создание заявления по шаблону

Status

subtle	true
colour	Green
title	REDOC

POST /api/v1/clients/:clientId/applicationGroups

На основании того, какой был выбран тип (шаблон) заявления, необходимо заполнить обязательные поля:

это может быть передача ранее определённых данных, таких как ФИО, отдел, должность и т.д. в качестве системных полей templateSystemFields
это может быть

UI форма для заполненияИдентификатор файла

передача данных, которые Сотрудник ввел на UI форме, например, даты отпуска, тип отпуска, новое название отдела при переводе и т.д.. Такие поля передаются как templateFields

Необходимо указать id заполняемых полей, системных (см.п.2) или пользовательских (см.п 1), а также тип заявления и id участников маршрута подписания (см.п.1).

Идентификатор файлаfileId - не заполняется, т.к. Система сама формирует файл заявления и конвертирует его в pdf/a формат для последующего подписания.

4

5) Получение данных Заявления

Status

subtle	true
colour	Green
title	REDOC

GET /api/

v1

v2/clients/:clientId/applicationGroups/:applicationGroupId

После того, как создано заявление, система формирует pdf файл, который можно отобразить для проверки перед подписанием

5

6) Загрузка файла заявления, сформированного по шаблону

Status

subtle	true
colour	Green
title	REDOC

GET /api/v1/clients/:clientId/applications/:applicationId/convertedFile

данный

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

5

7, в случае если результат не устраивает - переход к шагу 2

6

7) Запуск подписания Заявления УНЭП - запрос сообщения с кодом

Status

subtle	true
colour	Green
title	REDOC

POST /api/v1/clients/:clientId/applicationGroups/:applicationGroupId/sign/nqes

На активный канал получения кода подписания Сотрудника будет выслан код для подписания УНЭП. После - сотруднику необходимо ввести код и передан его для проверки, поэтому по итогу вызова данного метода требуется отобразить форму ввода кода

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

.

Канал получения кода подписания устанавливается при выпуске УНЭП Сотруднику.

8

7

) Завершение подписания Заявления УНЭП - подтверждение кода из сообщения

Status

subtle	true
colour	Green
title	REDOC

PUT /api/v1/clients/:clientId/applicationGroups/:applicationGroupId/sign/nqes

в данный метод передается код, который направляется в сообщении

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

Передача кода для проверки в УЦ.

Результат проверки кода не возвращается в ответе метода, т.к. процесс асинхронный. Требуется опрашивать статус Заявления для продолжения процесса. Подробнее про состояния Заявления.

9

8

) Получение данных Заявления

Status

subtle	true
colour	Green
title	REDOC

GET /api/

v1

v2/clients/:clientId/applicationGroups/:applicationGroupId

подписание заявления - ассинхронный процесс, в рамках которого

В рамках процесса подписания Заявления, кроме самого подписания, ещё формируется новая печатная форма с оттиском, поэтому рекомендуется запрашивать состояние заявления, чтобы:

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

7

10) Получение печатной формы заявления с оттиском

Status

subtle	true
colour	Green
title	REDOC

GET /api/v1/clients/:clientId/applications/:applicationId/printFormFile

Порядок действий

API-метод

Примечания

3. Сотрудник просматривает Заявление

Tip

title	Цель

- предоставить

Предоставить Сотруднику всю информацию по заявлению

Предусловия (одно из)

Заявление подано сотрудником
Сотрудник является согласующим

согласующим

API-метод

Примечания

1) Сотрудник загружает список заявлений, в соответствии с фильтрами

Status

subtle	true
colour	Green
title	REDOC

POST /api/

v1

v2/clients/:clientId/applicationGroups/

employeeRegistry

На данный момент данный метод не оформлен в API-документации

Метод аналогичен методу получение реестр заявлений для Кадровика

getEmployeeRegistry

2) Получение данных Заявления

Status

subtle	true
colour	Green
title	REDOC

GET /api/

v1

v2/clients/:clientId/applicationGroups/:applicationGroupId

Данный метод возвращает метаданные заявления, но не файл для просмотра

3) Получение печатной формы заявления с оттиском

Status

subtle	true
colour	Green
title	REDOC

GET /api/v1/clients/:clientId/applications/:applicationId/printFormFile

Этот шаг не обязательный, но позволяет наглядно увидеть кто и когда совершал действия по Заявлению.

4. Сотрудник Обрабатывает заявление как Согласующий

Tip

title	Цель

- предоставить

Предоставить ответственному сотруднику возможность принять решение по заявлению:

согласовано

согласовать

отклонено

отклонить

нужно заменить согласующего

Предусловия

Заявление подано сотрудником

(создано и подписано)
Текущий пользователь является согласующим

Сотрудник является согласующим

выполнен сценарий - Сотрудник просматривает Заявление

API-метод

Примечания

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

Согласование заявления Согласующим (подписание Заявление ПЭП)
Status
subtle true
colour Green
title REDOC

PUT /api/v1/clients/

:

{clientId}/applications/

:

{applicationId}/

participants/approver/approve

signBySes

Отклонение заявления Согласующим
Status
subtle true
colour Green
title REDOC

PUT /api/v1/clients/

:

{clientId}/applications/

:

{applicationId

/participants

}/

approver/reject

Запрос на замену согласующего

PUT /api/v1/clients/:id/applications/:applicationId/participants/approver/rejectApproving

На данный момент данный метод не оформлен в API-документации

2) Получение данных Заявления

GET /api/v1/clients/:clientId/applicationGroups/:applicationGroupId

3) Получение печатной формы заявления с оттиском

GET /api/v1/clients/:clientId/applications/:applicationId/printFormFile

5. Сотрудник (Заявитель) заменяет Согласующего на основании запроса

Цель - скорректировать согласующего, так как предыдущий сотрудник запросил смену согласующего

Предусловия

Заявление подано сотрудником
Сотрудник является согласующим
выполнен сценарий - Сотрудник просматривает Заявление
Определён список сотрудников, для Согласования
1. GET /api/v1/clients/:clientId/colleagues

1) Сотрудник выбирает кто будет согласовывать заявление

На основании метода

reject

После согласования Заявления со стороны Согласующего, Заявление продолжает свое движение по маршруту подписания, т.е. следующий подписант получит уведомление о том, что Заявление ожидает от него решения. Если Согласующий является последним по маршруту, то документооборот по Заявлению завершен.

Как правило последний участни по маршруту - это кадровый специалист, который и завершает обработку Заявления. Подробнее про работу Кадровика с заявлениями.

2) Получение печатной формы заявления с оттиском

Status

subtle	true
colour	Green
title	REDOC

GET /api/v1/clients/:clientId/

colleagues из полученного списка выбирается тот, кто будет передан в метод создания Заявления как Согласующий

Подробнее о методе см. раздел https://hr-link.atlassian.net/wiki/spaces/HRLIN/pages/666075304/04.#3.1.-%D0%9F%D0%BE%D0%BB%D1%83%D1%87%D0%B5%D0%BD%D0%B8%D0%B5-%D1%81%D0%BF%D0%B8%D1%81%D0%BA%D0%B0-%D0%A1%D0%BE%D1%82%D1%80%D1%83%D0%B4%D0%BD%D0%B8%D0%BA%D0%BE%D0%B2-%D0%B4%D0%BB%D1%8F-%D0%B2%D1%8B%D0%B1%D0%BE%D1%80%D0%B0-%D0%A1%D0%BE%D0%B3%D0%BB%D0%B0%D1%81%D1%83%D1%8E%D1%89%D0%B5%D0%B3%D0%BE

2) Сотрудник передает данные идентификатор нового согласующего

PUT /api/v1/clients/:clientId/

applications/:applicationId/

participants/approver/change

На данный момент данный метод не оформлен в API-документации

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

6

printFormFile

Этот шаг не обязательный, но позволяет наглядно увидеть, что операция отразилась в оттиске.

5. Сотрудник загружает архив КЭДО по Заявлению

Tip

title	Цель

- предоставить

Предоставить сотруднику архив, содержащий:

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

Предусловия

выполнен сценарий - Сотрудник просматривает Заявление

API-метод

Примечания

Сотрудник запрашивает архив КЭДО по Заявлению

GET /api/v1/clients/:clientId/applications/:applicationId/archive

Поиск документации

Livesearch

spaceKey	WIKI

Page tree

Versions Compared

Old Version 6

New Version Current

Key

Сценарии работы Сотрудника с Заявлениями

1. Сотрудник подает заявление из файла и подписывает его УНЭП

2. Сотрудник подаёт заявление по шаблону и подписывает его УНЭП

3. Сотрудник просматривает Заявление

4. Сотрудник Обрабатывает заявление как Согласующий

5. Сотрудник (Заявитель) заменяет Согласующего на основании запроса

5. Сотрудник загружает архив КЭДО по Заявлению

Page tree

Page History

Versions Compared

Old Version 6

New Version Current

Key

Сценарии работы Сотрудника с Заявлениями

1. Сотрудник подает заявление из файла и подписывает его УНЭП

2. Сотрудник подаёт заявление по шаблону и подписывает его УНЭП

3. Сотрудник просматривает Заявление

4. Сотрудник Обрабатывает заявление как Согласующий

5. Сотрудник (Заявитель) заменяет Согласующего на основании запроса

5. Сотрудник загружает архив КЭДО по Заявлению