Processo de envio de dados para o sistema Quírons (carga de dados)

Sistemas Envolvidos

Descrição dos sistemas envolvidos no contexto de negócio (e que serão envolvidos na integração).

• Protheus (módulo de Ponto EletrônicoGestão de Pessoas): Módulo responsável pela gestão da assiduidade e marcações/apontamentos de horários de trabalho do funcionáriode pessoas, dependentes de funcionários, dentre outros cadastros pertinentes aos colaboradores.
• Quírons - NG

O objetivo desta integração deste processo é permitir que a área do RH ou área responsável pelas marcações/apontamentos de horário, pela Gestão de Pessoas envie os dados do cadastro de tipos de abono dos cadastros de Funcionários, Dependentes e Pessoas(Participantes) para o sistema da NG e assim reduzir o trabalho de inclusão manual de todas as informações dentro do sistema.

• Benefícios 
  • Normalmente o colaborador responsável inclui as informações de cadastros de tipos de abono dos cadastros acima através de um arquivo (csv, txt) ou até mesmo manualmente. Com a interface de integração este processo de geração de dados isso será feito de forma  automática.
  • Não terá um investimento alto de tempo para o cadastramento, pois os dados já serão enviados através da integração a cada requisição do sistema especialista.

• Arquitetura (Tecnologia)
  • Toda integração entre o Protheus e o Quírons é feita por intermédio de comunicação direta com os Web Services (que são fixos)  REST(Representation State Transfer) utilizando o formato JSON (JavaScript  Object Notation) de serialização de dados, onde através da ativação do serviço do REST do Protheus esteja disponível para utilizar o serviço.

Importante: Recomendamos como boa prática, que seja criado um serviço REST específico para esta integração (Protheus x Quiróns). 

• Premissas e Propriedades
  • Na geração o usuário deverá informar  através dos filtros do sistema quais entidades e quais registros deverão ser enviados;
  • Os dados a serem enviados serão gravados na entidade RJP e serão lidos pelo processo de envio de dados para o sistema NG;
  • Será gerado um LOG informado quais dados foram marcados para a exportação e o usuário poderá guardar esta informação para consulta futura.
  • Quando o dado for enviado para a integração, o campo RJP_DTIN será gravado com a data do envio
  Premissas e Propriedades
  • O parceiro que será responsável pela requisição e transformação da informação recebida;
  • Cada produto deverá gerar um LOG de inclusão(P6_USERLGI) ou alteração (P6_USERLGA) de registros a fim de controlar os dados a serem integrados;
  • Na requisição, o parceiro deverá informar  através do preenchimento do parâmetro datemodified e se desejar uma carga completa(deixar o parâmetro vazio) ou somente os dados que foram atualizados(Informando a data de alteração). Caso seja solicitada a carga, todos os dados serão enviados novamente. Caso seja  solicitado uma atualização, somente os dados com data igual ou posterior a data informada, serão transmitidos;
  • Será implementado um controle de paginação a fim de facilitar o envio da informação para o solicitante. Neste processo o solicitante deverá informar qual é o tamanho da informação solicitada e qual página ele solicita;
  • Cabe a integração informar se existem mais páginas a serem solicitadas;

Ativação/Desativação da integração

Por padrão esta integração estará em repositório, porém demanda realizar a devida configuração conforme abaixo:

• Para ativar a integração o parâmetro MV_RHNG deverá estar marcado como verdadeiro (.T.) 
• Para desativar a integração o parâmetro MV_RHNG deverá estar marcado como falso (.F.) Configuração de Webservice Rest no Protheus no formato apresentado na seguinte documentação (Exemplo de Configuração de Webservice REST)

Controle de Ambiente

Exige que os seguintes pontos sejam revisados:

• Protheus com sua arquitetura devidamente estruturada.Módulo Ponto Eletrônico com os dados do cadastro de Tipo de abono devidamente inseridos
• Processo de Schedule configurado com o serviço (GPEM923 -Serviço automático de envio de dados para integração com NG ).

Controle de Versão

O grupo TOTVS, representado por suas marcas, irá administrar as demandas de evolução dos layouts e demais ajustes, acordando junto aos solicitantes o prazo de liberação de release.

Todas as evoluções programadas deverão ser discutidas e aprovadas pelas marcas antes do início do desenvolvimento e somente serão desenvolvidas em caso de concordância das marcas e alinhamento com as diretivas definidas pelo Comitê de Integração TOTVS.

Suporte

O suporte aos recursos da Integração será de responsabilidade da linha Protheus, onde será analisada pela equipe de suporte da Totvs.

Fluxo das Informações

Esta integração traz a funcionalidade exclusivamente para exportação do cadastro de Tipos de Abonodos cadastros de funcionários, dependentes e pessoas.

Cadastro

Esta integração contempla apenas a consulta e envio dos dados de Tipos de Abonoenviará somente dados previamente existentes nos cadastros de funcionários, dependentes e pessoas.

Processos

A solicitante realizará o consumo da API com dados básicos que serão utilizados como parâmetros para consultar a base  e retornar um conjunto de informações pertinentes ao cadastro de Tipos de AbonoO sistema da NG disponibilizará uma integração para receber os dados da carga inicial e deverá confirmar o recebimento de cada registro exportado.

Limitações / Restrições Gerais

• A integração não contemplará inclusão,alteração e exclusão de registros no Protheus, para isso o usuário deverá acessar o ERP e efetuar as devidas ações manualmente.
• Cada produto deverá gerar um LOG de inclusão e alteração de registros a fim de controlar os dados a serem integrados;
• A data de alteração integração do registro deverá ser enviada em cada processo, permitindo que o solicitante possa controlar essa informaçãoProtheus possa marcar o registro como integrado;

Como realizar a

Carga de Dados integração

Para realizar

• Preenchimento do EndPoint da API PONA050API;
• Utilizar a chamada do método Get e do Serviço allowanceTypes;
• Preenchimento dos parâmetros obrigatórios da API;

Formatos de Data

As Entradas e Saídas de dados tipo data(Date) acompanham o formato padrão YYYY-MM-DDThh:mm

Parâmetros de Entrada:

Parâmetro

Valor de Exemplo

Obrigatório

Valor Default

Integer

Integer

2000

authorization

Security = 1 no arquivo appserver.ini

Image Removed

Parâmetros e Chamada do Método:

Para a realização de testes foi utilizado a ferramenta SOAP UI e após a configuração do server protheus a API Rest, a  requisição deverá ser semelhante a imagem abaixo:

{protocolo}://{host}/{api}/rh/v2/allowanceTypes/

Response da API:

{
    "items": [
        {
            "branchId": "D MG    ",
            "code": "009",
            "companyId": "T1",
            "name": "ABONO INTEGRAL",
            "id": "T1|D MG    |009|"
        },
        {
            "branchId": "D MG    ",
            "code": "107",
            "companyId": "T1",
            "name": "ABONO ATRASO",
            "id": "T1|D MG    |107|"
        },
        {
            "branchId": "D MG    ",
            "code": "114",
            "companyId": "T1",
            "name": "ABONO FALTAS",
            "id": "T1|D MG    |114|"
        },
        {
            "branchId": "D MG    ",
            "code": "115",
            "companyId": "T1",
            "name": "ABONO 1/2 FALTA",
            "id": "T1|D MG    |115|"
        }
    ],
    "hasNext": false
}

Situações de Erros Tratados

O envio de dados inesperados nos parâmetros de entrada da API REST pode ocasionar alguns erros. Desta forma, foram criados alguns tratamentos de erros listados abaixo, cada um com sua respectiva mensagem e solução.

Tratamento de erros de integração Protheus:

Mensagens de Pré-Validação

Erro

Mensagem

Solução

400

Campo P6_USERLGI / P6_USERLGA não foi encontrado.

{
    "code": 400,
    "detailedMessage": "Campo USERLGA não foi encontrado: Entidade (SP6)",
    "helpUrl": "https://tdn.totvs.com/x/BJuMHw",
    "message": "Campo USERLGA não foi encontrado: Entidade (SP6)"
}

A Filial é um parâmetro obrigatório.

{
   "code": 400,
   "detailedMessage": "Falha ao validar as informações básicas da assinatura. Informação: branchId",
   "helpUrl": "https://tdn.totvs.com/x/BJuMHw",
   "message": "Falha ao validar as informações básicas da assinatura. Informação: branchId"
}

{
   "code": 400,
   "detailedMessage": "Falha ao validar as informações básicas da assinatura. Informação: companyId",
   "helpUrl": "https://tdn.totvs.com/x/BJuMHw",
   "message": "Falha ao validar as informações básicas da assinatura. Informação: companyId"
}

 a carga de dados para o sistema parceiro TOTVS será necessário configurar os seguintes processos:

• Habilitar a integração;

• Habilitar o serviço de integração;

• Selecionar os registros que deverão ser enviados;

Habilitar a integração

(Acesse a documentação aqui)

Image AddedImage Added

Criação de usuário e senha para integração.

O usuário, senha e e-mail utilizados na integração são armazenados nos seguintes parâmetros. 

Para a definição de usuário, senha e e-mail é necessário acessar a rotina Parâmetros NG (GPEM926) e preencher parâmetros de acordo com a definição para a integração. 

Image Added

Para mais informações acesse, nossas documentações complementares:

* Criação de parâmetros Quiróns

(Acesse a documentação aqui)

Image Added

Habilitar o serviço de integração

Selecionar os registros que serão enviados na carga inicial

Image Added

Parâmetros de Entrada:

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é:?

Final da relação de matrículas de funcionários ou dependentes.

Cadastro de Pessoas

Informa que será enviado na carga inicial a relação de funcionários.

Participante De:?

Início da relação de códigos de participantes.

Participante Até:?

Final da relação de códigos de participantes.

Log de Processamento

Informa se deseja gerar um relatório com o LOG da carga de dados.

Tela de confirmação do processamento da carga inicial:

Image Added

Tela demonstrando que não foram encontrados dados para exportação com o filtro informado:

Image Added

Tela demonstrando a quantidade de registros de cada entidade que foram marcados para exportação:

Image Added

Tela demonstrando a forma de impressão do LOG:

Image Added

Impressão do relatório demonstrando que os registros foram marcados para exportação:

Image Added

IMPORTANTE

Caso as entidades funcionários, dependentes e pessoas tiverem compartilhamentos diferentes, será necessário realizar a exportação de cada uma de forma separada

Itens a serem verificados durante o atendimento:

.