Excerpt

Info

title	О чём раздел

Под формирование кадрового документооборота подразумевается:

МЧД - получение списка доверенностей, получение данных доверенности
1. Созданием МЧД занимается Администратор → [01. Администратор. Базовые настройки справочников]
Создание и редактирование Черновика Документа
Отправление документов на подписание
1. Отправление Черновика на подписание
2. Создание Черновика, совмещённое с отправкой на подписание
3. Отправление Черновика, совмещённое с подписанием от лица Работодателя
ЛНА - создание, отправка на подписание

Table of Contents

Формирование Кадрового Документооборота

Info

Документ - объект направляемый Работодателем работнику для ознакомления или подписания, в рамках КЭДО.

Документ состоит из метаданных и файлов, обладает состоянием, которое определяется процессом.

Участники КЭДО могут совершать различные операции, которые зависят от роли и условий и состояния документа

В данном описании рассмотрено, с какими сценариями может столкнуться работодатель в рамках взаимодействия своей информационной системы (в которой организован КЭДО) и системой HRlink.

Tip

title	Цель

Начать КЭДО для необходимых сотрудников компании Клиента

Note

title	Предусловие

Только действующий сотрудник с правом подписания (это или включенная возможность подписания или действующий УНЭП) имеет право участвовать в КЭДО.

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

для понимания процесса работы с документами рекомендуется изучить раздел [Документ]

Действия и API-методы

Примечания

1

1) Кадровик загружает файла(ы) для документа(ов)

Status


subtle	true
colour	YellowGreen
title	Gdocredoc

POST /api/v1/files

Поле, в котором передается файл, может иметь любое имя.

В одном запросе можно передать один или несколько файлов. В случае отправки нескольких файлов следует давать полям разные имена.

2

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

Status


subtle	true
colour	YellowGreen
title	Gdocredoc

GET /api/v1/permittedDocumentTypes

Использование данного шага как части сценария позволит получить актуальный список типов документов для Кадровика

3

3) Кадровик создает черновик документа

Status


subtle	true
colour	YellowGreen
title	Gdocredoc

POST /api/v1/clients/:clientId/documentGroups

При создании можно задавать Внешний ID (externalId), соответствующий идентификатору документа в вашей ИС. В HRlink Внешний ID (externalId) хранится как строка, поэтому допустимы любые строковые символы. Ограничения на максимальную длину строки нет.

При создании документа система конвертирует полученный файл в pdf/a. Конвертация файла является асинхронным процессом!

Создание документа возможно только если в системе HRlink есть файл, который ляжет в основу подписания. То есть есть два варианта для связи набора метаданных документа с файлом:

через указание идентификатора файла (возвращается в ответ на вызов метода загрузки файла)
через указание документа основания sourceDocumentId или sourceDocumentExternalId

4

4) Кадровик инициирует проверку на возможность отправки на подписание

Status


subtle	true
colour	YellowGreen
title	Gdocredoc

POST /api/v1/clients/:clientId/documents/validateBeforeSendToSigning

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

5

5) Кадровик вносит исправления в данные черновика документа

Status


subtle	true
colour	YellowGreen
title	Gdocredoc

PUT /api/v1/clients/:clientId/documentGroups

частный случай исправления - затирание externalId документа и повторение шагов 1-4

5) Кадровик затирает ID своей ИС в удаленном документе

Status


subtle	true
colour	Green
title	redoc

PUT /api/v1/clients/:clientId/documents/:externalId/externalId/clearExternalId

альтернативой редактированию может быть удаление черновика и повторение шагов 1-4

5) Кадровик удаляет документ по ID документа в HRL

Status


subtle	true
colour	Green
title	redoc

DELETE /api/v1/clients/:clientId/documents/:documentId

или

Кадровик удаляет список документов по ID своей ИС или ID в HRL
Status
subtle true
colour Green
title redoc

DELETE /api/v1/clients/:clientId/documents

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

Редактирование черновика позволяет внести изменения в метаданные документа:

тип, номер, дата
актуализировать состав участников

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

6

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

Status


subtle	true
colour	YellowGreen
title	Gdocredoc

PUT /api/v2v1/clients/:{clientId}/documents/sendToSigning

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

Кадровик подписывает Черновик (как руководитель) и отправляет дальше на подписание

Note

title	Предусловие

Выполнены шаги 1-3 сценария [Кадровик создает Черновик Документа и отправляет его на подписание]
Есть идентификатор документа

Действия и API-методы

Примечания

1

1) Кадровик инициирует проверку документов на возможность подписания и отправки на подписание

Status


subtle	true
colour	Yellow
title	Gdoc

POST /api/v1/clients/:clientId/documents/validateBeforeSendAndSign

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

2

2) Кадровик запрашивает файл, который подписывается в HRlink

Status


subtle	true
colour	Yellow
title	Gdoc

GET /api/v1/clients/:clientId/documents/:documentId/convertedFile

Необходимо получить файл, который был получен в HRlink после конвертации переданного файла в формат pdf/a.

Подписание УКЭПом должно производиться именно относительно файла, полученного в данном методе

3

3) Кадровик подписывает УКЭП (как руководитель) и отправляет документ дальше

Status


subtle	true
colour	Yellow
title	Gdoc

PUT /api/v1/clients/:clientId/documents/sendAndSign

Само подписание УКЭПом производится за рамками HRlink, в данном методе только передаётся файл подписи.

если включена настройка использования МЧД, то требуется учитывать права Подписанта в рамках МЧД

Кадровик создает Черновик с совмещённой отправкой на подписание при создании

Note

title	Предусловие

если включена настройка использования МЧД, то требуется учитывать права Подписанта в рамках МЧД

Файлы для документа загружен с помощью метода загрузки файла

Действия и API-методы

Примечания

1

1) Кадровик использует метод отправки документа на подписание при создании

Status


subtle	true
colour	Yellow
title	Gdoc

POST /api/v1/clients/:clientId/documentGroups/sendToSigning

Выполнение метода является ассинхронным, поэтому в ответ возвращается не идентификатор документа, а идентификатор задачи.

2

2) Кадровик запрашивает массив документов с заданными фильтрами

Status


subtle	true
colour	Yellow
title	Gdoc

POST /api/v1/clients/:clientId/documents/hrRegistry

Необходимость проверки обусловлена ассинхронностью процесса.

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

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

Контроль Процесса Подписания

Кадровик получает данные по документам

Получение метаданных документа

Tip

title	Цель

В разделе [REST API - "Запрос-Ответ"] отмечено, что HRlink не направляет в ИС запросов, а только отвечает на запрос.

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

Действия и API-методы

Примечания

1

1) Кадровик запрашивает список документов с учётом фильтров

Status


subtle	true
colour	Yellow
title	Gdoc

POST /api/v1/clients/:clientId/documents/hrRegistry

Получение реестра документов позволяет реализовать на стороне клиента опрос по документам, подходящим под набор условий:

тип документа
состояние документа
дата документа
перечень идентификаторов
- важно учитывать [Архитектурные особенности объекта] Документ

При работе с реестрами важно учитывать [Пагинацию]

2

2) Кадровик запрашивает документ по ID своей ИС

Status


subtle	true
colour	Yellow
title	Gdoc

GET /api/v1/clients/:clientId/documents/:externalId/externalId

или

Кадровик запрашивает документ по ID HRL
Status
subtle true
colour Yellow
title Gdoc

GET /api/v1/clients/:clientId/documents/:documentId

Альтернативой получения списка документов является запрос состояния конкретного документа по его идентификатору.

важно учитывать [Архитектурные особенности объекта] Документ

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

Tip

title	Цель

Побудить к подписанию Сотрудника, на ком "завис" документ.

Note

title	Предусловие

У Клиента есть идентификатор документа

Действия и API-методы

Примечания

1

2) Кадровик инициирует повторное уведомление по документу

Status


subtle	true
colour	Red
title	addon

POST /api/v1/clients/:clientId/documents/signers/next/notify

Кадровому работнику не требуется определять на ком “зависло” подписание, система сама направляет уведомление текущему подписанту, с учётом того, какой канал уведомления является актуальным для Подписанта.

Expand

title	Пояснения к методу повторного уведомления

POST /api/v1/clients/:clientId/documents/signers/next/notify

Тело запроса

Markdown
``` { "documentIds": [...] } ```

допускается только указание UUID идентификаторов HRlink

Валидации:

ID клиента должен соответствовать формату UUID
Клиент с заданным ID должен существовать
Текущий пользователь должен относиться к клиенту
Тело запроса должно быть задано
В теле запроса должен быть задан список ID документов
Документы с заданными ID должны существовать
Документы должны относиться к заданному клиенту
Документы должны быть не удалены
Документы должны быть не черновиками
Текущий пользователь должен иметь право на отправку уведомления следующему подписанту для каждого из документов DOCUMENTS_SEND_TO_SIGNING (на уровне пользователя или сотрудника)
По всем документам не должно быть подписантов, которые отказались подписывать
У каждого из документов должны быть следующие подписанты
Лимит СМС в пакете лицензий не должен быть исчерпан
Активный этап маршрута подписания каждого из документов может быть завершён, даже если на этапе есть уволенные подписанты

Ответ

Markdown
``` { "result": true } ```

вместо использования данного метода можно в ЛК настроить параметры автоуведомлений, для этого необходимо связаться с персональным менеджером.

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

Tip

title	Цель

Добавить дополнительную информацию к документу

видимую только кадровикам
видимую всем участника КЭДО

Note

title	Предусловие

У Клиента есть идентификатор документа

Действия и API-методы

Примечания

1

1) Кадровик добавляет текст заметки к документу

Status


subtle	true
colour	Red
title	addon

PUT /api/v1/clients/:clientId/documents/:documentId/notice

примечание оставленное данным методом будет видно только Кадровикам.

Expand

title	Пояснения к методу добавления примечания Кадровика

PUT /api/v1/clients/:clientId/documents/:documentId/notice

Тело запроса

Markdown
``` { "notice": "заметка кадровика", "version": 1 } ```

Валидации

ID клиента должен соответствовать формату UUID
ID документа должен соответствовать формату UUID
Тело запроса задано
Клиент с заданным ID должен существовать
Текущий пользователь должен относиться к клиенту
Документ с заданным ID должен существовать
Документ должен относиться к заданному клиенту
Если в теле запроса указана версия документа, то она должна быть указана корректно
У текущего пользователя должно быть право изменять заметку кадровика о документе DOCUMENTS_UPDATE

Ответ

Markdown
``` { "result": true, "document": { "notice": "заметка кадровика" } } ```

2

2) Кадровик добавляет комментарий к документу, видимый всем участникам

Status


subtle	true
colour	Red
title	addon

POST /api/v1/clients/:clientId/documents/:documentId/comments

примечания оставленные данным методом будут видны всем пользователям, которые видят документ и использую ЛК HRlink

Expand

title	Пояснения к методу добавления общего комментария

POST /api/v1/clients/:clientId/documents/:documentId/comments

Тело запроса

Markdown
``` { "message": "Тестовый комментарий", "version": 1 } ```

Ответ

Markdown

```
{
    "result": true,
    "comment": {
        "id": "6cc81135-6318-442e-907f-83dbb4f9a9aa",
        "version": 1,
        "user": {
            "lastName": "Шелест",
            "firstName": "Леонид",
            "patronymic": null,
            "userId": "240a8b5e-9e2e-42a7-8977-160da4be05db"
        },
        "message": "тестовый комментарий",
        "createdDate": "2023-12-12T17:56:29.951576Z"
    }
}
```

Получение файлов, связанных с документом

Tip

title	Цель

Для разных целей можно использовать разные файлы КЭДО:

отображение документа с отметкой о подписании - печатная форма
для подписания файла УКЭП - сконвертированный файл
для дополнительного бекапирования - архив КЭДО
- HRlink для дополнительного бекапирования может предложить использование функционала выгрузки на SFTP сервер клиента.

Note

title	Предусловие

У Клиента есть идентификатор документа

Действия и API-методы

Примечания

1

1) Кадровик получает печатную форму документа с оттисками

Status


subtle	true
colour	Yellow
title	Gdoc

GET /api/v1/clients/:clientId/documents/:documentId/printFormFile

печатная форма входит в архив КЭДО

2

2) Кадровик запрашивает файл, который подписывается в HRlink

Status


subtle	true
colour	Yellow
title	Gdoc

GET /api/v1/clients/:clientId/documents/:documentId/convertedFile

сконвертированный файл входит в архив КЭДО

в случае, если процессы клиента предполагают подписание файла в нескольких системах, нужно учитывать, что в HRlink файл в документе - конвертируется и подписание происходит над сконвертированным файлом.

3

3) Кадровик скачивает архив КЭДО по ID документа своей ИС

Status


subtle	true
colour	Yellow
title	Gdoc

GET /api/v1/clients/:clientId/documents/:externalId/externalId/archive

или

Кадровик скачивает архив КЭДО по ID документа HRL
Status
subtle true
colour Yellow
title Gdoc

GET /api/v1/clients/:clientId/documents/:documentId/archive

Архив КЭДО включает в себя:

Сконвертированный файл, который подписывался
Печатная Форма (ПФ) с оттиском электронной подписи
Описание электронного документа XML файл
Протокол КЭДО (входит в архив, только если его скачивает Кадровый специалист)
Файлы подписей - может быть 1 или несколько файлов. Файл подписи ПЭП Госуслуги представлен в виде zip архива.

Предыдущий раздел

02. Кадровик. Основные процессы: Управление Персоналом

Следующий раздел

04. Кадровик. Основные процессы: Обработка Заявлений

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

Livesearch

spaceKey	WIKI
size	large

Page tree

Versions Compared

Old Version 11

New Version Current

Key

Формирование Кадрового Документооборота

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

Кадровик подписывает Черновик (как руководитель) и отправляет дальше на подписание

Кадровик создает Черновик с совмещённой отправкой на подписание при создании

Контроль Процесса Подписания

Кадровик получает данные по документам

Получение метаданных документа

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

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

Получение файлов, связанных с документом

Предыдущий раздел

Следующий раздел

Page tree

Page History

Versions Compared

Old Version 11

New Version Current

Key

Формирование Кадрового Документооборота

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

Кадровик подписывает Черновик (как руководитель) и отправляет дальше на подписание

Кадровик создает Черновик с совмещённой отправкой на подписание при создании

Контроль Процесса Подписания

Кадровик получает данные по документам

Получение метаданных документа

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

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

Получение файлов, связанных с документом

Предыдущий раздел

Следующий раздел