INTEGRAÇÃO GPEEsocialMonitorHomeCards - Consulta das informações dos Cards dos Eventos no Monitor

Contexto de negócio (Introdução)

Cada vez mais o mercado exige que as operações complexas e manipulação de dados sejam ainda mais ágeis e intuitivas. Neste contexto, surgiu a necessidade da criação de uma interface que possibilite automatizar o envio dos dados das empresas para o governo,de forma rápida, clara e sem que o cliente necessite adquirir um módulo adicional do sistema. Desta forma, o desenvolvimento de um Monitor de Eventos foi necessário para a entrega das obrigações fiscais das empresas para o governo, de modo que as informações que trafegam nele possam ser enviadas em lotes de eventos e depois consultados através de relatórios específicos para cada tipo de serviço.

A utilização do Middleware, como interface de comunicação, possibilitou maior segurança e velocidade de acesso às informações, já que se utilizam de APIs REST na troca de dados. O novo visual do Monitor THF também foi outro passo importante na questão da usabilidade do cliente, que passou a realizar o envio dos eventos fiscais com um número menor de passos e de forma mais intuitiva.

De modo geral, o eSocial do futuro simplifica os processos de seus clientes, em relação ao cumprimento de suas obrigações fiscais, o tornando mais seguro, simples e rápido.

Maiores informações podem ser acessadas em: https://tdn.totvs.com/x/oaT9Hw.

Sistemas Envolvidos

• Protheus - SIGAGPE (Gestão de Pessoal): Módulo responsável pela gestão dos dados dos funcionários, folha de pagamento e dentre outros cadastros pertinentes aos colaboradores.

Integração

O objetivo desta integração é permitir que o Monitor THF, consiga exibir os totais dos registros dos eventos selecionados pelo usuário nos Cards do Monitor.

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

• Premissas e Propriedades
  • O requerente da API será responsável pela requisição e transformação da informação recebida;
  • 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 ela solicita;
  • Cabe a integração informar se existem mais páginas a serem solicitadas.

Escopo

Por intermédio desta integração será disponibilizada a seguinte funcionalidade:

• Consulta dos registros para exibição dos cards;

Fora do escopo

• Automatização de Cadastramento dos Registros dos Eventos.
• O serviço de disponibilização de dados dos registros dos eventos apenas retorna os dados solicitados, não cabendo à API tratar a informação depois de ser entregue ao solicitante;

Pré-requisitos instalação/implantação/utilização

• Versões mínima do Protheus: 12.1.25;
• Possuir acesso à Internet, caso o sistema que venha a utilizar a integração com a aplicação Protheus que faça uso da mesma;
• Estrutura de rede estável, para que haja trafego de dados sem interrupção;
• Protheus devidamente configurado e serviço Rest habilitado em seu server;
• Binário Lobo Guará;
• Configuração dos parâmetros utilizados pelo Monitor THF, disponíveis nas documentações: https://tdn.totvs.com/x/dau2Hg e https://tdn.totvs.com/x/TIp-Hw.

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

Para utilizar a integração será necessário realizar a devida configuração do Webservice Rest no Protheus, com o 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 Gestão de Pessoal com seu cadastro de Grupo de Empresas, Empresas, Unidades de Negócio e Filiais devidamente cadastrados.

Controle de Versão

O grupo TOTVS, representado por suas marcas, irá administrar as demandas de evolução dos leiautes 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 áreas antes do início do desenvolvimento e somente serão desenvolvidas em caso de concordância das áreas e alinhamento com as diretivas definidas pelo contrato de Integração.

Suporte

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

Fluxo das Informações

Esta integração traz a funcionalidade exclusivamente de consulta dos registros para exibição nos cards do Monitor.

Cadastro

Esta integração contempla apenas a consulta dos registros para exibição nos cards dos eventos no Monitor.

Processos

O Monitor THF, realizará o consumo da API com dados básicos que serão utilizados como parâmetros para consultar a base de registros e retornar um conjunto de informações para o requisitante.

Limitações / Restrições Gerais

• A integração não contemplará inclusão, alteração ou exclusão de registros no Protheus, para isso o usuário deverá acessar o ERP e efetuar as devidas ações manualmente.

Como realizar a chamada da API REST

Para realizar a integração é necessário passar informações básicas de consulta para retorno das filiais, são elas:

• Preenchimento do EndPoint da API GPEEsocialMonitorHomeCards;
• Utilizar a chamada do método POST com o preenchimento dos parâmetros obrigatórios da API no body da requisição.

Formatos de Data

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

Parâmetros

Parâmetros e Chamada do Método:

Parâmetros e Chamada do Método:

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

Estrutura: { protocolo } : // { endereço servidor Rest } : { Porta Rest } / rest / api / rh / { versão } / GPEEsocialMonitorHomeCards /

Exemplo: http://localhost:8060/rest/api/rh/esocial/v1/GPEEsocialMonitorHomeCards/

Retorno da API:

{
    "eventCode": "S-2200",
    "total": 346,
    "eventDescription": "Cadastramento Inicial do Vínculo e Admissão/Ingresso de Trabalhador",
    "items": [
        {
            "status": [
                {
                    "title": "Rejeitado",
                    "type": "3",
                    "value": 3,
                    "warning": true
                },
                {
                    "title": "Sucesso",
                    "type": "4",
                    "value": 337,
                    "warning": false
                },
                {
                    "title": "Excluido",
                    "type": "-1",
                    "value": 1,
                    "warning": true
                },
                {
                    "title": "Excluido",
                    "type": "-1",
                    "value": 5,
                    "warning": false
                },
                {
                    "title": "Pendentes de envio",
                    "type": 1,
                    "value": 0,
                    "warning": false
                },
                {
                    "title": "Aguardando governo",
                    "type": 2,
                    "value": 0,
                    "warning": false
                }
            ]
        }
    ]
}

Informações das propriedades de retorno da API:

Nos retornos as informações são obtidas da tabela RJE.

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

{
    "errorCode": 400,
    "errorMessage": "O parâmetro 'branches' é obrigatório e não foi informado."
}

{
    "errorCode": 400,
    "errorMessage": "O parâmetro 'events' é obrigatório e não foi informado."
}

{
  "errorCode": 500,
    "errorMessage": "Ocorreu uma falha no retorno da informação. Falha ao Inicializar o Ambiente com os dados informados! Saída no final: O arquivo SX2TX0 não existe."
}

Checklist de suporte da aplicação

Itens a serem verificados durante o atendimento:

• Verificar se os pré-requisitos foram atendidos para a chamada da API;
• Verificar se na chamada da API o EndPoint, o nome do serviço e todos os campos obrigatórios foram informados;
• Verificar se o retorno da API apresenta algum erro tratado (códigos e mensagens de erro citados neste documento) e consultar a solução na mesma tabela que descreve o erro;
• Em caso de Erro não tratado, verificar se possui alguma informação de banco de dados, conexão com o servidor ou algo que possa identificar a origem do problema.

Anexos