Definiciones del Motor eSocial
Atenção
Esta documentación se aplica únicamente a los
El eSocial Engine es el encargado de ensamblar los archivos XML luego de generar la información en Gestión de Personas.
Al cambiar el tipo de entorno en la pantalla Configuración de eSocial (FR030DES), es importante revisar la configuración de eSocial Engine en esta pantalla, para que los envíos se transmitan al destino correcto (URL de eDocs o directorio para guardar en disco, según el tipo de procesamiento).
Las definiciones de eSocial Engine se recargan cada vez que se ejecuta, lo que reduce la necesidad de reiniciar eSocial Engine con cada cambio.
El eSocial Engine divide los registros en archivos de hasta 30 mb como máximo. Una vez alcanzado este tamaño, se crea un nuevo archivo para continuar con la generación de registros.
Importante
Para cambiar o eliminar información que ya se ha enviado al eSocial, el proceso se debe realizar directamente en el origen de la información. De esta forma el sistema está preparado para monitorear y generar las tratativas de forma automática, enviando los lecturas de cambio y exclusión.
Al realizar estas operaciones manualmente en la base de datos, el sistema no genera las debidas pendencias para el eSocial. Esto causa inconsistencias irreversibles entre la base de datos del sistema y el Gobierno.
Por esta razón, no se permite realizar ningún comando directamente en la base de datos sin orientación específica de Senior, especialmente en las tablas: R030DES, R000DME, R034MAT y todas con prefijo R350 *.
Guía general
ÁguilaGeneral es obligatorio, las configuraciones informadas en esta pestaña se aplicarán a todas las empresas.
Tipo de ambiente eSocial
Identifica el tipo de entorno:
- "1 - Producción": este tipo se utiliza para enviar datos del empleador a la base oficial del eSocial, y debe ser usado solamente en la base de producción.
Importante
- La opción "1 - Producción" no está habilitada de forma predeterminada en el sistema, y para utilizarla, debe cambiar una clave en los archivos de configuración del sistema.
- Con esta opción no se permite realizar la exclusión de datospor lo tanto, los envíos hechos con este tipo de ambiente son oficiales y están sujetos a efectos jurídicos y fiscalización.
- "2 - Producción restringida - Datos reales": este tipo hace el envío de datos reales a la base de homologación del eSocial, que serán validados, incluso con los sistemas externos, sin efectos jurídicos.
Esta opción permite realizar la exclusión de datos del medio ambiente de homologación.
Importante
Al cambiar el tipo de entorno, es importante revisar la configuración del motor eSocial (FR000DMEpara que los envíos se transmitan al destino correcto (URL del eDoc o directorio para guardar en disco, dependiendo del tipo de procesamiento).
Tipo de procesamiento
Defina si la información para eSocial se enviará a través de un servicio web o archivos XML guardados en el disco. Dependiendo de la opción seleccionada, el sistema habilitará los campos para la información del servicio web o para la generación de archivos.
En el sistema las opciones son:
- 1 - Enviar a eDocs eSocial;
- 2 - Guardar archivo en disco (Mensajero de terceros).
Al utilizar el tipo de procesamiento "2 – Guardar Archivo en Disco (Third Party Messenger)", todas las empresas que serán enviadas a eSocial deberán estar registradas en la pestaña "Empresa", ya que será necesario indicar un directorio diferente para cada una de ellas. a ellos.
Observación
Recomendamos usar la opción "1 - Enviar a eDocs eSocial" para los clientes que usan eDocs. Esta opción no requiere configuración de Middleware o GlassFish y tiene un mejor rendimiento.
Datos para eDocs
Si en el tipo de procesamiento la opción seleccionada es "1 - Enviar a eDocs eSocial", este grupo queda habilitado y debe ser rellenado.
URL eDocs
Registre la dirección del servicio web definida en eDocs.
La dirección URL predeterminada para este campo debe seguir este formato:http: // servidor: puerto /SDE/
Nota
El nombre SDEdestacado en la URL anterior es fijo y obligatorio, por lo que no debe ser cambiado.
Consulte la documentación del servicio web de integración para obtener información detallada sobre cómo utilizarlo.
Usuario eDocs
Informar al usuario utilizado para conectarse al servicio web eDocs. Es el mismo usuario informado en eDocs (Configuración > Empresa, en la pestaña Integración - Servicio web).
Contraseña eDocs
Ingrese la contraseña utilizada para conectarse al servicio web de eDocs. Es la misma contraseña informada en eDocs (Configuración > Empresa, en la pestaña Integración - Servicio web).
CNPJ / CPF Certificado Digital
Registrar el CNPJ/CPF del certificado digital registrado en eDocs.
Datos para guardar en archivo
Si en el tipo de procesamiento la opción seleccionada es "2 - Guardar Archivo en Disco (Mensajero de Tercer)", este grupo queda habilitado y debe ser rellenado.
Directorio de archivos XML
En este campo se indica el directorio donde el sistema debe almacenar el archivo XML generado. Si este campo no tiene una ubicación seleccionada, el sistema generará los archivos en la carpeta del ejecutable del motor (dentro de la carpeta Vetorh, en el directorio donde está instalado el sistema).
Cuando el motor está configurado para guardar archivos en disco, y hay envíos para el procesamiento, se crean los directorios Proceso \ eSocial y regreso. Los archivos XML que se enviarán al gobierno se almacenarán en el directorio Processar\eSocial. Los archivos de devolución de eDocs se almacenarán en el directorio de devolución, con el prefijo "ESOCIAL" (ejemplo: ESOCIAL_ID1806800930000002017071915194800011.xml).
la Motor eSocial supervisará este directorio, verificando si existen pendencias a generar, ya sea en el envío o por el archivo de retorno del ambiente del Gobierno.
El campo tiene un botón, representado por un icono de lupa, que le permite enumerar y guardar los registros de eSocial Engine de los últimos 45 días. Esto fue pensado para aquellos que no tienen acceso al directorio de registros. También es posible descargar los archivos deseados siempre que el sistema tenga acceso a los archivos de registro. Los archivos se copiarán, comprimirán y se abrirá un cuadro de diálogo para que pueda guardar los archivos.
Importante
Para que el motor pueda crear los directorios es necesario que el usuario tenga los permisos de lectura y escritura en estos lugares para generar los archivos XML.
Datos Generales
Este grupo está habilitado independientemente del tipo de generación de XML y debe completarse.
Generar archivos de registro
Informar si el motor debe guardar los registros o no.
Directorio de archivos de registro
Configure el directorio donde se generarán los registros si la opción para generar el registro es "1 - Sí".
Si no se informa una ruta para generar el Log, se genera en la carpeta ejecutable del motor (dentro de la carpeta Vetorh, en el directorio donde está instalado el sistema).
Tamaño del lote
Informar la cantidad de archivos que serán enviados por lote a eDocs. El tamaño del lote ingresado debe ser mayor que cero y menor o igual a 100.
Tiempo máximo de ejecución
Defina el tiempo máximo que debe tomar el servicio web de integración para procesar una solicitud con eDocs. El tiempo máximo de ejecución del lote informado debe estar entre 60 y 360 minutos.
Tiempo de verificación pendiente
Informar el intervalo de tiempo para que el sistema genere un nuevo archivo XML. El tiempo de verificación de asuntos pendientes debe estar entre 1 y 120 minutos.
Guía de la empresa
La pestaña Empresa quedará habilitada luego de registrar la información en la pestaña General, en esta pestaña se registra la información específica del Motor para una determinada empresa, es decir, las empresas parametrizadas en esta ubicación podrán generar el archivo XML en otro del parametrizado en la pestaña General. Si se realizan parametrizaciones en esta pestaña, prevalecerán sobre las de la pestaña General.
Si hay más de una empresa registrada en eDocs, se debe configurar la pestaña Empresa para cada una de ellas. Esto se debe a que cada empresa tiene su certificado digital, así como sus datos de usuario y contraseña.
Empresa
Seleccione la empresa que necesita que se genere el archivo XML diferente al registrado en la pestaña General.
Tipo de ambiente eSocial
Identifica el tipo de entorno:
- "1 - Producción": este tipo se utiliza para enviar datos del empleador a la base oficial del eSocial, y debe ser usado solamente en la base de producción.
Importante
- La opción "1 - Producción" no está habilitada de forma predeterminada en el sistema, y para utilizarla, debe cambiar una clave en los archivos de configuración del sistema.
- Con esta opción no se permite realizar la exclusión de datospor lo tanto, los envíos hechos con este tipo de ambiente son oficiales y están sujetos a efectos jurídicos y fiscalización.
- "2 - Producción restringida - Datos reales": este tipo hace el envío de datos reales a la base de homologación del eSocial, que serán validados, incluso con los sistemas externos, sin efectos jurídicos.
Esta opción permite realizar la exclusión de datos del medio ambiente de homologación.
Importante
Al cambiar el tipo de entorno, es importante revisar la configuración del motor eSocial (FR000DMEpara que los envíos se transmitan al destino correcto (URL del eDoc o directorio para guardar en disco, dependiendo del tipo de procesamiento).
Tipo de procesamiento
Defina si los archivos XML para las empresas seleccionadas se enviarán a través del servicio web o si los archivos se guardarán en el disco. Dependiendo de la opción seleccionada, el sistema habilitará los campos para la información del servicio web o para la generación de archivos.
En el sistema las opciones son:
- 1 - Enviar a eDocs eSocial;
- 2 - Guardar archivo en disco (Mensajero de terceros).
Al utilizar el tipo de procesamiento "2 – Guardar archivo en disco (Mensajero de terceros)", todas las empresas que se enviarán a eSocial deben registrarse en esta pestaña, indicando un directorio diferente para cada una de ellas en el campo "Directorio de XML". archivos”.
Datos para eDocs
Si en el tipo de procesamiento la opción seleccionada es "1 - Enviar a eDocs eSocial", este grupo queda habilitado y debe ser rellenado.
URL eDocs
Registre la dirección del servicio web definida en eDocs.
La dirección URL predeterminada para este campo debe seguir este formato:http: // servidor: puerto /SDE/
Nota
El nombre SDEdestacado en la URL anterior es fijo y obligatorio, por lo que no debe ser cambiado.
Consulte la documentación del servicio web de integración para obtener información detallada sobre cómo utilizarlo.
Usuario eDocs
Informar al usuario utilizado para conectarse al servicio web eDocs. Es el mismo usuario informado en eDocs (Configuración > Empresa, en la pestaña Integración - Servicio web).
Contraseña eDocs
Ingrese la contraseña utilizada para conectarse al servicio web de eDocs. Es la misma contraseña informada en eDocs (Configuración > Empresa, en la pestaña Integración - Servicio web).
CNPJ / CPF Certificado Digital
Registrar el CNPJ/CPF del certificado digital registrado en eDocs.
Datos para guardar en archivo
Si en el tipo de procesamiento la opción seleccionada es "2 - Guardar Archivo en Disco (Mensajero de Tercer)", este grupo queda habilitado y debe ser rellenado.
Directorio de archivos XML
En este campo se indica el directorio donde el sistema debe almacenar el archivo XML generado. Si este campo no tiene una ubicación seleccionada, el sistema generará los archivos en la carpeta del ejecutable del motor (dentro de la carpeta Vetorh, en el directorio donde está instalado el sistema).
Cuando el motor está configurado para guardar archivos en disco, y hay envíos para el procesamiento, se crean los directorios Proceso \ eSocial y regreso. Los archivos XML que se enviarán al gobierno se almacenarán en el directorio Processar\eSocial. Los archivos de devolución de eDocs se almacenarán en el directorio de devolución, con el prefijo "ESOCIAL" (ejemplo: ESOCIAL_ID1806800930000002017071915194800011.xml).
la Motor eSocial supervisará este directorio, verificando si existen pendencias a generar, ya sea en el envío o por el archivo de retorno del ambiente del Gobierno.
El campo tiene un botón, representado por un icono de lupa, que le permite enumerar y guardar los registros de eSocial Engine de los últimos 45 días. Esto fue pensado para aquellos que no tienen acceso al directorio de registros. También es posible descargar los archivos deseados siempre que el sistema tenga acceso a los archivos de registro. Los archivos se copiarán, comprimirán y se abrirá un cuadro de diálogo para que pueda guardar los archivos.
Importante
Para que el motor pueda crear los directorios es necesario que el usuario tenga los permisos de lectura y escritura en estos lugares para generar los archivos XML.
Uso del motor eSocial
Envío a través de servicios web
Quien utilice el servicio web para integrar la información con eDocs no necesitará generar archivos para guardarlos en disco, ya que la información será enviada por el servicio webConsultar EstadoDocumentos.
Archivos guardados en el disco
generación de archivos XML
Cualquiera que no utilice el servicio web para integrar información con eDocs deberá generar archivos XML en el formato a continuación. Estos archivos deben guardarse en la carpeta "Return" dentro del directorio configurado en Miscellaneous > eSocial Engine Definitions > fieldDirectorio de archivos XML.
| ID | Campo | Padre | Tipo | Incidencia | Descripción |
|---|---|---|---|---|---|
| 0 | EstadoDocumento | 1-1 | Estado del documento electrónico | ||
| 1 | Documento | 0 | 1-1 | Datos de identificación del documento | |
| 1.1 | Documento clave | 1 | Texto | 1-1 | Clave/identificador del documento |
| 2 | Situación | 0 | Número | 1-1 |
Se debe informar el estado del documento. 1 - Autorizado: Debe usarse cuando el gobierno haya procesado la presentación y devuelto el número de recibo del evento. 2 - Rechazada: Debe utilizarse cuando el gobierno tramitó la presentación y devolvió las críticas identificadas en el evento. |
| 3 | ProtocoloAutorización | 0 | Texto | 0-1 | Número de recibo devuelto por el gobierno para el evento. Obligatorio cuando Estado = 1 - Autorizado. |
| 4 | Fecha de autorización | 0 | Fecha | 0-1 | Fecha de autorización devuelta por el gobierno. Obligatorio cuando Estado = 1 - Autorizado. |
| 5 | Mensaje | 0 | Texto | 0-1 | Resumen del estado del evento. Cuando Estado = 2. Ejemplos: a) Contenido de evento no válido; b) Devuelto con errores del Gobierno. |
| 6 | DetallesCrítica | 0 | 0-1 | Generado para eSocial con detalles de rechazo | |
| 6.1 | DetalleCrítica | 5 | 0-N | Generado para eSocial con detalles de rechazo | |
| 6.1.1 | Código | 5.1 | Número | 1-1 | Código del rechazo |
| 6.1.2 | Localización | 5.1 | Texto | 0-1 | Ubicación de la etiqueta del problema |
| 6.1.3 | Mensaje | 5.1 | Texto | 1-1 | mensaje de problema |
Aquí hay un ejemplo deenvío autorizado, es decir, se envió información a través de los layouts y el feedback fue 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>Los siguientes son dos ejemplos deenvíos rechazados, es decir, se envió información a través de los layouts y la devolución fue negativa.
Ejemplo 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>
Ejemplo 2:
<s:Envelope xmlns:s="http://schemas.xmlsoap.org/soap/envelope/"><s:Body><ConsultarSituacaoDocumentosResponse ><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
