Definiciones del Motor eSocial
Atención
Esta documentación se aplica sólo al módulo: AP.
El motor eSocial es responsable de montar los archivos XML después de la generación de las informaciones en la Gestión de Personas.
Al cambiar el tipo de entorno en la pantalla de Configuración de eSocial (FR030DESes importante revisar la configuración del motor eSocial en esta pantalla para que los envíos se transmiten al destino correcto (URL del eDoc o directorio para guardar en disco, dependiendo del tipo de procesamiento).
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
La guía general es obligatorio, las configuraciones informadas en esta guí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 Procesamiento
Defina si la información para el eSocial será enviada por web service o por archivos XML guardados en disco. Dependiendo de la opción seleccionada, el sistema habilitará los campos para información del servicio web o para la generación del archivo.
En el sistema las opciones son:
- 1 - Enviar a eDocs eSocial;
- 2 - Guardar archivo en disco (mensajero de tercero).
Al utilizar el tipo de procesamiento "2 - Guardar Archivo en Disco (Mensajero de Tercero)", todas las empresas que se envíen al eSocial deberán ser registradas en la pestaña "Empresa", pues será necesario indicar un directorio diferente para cada una de ellas.
Observación
Recomendamos el uso de la opción "1 - Enviar a eDocs eSocial" para clientes que utilicen el producto. eDocs. Esta opción no requiere configuración de Middleware o GlassFish y presenta 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 se habilita independientemente del tipo de generación de XML y se debe rellenar.
Generar archivos de registro
Si el motor debe guardar los registros o no.
Directorio de archivos de registro
Defina el directorio donde se generarán los registros si la opción para generar el registro es "1 - Sí".
Si no se informa de una ruta para la generación del registro se genera en la carpeta del ejecutable del motor (dentro de la carpeta Vetorh, en el directorio donde está instalado el sistema).
Tamaño del lote
Introduzca la cantidad de archivos que se enviar por lote a eDocs. El tamaño del lote informado debe estar entre 100 y 5000.
Tiempo máximo de ejecución
Defina el tiempo máximo que el servicio web de integración debe llevar para procesar una solicitud con el cliente. eDocs. El tiempo máximo de ejecución del lote informado debe estar entre 60 y 360 minutos.
Tiempo Verificación Pendientes
Introduzca el intervalo de tiempo para que el sistema genere nuevo archivo XML. El tiempo de verificación de las pendencias informado debe estar entre 1 y 120 minutos.
Guía Empresa
La ficha Empresa quedará habilitada después de registrar la información en la ficha General, en esta guía se registra la información específica del motor para una determinada empresa, es decir, las empresas parametrizadas en esta ubicación pueden generar el archivo XML de forma diferente a la parametrizada en la ficha General. Si se realizan ajustes en esta guía, prevalecerán sobre las de la guía General.
Si hay más de una empresa registrada en eDocs, la ficha Empresa debe configurarse obligatoriamente para cada una de ellas. Esto es porque cada empresa posee su certificado digital, así como los datos de usuario y contraseña.
Empresa
Seleccione la empresa que necesita que el archivo XML se genere de forma diferente a la registrada en la ficha 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 Procesamiento
Defina si los archivos XML para las empresas seleccionadas se enviar por servicio web o si los archivos se guardarán en el disco. Dependiendo de la opción seleccionada, el sistema habilitará los campos para información del servicio web o para la generación del archivo.
En el sistema las opciones son:
- 1 - Enviar a eDocs eSocial;
- 2 - Guardar archivo en disco (mensajero de tercero).
Al utilizar el tipo de procesamiento "2 - Guardar Archivo en Disco (Mensajero de Tercer)", todas las empresas que se enviarán a eSocial deberán ser registradas en esta guía, indicando un directorio diferente para cada una de ellas en el campo "Directorio de los Archivos XML" .
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.
Utilizando el motor eSocial
Envío por web services
¿Quién utiliza el servicio web para integrar la información con eDocs, no necesitará generar archivos para guardarlos en disco, porque la información será enviada por el servicio web ConsultarSituacaoDocumentos.
Archivos guardados en disco
Generación de archivos XML
¿Quién no utiliza el servicio web para integrar la información con eDocs, tendrá que generar los archivos XML en el siguiente formato. Estos archivos se deben guardar en la carpeta "Retorno" dentro del directorio configurado en Varios> Ajustes Motor eSocial> campo Directorio de archivos XML.
| ID | Campo | Padre | Tipo | Incidencia | Descripción |
|---|---|---|---|---|---|
| 0 | SitucaoDocumento | 1-1 | Situación de documento electrónico | ||
| 1 | Documento | 0 | 1-1 | Datos de identificación del documento | |
| 1.1 | ChaveDocumento | 1 | Texto | 1-1 | Clave / Identificador del documento |
| 2 | situación | 0 | Número | 1-1 |
Se informará de la situación del documento. 1 - Autorizado: Debe ser utilizado cuando el gobierno procesó el envío y retornó el número de recibo del evento. 2 - Rechazado: Debe ser utilizando cuando el gobierno procesó el envío y retornó críticas identificadas en el evento. |
| 3 | ProtocoloAutorizacao | 0 | Texto | 0-1 | Número de recibo devuelto por el gobierno para el evento. - Obligatorio cuando Situación = 1 - Autorizado. |
| 4 | Mensaje | 0 | Texto | 0-1 | Resumen de la situación del evento. Cuando Situación = 2. Ejemplos: a) Contenido del evento inválido; b) Retornado con errores del Gobierno. |
| 5 | DetalhesCritica | 0 | 0-1 | Generado para eSocial con detalles del rechazo | |
| 5.1 | DetalheCritica | 5 | 0 N | Generado para eSocial con detalles del rechazo | |
| 5.1.1 | Código | 5.1 | Número | 1-1 | Código del rechazo |
| 5.1.2 | Ubicación | 5.1 | Texto | 0-1 | Ubicación de la etiqueta con problema |
| 5.1.3 | Mensaje | 5.1 | Texto | 1-1 | Mensaje del problema |
Sigue un ejemplo de envío autorizado, es decir, informaciones fueron enviadas a través de los leiautes y el retorno fue positivo:
<? xml version = "1.0" encoding = "utf-8"?>
<SituaciónDocumento xmlns: ds = "http://www.w3.org/2000/09/xmldsig#">>
<Documento>
<ChaveDocumento> ID1806800930000002017071917133100001 </ ChaveDocumento>
</ Documento>
<Situación> 1 </ Situación>
<ProtocoloAutorizacao> 1.2.0000000000000011124 </ ProtocoloAutorizacao>
</ SituacaoDocumento>
A continuación, siguen dos ejemplos de envíos rechazados, es decir, informaciones fueron enviadas a través de los leiautes y el retorno fue negativo.
Ejemplo 1:
<? xml version = "1.0" encoding = "utf-8"?>
<SituaciónDocumento xmlns: ds = "http://www.w3.org/2000/09/xmldsig#">>
<Documento>
<ChaveDocumento> ID1806800930000002017071917133100001 </ ChaveDocumento>
</ Documento>
<Situación> 2 </ Situación>
<Código> 401 </ code>
<DetalhesCritica>
<DetalheCritica>
<Código> 537 </ code>
<Mensaje> Ya existe en el sistema registro con mismo código de identificación (clave) en período de vigencia conflictivo con el período informado en el registro actual.
Acción Sugerida: El evento sólo se puede recibir si no existe otro evento para la tabla con el mismo código de identificación (clave) en período de vigencia conflictivo con el período informado en el evento actual.
Asegúrese de que el código de identificación y los períodos informados son correctos. </ Mensajes>
<Localizacion />
</ DetalheCritica>
</ DetalhesCritica>
</ SituacaoDocumento>
Ejemplo 2:
<s: Sobre xmlns: s = "http://schemas.xmlsoap.org/soap/envelope/">
<S: Cuerpo>
<ConsultarSituaciónDocumentosResponse>
<ConsultarSituaciónDocumentosResult xmlns: a = "http://schemas.microsoft.com/2003/10/Serialization/Arrays" xmlns: i = "http://www.w3.org/2001/XMLSchema-instance">
<a: anyType i: type = "SituaciónDocumento">
<Documento>
<ChaveDocumento> ID1123456780000002017071115003800010 </ ChaveDocumento>
</ Documento>
<Situación> 2 </ Situación>
<DetalhesCritica>
<DetalheCritica>
<Código> 537 </ code>
<Localizacao> Pruebas </ location>
<Mensaje> Ya existe en el sistema registro con mismo código de identificación (clave) en período de vigencia conflictivo con el período informado en el registro actual.
Acción Sugerida: El evento sólo se puede recibir si no existe otro evento para la tabla con el mismo código de identificación (clave) en período de vigencia conflictivo con el período informado en el evento actual.
Asegúrese de que el código de identificación y los períodos informados son correctos. </ Mensajes>
</ DetalheCritica>
<DetalheCritica>
<Código> 986 </ code>
<Mensaje> AAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAA.
Acción Sugerida: El evento sólo se puede recibir si no existe otro evento para la tabla con el mismo código de identificación (clave) en período de vigencia conflictivo con el período informado en el evento actual.
Asegúrese de que el código de identificación y los períodos informados son correctos. </ Mensajes>
</ DetalheCritica>
</ DetalhesCritica>
</ A: anyType>
</ ConsultarSituacaoDocumentosResult>
</ ConsultarSituacaoDocumentosResponse>
</ S: Cuerpo>
</ S: Envelope>
English
Español
