...
O Quírons é uma solução SaaS voltada para SST (Saúde e Segurança do Trabalho) desenvolvida pela NG Informática, para maiores informações consulte a documentação no link https://quirons.com.br/.
03.
...
COMUNICAÇÃO DO QUÍRONS COM AS APIS DO PROTHEUS
Toda comunicação entre os sistemas acontece através das APIs REST.
Para que o Quirons Quírons se comunique com as APIs do Protheus primeiro realize a configuração prévia do Quírons.
Feita essa configuração, habilite o REST do Protheus será necessária uma configuração prévia.
<link>
04. PARAMETRIZAÇÃO PROTHEUS
e já será possível carregar algumas informações como o cadastro de Funções, Turnos de trabalho, Centro de Custo e etc.
Informações |
---|
|
Os campos _USERLGI e _USERLGA são utilizados para controlar quando um registro foi incluído ou alterado. Caso se depare com uma mensagem informando que o campo USERLGI ou USERLGA não foi encontrado, será necessário habilitá-los no módulo configurador. Como habilitar os campos USERLGI / USERLGA Cloak |
---|
| Acesse SIGACFG / Base de Dados / Base de Dados / Dicionário de Dados Encontre a tabela desejada:
Clique para editar a tabela e habilite os campos reservados: Log de Inclusão e Log de Alteração.
Agora salve para efetivar a alteração do dicionário(nesse passo será necessário acesso exclusivo ao sistema).
|
|
04. COMUNICAÇÃO DO PROTHEUS COM AS APIS DO QUÍRONS
O Protheus também se comunica O Protheus recebe e disponibiliza dados a partir de suas APIs como também envia dados utilizando as APIs do Quírons.
Para que a comunicação aconteça os seguintes passos serão necessários:
A cada alteração de Funcionários, Dependentes, Cargos, por exemplo, será gravado um registro na tabela RJP que indicará que aquele cadastro deve ser enviado.
Para que as alterações feitas no Protheus sejam refletidas no Quírons, o cliente deve fazer as seguintes as seguintes configurações:
...
Deck of Cards |
---|
startHidden | false |
---|
history | false |
---|
id | ids |
---|
|
Card |
---|
default | true |
---|
id | id1 |
---|
label | 1. Parâmetro MV_RHNG |
---|
title | 1. Parâmetro MV_RHNG |
---|
| Acessar o módulo configurador e preencher o PARÂMETRO MV_RHNG |
|
com .T. Image Modified Image Modified
|
|
...
2. Carga Inicial
A Carga Inicial(GPEM925) deverá ser utilizada para integrar cadastros (como funcionários, dependentes, cargos e etc) incluídos antes da ativação do parâmetro MV_RHNG.
<Incluir telas >
...
A partir desse momento, a cada inclusão ou alteração os dados serão gravados na tabela RJP e |
|
|
...
podem ser visualizados no Monitor Integração NG(GPEM924). |
|
Card |
---|
default | true |
---|
id | id2 |
---|
label | 2. Monitor Integração NG |
---|
title | 2. Monitor Integração NG (GPEM924) |
---|
| Acesse o Monitor Integração NG (GPEM924) para visualizar os histórico de registros que já foram integrados ou estão pendentes de integração. Image Added
Opções disponíveis: Visualizar um registro no detalhe: Excluir da fila de integração: Forçar o reenvio de um registro já integrado: |
Card |
---|
id | id3 |
---|
label | 3. Autenticação dos webservices NG |
---|
title | 3. Autenticação dos webservices NG GPEM926 |
---|
| Parâmetros NG (GPEM926). Utilize essa rotina para configurar a autenticação com as APIs do Quírons. Primeiro informe a URL base das APIs do Quírons e em seguida informe o usuário e senha do usuário do Quírons que será utilizado nas integrações.
Image Added
* Importante se certificar que o servidor onde o Protheus está instalado possui acesso à URI cadastrada aqui. Em ambientes cloud, por uma questão de segurança, endereços externos costumam ser bloqueados por padrão.
** Caso tenha dúvidas sobre ou onde obter as informações acima, entre em contato com o suporte da NG. |
Card |
---|
id | id4 |
---|
label | 4. Habilitar o Job de Integração |
---|
title | 4. Habilitar o Job de Integração |
---|
|
|
JOB de Integração (GPEM923). Essa rotina que deve ser cadastrada no SCHEDULE será responsável por verificar as alterações pendentes na tabela RJP e fazer o envio para o Quírons. Image Modified
|
|
integração com o Quírons utilizará as seguintes mensagens :
...
05. ADAPTER
O cadastro de adapter são rotinas responsáveis por realizar o processamento das mensagens enviadas e recebidas, possibilitando a inclusão, alteração e exclusão.
Para realizar o cadastro/configuração do adapter, antes é necessário ter uma ROTA cadastrada (Item 03). Após ter realizado o cadastro da rota, navegar no menu em Ambiente > Schedule > Adapter EAI (CFGA020).
Exemplo:
Image Removed
Image Removed
Aviso |
---|
Obs.: Em todos adapters, no grid Roteamento de mensagens (para Mensagem Única com canal de envio EAI), selecionar a rota cadastrada conforme item 03 deste documento. |
Image Removed
Deck of Cards |
---|
|
Card |
---|
id | 1 |
---|
label | ITEM |
---|
effectType | fade |
---|
| - Mensagem Única (XX4_UNMESS): 1-Sim
- Rotina (XX4_ROTINA): MATA010
- Mensagem (XX4_MODEL): ITEM
- Descrição (XX4_DESCRI): PRODUTO
- Envia (XX4_SENDER): Sim (Envia mensagem JSON para Quírons)
- Recebe (XX4_RECEIV): Sim (Recebe mensagem JSON do Quírons)
- Método (XX4_METHOD): Síncrono/Assíncrono
- Operação (XX4_TPOPER): 1-Todas
- Canal Envio (XX4_CHANEL): 3 - EAI - PAD.APP.
- Versão Envio (XX4_SNDVER): 4.005
- Formato (XX4_FORMAT): JSON
|
Card |
---|
id | 2 |
---|
label | UNITOFMEASURE |
---|
effectType | fade |
---|
| - Mensagem Única (XX4_UNMESS): 1-Sim
- Rotina (XX4_ROTINA): QIEA030
- Mensagem (XX4_MODEL): UNITOFMEASURE
- Descrição (XX4_DESCRI): UNIDADE DE MEDIDA
- Envia (XX4_SENDER): Sim (Envia mensagem JSON para Quírons)
- Recebe (XX4_RECEIV): Sim (Recebe mensagem JSON do Quírons)
- Método (XX4_METHOD): Síncrono/Assíncrono
- Operação (XX4_TPOPER): 1-Todas
- Canal Envio (XX4_CHANEL): 3 - EAI - PAD.APP.
- Versão Envio (XX4_SNDVER): 2.002
- Formato (XX4_FORMAT): JSON
|
Card |
---|
id | 3 |
---|
label | WAREHOUSE |
---|
effectType | fade |
---|
| - Mensagem Única (XX4_UNMESS): 1-Sim
- Rotina (XX4_ROTINA): AGRA045
- Mensagem (XX4_MODEL): WAREHOUSE
- Descrição (XX4_DESCRI): LOCAIS DE ESTOQUE
- Envia (XX4_SENDER): Sim (Envia mensagem JSON para Quírons)
- Recebe (XX4_RECEIV): Sim (Recebe mensagem JSON do Quírons)
- Método (XX4_METHOD): Síncrono/Assíncrono
- Operação (XX4_TPOPER): 1-Todas
- Canal Envio (XX4_CHANEL): 3 - EAI - PAD.APP.
- Versão Envio (XX4_SNDVER): 1.000
- Formato (XX4_FORMAT): JSON
|
Card |
---|
id | 4 |
---|
label | STOCKLEVEL |
---|
effectType | fade |
---|
| - Mensagem Única (XX4_UNMESS): 1-Sim
- Rotina (XX4_ROTINA): MATA225
- Mensagem (XX4_MODEL): STOCKLEVEL
- Descrição (XX4_DESCRI): SALDOS EM ESTOQUE
- Envia (XX4_SENDER): Sim (Envia mensagem JSON para Quírons)
- Recebe (XX4_RECEIV): Não (Não recebe mensagem JSON do Quírons)
- Método (XX4_METHOD): Síncrono/Assíncrono
- Operação (XX4_TPOPER): 1-Todas
- Canal Envio (XX4_CHANEL): 3 - EAI - PAD.APP.
- Versão Envio (XX4_SNDVER): 3.004
- Formato (XX4_FORMAT): JSON
|
Card |
---|
id | 5 |
---|
label | REQUEST |
---|
effectType | fade |
---|
| - Mensagem Única (XX4_UNMESS): 1-Sim
- Rotina (XX4_ROTINA): MATA105
- Mensagem (XX4_MODEL): REQUEST
- Descrição (XX4_DESCRI): SOLICITACAO AO ARMAZEM
- Envia (XX4_SENDER): Sim (Envia mensagem JSON para Quírons)
- Recebe (XX4_RECEIV): Sim (Recebe mensagem JSON do Quírons)
- Método (XX4_METHOD): Síncrono/Assíncrono
- Operação (XX4_TPOPER): 1-Todas
- Canal Envio (XX4_CHANEL): 3 - EAI - PAD.APP.
- Versão Envio (XX4_SNDVER): 1.009
- Formato (XX4_FORMAT): JSON
|
Card |
---|
id | 6 |
---|
label | STOCKTURNOVER |
---|
effectType | fade |
---|
| - Mensagem Única (XX4_UNMESS): 1-Sim
- Rotina (XX4_ROTINA): MATA241
- Mensagem (XX4_MODEL): STOCKTURNOVER
- Descrição (XX4_DESCRI): MOVIMENTACOES INTERNAS MULT.
- Envia (XX4_SENDER): Sim (Envia mensagem JSON para Quírons)
- Recebe (XX4_RECEIV): Sim (Recebe mensagem JSON do Quírons)
- Método (XX4_METHOD): Síncrono/Assíncrono
- Operação (XX4_TPOPER): 1-Todas
- Canal Envio (XX4_CHANEL): 3 - EAI - PAD.APP.
- Versão Envio (XX4_SNDVER): 1.000
- Formato (XX4_FORMAT): JSON
|
Card |
---|
id | 7 |
---|
label | SCHEDULE/AGENT |
---|
effectType | fade |
---|
| Para que o envio das mensagens assíncronas seja realizado, é necessário efetuar o cadastro das rotinas FWEAISEND/FWEAI, no Schedule Protheus. - FWEAISEND: Esta rotina é exclusiva para o envio das mensagens da fila do EAI. O agendamento desta rotina é realizado por Empresa cadastrada no sistema. No envio da mensagem, um canal de comunicação é aberto com o webservice do produto integrado, e esta comunicação é encerrada após o recebimento da mensagem de retorno (no caso das Mensagens Única TOTVS, após o recebimento da ReceiptMessage, indicando que que o processo ocorreu corretamente) ou por timeout (mensagem com status de falha).
- FWEAI: Esta rotina de envio e recebimento de mensagens do EAI Protheus. Quando agendada, esta rotina executa dois passos.
- Inicia o processamento das mensagens recebidas na fila do EAI Protheus.
- Inicia o envio das mensagens que estão na fila do EAI Protheus.
Antes de efetuar o cadastro das rotinas FWEAISEND/FWEAI, é necessário a inclusão dos Agent. - AGENT: Este é o componente que gerencia as execuções e distribui as tarefas para que as Executes configuradas que estão disponíveis no momento. Os Agents podem estar localizados em servidores diferentes, possibilitando o balanceamento da carga de execuções.
Inclusão das rotinas FWEAIRECE/FWEAISEND no agendamento - Navegar no menu em Ambiente > Schedule > Schedule (CFGA010).
- Na barra lateral, acessar Schedule > Agendamentos > Cadastro
- No grid Detalhes, clicar no primeiro ícone
Image Removed para inclusão.- Código: Valor sequencial que representa o identificador único desse agente no sistema. Ele é preenchido automaticamente;
Usuário: Usuário do Protheus que será utilizado para inicializar o processo; Nome do usuário: Nome do usuário no sistema. É preenchido à partir do Usuário selecionado no campo anterior; Rotina: FWEAI (Rotina envio e recebimento de mensagens do EAI Protheus) / FWEAISEND (Rotina recebimento de mensagens do EAI Protheus). Data: Qual a data da execução do agendamento. Hora: Qual a hora em que a função será executada.
Observe a opção “Recorrência” Image Removedna barra de opções permite que você especifique a execução em intervalos regulares (diariamente, mensalmente, anual, a cada X horas…) - Ambiente: Qual o ambiente que será inicializado na execução;
Empresa/Filial: Qual empresa e filial será aberta no momento da execução. Novamente, repare que esses campos não invalidam funcionalidades que abram e utilizem um ambiente diferente; Módulo: Qual o módulo do Protheus que será utilizado na execução do agendamento. Essa informação é importante pois interfere na forma como o Protheus irá consumir as licenças disponíveis para a execução do job; Nome do Módulo: O nome do módulo selecionado no campo anterior e é preenchido automaticamente; Habilitada: Flag que determina se a execução do agendamento está habilitada ou não; - Descrição: Descrição livre sobre o agendamento;
|
|
06. DE/PARA EMPRESAS
Em uma integração entre sistemas é comum os sistemas terem códigos diferentes, neste caso é muito importante ter um 'De/Para" (XXD), para que seja mapeado e retornado o valor interno de um determinado registro da tabela informada no cadastro de De/Para.
Para realizar cadastro, deve acessar o modulo SIGACFG, depois navegar no menu em Ambiente > Schedule > Emp.Filial Mensagem Única (APCFG050).
- Referência: QUIRONS (SEM ACENTO).
- Empresa : Código da Empresa Quírons a integrar.
- Filial: Código da Filial Quírons a integrar.
- Grupo Emp. Protheus: Código da Empresa no Protheus a integrar com o sistema Quírons.
- Fil. Protheus: Código da Filial no Protheus a integrar com o sistema Quírons.
Exemplo:
- Referência: QUIRONS
- Empresa : T1
- Filial: D MG 01
- Grupo Emp. Protheus: T1
- Fil. Protheus: D MG 01
Image Removed
07. OBSERVAÇÕES
Para realizar integração com o Quírons na Baixa da Requisição (MATA185), nos parâmetros (F12) a primeira pergunta deve estar conforme imagem abaixo.
Image Removed
08. ASSUNTOS RELACIONADOS
Informações |
---|
| O programa GPEM923 funciona apenas como JOB e não possui interface visual, por esse motivo não é necessário incluí-lo no menu. |
|
Card |
---|
id | id5 |
---|
label | 5. Histórico de Envio |
---|
title | 5. Histórico de Envio |
---|
| Histórico de Envio Para habilitar a gravação do Histórico do que é enviado para o Quírons será necessário configurar o parâmetro MV_HISTQUI com 1 ou 2.
Onde: 0 | Nunca grava histórico. | 1 | Grava histórico de erros apenas. | 2 | Sempre grava o histórico |
Desse momento em diante o histórico ficará gravado na tabela RU7 e poderá ser consultado em: Monitor Integração NG (GPEM924) / Outras Ações / Histórico Envio. Image Added
Caso tenha o interesse de apagar todo o Histórico ou apenas o histórico de determinado intervalo é possível fazê-lo através da opção: Monitor Integração NG (GPEM924) / Outras Ações / Limpar Histórico.
|
Card |
---|
id | id6 |
---|
label | 6. O que será integrado |
---|
title | 6. O que será integrado |
---|
| Apenas a nível de informação, finalizada a configuração o Protheus estará apto a enviar: Tabela | Descrição | Path Quírons |
---|
SQG | Cadastro de Candidatos | /ttalk/person | SRA | Funcionários | /ttalk/employee | SR7 | Histórico Funcional - Alterações Salariais | /ttalk/functionalHistory | SRB | Dependentes | /ttalk/dependant | SRE | Histórico Funcional - Transferências | /ttalk/functionalHistory | RA4 | Treinamentos | /ttalk/trainingHistory | SQB | Departamentos | /ttalk/department | SQ3 | Cargos | /ttalk/position |
|
|
05. CARGA INICIAL
A Carga Inicial deve ser utilizada para enviar, para a tabela RJP, informações criadas antes da ativação do parâmetro MV_RHNG.
Acessar a rotina disponível em: SIGAGPE / Atualizações / Integrações / Integração Ng / Carga Inicial (GPEM925)
Preencher as perguntas e clicar em OK:
Image Added
Parâmetros de entrada:
Cloak |
---|
|
Parâmetro | Valor de Exemplo | Obrigatório | Tipo | Parâmetro | Valor Default | Descrição | Filial De:? | D MG 01 | Não | String | query |
| Inicio da relação de filiais. | Filial Até:? | D MG 01 | Não | String | query |
| Final da relação de filiais. | Cadastro de Funcionários | Check | Não | Opção | query |
| Informa que será enviado na carga inicial a relação de funcionários. | Cadastro de Dependentes | Check | Não | Opção | query |
| Informa que será enviado na carga inicial a relação de funcionários. | Matrícula De:? | 000001 | Não | String | query |
| Início da relação de matrículas de funcionários ou dependentes. | Matrícula Até:? | 999999 | Não | String | query |
| Final da relação de matrículas de funcionários ou dependentes. | Cadastro de Candidatos | Check | Não | Opção | query |
| Informa que será enviado na carga inicial a relação de candidatos. | Candidato De:? | 000001 | Não | String | query |
| Início da relação de códigos de participantes. | Candidato Até:? | 999999 | Não | String | query |
| Final da relação de códigos de participantes. | Log de Processamento | Check | Não | Opção | query |
| Informa se deseja gerar um relatório com o LOG da carga de dados. |
|
Mais detalhes:
Cloak |
---|
|
Na primeira execução o processo pode ser um pouco demorado por isso será solicitada uma confirmação:
No final será possível visualizar o log dos registros gravados na tabela RJP:
No final será possível visualizar o log dos registros gravados na tabela RJP:
|
Informações |
---|
|
Para uma melhor experiência, sugerimos que o usuário esteja logado na mesma filial em que ele deseja realizar a operação nos cadastros cujo conteúdo será integrado com o Quírons e que a Carga Inicial seja realizada por Filial. Caso as tabelas de funcionários, dependentes e candidatos tiverem compartilhamentos diferentes, será necessário realizar a carga de cada uma de forma separada. |
06. DEMAIS INFORMAÇÕES
APIs dessa Integração disponíveis por padrão no REST Protheus:
Descrição | Path | Tabela | Métodos | Objetivo |
---|
Tipos de Abono | /allowanceTypes | SP6 | GET | Somente consulta |
Centro de Custo | /payrollCostCenter | CTT | GET | Somente consulta |
Turnos de Trabalho | /workingShift | SR6 | GET | Somente consulta |
Cadastro de Funções | /positions | SRJ | GET | Somente consulta |
Tipos de Afastamento/Ausência | /leaveOfAbsenceType | RCM | GET | Somente consulta |
Tipos de Estabilidade | /stabilityType | RCC | GET | Somente consulta |
Tipos de Treinamento | /classes | RA2 | GET | Somente consulta |
Adicionais de Periculosidade e Insalubridade | /additional | SRA | PUT | Alteração |
Estabilidade Funcional | /stabilitycontrol | RFX | POST, PUT, DELETE | Inclusão, Alteração, Exclusão |
Marcações de Ponto | /allowanceControl | RF0 | POST, PUT, DELETE | Inclusão, Alteração, Exclusão |
Necessidade de Treinamento | /trainingNecessity | RA2/RA3 | POST, PUT, DELETE | Inclusão, Alteração, Exclusão |
Afastamentos / Ausências | /leaveOfAbsenceControl | SR8 | POST, PUT, DELETE | Inclusão, Alteração, Exclusão |
Outros detalhes técnicos podem ser consultados na documentação:
DI Protheus X NG - Integração de Movimentos - Medicina e Segurança - RH.
07. ASSUNTOS RELACIONADOS
Configuração Integração Quírons e Totvs
Exemplo de configuração do REST#872616691
DI Protheus X NG - Integração de Movimentos - Medicina e Segurança - RH.
Alterar Parâmetros (CFGX017 - SIGACFG)
DT Gravação de histórico do Quirons - Tela de Monitoramento
DT Monitor de Processamento Quírons Novo
...