API - Atualização de Usuários Solicitantes e Responsáveis do BPM
Sumário
1. Objetivo
Atualizar o nome dos usuários Responsável e Solicitante no BPM. Esse processo é necessário quando a integração via Autenticação G5 (XT) para a Senior X realiza o update (atualização) do nome do usuário no XT, o que acaba gerando um segundo registro no BPM para a mesma pessoa física (usuário XT).
A API transfere automaticamente todas as solicitações criadas e tarefas (em qualquer status) do antigo usuário para o novo usuário.
Essa API não altera os campos Usuário substituto nem o campo Usuário em cópia, sendo assim, certificar que antes de renomear o login na G5, o usuário não esteja como Usuário em cópia ou Usuário substituto no BPM.
Exemplificação do problema:
- Situação antes de renomear o usuário na G5.
- Nome: Maria Silveira
- Matrícula:1521
- CPF: 123.456.789-10
- Login: 1521
Login usuário G5 1521 Login usuário G7 1521 Usuário BPM 1521 # Quantidade Solicitações criadas 120 Tarefas atribuídas 35 - Renomear o login na G5
- Nome: Maria Silveira
- Matrícula:1521
- CPF: 123.456.789-10
- Login: maria.silveira
No BPM acaba criando um novo usuário, ficando desta maneira os registros:
| Login usuário G5 | maria.silveira |
| Login usuário G7 | maria.silveira |
| Usuário BPM (antigo) | 1521 |
| Usuário BPM (novo) | maria.silveira |
Ou seja, no BPM acaba gerando dois usuários distintos, mantém o login com o nome antigo e cria um novo usuário com o novo login. Isso é uma característica nativa de concepção da plataforma, cuja modificação estrutural não é visível no momento.
Supondo que, após ter sido realizada a atualização do nome do login, o usuário começa a acessar o BPM fazendo suas atribuições diárias, os cenários quanto a quantidade das Solicitações e Tarefas pode ficar conforme a seguir:
| Usuário BPM (antigo) | 1521 |
| Solicitações criadas | 120 |
| Tarefas atribuídas | 35 |
| Usuário BPM (novo) | maria.silveira |
| Solicitações criadas | 15 |
| Tarefas atribuídas | 6 |
Sendo necessário executar a API deste manual. Após a execução, o resultado deve ser:
| Usuário BPM (novo) | maria.silveira |
| Solicitações criadas | 135 |
| Tarefas atribuídas | 41 |
2. Pré-requisitos
- Possuir no BPM dois usuários vinculados à mesma pessoa, ou seja, dois registros de usuário para o mesmo usuário da G7/G5.
- O usuário que irá realizar a chamada deve possuir a permissão do recurso:
res://senior.com.br/platform/workflow/alter-subjects.
3. Detalhamento das APIs
3.1 API updateSubjectsName - Atualização de usuários em lote
URL
| endpoint | POST platform/workflow/actions/updateSubjectsName
|
|---|
Parâmetros:
| Parâmetro | Tipo | Obrigatório | Descrição |
|---|---|---|---|
| subjects | subjects[] | Sim | Lista de objetos com os parâmetros de usuário original e o novo usuário. |
| subjectOrigin | String | Sim | Usuário antigo, que precisará ser substituído pelo novo usuário. |
| subjectDestiny | String | Sim | Usuário novo que herdará as solicitações e tarefas do usuário de origem. |
Exemplo:
{
"subjects": [
{
"subjectOrigin": "1521",
"subjectDestiny": "maria.silveira"
}
]
}
Resposta
A API pode retornar dois códigos de resposta:
| Código | Descrição |
|---|---|
| 201 | Realizada a alteração dos usuários em questão. |
| 400 | Usuário de origem ou destino não encontrado pelo sistema. |
Observação
O limite da API é de 100 subjects.
4. Boas Práticas
Antes de utilizar o envio em lote dos registros, realize o teste com somente um usuário para validar se o comportamento é o esperado e se ao acessar o BPM com o novo usuário está visualizando as tarefas e solicitações herdadas do usuário antigo.
English
Español
