Esta documentación tiene como objetivo mostrar el proceso de integración de Informaciones de empleado e Imagen y Registros con SAP. Actualmente la integración sigue este Flujo:
Premisas de la integración:
- SAP debe suministrar API para integrar empleados e imágenes. El cliente debe entrar en contacto con SAP para verificar, pues no tiene una integración estándar con SAP.
- El Web Service de SAP debe estar accesible remotamente en la infraestructura del cliente. Usualmente el puerto HTTP (80, 8080, etc.) debe estar abierto para ser accesible por la plataforma Carol.
- La Firma del Web Service debe seguir la especificación de API REST integrada por el Clockin (request/parámetros y response/formato JSON - en el ítem que está más abajo JSON modelo para integración de empleado e imagen del SAP).
- Para la integración de registros con SAP es posible por medio de tres procesos:
- Importación manual de AFD para SAP: consiste en la generación de AFD (Archivo de Fuente de Datos) del layout estándar, de acuerdo con la legislación resolución 1510, por el proceso de generación programado en agenda del Clockin e importación por medio del proceso de reloj registrador de SAP.
- El conjunto de archivos AFD se genera en el Storage del Google y para tener acceso al archivo es necesario que se realice el download de este. No existe un proceso automático en el producto estándar para download en directorio especificado por el cliente. Después de la acción del usuario para el download del archivo, este puede importarse por el Proceso de importación de SAP.
- Automatización por medio de download de los archivos AFD: el cliente puede adquirir el personalizado para permitir efectuar el download de los archivos AFD del Storage del Google, generados para cada dispositivo, más rápidamente. El objetivo es permitir que los archivos se descarguen en un directorio de red, informado de acuerdo con el parámetro. A continuación es necesario configurar la rutina del SAP para la lectura/importación periódica de los archivos. Para más informaciones entre en contacto por medio de ticket con la Fábrica TOTVS.
- Integración vía API del Clockin: consiste en la integración automática de registros vía consumo de API REST Clockin que se encuentra disponible de acuerdo con la documentación que se encuentra aquí. El cliente debe solicitar a SAP el suministro del servicio para el consumo de API REST Clockin.
Connector:
Tiene por objetivo buscar los datos de empleados y fotos de SAP (API Success Factors - HR). Para ello es necesario que el Connector esté actualizado en el entorno junto con el mapeo estándar. En la implantación se pondrá a disposición el conector y los mapeos estándar para la integración.
Data Pipeline:
Muestra cómo la información llega al Conector SAP y se aplica el merge (proceso donde ocurre la unión de informaciones recibidas de SAP para que sea posible actualizar en los Data Models del Clockin) hasta llegar al Data Model Employee e Image. Esta información es posible visualizar por medio del Data Journey (primera opción del Menú de Carol, en la parte superior izquierda).
- FOTOS: Recibidas por Staging area (tabla que recibe informaciones fidedignas del origen) SAP_PHOTO coon mapeo para el Data Model IMAGE.
- EMPLEADOS: Recibidos por Staging area (tabla que recibe informaciones fidedignas del origen) SAP_EMPLOYEE pasando por el ETL (tipo de fecha integración utilizado para combinar datos - extraer, transformar, cargar) de duplicación con las siguientes Stagings áreas de salidas:
- EMPLOYEE_LK: Disponible para mapear con Data Model USER, si fuera necesario.
- EMPLOYEE: Mapeo con Data Model EMPLOYEE.
Settings:
Permite realizar la configuración de la integración SAP por medio del Settings de Carol. Para que suceda la integración de las informaciones con Carol es necesario informar los siguientes campos:
País/Empresas → countrycompanies
Informar el país y empresas que deben sincronizarse. La propiedad específica el país, el array especifica la lista de empresas. Ejemplo: {"GTM":["GT01", "GT02"],"NIC":["NI01", "NI02"],"MEX":["MX01", "MX02"]}
API Empleados → employeeapi
URL de la API para obtener los datos de los empleados.
Valor default para los parámetros:
pagesize (top) = 10.000
offset (skip) = 0
Sync Empleados → employeesync
Filtro para buscar empleados que deben ser sincronizados para Carol (Sí/No)
API Fotos → photoapi
URL de la API para obtener las fotos de los empleados.
Fecha / Hora Última modificación de los empleados → lastdatemodified
Parámetro que indicará cuál es el valor de la última sincronización por pais.
Si estuviera en blanco, inicia una sincronización completa.
Carol App va a actualizar la última sincronización efectuada por país en esta configuración, de acuerdo con la siguiente estructura.
Ejemplo de formateo: {"MEX":"2020-11-27T01:01:13.730042","NIC":"2020-11-27T01:01:23.571120","GTM":"2020-11-27T01:10:17.284987"}
Sync Fotos → photosync
Sync Fotos para Carol (Sí/No)
Sysclock → sysclock
Filtro para para buscar empleados que deben ser sincronizados para Carol. Valor 1 = Sí.
Page Size → pagesize
Parám TOP para a API Empleados.
API Token → tokenapi
URL de la API para generación del token de autenticación (OAuth 2.0 - Basic Authentication).
Usuario → tokenapiuser
Usuario para la API de autenticación.
Contraseña → tokenapipassword
Contraseña para la API de autenticación.
Proceso:
SapIntegrationApp - Proceso batch de TOTVS RRHH Clock-in con los siguientes comportamientos de acuerdo con los datos recibidos:
- Fotos: tiene como objetivo realizar la búsqueda de fotos realizando la integración con SAP en la URL del campo API Fotos informada en Settings A partir de una fecha de corte se receben 100 registros por request (página) hasta alcanzar la última página (sin registro).
- Empleados: tiene como objetivo la búsqueda de empleados realizando la integración con SAP en la URL del campo API Empleados. De acuerdo con la estructura pasada en el parámetro País/Empresas se efectúa una requisición por país y sin paginación, es decir, todos los registros de acuerdo con el filtro pasado.
Web Service SAP
Para que la integración de empleados e imágenes de los empleados pueda ocurrir entre SAP y Carol, es necesario que SAP ponga a disposición APIS de integración de empleados e imágenes. A continuación se muestra cómo el Connector de SAP está configurado para recibir informaciones de SAP por medio de los mapeos de datos,
Mapeo de datos
El Mapeo de datos tiene como objetivo permitir el de-a de informaciones para que estas se transfieran de SAP a Clockin. El mapeo se actualiza en el momento de la implantación. De esta manera estas informaciones servirán para saber qué informaciones deben considerarse en la api de integración que debe ser puesta a disposición por SAP para la integración con Clockin. A continuación se muestra el mapeo estándar de Conector Employee para DM Employee para la integración con Clockin:
También se muestra el mapeo del Conector sap_photo para DM Image para la integración con Clockin:
JSON modelo para integración de empleado e imagen de SAP:
Para realizar la integración de informaciones con Clockin es necesario seguir el modelo del JSON informado a continuación:
TOTVS Clock-in x SAP.postman_collection.json