Histórico da Página
...
| Produto: |
| ||||||||
|---|---|---|---|---|---|---|---|---|---|
| Linha de Produto: |
| ||||||||
| Segmento: |
| ||||||||
| Módulo: | SIGAGPE | ||||||||
| Função: | GPEA430 GPEA944A GPEA944B GPEA944C GPEM939 GPEM939A GPEM939B GPEM939C GPTABBRA | ||||||||
| Ticket: | |||||||||
| Requisito/Story/Issue (informe o requisito relacionado) : | DRHCALCPRT-3734 DRHCALCPRT-4009 DRHCALCPRT-4164 DRHCALCPRT-3736 DRHCALCPRT-3733 DRHCALCPRT-3735 DRHCALCPRT-3737 |
02. SITUAÇÃO/REQUISITO
Criar uma rotina que fará a integração com o P&M (Performance & Metas) dos itens abaixo:
- Filiais (tabela SM0);
- Grupos de cargo (tabela SQ0);
- Cargos (tabela SQ3);
- Departamentos (tabela SQB);
- Funcionários (tabela SRA).
DRHCALCPRT-4380 DRHCALCPRT-4375 DRHCALCPRT-4452 DRHCALCPRT-4504 DRHCALCPRT-4518 DRHCALCPRT-4374 DRHCALCPRT-4376 DRHCALCPRT-4377 DRHCALCPRT-4378 DRHCALCPRT-4400 DRHCALCPRT-4381 DRHCALCPRT-4401 DRHCALCPRT-5010 DRHCALCPRT-6427 |
02. SITUAÇÃO/REQUISITO
Criar uma rotina que fará a integração dos cadastros do Protheus com o P&M (Performance & Metas) e uma rotina que possibilite consultar Criar uma rotina que possibilite consultar as informações dos lotes de integrações com o P&M (Performance & Metas).
03. SOLUÇÃO
...
Efetuado o desenvolvimento da integração com o P&M (Performance & Metas)
...
.
| Aviso | ||||||||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| ||||||||||||||||||||||||||
A melhoria depende da aplicação da atualização liberada no pacote de expedição do módulo RH a partir de 15/07/2022 e da execução do UPDDISTR com o dicionário diferencial para os releases iguais ou superiores a versão 12.1.27.
|
...
- Filiais (tabela SM0);
- Grupos de cargo (tabela SQ0);
- Cargos (tabela SQ3);
- Departamentos (tabela SQB);
- Funcionários (tabela SRA).
Foi efetuado a criação da rotina GPEM939B para permitir a visualização das informações dos lotes de integração com o P&M (Performance & Metas), bem como consultar manualmente o status de integração. Também foi disponibilizada a rotina GPEM939C para ser possível agendar no Schedule a consulta automática dos lotes de integração.
| Aviso | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
A melhoria depende da aplicação da atualização liberada no pacote de expedição do módulo RH a partir de XXXX/XXXX/2022 e da execução do UPDDISTR com o dicionário diferencial para os releases iguais ou superiores a versão 12.1.27. Foi efetuado a criação da tabela REF, conforme estrutura abaixo: | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| X2_CHAVE | X2_NOME | X2_MODO | X2_MODOUN | X2_MODOEMP | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| REF | Lote de integração P&M | C | C | C |
| Nota | ||
|---|---|---|
| ||
O modo de acesso da tabela REF deve ser obrigatoriamente compartilhado. |
Foi efetuado a criação dos índices na tabela REF, conforme estrutura abaixo:
|
|
|
|
Foi efetuado a criação de |
tabelas no dicionário SX2, conforme estrutura abaixo: |
|
|
|
|
|
|
|
|
|
Filial do lote
Process ID do lote retornado pelo P&M
Tipo da API
Data da integração
Hora da integração
Status da integração
JSON do lote integrado
O modo de acesso das tabelas REF, REN e RET devem ser obrigatoriamente compartilhado. Foi efetuado a criação de campos no dicionário SX3 conforme estrutura abaixo:
|
|
|
|
|
Foi efetuado a criação de parâmetros, conforme estrutura abaixo:
https://{TENANT}.rac.{ENVIRONMENT}.totvs.app/totvs.rac/connect/token
Exemplo: https://admin.rac.totvs.app/totvs.rac/connect/token
https://{NOME_EMPRESA}.performance.totvs.app/integration-general/
Exemplo: https://empresateste.performance.dev.totvs.app/integration-general/
Será exibida para o usuário na rotina de integração.
Será exibida para o usuário na rotina de integração.
Será exibida para o usuário na rotina de integração.
Será exibida para o usuário na rotina de integração.
| Nota | ||
|---|---|---|
| ||
Os parâmetros MV_APIPEM0 e MV_APIPEM1 precisam ser configurados conforme o formato de exemplo da tabela acima. |
| Nota | ||
|---|---|---|
| ||
Será necessário incluir manualmente um item no menu do módulo SIGAGPE para a rotina GPEM939 e para a rotina GPEM939B. Sugere-se criá-las em um grupo separada, chamado de Performance & Metas em Miscelânea. Além disso, para ser possível realizar a integração com o P&M, é necessário que o cadastro grupos de cargo tenha sido realizado através da rotina TRMA030, uma vez que essa informação é obrigatória para o P&M, além de vincular os grupos aos cargos cadastrados no sistema. |
A rotina GPEM939 é do tipo Wizard e possui cinco passos:
...
| startHidden | false |
|---|---|
| id | WIZARD |
...
| default | true |
|---|---|
| id | wizard1 |
| label | 1-Observações |
| title | Observações |
Essa tela exibe um breve descritivo da rotina e contém um botão que direciona para esta documentação do TDN.
...
| id | wizard2 |
|---|---|
| label | 2-Configuração |
| title | Configuração |
Essa tela exibe quatro perguntas para a configuração da integração:
- "Verificação registro ativo": essa opção tem o intuito de definir como o sistema efetuará a validação se determinado registro está ativo, uma vez que apenas registros ativos serão enviados ao P&M. Ao selecionar a opção "Somente pelo campo campo MSBLQL (se houver)", caso o campo MSLBL exista na tabela, será considerado apenas os registros ativos (MSBLQL diferente de 1); se for selecionado a opção "Campo MSBLQL (se houver) + vínculo com registro ativo da SRA", além da verificação do campo MSBLQL diferente de 1, para um registro ser considerado como ativo terá que ter vínculo com registros ativos da tabela SRA, ou seja, funcionários ativos ou que foram demitidos com data de demissão superior à data de corte (a data é configurada na pergunta abaixo);
- "Data de corte demissão": define a data de corte de demissão para que um funcionário seja considerado ativo ou não, ou seja, funcionário demitidos a partir da data configurada serão considerados ativos, enquanto que funcionários demitidos antes da data serão considerados como inativos.
- "Verificação retorno P&M:": define se a rotina irá aguardar o retorno do processamento da integração pelo P&M ou não.
- "Tempo limite (em minutos):": define o tempo máximo que a rotina irá aguardar para obter o status de retorno do processamento pelo P&M.
...
| title | Observação técnica |
|---|
A verificação do registro ativo da opção "Campo MSBLQL (se houver) + vínculo com registro ativo da SRA" é diferente para cada opção de integração:
- Filiais: uma filial será considerada como ativa se houver funcionários cujo cargo esteja vinculado a um grupo (verificação do campo Q3_GRUPO) sendo pelo menos um funcionário ativo conforme regra explicada acima (verificação dos campos RA_CARGO, RA_SITFOLH e RA_DEMISSA);
- Grupos de cargo: um grupo será considerado como ativo se houver cargos com vínculo ao grupo (verificação do campo Q3_GRUPO) e cujo cargo esteja vinculado a pelo menos um funcionário ativo conforme regra explicada acima (verificação dos campos RA_CARGO, RA_SITFOLH e RA_DEMISSA);
- Cargos: um cargo será considerado ativo se houver grupo preenchido e se houver pelo menos um funcionário ativo vinculado conforme regra explicada acima (verificação dos campos RA_CARGO, RA_SITFOLH e RA_DEMISSA);
- Departamentos: um departamento será considerado ativo se houver pelo menos um funcionário ativo vinculado conforme regra explicada acima (verificação dos campos RA_DEPTO, RA_SITFOLH e RA_DEMISSA);
- Funcionários: um funcionário será considerado ativo se possuir cargo com grupo de cargo preenchido, departamento preenchido e CPF preenchido, além da regra da situação de folha explicado acima.
Ao definir que irá aguardar o retorno do processamento da integração pelo P&M, a rotina irá consumir uma API do P&M para verificar o status do processamento do lote, e assim que processado, irá exibir o status das integrações no log. Atente-se que a rotina irá tentar obter o status da integração até o tempo máximo estipulado; atingindo o tempo limite, a rotina irá ser encerrada exibindo o log dos status obtidos até o momento. Havendo erro no processamento do P&M, no log de ocorrências será exibido o ID do registro enviado ao P&M, contendo o código da validação e sua respectiva mensagem, conforme lista detalhada na documentação: https://tdn.totvs.com/pages/viewpage.action?pageId=676047532. Todas as validações e mensagens são geradas pelo P&M, sendo de responsabilidade do usuário analisar a mensagem da validação e, se necessário, tomar ação para reenviar o registro novamente.
Observe que na possibilidade do P&M demorar para processar a integração, a rotina irá ficar "presa" até que toda a integração enviada seja processada pelo P&M ou até o tempo limite ser atingido.
...
| id | wizard3 |
|---|---|
| label | 3-Opções |
| title | Opções |
Essa tela exibe a lista de opções existentes para integração com o P&M do tipo checkbox e deve ser selecionada as opções que serão integradas.
...
| id | wizard4 |
|---|---|
| label | 4-Filtro |
| title | Filtro |
Essa tela exibe botões para a definição de filtros para a integração, separados pelos registros que podem ser integrados, ou seja, há um botão de filtro para filiais, outro botão para grupos de cargo, etc..
O botão de filtro de filiais sempre será exibido, independente se a opção de integração de filiais esteja ou não selecionada, pois o filtro de filial será utilizado para efetuar o filtro na integração de todas as opções. Já os outros botões serão desativados para clique caso a respectiva opção de integração não esteja selecionada.
No filtro de filial, será exibido uma MarkBrowse para seleção de filiais, enquanto que nos demais filtros será possível definir um filtro sobre qualquer campo da respectiva tabela, conforme necessidade.
|
Considerações importantes:
- A integração com o P&M é do tipo assíncrona, isto é, o P&M fará o processamento das informações enviadas conforme a fila de processamento.
- A integração somente envia informações da tabela do grupo de empresas em que o usuário está logado.
- O P&M exige que algumas informações sejam obrigatoriamente enviadas. Por esse motivo, para ser possível realizar a integração com o P&M, é necessário que o cadastro grupos de cargo tenha sido realizado através da rotina TRMA030, uma vez que essa informação é obrigatória para o P&M. Algumas outras informações também serão obrigatórias:
- Um cargo somente será enviado se for preenchido o grupo no campo Q3_GRUPO e que esse grupo seja válido na tabela SQ0;
- Um funcionário somente será enviado se for preenchido o CPF no campo RA_CIC, e-mail no campo RA_EMAIL, se houver departamento preenchido no campo RA_DEPTO e que esse departamento seja válido na tabela SQB, se houver cargo preenchido no campo RA_CARGO e que esse cargo seja válido na tabela SQ3 e que o cargo tenha um grupo preenchido no campo Q3_GRUPO e que esse grupo seja válido na tabela SQ0 e que o funcionário tenha um relacionamento com participante na tabela RDZ.
- O P&M não permite que determinado cadastro tenha a mesma descrição de outro enviado anteriormente, mesmo possuindo códigos diferentes. Dessa forma, se os cadastros de grupos de cargo, cargos ou departamentos serem de modo exclusivo, será necessário realizar um cadastro de De x Para através das rotinas GPEA944A, GPEA944B ou GPEA944C.
- Apenas o envio de funcionários irá validar a restrição de acesso por filiais.
- Atente-se que o sistema não fará controle se determinado registro foi ou não integrado com sucesso ao P&M. Havendo necessidade de reenvio de informações para o P&M por qualquer motivo, será efetuado envio dos registros de acordo com os filtros criados pelo usuário na rotina de integração, sendo possível reenviar todos os registros novamente ou apenas um ou alguns registros em específico.
- Em caso do processamento das informações pelo P&M retornar erros de validação, atente-se que as mensagens apresentadas na integração são as retornadas pelo P&M. Para mais detalhes sobre os motivos de apresentação dos erros, deve-se consultar a documentação do P&M no link: https://tdn.totvs.com/pages/viewpage.action?pageId=676047532.
- As rotinas mencionadas devem ser incluídas manualmente no menu.
| Nota | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
As informações enviadas para o P&M são geradas conforme o detalhamento abaixo:
As opções de integração irão consumir as seguintes APIs do P&M:
Após a geração e envio de um lote de registros para o P&M, será retornado para o Protheus um UUIID de identificação do lote de processamento e esse ID será salvo na tabela REF conforme exemplo abaixo:
|
...
| id | wizard5 |
|---|---|
| label | 5-Processamento |
| title | Processamento |
Essa tela exibe um descritivo e um botão, que ao ser clicado iniciará a integração com o Performance & Metas.
...
| title | Observação técnica |
|---|
As informações enviadas para o P&M são geradas conforme detalhamento abaixo:
...
| startHidden | false |
|---|---|
| id | jsons |
| Card | ||||||||
|---|---|---|---|---|---|---|---|---|
| ||||||||
"integrationId": M0_CODIGO+M0_CODFIL, "name": M0_FILIAL |
| Card | ||||||
|---|---|---|---|---|---|---|
| ||||||
"integrationId": M0_CODIGO+Q0_FILIAL+Q0_GRUPO, "name": Q0_DESCRI |
| Card | ||||||
|---|---|---|---|---|---|---|
| ||||||
"integrationId": M0_CODIGO+Q3_FILIAL+Q3_CARGO, "name": Q3_DESCSUM, "positionGroupIntegrationId": M0_CODIGO+Q0_FILIAL+Q0_GRUPO; |
| Card | ||||||
|---|---|---|---|---|---|---|
| ||||||
"integrationId": M0_CODIGO+QB_FILIAL+QB_DEPTO, "name": QB_DESCRIC; |
...
| id | funcionarios |
|---|---|
| label | Funcionários |
| title | Funcionários |
"integrationId": M0_CODIGO+RDZ_CODRD0,
"name": RA_NOMECMP ou RA_NOME,
"socialName": RA_NSOCIAL,
"email": RA_EMAIL,
"admissionDate", RA_ADMISSA,
"lastRaiseDate": R3_DATA,
"birthDate": RA_NASC,
"departmentIntegrationId": M0_CODIGO+QB_FILIAL+QB_DEPTO,
"positionIntegrationId": M0_CODIGO+Q3_FILIAL+Q3_CARGO,
"facilityIntegrationId": M0_CODIGO+RA_FILIAL,
Após a geração e envio de um lote de registros para o P&M, será retornado para o Protheus um UUIID de identificação do lote de processamento e esse ID será salvo na tabela REF conforme exemplo abaixo:
...
Sempre em branco
...
Process ID do lote retornado pelo P&M
...
Tipo da API:
1=Filiais
2=Grupos de cargo
3=Cargos
4=Departamentos
5=Funcionários
...
Data da integração
...
Hora da integração
...
Status da integração:
0=Não iniciado
1=Executando
2=Concluído
3=Houve erro de validação
X=Não encontrado
...
JSON do lote
...
- A informação do ID será utilizada posteriormente para consultar o status de processamento do lote no P&M.
- Atente-se que o sistema Protheus não fará controle se determinado registro foi ou não integrado com sucesso ao P&M. Havendo necessidade de reenvio de informações para o P&M, será efetuado envio dos registros de acordo com os filtros criados pelo usuário na rotina de integração, sendo possível reenviar todos os registros novamente ou apenas um ou alguns registros em específico.
- A integração somente envia informações da tabela do grupo de empresas em que está logado.
- Não há controle de restrição de acesso por filiais.
A rotina GPEM939B é do tipo MarkBrowse e irá exibir os registros da tabela REF:
Ao efetuar um duplo clique no registro ou ao clicar na coluna de cabeçalho, os registros com o campo REF_STATUS com 0 ou 1 serão selecionados. Ao clicar no botão "Consultar Status", será efetuado consulta do status no P&M, e ao fim será retornado um log de ocorrências com os status dos lotes, bem como eventuais erros de validação retornados pelo P&M.
Ao posicionar em um registro e clicar no botão "Visualizar" será aberto as informações detalhadas do lote. Caso o status seja 3, será exibido em "Outras Ações" o botão Consultar Inconsistências para que seja gerado um log com os erros retornados pelo P&M em um formato mais amigável.
...
04. DEMAIS INFORMAÇÕES
Atualizador de dicionário e base de dados - UPDDISTR.
...
Schedule - Como agendar a execução de rotinas.
Premissas para Integração P&M.
Integração com o P&M (Performance & Metas).
05. ASSUNTOS RELACIONADOS
...
Visão Geral
Import HTML Content
Conteúdo das Ferramentas
Tarefas