English
Español
Definições do Motor eSocial
Atenção
Esta documentação se aplica somente ao
O Motor eSocial é responsável por montar os arquivos XML após a geração das informações no Gestão de Pessoas.
Ao alterar o tipo de ambiente na tela de Definições do eSocial (FR030DES), é importante rever as definições do Motor eSocial nesta tela, para que os envios sejam transmitidos para o destino correto (URL do eDocs ou diretório para salvar em disco, dependendo do tipo de processamento).
As definições do Motor eSocial são recarregadas a cada execução dele, reduzindo a necessidade de reiniciar o Motor eSocial a cada alteração.
O Motor eSocial divide os logs em arquivos de até 30mb, no máximo. Após este tamanho ser atingido, é criado um novo arquivo para dar continuidade para a geração do log.
Importante
Para alterar ou excluir informações que já foram enviadas ao eSocial, o processo deve ser feito diretamente na origem das informações. Dessa forma, o sistema estará preparado para monitorar e gerar as tratativas de forma automática, enviando os leiautes de alteração e exclusão.
Ao realizar essas operações manualmente no banco de dados, o sistema não irá gerar as devidas pendências para o eSocial, o que causa inconsistências irreversíveis entre a base de dados do sistema e a do Governo.
Por essa razão, não é permitido realizar qualquer comando diretamente no banco de dados sem orientação específica da Senior, especialmente nas tabelas: R030DES, R000DME, R034MAT e todas com prefixo R350*.
Guia Geral
A guia Geral é de preenchimento obrigatório, as configurações informadas nessa guia serão aplicadas para todas as empresas.
Tipo de Ambiente eSocial
Identifica o tipo de ambiente:
- "1 - Produção": este tipo é usado para envio de dados do empregador para a base oficial do eSocial, e deve ser usado somente na base de produção.
Importante
- A opção "1 - Produção" não é habilitada por padrão no sistema, e para usá-la, deve ser alterada uma chave nos arquivos de configuração do sistema.
- Com esta opção não é permitido realizar a exclusão de dados, portanto, os envios feitos com este tipo de ambiente são oficiais e estão sujeitos a efeitos jurídicos e fiscalização.
- "2 - Produção restrita - Dados reais": este tipo faz o envio de dados reais para a base de homologação do eSocial, que serão validados, inclusive com os sistemas externos, sem efeitos jurídicos.
Esta opção permite realizar a exclusão de dados do ambiente de homologação.
Importante
Ao alterar o tipo de ambiente, é importante rever as definições do Motor eSocial (FR000DME), para que os envios sejam transmitidos para o destino correto (URL do eDocs ou diretório para salvar em disco, dependendo do tipo de processamento).
Tipo Processamento
Defina se as informações para o eSocial serão enviados por web service ou por arquivos XML salvos em disco. Dependendo da opção selecionada o sistema habilitará os campos para informações do web service ou para a geração do arquivo.
No sistema as opções são:
- 1 - Enviar para eDocs eSocial;
- 2 - Salvar Arquivo em Disco (Mensageiro de Terceiro).
Ao utilizar o tipo de processamento "2 – Salvar Arquivo em Disco (Mensageiro de Terceiro)", todas as empresas que serão enviadas para o eSocial deverão ser cadastradas na guia "Empresa", pois será necessário indicar um diretório diferente para cada uma delas.
Observação
Recomendamos a utilização da opção "1 - Enviar para eDocs eSocial" para clientes que utilizarem o eDocs. Esta opção não requer configuração de Middleware ou GlassFish e apresenta melhor performance.
Dados para eDocs
Se no tipo de processamento a opção selecionada for "1 - Enviar para eDocs eSocial", este grupo fica habilitado e deve ser preenchido.
URL eDocs
Cadastre o endereço do web service definido no eDocs.
A URL padrão para este campo deve seguir este formato: http://servidor:porta/SDE/
Nota
O nome SDE destacado na URL acima é fixo e obrigatório, portanto não deve ser alterado.
Consulte a documentação do web service de integração para obter informações detalhadas de como usá-lo.
Usuário eDocs
Informe o usuário utilizado para conectar no web service do eDocs. Trata-se do mesmo usuário informado no eDocs (Configuração > Empresa, na guia Integração - Web service).
Senha eDocs
Informe a senha utilizada para conectar no web service do eDocs. Trata-se da mesma senha informada no eDocs (Configuração > Empresa, na guia Integração - Web service).
CNPJ/CPF Certificado Digital
Cadastre o CNPJ/CPF do certificado digital cadastrado no eDocs.
Dados para Salvar em Arquivo
Se no tipo de processamento a opção selecionada for "2 - Salvar Arquivo em Disco (Mensageiro de Terceiro)", este grupo fica habilitado e deve ser preenchido.
Diretório dos Arquivos XML
Informe neste campo o diretório onde o sistema deverá armazenar o arquivo XML gerado. Se este campo não tiver um local selecionado, o sistema gerará os arquivos na pasta do executável do Motor (dentro da pasta Vetorh, no diretório onde o sistema está instalado).
Quando o motor estiver configurado para salvar arquivos em disco, e existirem envios para processamento, serão criados os diretórios Processar\eSocial e Retorno. No diretório Processar\eSocial serão armazenados os arquivos XML que serão enviados para o governo. No diretório Retorno serão armazenados os arquivos de retorno do eDocs, com o prefixo "ESOCIAL" (exemplo: ESOCIAL_ID1806800930000002017071915194800011.xml).
O Motor eSocial monitorará este diretório, verificando se existem pendências a gerar, seja no envio ou pelo arquivo de retorno do ambiente do Governo.
O campo possui um botão, representado pelo ícone de uma lupa, que permite listar e salvar os logs do Motor eSocial dos últimos 45 dias. Isto foi pensando para quem não possui acesso ao diretório dos logs. Também é possível baixar os arquivos desejados, desde que o sistema tenha acesso aos arquivos de log. Os arquivos serão copiados, compactados e uma caixa de diálogo será aberta para que seja possível salvar os arquivos.
Importante
Para o Motor conseguir criar os diretórios é necessário que o usuário possua as permissões de Leitura e Gravação nesses locais, para geração dos arquivos XML.
Dados Gerais
Este grupo fica habilitado independentemente do tipo de geração do XML e deve ser preenchido.
Gerar Arquivos de Log
Informe se o Motor deve salvar os logs ou não.
Diretório dos Arquivos de Log
Defina o diretório onde os logs serão gerados se a opção para geração do log for "1 - Sim".
Se não for informado um caminho para geração do Log este é gerado na pasta do executável do motor (dentro da pasta Vetorh, no diretório onde o sistema está instalado).
Tamanho do Lote
Informe a quantidade de arquivos que serão enviados por lote para o eDocs. O tamanho do lote informado deve ser maior que zero e menor ou igual a 100.
Tempo Máximo de Execução
Defina o tempo máximo que o web service de integração deverá levar para processar uma requisição com o eDocs. O tempo máximo de execução do lote informado deve estar entre 60 e 360 minutos.
Tempo Verificação Pendências
Informe o intervalo de tempo para que o sistema gere novo arquivo XML. O tempo de verificação das pendências informado deve estar entre 1 e 120 minutos.
Guia Empresa
A guia Empresa ficará habilitada após cadastrar as informações na guia Geral, nesta guia cadastram-se as informações específicas do Motor para determinada empresa, ou seja, as empresas parametrizadas neste local poderão gerar o arquivo XML de forma diferente a parametrizada na guia Geral. Caso sejam feitas parametrizações nesta guia, elas prevalecerão sobre as da guia Geral.
Se houver mais de uma empresa cadastrada no eDocs, a guia Empresa obrigatoriamente deve ser configurada para cada uma delas. Isto pois cada empresa possui seu certificado digital, assim como os dados de usuário e senha.
Empresa
Selecione a empresa que necessita que o arquivo XML seja gerado de forma diferente da cadastrada na guia Geral.
Tipo de Ambiente eSocial
Identifica o tipo de ambiente:
- "1 - Produção": este tipo é usado para envio de dados do empregador para a base oficial do eSocial, e deve ser usado somente na base de produção.
Importante
- A opção "1 - Produção" não é habilitada por padrão no sistema, e para usá-la, deve ser alterada uma chave nos arquivos de configuração do sistema.
- Com esta opção não é permitido realizar a exclusão de dados, portanto, os envios feitos com este tipo de ambiente são oficiais e estão sujeitos a efeitos jurídicos e fiscalização.
- "2 - Produção restrita - Dados reais": este tipo faz o envio de dados reais para a base de homologação do eSocial, que serão validados, inclusive com os sistemas externos, sem efeitos jurídicos.
Esta opção permite realizar a exclusão de dados do ambiente de homologação.
Importante
Ao alterar o tipo de ambiente, é importante rever as definições do Motor eSocial (FR000DME), para que os envios sejam transmitidos para o destino correto (URL do eDocs ou diretório para salvar em disco, dependendo do tipo de processamento).
Tipo Processamento
Defina se os arquivos XML para as empresas selecionadas serão enviados por web service ou se os arquivos serão salvos em disco. Dependendo da opção selecionada o sistema habilitará os campos para informações do web service ou para a geração do arquivo.
No sistema as opções são:
- 1 - Enviar para eDocs eSocial;
- 2 - Salvar Arquivo em Disco (Mensageiro de Terceiro).
Ao utilizar o tipo de processamento "2 – Salvar Arquivo em Disco (Mensageiro de Terceiro)", todas as empresas que serão enviadas ao eSocial deverão ser cadastradas nesta guia, indicando um diretório diferente para cada uma delas no campo “Diretório dos Arquivos XML”.
Dados para eDocs
Se no tipo de processamento a opção selecionada for "1 - Enviar para eDocs eSocial", este grupo fica habilitado e deve ser preenchido.
URL eDocs
Cadastre o endereço do web service definido no eDocs.
A URL padrão para este campo deve seguir este formato: http://servidor:porta/SDE/
Nota
O nome SDE destacado na URL acima é fixo e obrigatório, portanto não deve ser alterado.
Consulte a documentação do web service de integração para obter informações detalhadas de como usá-lo.
Usuário eDocs
Informe o usuário utilizado para conectar no web service do eDocs. Trata-se do mesmo usuário informado no eDocs (Configuração > Empresa, na guia Integração - Web service).
Senha eDocs
Informe a senha utilizada para conectar no web service do eDocs. Trata-se da mesma senha informada no eDocs (Configuração > Empresa, na guia Integração - Web service).
CNPJ/CPF Certificado Digital
Cadastre o CNPJ/CPF do certificado digital cadastrado no eDocs.
Dados para Salvar em Arquivo
Se no tipo de processamento a opção selecionada for "2 - Salvar Arquivo em Disco (Mensageiro de Terceiro)", este grupo fica habilitado e deve ser preenchido.
Diretório dos Arquivos XML
Informe neste campo o diretório onde o sistema deverá armazenar o arquivo XML gerado. Se este campo não tiver um local selecionado, o sistema gerará os arquivos na pasta do executável do Motor (dentro da pasta Vetorh, no diretório onde o sistema está instalado).
Quando o motor estiver configurado para salvar arquivos em disco, e existirem envios para processamento, serão criados os diretórios Processar\eSocial e Retorno. No diretório Processar\eSocial serão armazenados os arquivos XML que serão enviados para o governo. No diretório Retorno serão armazenados os arquivos de retorno do eDocs, com o prefixo "ESOCIAL" (exemplo: ESOCIAL_ID1806800930000002017071915194800011.xml).
O Motor eSocial monitorará este diretório, verificando se existem pendências a gerar, seja no envio ou pelo arquivo de retorno do ambiente do Governo.
O campo possui um botão, representado pelo ícone de uma lupa, que permite listar e salvar os logs do Motor eSocial dos últimos 45 dias. Isto foi pensando para quem não possui acesso ao diretório dos logs. Também é possível baixar os arquivos desejados, desde que o sistema tenha acesso aos arquivos de log. Os arquivos serão copiados, compactados e uma caixa de diálogo será aberta para que seja possível salvar os arquivos.
Importante
Para o Motor conseguir criar os diretórios é necessário que o usuário possua as permissões de Leitura e Gravação nesses locais, para geração dos arquivos XML.
Utilizando o Motor eSocial
Envio por web services
Quem utilizar web service para integrar as informações com o eDocs, não necessitará gerar arquivos para salvá-los em disco, porque as informações serão enviadas pelo web service ConsultarSituacaoDocumentos.
Arquivos salvos em disco
Geração de arquivos XML
Quem não utilizar web service para integrar as informações com o eDocs, terá que gerar os arquivos XML no formato abaixo. Esses arquivos devem ser gravados na pasta "Retorno" dentro do diretório configurado em Diversos > Definições Motor eSocial > campo Diretório dos Arquivos XML.
| ID | Campo | Pai | Tipo | Ocorrência | Descrição |
|---|---|---|---|---|---|
| 0 | SitucaoDocumento | 1-1 | Situação de documento eletrônico | ||
| 1 | Documento | 0 | 1-1 | Dados de identificação do documento | |
| 1.1 | ChaveDocumento | 1 | Texto | 1-1 | Chave/Identificador do documento |
| 2 | Situacao | 0 | Número | 1-1 |
Deve ser informada a situação do documento. 1 - Autorizado: Deve ser utilizado quando o governo processou o envio e retornou o número de recibo do evento. 2 - Rejeitado: Deve ser utilizando quando o governo processou o envio e retornou críticas identificadas no evento. |
| 3 | ProtocoloAutorizacao | 0 | Texto | 0-1 | Número de recibo retornado pelo governo para o evento. Obrigatório quando Situacao = 1 - Autorizado. |
| 4 | DataAutorizacao | 0 | Data | 0-1 | Data de autorização retornada pelo governo. Obrigatório quando Situacao = 1 - Autorizado. |
| 5 | Mensagem | 0 | Texto | 0-1 | Resumo da situação do evento. Quando Situacao = 2. Exemplos: a) Conteúdo do evento inválido; b) Retornado com erros do Governo. |
| 6 | DetalhesCritica | 0 | 0-1 | Gerado para eSocial com detalhes da rejeição | |
| 6.1 | DetalheCritica | 5 | 0-N | Gerado para eSocial com detalhes da rejeição | |
| 6.1.1 | Codigo | 5.1 | Número | 1-1 | Código da rejeição |
| 6.1.2 | Localização | 5.1 | Texto | 0-1 | Localização da tag com problema |
| 6.1.3 | Mensagem | 5.1 | Texto | 1-1 | Mensagem do problema |
Segue um exemplo de envio autorizado, ou seja, informações foram enviadas através dos leiautes e o retorno foi positivo:
<?xml version="1.0" encoding="utf-8"?>
<SituacaoDocumento xmlns:ds="http://www.w3.org/2000/09/xmldsig#">
<Documento>
<ChaveDocumento>ID1806800930000002017071917133100001</ChaveDocumento>
</Documento>
<Situacao>1</Situacao>
<ProtocoloAutorizacao>1.2.0000000000000011124</ProtocoloAutorizacao> <DataAutorizacao>2016-11-07T10:30:33-02:00</DataAutorizacao>
</SituacaoDocumento>Na sequência, seguem dois exemplos de envios rejeitados, ou seja, informações foram enviadas através dos leiautes e o retorno foi negativo.
Exemplo 1:
<?xml version="1.0" encoding="utf-8"?>
<SituacaoDocumento xmlns:ds="http://www.w3.org/2000/09/xmldsig#">
<Documento>
<ChaveDocumento>ID1806800930000002017071917133100001</ChaveDocumento>
</Documento>
<Situacao>2</Situacao>
<Codigo>401</Codigo>
<DetalhesCritica>
<DetalheCritica>
<Codigo>537</Codigo>
<Mensagem>Já existe no sistema registro com mesmo código de identificação (chave) em período de vigência conflitante com o período informado no registro atual.
Ação Sugerida: O evento somente pode ser recepcionado se não existir outro evento para a tabela com o mesmo código de identificação (chave) em período de vigência conflitante com o período informado no evento atual.
Certifique-se que o código de identificação e os períodos informados estejam corretos.</Mensagem>
<Localizacao />
</DetalheCritica>
</DetalhesCritica>
</SituacaoDocumento>
Exemplo 2:
<s:Envelope xmlns:s="http://schemas.xmlsoap.org/soap/envelope/"><s:Body><ConsultarSituacaoDocumentosResponse xmlns="http://www.senior.com.br/nfe"><ConsultarSituacaoDocumentosResult xmlns:a="http://schemas.microsoft.com/2003/10/Serialization/Arrays" xmlns:i="http://www.w3.org/2001/XMLSchema-instance"><a:anyType i:type="SituacaoDocumento"><Documento><ChaveDocumento>ID1123456780000002017071115003800010</ChaveDocumento></Documento><Situacao>2</Situacao><DetalhesCritica><DetalheCritica><Codigo>537</Codigo><Localizacao>Testes</Localizacao><Mensagem>Já existe no sistema registro com mesmo código de identificação (chave) em período de vigência conflitante com o período informado no registro atual.Ação Sugerida: O evento somente pode ser recepcionado se não existir outro evento para a tabela com o mesmo código de identificação (chave) em período de vigência conflitante com o período informado no evento atual.Certifique-se que o código de identificação e os períodos informados estejam corretos.</Mensagem></DetalheCritica><DetalheCritica><Codigo>986</Codigo><Mensagem>AAAAAAAAAAAAAAAA AAAAAAAAAAAAAA AAAAAA AAAAAAAAAAAAAAAAAAAAAAAAAA AAAAAA AAAAAAA AAAAAAAAAAAAA AAAAAAAAAAA AAAA AAAAAAAAAAAAAA AAAAAAAAAA AAA A AA A AAAAAAAAAAAAAAAAA.Ação Sugerida: O evento somente pode ser recepcionado se não existir outro evento para a tabela com o mesmo código de identificação (chave) em período de vigência conflitante com o período informado no evento atual.Certifique-se que o código de identificação e os períodos informados estejam corretos.</Mensagem></DetalheCritica></DetalhesCritica></a:anyType></ConsultarSituacaoDocumentosResult></ConsultarSituacaoDocumentosResponse></s:Body></s:Envelope>
English
Español
