01. DADOS GERAIS

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

DRHCALCPRT-4380

DRHCALCPRT-4375

DRHCALCPRT-4452

DRHCALCPRT-4374

DRHCALCPRT-4504


02. SITUAÇÃO/REQUISITO

Criar uma rotina que fará a integração dos cadastros do Protheus com o P&M (Performance & Metas).

Criar uma rotina que possibilite consultar as informações dos lotes de integrações com o P&M (Performance & Metas).

03. SOLUÇÃO

A funcionalidade abaixo está em desenvolvimento.


Foi efetuado a criação da rotina GPEM939 para efetuar a integração com o P&M (Performance & Metas) dos itens abaixo:


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.


A melhoria depende da aplicação da atualização liberada no pacote de expedição do módulo RH a partir de [EM CONSTRUÇÃO, SEM DATA] 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 de índices no dicionário SIX, conforme estrutura abaixo:

INDICEORDEMCHAVESHOWPES
REF1REF_FILIAL+REF_TIPO+REF_STATUS+DTOS(REF_DATINT)+REF_HORINT       S
REF2REF_FILIAL+REF_PRCIDN
REF3REF_FILIAL+DTOS(REF_DATINT)+REF_HORINT       S
REN1REN_FILIAL+REN_TIPO+REN_CODIGOS
RET1RET_FILIAL+RET_TIPO+RET_CODIGOS
RET2RET_FILIAL+RET_TIPO+RET_FILCAD+RET_CODCAD S


Foi efetuado a criação de tabelas no dicionário SX2, conforme estrutura abaixo:

X2_CHAVEX2_NOMEX2_MODOX2_MODOUNX2_MODOEMP
REFLote de integração P&MCCC
RENCadastros P&MCCC
RETVínculos Cadastros P&MCCC

O modo de acesso das tabelas REF, REN e RET devem ser obrigatoriamente compartilhado.


Foi efetuado a criação de campos na tabela REF, conforme estrutura abaixo:

X3_ARQUIVOX3_ORDEMX3_CAMPOX3_TIPOX3_TAMANHOX3_TITULOX3_DESCRICHELP
REF01REF_FILIALC2FilialFilial

Filial do lote

REF02REF_PRCIDC100Process IDProcess ID

Process ID do lote retornado pelo P&M

REF03REF_TIPOC1Tipo APITipo API

Tipo da API

REF04REF_DATINTD8Data Integr.Data Integr.

Data da integração

REF05REF_HORINTC8Hora Integr.Hora Integr.

Hora da integração

REF06REF_STATUSC1StatusStatus Integração

Status da integração

REF07REF_LOTEM10LoteLote Integração

JSON do lote integrado

REF08REF_RETORNM10RetornoRetorno P&M

Retorno do lote pelo P&M

REF09REF_USERC6UsuárioUsuário

Usuário responsável pela geração do lote

REF10REF_OKC2Selecionado?Selecionado?

Evento selecionado para consulta?

REN01REN_FILIALC2FilialFilialFilial do registro
REN02REN_TIPO  C1TipoTipoTipo do cadastro para o P&M
REN03REN_CODIGOC20CódigoCódigoCódigo do cadastro no P&M
REN04REN_DESC  C100DescriçãoDescriçãoDescrição do cadastro no P&M
RET01RET_FILIALC2FilialFilialFilial do registro
RET02RET_TIPO  C1TipoTipoTipo do cadastro para o P&M
RET03RET_CODIGOC20CódigoCódigoCódigo do cadastro no P&M
RET04RET_FILCADC2Fil. CadFilial CadastroFilial do cadastro
RET05RET_CODCADC20Cód. Cadast.Código CadastroCódigo do cadastro


Foi efetuado a criação de parâmetros no dicionário SX6, conforme estrutura abaixo:

X6_VARX6_TIPOX6_DESCRICX6_DESC1Exemplo de preenchimentoObservação
MV_APIPEM0CURL para geração do token de acesso do ambientede integração com o Performance & Metas

https://{TENANT}.rac.{ENVIRONMENT}.totvs.app/totvs.rac/connect/token

Exemplo: https://admin.rac.totvs.app/totvs.rac/connect/token


MV_APIPEM1CURL base do ambiente de integração com oPerformance & Metas

https://{NOME_EMPRESA}.performance.totvs.app/integration-general/

Exemplo: https://empresateste.performance.dev.totvs.app/integration-general/


MV_APIPEM2CClientId do ambiente de integração com oPerformance & Metas

MV_APIPEM3CSecretId do ambiente de integração com oPerformance & Metas

MV_APIPEM4NTipo de verificação de registro ativo naintegração com o Performance & Metas
Não precisa ser configurada no módulo SIGACFG. 
Será exibida para o usuário na rotina de integração.
MV_APIPEM5DData de corte da integração com oPerformance & Metas
Não precisa ser configurada no módulo SIGACFG. 
Será exibida para o usuário na rotina de integração.
MV_APIPEM6NDefine se espera ou não o retorno da integraçãocom o Performance & Metas
Não precisa ser configurada no módulo SIGACFG. 
Será exibida para o usuário na rotina de integração.
MV_APIPEM7NDefine o tempo máximo em minutos de espera paraobter o retorno do Performance & Metas
Não precisa ser configurada no módulo SIGACFG. 
Será exibida para o usuário na rotina de integração.

Os parâmetros MV_APIPEM0 e MV_APIPEM1 precisam ser configurados conforme o formato de exemplo da tabela acima.


Foi efetuado a criação de relacionamentos no dicionário SX9, conforme estrutura abaixo:

X9_DOMX9_IDENTX9_CDOMX9_EXPDOMX9_EXPCDOMX9_LIGDOMX9_LIGCDOMX9_CONDSQLX9_USEFIL
REN001RETREN_TIPO+REN_CODIGORET_TIPO+RET_CODIGO1N
S
SQ0001RETQ0_FILIAL+Q0_GRUPORET_FILCAD+RET_CODCAD1N#RET_TIPO  ='1'N
SQ3001RETQ3_FILIAL+Q3_CARGORET_FILCAD+RET_CODCAD1N#RET_TIPO  ='2'N
SQB001RETQB_FILIAL+QB_DEPTORET_FILCAD+RET_CODCAD1N#RET_TIPO  ='3'N
  • 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 abaixo devem ser incluídas manualmente no menu.


A rotina GPEM939 é do tipo Wizard e possui cinco passos:

Essa tela exibe um breve descritivo da rotina e contém um botão que direciona para esta documentação do TDN.


Essa tela exibe quatro perguntas para a configuração da integração:



  1. "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 que não sejam demitidos ou que foram demitidos com data de demissão superior à data de corte informada na pergunta abaixo;
  2. "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.
  3. "Verificação retorno P&M:": define se a rotina irá aguardar o retorno do processamento da integração pelo P&M ou não.
  4. "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.


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.

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.

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. 



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.

Essa tela exibe um descritivo e um botão, que ao ser clicado iniciará a integração com o Performance & Metas.




As informações enviadas para o P&M são geradas conforme detalhamento abaixo:

"integrationId": M0_CODIGO+M0_CODFIL,

"name": M0_FILIAL

"integrationId": M0_CODIGO+Q0_FILIAL+Q0_GRUPO,

"name": Q0_DESCRI

"integrationId": M0_CODIGO+Q3_FILIAL+Q3_CARGO,

"name": Q3_DESCSUM,

"positionGroupIntegrationId": M0_CODIGO+Q0_FILIAL+Q0_GRUPO;

"integrationId": M0_CODIGO+QB_FILIAL+QB_DEPTO,

"name": QB_DESCRIC;

"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:

CampoConteúdo
REF_FILIAL

Sempre em branco

REF_PRCID

Process ID do lote retornado pelo P&M

REF_TIPO

Tipo da API:

1=Filiais

2=Grupos de cargo

3=Cargos

4=Departamentos

5=Funcionários

REF_DATINT

Data da integração

REF_HORINT

Hora da integração

REF_STATUS

Status da integração:

0=Não iniciado

1=Executando

2=Concluído

3=Houve erro de validação

X=Não encontrado

REF_LOTE

JSON do lote

REF_RETORNRetorno do processamento realizado pelo P&M
REF_USERCódigo do usuário responsável pela integração



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. Ao clicar no botão "Consultar Inconsistências", será gerado um log com os erros retornados pelo P&M em um formato mais amigável caso o status do lote seja igual a 3.



A rotina GPEM939C pode ser cadastrada no Schedule do módulo SIGACFG - Configurador para efetuar a consulta automática de todos os lotes que ainda não tiveram o status retornado pelo P&M, conforme exemplo abaixo:

Exemplo de retorno gerado no console do appserver:


04. DEMAIS INFORMAÇÕES

Atualizador de dicionário e base de dados - UPDDISTR.

Incluindo Campos Reservados (CFGX034 - SIGACFG).

Integração de cadastros básicos de pessoas.

Schedule - Como agendar a execução de rotinas.


05. ASSUNTOS RELACIONADOS

DT Integração com P&M (Performance & Metas) - Fase 2.




<style>
div.theme-default .ia-splitter #main {
    margin-left: 0px;
}
.ia-fixed-sidebar, .ia-splitter-left {
    display: none;
}
#main {
    padding-left: 10px;
    padding-right: 10px;
    overflow-x: hidden;
}

.aui-header-primary .aui-nav,  .aui-page-panel {
    margin-left: 0px !important;
}
.aui-header-primary .aui-nav {
    margin-left: 0px !important;
}

.aui-tabs.horizontal-tabs>.tabs-menu>.menu-item.active-tab a::after { 
	background: #FF9900; !important 
}

.menu-item.active-tab { 
	border-bottom: none !important; 
}

</style>