INTEGRAÇÃO

Contexto de Negócio (Introdução)

Cada vez mais o mercado exige que as operações complexas e manipulação de dados ainda mais ágeis e com custos reduzidos. Com o RH não é diferente, por isso os processos administrativos e judiciais pertinentes aos autônomos ou produtores rurais que foram cadastrados no EMS, precisam ser enviados para o eSocial de forma transparente para o usuário. 

Frente a esta necessidade, foi criada uma interface que possibilite automatizar o cadastro de processo, através de uma interface de integração. 

Sistemas Envolvidos

• HCM (módulo Folha de Pagamento): O módulo Folha de Pagamento visa efetuar os cálculos da folha de pagamento para os funcionários, mantendo o controle sobre os valores referentes aos eventos relativos a estes funcionários.

• EMS (módulo Recebimento): O módulo Recebimento visa agilizar e assegurar o recebimento dos materiais da empresa, possibilitando todos os controles necessários dos materiais.

Integração

O objetivo desta integração é permitir que a área do RH, recebam os processos administrativos e judiciais de outros sistemas especializados na área, reduzindo assim o trabalho de inclusão manual de todas as informações dentro do sistema;

• Arquitetura (Tecnologia)
  
  • Esta integração é 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.

Escopo

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

• Ao ser cadastrado ou alterado o processo no Recebimento, é possível enviar o mesmo para o RH, centralizando as informações que serão disponibilizadas para o eSocial. 
• Este processo e suas informações de suspensão serão cadastradas no FP0030.
• A partir do momento que estiver cadastrado no FP0030, será gerada ou atualizada mensagem S-1070 correspondente. 

Abaixo demonstramos um desenho como esta integração se dará:

Fora do escopo

• Eliminação de processos via integração.
• Alteração de processos previamente cadastrados no HCM. Processos cadastrados no HCM, devem ser mantidos no HCM. 

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

• Versões mínima do TOTVS/Datasul: 12.1.27
• Estrutura de rede estável, para que haja trafego de dados sem interrupção
• Datasul devidamente configurado e serviço Rest habilitado em seu server, com acesso à internet. 

Processos

O Sistema requisitante enviará as informações via Json para a interface de integração, desta forma será gerado um novo registro na tabela de processos no HCM. Caso tenha êxito na geração do registro, será retornado a mesma estrutura de Json confirmando sua gravação, caso contrário enviará as informações de inconsistências citadas nos próximos tópicos.

Limitações / Restrições Gerais

• Com o objetivo de manter a estrutura e a agilidade da estrutura Rest, o Web Service Rest receberá registro individual de cada processo.
• A integração não contemplará exclusão de registros no HCM, para isso o usuário deverá acessar o HCM e excluir manualmente o mesmo e seus devidos relacionamentos. 

Como realizar a chamada da API REST

Para realizar a integração, é necessário as informações básicas para cadastramento do processo.

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

Parâmetros de Entrada:

Parâmetros e Chamada do Método:

Autenticação do tipo básica. 

Método POST.

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

Request da API: Exemplo:

Dados utilizados da API

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 Datasul:

Mensagens de Pré-Validação

{
   "errorCode": 1,
   "errorMessage": "Já existe candidato externo com o CPF informado."
}

{
   "errorCode": 366,
   "errorMessage": "Nome deve ser preenchido."
}

{
   "errorCode": 158,
  "errorMessage": "País/UF Nascimento Inválido para CPF "
}

{
   "errorCode": 56,
  "errorMessage": "Parâmetros Recrutamento e Seleção (RS0006) inexistente para a empresa informada."
}

{
   "errorCode": 158,
  "errorMessage": "Funcionário Responsável não foi informado nos Parâmetros Recrutamento e Seleção (RS0006) para a empresa informada."
}

{
   "errorCode": 158,
  "errorMessage": "Motivo Requisição Pessoal não foi informado nos Parâmetros Recrutamento e Seleção (RS0006) para a empresa informada."
}

{
   "errorCode": 56,
  "errorMessage": "Funcionário Responsável Inexistente. Verifique Parâmetros Recrutamento e Seleção (RS0006) da empresa informada."
}

{
   "errorCode": 158,
  "errorMessage": "Grau de Instrução Inválido."
}

{
   "errorCode": 158,
  "errorMessage": "Empresa Parâmetros RH Inválida."
}

OBS: Estas mensagens de validações serão retornadas sempre que algum campo passado que seja obrigatório ou que algum campo enviado tenha sua origem de dados em outra tabela e não seja localizado na mesma, vale lembrar que são apenas exemplos de mensagens de erros e podendo variar o nome da propriedade enviada.

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, clientlog, log do appServer ou algo que possa identificar a origem do problema.