Histórico da Página
INTEGRAÇÃO EmployeeDataContent - Consulta de Cadastro de Funcionários
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
- Datasul (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.
- DIVICOM (Sistema Especialista): Empresa com ampla experiência em gestão de benefícios, sendo pioneira na Administração de benefícios e com atuação no mercado desde 1996 tendo atendido mais de 1.000.000 de clientes.(Dados extraídos do site do próprio parceiro,mais informações).
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)
- Esta integração entre o TOTVS Datasul e o HUB (Sistema DIVICOM) é 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 Datasul 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 e alteração 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 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 do TOTVS Datasul dentro do aplicativo da HUB (DIVICOM).
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 TOTVS Datasul: 12.1.25
- Possuir acesso à Internet, caso o sistema que venha a utilizar a integração com a aplicação TOTVS Datasul que faça uso da mesma.
- Estrutura de rede estável, para que haja trafego de dados sem interrupção
- TOTVS Datasul 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:
- Configuração de Webservice Rest no TOTVS Datasul no formato apresentado na seguinte documentação ( (Exemplo de Configuração de Webservice Datasul REST))
Controle de Ambiente
Exige que os seguintes pontos sejam revisados:
- TOTVS Datasul 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 TOTVS Datasul , 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(FP1500) 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 TOTVS Datasul , 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 EmployeeDataContent ApiEmployeeDataContent;
- 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 | Tipo | Parâmetro | Valor Default | Descrição |
page | 1 | Sim | Integer | query | Página que está sendo requisitada. | |
pageSize | 1 | Não | Integer | query | 100 | Quantidade de funcionários por página. |
product | DIVICOM | Sim | String | query | ||
datemodified | 2001-01-01T18:25:43 | Não | String | query | Data que será utilizada como filtro para trazer funcionários com data de alteração(RA_USERLGA) | |
branchId | 180 | Sim | String | query | ||
companyId | 10 | Sim | String | query |
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 TOTVS Datasul 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 | ||||||
---|---|---|---|---|---|---|
| ||||||
{ "data": { "total": 1, "items": [ { "street": "RUA DELFINO ANTONIO LOPES", "hiringDate": "2013-09-10T00:00:00.000", "city": "PIRAJU", "id": "10|180|6503", "complement": "", "roleDescription": "GERENTE FILIAL INSUMOS - 0", "zipCode": "18800000", "companyKey": "10", "name": "NERO", "departmentDescription": "PLANO DE LOTACAO 3 - UNIDADE DE INSUMOS", "streetNumber": "00000057", "workCardNumber": "0000059481", "roleInternalId": "9071|0", "areaCode": "15", "neighborhood": "JARDIM ELDORADO", "roleLevel": "0", "roleCode": "9071", "code": "6503", "socialIntegProgCode": "12425827643", "workCardSerie": "00000137", "workshiftDescription": "08:00/18:00 INT 01:12", "demissionDate": null, "email": "[email protected]", "employeePositionDescription": "GERENTE FILIAL INSUMOS", "areaCodeMobile": "14", "branch": "180", "homeState": "SP", "fullName": "NERO PINHEIRO", "mobileNumber": "97822974", "departmentCode": "3 - 03030100000", "telephone": "997464958", "workShiftCode": "1" } ], "hasNext": false }, "length": null, "messages": [] } |
Dados utilizados da API
Por ser uma estrutura única para todos os produtos, há dados que existem em um produto (RM e/ou Protheus) e não existe no TOTVS Datasul, desta forma cada produto utilizará os campos pertinentes aos seus ambientes.
CAMPOS Datasul | PROPRIEDADES API REST | DESCRIÇÃO |
---|---|---|
funcionario.cdn_empresa | companyKey | Código da Empresa da tabela Funcionário (FP1500) |
funcionario.cdn_estab | branch | Código do Estabelecimento da tabela Funcionário (FP1500) |
funcionario.cdn_funcionario | code | Código do Funcionário cadastrado no programa FP1500 |
funcionario.cdn_empresa | funcionario.cdn_estab | funcionario.cdn_funcionario | id | Concatenação entre o Código da Empresa + Código do Estabelecimento + Código do Funcionário, separando as informações por | (pipe) |
funcionario.nom_abrev_pessoa_fisic | name | Nome abrevidado do Funcionário informado no programa FP1500 |
compl_pessoa_fisic.nom_relat_legal | fullName | Nome completo do Funcionário informado no programa FP1500 |
funcionario.cdn_plano_lotac - funcionario.cod_unid_lotac | departmentCode | Plano + Unidade de Lotação informado para o Funcionário no FP1500, separados por hífen |
plano_lotac.des_plano_lotac - unid_lotac.des_unid_lotac | departmentDescription | Descrição do Plano + Unidade de Lotação informado no FP0800, separados por hífen |
funcionario.dat_admis_func | hiringDate | Data de Admissão do Funcionário informada no programa FP1500 |
funcionario.dat_desligto_func | demissionDate | Data de Desligamento do Funcionário indicada no programa FP1500 |
rh_pessoa_fisic.nom_ender_rh | street | Nome da Rua onde reside o Funcionário indicado no FP1440 |
SUBSTRING(rh_pessoa_fisic.cod_livre_1,66,08) | streetNumber | Número da rua onde mora o Funcionário, conforme indicado no FP1440 |
rh_pessoa_fisic.nom_pto_refer | complement | Complemento/Referência do endereço do Funcionário informado no FP1440 |
rh_pessoa_fisic.nom_bairro_rh | neighborhood | Bairro onde mora o Funcionário informado no FP1440 |
rh_pessoa_fisic.cod_unid_federac_rh | homeState | Estado onde mora o Funcionário informado no FP1440 |
cargo.des_cargo | employeePositionDescription | Descrição do Cargo do funcionário, conforme cadastrado no programa FP0720 |
rh_pessoa_fisic.nom_cidad_rh | city | Cidade do Funcionário |
rh_pessoa_fisic.cod_cep_rh | zipCode | CEP do funcionário indicado no FP1440 |
rh_pessoa_fisic.num_ddd | areaCode | DDD do funcionário indicado no FP1440 |
rh_pessoa_fisic.num_telefone | telephone | Telefone do funcionário indicado no FP1440 |
rh_pessoa_fisic.num_ddd_contat | areaCodeMobile | DDD de Contato do funcionário indicado no FP1440 |
rh_pessoa_fisic.num_telef_contat | mobileNumber | Telefone de Contato do funcionário indicado no FP1440 |
funcionario.cod_pis | socialIntegProgCode | Número do PIS do funcionário, informado no FP1500 |
funcionario.cod_cart_trab | workCardNumber | Número da carteira de trabalho do funcionário, informado no FP1500 |
funcionario.cod_ser_cart_trab | workCardSerie | Série da carteira de trabalho do funcionário, informado no FP1500 |
funcionario.cdn_turno_trab | workShiftCode | Turno de trabalho relacionado ao funcionário no FP1500 |
turno_trab.des_turno_trab | workshiftDescription | Descrição do Turno de Trabalho, conforme informado no FP1400 |
funcionario.cdn_cargo_basic | roleCode | Cargo do Funcionário no FP1500 |
funcionario.cdn_cargo_basic | funcionario.cdn_niv_cargo | roleInternalId | Concatenação entre o Código do Cargo e o Código do Nível, separados por | (pipe) |
cargo.des_cargo | roleDescription | Descrição do Cargo no FP1500 |
funcionario.cdn_niv_cargo | roleLevel | Código do Nível do funcionário no FP1500 |
rh_pessoa_fisic.nom_e_mail | E-mail do Funcionário no FP1440 |
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 TOTVS Datasul:
Mensagens de Pré-Validação
Erro | Mensagem | Solução | API RESPONSE |
17006 | Parâmetro 'product' incorreto. | Informar DIVICOM de forma fixa no parâmetro 'product'. | |
17006 | O parâmetro 'companyId' incorreto. | O parâmetro 'companyId' incorreto. | |
17006 | O parâmetro 'branchId' incorreto. | Preencher o parâmetro 'branchId'. | |
17006 | Empresa/Estabelecimento inválidos! | Informar valores válidos no TOTVS Datasul para os parâmetros 'companyId' e 'branchID |
Mensagens de Pós-Validação
Erro | Mensagem | Solução | API RESPONSE | |
17006 | Nenhum registro localizado. | Favor informar corretamente os parâmetros para que os dados do TOTVS Datasul sejam corretamente retornados. |
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.