Páginas filhas
  • DI Processos Administrativos ou Judiciais - Datasul (EMS x HCM)

Versões comparadas

Chave

  • Esta linha foi adicionada.
  • Esta linha foi removida.
  • A formatação mudou.
Comentário: Migration of unmigrated content due to installation of a new plugin

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 (CD2021), é possível enviar o mesmo para o RH por meio do programa CD2014, 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.
  • Parâmetros de conexão devem estar cadastrados corretamente no CD0387: URL, Porta, Usuário e Senha, além de estar marcado para integrar com Middleware.

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âmetro

Valor de Exemplo

Obrigatório

Tipo

Valor Default

Descrição
authorization usuario:senhaSim

header


autenticação é importante para o funcionamento correto da API em casos de ambientes com autenticação Http Basic.
contentrequest da apisimbody

Estrutura json com informações de cadastro do processo:

Propriedades Obrigatórias:

Dados do Processo:

  • tpProc: Tipo de Processo conforme leiaute do eSocial.
  • nrProc: Número do Processo. 
  • iniValid: Início da Validade do Processo. 
  • indMatProc: Indicativo de Matéria do Processo ou Alvará Judicial. 

Dados da Suspensão:

  • companyCode: Empresa que a suspensão se aplica.
  • baseCompanyId: Caso não seja informado o código da empresa que a suspensão se aplica, deve ser informada a base do CNPJ da Empresa que a suspensão se aplica. 
  • codSusp: Código indicativo da suspensão.
  • indSusp: Indicativo de suspensão da exigibilidade conforme leiaute do eSocial. 
  • dtDecisao: Data da decisão.
  • indDeposito: Indicativo de depósito do Montante Integral. 


Parâmetros e Chamada do Método:

Autenticação do tipo básica. 

Método POST.

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

Request da API: Exemplo:

Dados utilizados da API

Propriedade API RESTCAMPO HCMDESCRIÇÃOFormato / Exemplo
companyCodecdn_empresaEmpresa que a suspensão se aplica. 123
baseCompanyIdcod_base_id_federBase do CNPJ da empresa que a suspensão se aplica. Será considerado apenas quando o código da empresa (companyCode) não for informado. 12345678
tpProcidi_tip_proces_justicTipo de processo conforme leiaute do eSocial. 1
nrProccod_proces_justicNúmero do processo. 12345678901234567890
iniValiddat_inic_validInício da validade do processo. "2019-02"
fimValiddat_term_validFim da validade do processo. "9999-12"
indAutoriaidi_tip_autoriaAutoria da ação judicial. 2
indMatProcidi_mater_procesIndicativo da matéria do processo ou alvará judicial.5
observacaodes_obs_spedObservações relacionadas ao processo. Lorem ipsum dapibus molestie semper malesuada aliquam purus suspendisse tristique, etiam per urna arcu ante curabitur quam quis metus tempus, egestas a massa euismod sem fermentum maecenas sodales. vulputate molestie faucibus ac accumsan.
ufVaracod_uf_varaUF da Vara. SC
codMuniccdn_munpio_spedCódigo do município, conforme tabela do IBGE. 1234567
idVaracod_varaCódigo de Identificação da Vara. 1234
infoSusp
Pode ter nenhuma ou várias suspensões conforme o processo. 


codSuspnum_seq_utilizCódigo indicativa da suspensão. 1
indSuspidi_tip_decis_proces_justicIndicativo de suspensão da exigibilidade. "04"
dtDecisaodat_decisData da decisão, sentença ou despacho. "2019-07-21"
indDepositolog_depos_montanteIndicativo de depósito do montante integral. 

"S" para sim

"N" para não. 

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


Mensagens de Pré-Validação

Erro

Mensagem

Solução

API RESPONSE

265

Processo (nrProc) deve ser informado(a). 

Verificar se a propriedade json nrProc está preenchida no pacote enviado .

Bloco de código
themeEclipse
linenumberstrue
collapsetrue
{
   			"message": "Processo (nrProc) deve ser informado(a).\n",
    		"code": "265",
    		"type": "error"
}
158

Informe um(a) Tipo Processo (tpProc) válido(a). Valores Válidos: 1 ou 2 ou 3

Verificar se a propriedade json tpProc existe e está com valor válido conforme leiaute do eSocial.   
Bloco de código
themeEclipse
linenumberstrue
collapsetrue
{
   			"message": "Informe um(a) Tipo Processo (tpProc) válido(a). Valores Válidos: 1 ou 2 ou 3.\n",
    		"code": "158",
            "type": "error"
}
56650

Processo cadastrado(a) no HCM deve ser mantido neste produto. Verifique o FP0030.

Se o processo já foi cadastrado pelo HCM (FP0030), a manutenção do mesmo deve ocorrer no HCM e não via integração. 
Bloco de código
themeEclipse
linenumberstrue
collapsetrue
{
   			"message": "Processo cadastrado(a) no HCM deve ser mantido neste produto. Verifique o FP0030.\n",
    		"code": "56650",
            "type": "error"
}
7137

Empresa não relacionada com Nenhum Empregador.

Empresa informada na integração (companyCode) deve ser um empregador ou estar relacionado a algum empregador. Verifique complemento do eSocial no FP0500 Manutenção Parâmetros Empresa RH. 
Bloco de código
themeEclipse
linenumberstrue
collapsetrue
{
   			"message": "Empresa não relacionada com Nenhum Empregador",
    		"code": "7137",
            "type": "error"
}



53817

Dado Registro infoSusp (codSusp: 1) incorreto - indSusp (50).

Este campo (indSusp) deve ter valor conforme leiaute do eSocial. 
Bloco de código
themeEclipse
linenumberstrue
collapsetrue
{
   			"message": "Dado Registro infoSusp (codSusp: 1) incorreto - indSusp (50).",
    		"code": "53817",
            "type": "error"
}


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 ou não estejam de acordo com o leiaute do eSocial. 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.

EMS2:

  • Verificar se os parâmetros de conexão foram cadastrados corretamente no CD0387: URL, Porta, Usuário e Senha.
  • Verificar se estão cadastrados corretamente os processos no CD2021 dentro do período selecionado no CD2014.
  • Verificar se o processo (CD2021) está relacionado ao estabelecimento (CD2021A).