INTEGRAÇÃO GPEA002API - Relação de Centros de Custos

Contexto de negócio (Introdução)

Relação de Funções - positions  - INTEGRAÇÃO GPEA030API

Sistemas Envolvidos

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

• Protheus (módulo  módulo de 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 colaboradoresdo funcionário.
• Quírons - NG

Integração

O objetivo desta integração é permitir que a área do RH ou área responsável pelos benefíciospelo cadastro de funções do funcionário, envie os dados do cadastro de centro de custo funções 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 ou empresa de benefícios, incluir inclui as informações dos centros de cadastros de custo  funções através de um arquivo (csv, txt) ou até mesmo manualmente, com . Com a interface de integração 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 Sistema 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.

• 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(CTTRJ_USERGAUSERLGI) ou alteração (CTTRJ_USERGAUSERLGA) 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 deverão ser serão enviados novamente. Caso seja  solicitado uma atualização, somente os dados com data igual ou posterior a data informada, serão transmitidos;
  • A data de alteração do registro deverá ser enviada em cada processo, permitindo que o solicitante possa controlar essa informação;
  • 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 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:

• 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 Gestão de Pessoal com os dados do cadastro de Centro de Custo funções devidamente inseridos.

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 centro de custofunções.

Cadastro

Esta integração contempla apenas a consulta e envio dos dados de cadastro de custofunções.

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 centro de custofunções.

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 do registro deverá ser enviada em cada processo, permitindo que o solicitante possa controlar essa informação;

Como realizar a chamada da API REST

Para realizar a integração com o parceiro TOTVS é necessário as informações básicas de consulta para retorno dos funcionários das funções desejados.

• Preenchimento do EndPoint da API GPEA002API GPEA030API;
• Utilizar a chamada do método Get e do Serviço payrollcustcenterpositions;
• 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:

Image RemovedImage Added

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/v1/payrollcustcenterpositions/

Response da API:

{
    "items": [
        {
            "codebranchId": "000000009D MG    ",
            "companyIdpositionCode": "T100001",
            "namecbo": "DEPARTAMENTO DE PESSOAL252210",
            "idcompanyId": "T1|D MG 01 |000000009",
            "name": "FUNCAO PADRAO",
            "branchid": "T1|D MG 01   |00001|"
        },
        {
            "codebranchId": "000000013D MG    ",
            "companyIdpositionCode": "T100002",
            "namecbo": "MEURH",
            "idcompanyId": "T1|D MG 01 |000000013",
            "name": "MENOR APRENDIZ",
            "branchid": "T1|D MG   01 |00002|"
        },
        {
            "codebranchId": "BOZOD MG    ",
            "companyIdpositionCode": "T100003",
            "namecbo": "CENTRO DE CUSTO DO BOZO456677",
            "idcompanyId": "T1|D MG 01 |BOZO",
            "name": "GPE002-FUNCAO",
            "branchid": "T1|D MG   01 |00003|"
        }
    ],
    "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

{
    "code": 400,
    "detailedMessage": "

Campo 

USERLGA 

não 

foi 

encontrado: 

Entidade (SRJ)",
    "helpUrl": "

https://tdn.totvs.com/x/

BJuMHw",
    "message": "Campo 

USERLGA não foi encontrado

: Entidade (SRJ)"
}

{
   "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"
}

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.