Páginas filhas
  • DI Protheus X eSocial do Futuro - Filiais

Versões comparadas

Chave

  • Esta linha foi adicionada.
  • Esta linha foi removida.
  • A formatação mudou.

INTEGRAÇÃO EsocialBranches - Consulta de Cadastro de Filiais

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 com custos reduzidos. Com o RH não é diferente, os processos cada vez mais complexos e com muitas inovações e prestadores de serviços no ramo de benefícios para administrar dentro do RH, empresas e  softwares especialistas na administração de benefícios estão cada vez mais presentes no mercado e foi neste contexto que surgiu a necessidade da criação de uma interface para que possibilite automatizar o envio dos dados que hoje são realizados manualmente do ERP para o softwares especialista, seja feito através de uma interface de integração.


Sistemas Envolvidos

  • Protheus (módulo 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.
  • TAF (módulo TOTVS Automação Fiscal): Módulo responsável pela gestão dos dados d, folha de pagamento e dentre outros cadastros pertinentes aos colaboradores.


Integração

O objetivo desta integração é permitir que a área do RH ou área responsável pelos benefícios, envie os dados de funcionários para o sistema da DIVICOM e assim redução no 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 as informações dos funcionários através de um arquivo (csv, txt) ou até mesmo manualmente, 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 é 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(RA_USERLGI) e alteração(RA_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 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 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 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 de funcionários;

draw.io Diagram
bordertrue
viewerToolbartrue
fitWindowfalse
diagramNameDivicom X Protheus - Funcionários
simpleViewerfalse
diagramWidth673
revision1


Fora do escopo

  • Automatização de Cadastramento de funcionários.
  • O serviço de disponibilização de dados de Funcionário 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.

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:

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 funcionário devidamente cadastrado.

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 MicroSiga Protheus, onde será analisada pela equipe de suporte da Totvs.

Fluxo das Informações

Esta integração traz a funcionalidade exclusivamente de cadastro de funcionários

Cadastro

Esta integração contempla apenas a consulta e envio dos dados de cadastro de funcionários.

Processos

A DIVICOM realizará o consumo da API com dados básicos que serão utilizados como parâmetros para consultar a base de funcionários e retornar um conjunto de informações pertinentes ao Cadastro de Funcionário(GPEA010) e retornar os dados para o requisitante.

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 desejados.

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

TipoParâmetro

Valor Default

Descrição
page1Sim

Integer

query
Página que está sendo requisitada.
pageSize1Não

Integer

query

100

Quantidade de funcionários por página.
productPROTHEUSSim

String

query

datemodified2001-01-01T18:25:43NãoStringquery
Data que será utilizada como filtro para trazer funcionários com data de alteração(RA_USERLGA)
branchIdD MG 01SimStringquery

companyIdT1SimStringquery

authorization

não será informado pelos parâmetros RESTSimStringheader
Configuração do parâmetro 

Security = 1 no arquivo appserver.ini


Parâmetros e Chamada do Método:

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/employeedatacontent/


Response da API:


Bloco de código
languagecpp
themeConfluence
titleResponse Json
{
   "items": [   {
      "telephone": "                    ",
      "areaCodeMobile": "  ",
      "workCardSerie": "99999",
      "companyKey": "T1|D MG 01 ",
      "workShiftSequence": "  ",
      "badgeNumber": "          ",
      "streetNumber": "      ",
      "complement": "                              ",
      "branch": "D MG 01 ",
      "salaryCategory": "M",
      "roleDescription": "FUNCAO PADRAO       ",
      "workCardNumber": "999999 ",
      "departamentInternalId": "        |         ",
      "socialIntegProgCode": "            ",
      "code": "000001",
      "neighborhood": "               ",
      "birthDate": "1963-06-10T00:00:00",
      "costCenterInternalId": "000000001",
      "zipCode": "        ",
      "areaCode": "  ",
      "name": "JOAO DA SILVA                 ",
      "hiringDate": "1999-03-10T00:00:00",
      "workShiftCode": "001",
      "city": "                    ",
      "roleCode": "00001",
      "costCenterDescription": "TEC PADRAO                              ",
      "gender": "M",
      "street": "TESTE                         ",
      "homeState": "SP",
      "workCardStateIssuing": "SP",
      "workShiftInternalId": "D MG    |001",
      "roleInternalId": "D MG    |00001",
      "departamentCode": "         ",
      "demissionDate": "",
      "costCenterCode": "000000001",
      "employeePositionDescription": "                              ",
      "mobileNumber": "          ",
      "fullName": "                                                                      ",
      "employeeSituation": " ",
      "workshiftDescription": "TURNO UNICO                                       ",
      "id": "T1|D MG 01 |000001",
      "employeePositionCode": "     ",
      "employeePositionCodeInternalId": "        |     ",
      "naturalCity": "SP",
      "contractEnd": "",
      "email": "                                                  ",
      "departmentDescription": "                              "
   }],
   "hasNext": true,
   "total": 3307
}


Dados utilizados da API

Por ser uma estrutura única para todos os produtos, há dados que existem em um produto (RM) e não existe no Protheus, desta forma cada produto utilizará os campos pertinentes aos seus ambientes.


CAMPOS PROTHEUSPROPRIEDADES API RESTDESCRIÇÃO
SM0->M0_CODIGO + "|" + SRA->RA_FILIALcompanyKeyAgrupamento de Empresa, Unidade de negócio e Filial" - SM0->M0_CODIGO
SRA->RA_FILIALbranchFilial do Funcionario
SRA->RA_MATcodeMatricula do Funcionario
SM0->M0_CODIGO + "|" + SRA->RA_FILIAL + "|" + SRA->RA_MATidChave única do funcionário
SRA->RA_NOMEnameNome do Funcionário
SRA->RA_NOMECMPfullNameNome Completo do Funcionário
SRA->RA_CRACHAbadgeNumberNúmero do Crachá
SRA->RA_DEPTOdepartamentCodeCodigo do departamento
QB_FILIAL + "|" + QB_DEPTO + departamentInternalIdInternalId do Departamento
QB_DESCRICdepartmentDescriptionDescrição do Departamento
RA_ADMISSAhiringDateData de Admissão
RA_DEMISSAdemissionDateData de Demissão
RA_NASCbirthDateData de aniversário
RA_SEXOgenderSexo
RA_ENDERECstreetRua do funcionário
RA_NUMENDEstreetNumberNúmero do endereço
RA_COMPLEMcomplementComplemento do endereço
RA_BAIRROneighborhoodBairro do Funcionário
RA_ESTADOhomeStateEstado do Funcinário
RA_NATURALnaturalCityNaturalidade
RA_SITFOLHemployeeSituationSituação do Funcionário na Folha
RA_MUNICIPcityCidade do Funcionário
RA_CEPzipCodeNúmero do Cep
RA_DDDFONEareaCodeCódigo de Área(DDD)
RA_TELEFONtelephoneTelefone
RA_DDDCELUareaCodeMobileCódigo de Área(DDD)
RA_NUMCELUmobileNumberNúmero do Telefone Celular
RA_PISsocialIntegProgCodeNumero do PIS do Funcionário
RA_NUMCPworkCardNumberCarteira de Trabalho do Funcionário
RA_SERCPworkCardSerieSerie da Carteira de Trabalho Profissional
RA_UFCPworkCardStateIssuingUnidade da federação emitente da carteira de trabalho
RA_CCcostCenterCodeCódigo do Centro de Custo
RA_CCcostCenterInternalIdcostCenterInternalId
CTT_DESC01costCenterDescriptionDescrição do Centro de Custo
RA_CARGOemployeePositionCodeCódigo do Cargo do Funcionário
SQ3->Q3_FILIAL + "|" + RA_CARGOemployeePositionCodeInternalIdInternalId do Cargo do Funcionário
Q3_DESCSUMemployeePositionDescriptionDescrição do Cargo do Funcionário
RA_CATFUNCsalaryCategoryCategoria Salarial. Rever estas categorias quando for utilizar com o RM. Produto Datasul também possui outras categorias (Semana, Quinzenal e Diarista)
RA_TNOTRABworkShiftCodeTurno de Trabalho
R6_FILIAL+ "|" + RA_TNOTRABworkShiftInternalIdO InternalID do Turno de Trabalho
R6_DESCworkshiftDescriptionDescrição do Turno de Trabalho
RA_SEQTURNworkShiftSequenceSequência de Turno do funcionário
RA_CODFUNCroleCodeCódigo da Função do Funcionário
RJ_FILIAL + "|" + RA_CODFUNCroleInternalIdInternalID do Código da Função do Funcionário
RJ_DESCroleDescriptionDescrição da Função do Funcionário
RA_DTFIMCTcontractEndData de término do contrato trabalho/experiência
RA_EMAILemailEmail do funcionário

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

API RESPONSE

400

Campo RA_USERLGA não foi encontrado.

Habilitar o campo RA_USERLGA pelo configurador.

Bloco de código
languagecpp
themeConfluence
titleCampos não estiverem devidamente habilitado
{
   "code": 400,
   "detailedMessage": "",
   "helpUrl": "http://tdn.totvs.com/x/Uzh_HQ",
   "message": "Campo RA_USERLGA não foi encontrado."
}
400

O Produto é um parâmetro obrigatório.

Preencher o parâmetro Produto.
Bloco de código
languagecpp
themeConfluence
titlePropriedade Product vazia
{
   "code": 400,
   "detailedMessage": "",
   "helpUrl": "http://tdn.totvs.com/x/Uzh_HQ",
   "message": "O parâmetro product é obrigatório."
}
400

A Filial é um parâmetro obrigatório.

Preencher o parâmetro Filial.
Bloco de código
languagecpp
themeConfluence
titlePropriedade Filial vazia
{
   "code": 400,
   "detailedMessage": "",
   "helpUrl": "http://tdn.totvs.com/x/Uzh_HQ",
   "message": "O parâmetro branchId é obrigatório."
}


Mensagens de Pós-Validação

Erro

Mensagem

Solução

API RESPONSE
400

Nenhum registro localizado.

Informar outra data de alteração para ser utilizada na consulta.
Bloco de código
languagecpp
themeConfluence
titlePropriedade Filial vazia
{
   "code": 400,
   "detailedMessage": "",
   "helpUrl": "http://tdn.totvs.com/x/Uzh_HQ",
   "message": "Nenhum registro localizado."
}


Tratamento de Erros Inesperados(TRY/CATCH):

Bloco de código
languagecpp
themeConfluence
titleErro Inesperado
{
   "code": 500,
   "detailedMessage": "",
   "helpUrl": "http://tdn.totvs.com/x/Uzh_HQ",
   "message": "Ocorreu uma falha no retorno da informação.\r\nErro ao preparar o ambiente com a Empresa e Filial informados!\r\nSaída no final: Falha de conexão com o banco de dados\r\nContacte o administrador do sistema"
}



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