Integración de catalogo hacia empathy.

• Características
• Instalación y configuración inicial
• Automatización de actualizaciones
• Regionalización
• Retención y limpieza de registros
• Limpieza de productos inactivos
• Consideraciones

• Indexación completa del catalogo
• Recepción de cambios de productos, precios e inventario
• Actualización automática programable
• Búsquedas regionalizadas por white label

1. instala la app the con el comando vtex install empathymx.empathy-feed-connector-mr en tu cuenta de vtex, o accediendo a http://{nombre de la cuenta}.myvtex.com/admin/apps/empathymx.empathy-feed-connector-mr/setup y dar click en instalar

2. espera 5 min a que finalice la instalación y entra a "Configuración de la tienda > pedidos/configuración" e ingresa en el panel afiliados

   

   Al ingresar se le da click a nuevo afiliado y en el panel se añade la información requerida, para el "Endpoint de busca" se debe añadir la siguiente ruta remplazando nombre de la cuenta por el propio: https://{nombre de la cuenta}.myvtex.com/_v/empathy/skuUpdate, en version de endpoint de búsqueda dejar seleccionado 1.x.x, y se deja desmarcado utilizar mi medio de pago; los demás campos se pueden llenar a conformidad del usuario.

   

   Finalmente se le da en guardar, con esto se activa la recepción de las actualizaciones de los productos, asi como de su inventario y precios.

3. Posterior a esto accede al panel de administración desde el menu en la sección "Catalogo", ingresando a "Conector Empathy"

   

   En en la sección "Configuración de Empathy" seleccionas editar configuración, en este se selecciona el ambiente de empathy, staging si se encuentra en desarrollo o producción si se quiere enviar directamente al ambiente productivo de empathy, también agregan las credenciales compartidas por el equipo de Empathy para su api, y el "instance ID" con el que se va a usar el buscador, este se puede encontrar en el play-board de empathy al ingresar a "Instance Management" en la esquina superior derecha, finalmente se le da en guardar cambios para mantener la configuración.

4. Para enviar un cargue inicial de todos los productos, al final de la pagina de la aplicación se encuentra la sección "Forzar acciones", que incluye los siguientes botones:

   • Sincronizar todo el catálogo: Vuelve a leer la información desde las fuentes externas y actualiza el buscador desde cero. Es un proceso exhaustivo y puede tardar varias horas dependiendo del tamaño del catálogo; puedes cerrar la página mientras se ejecuta, porque continúa por su cuenta. Podrás iniciar una nueva sincronización cuando la actual termine.
   • Publicar cambios actuales: Envía la información que ya está procesada en la base de datos directamente al buscador. Es un proceso rápido para reflejar cambios inmediatos.
   • Detener actualización en curso: Interrumpe un proceso de sincronización total activo. Este botón solo aparece cuando hay una sincronización en ejecución.

   Mientras se ejecuta la sincronización, la aplicación muestra el progreso en tiempo real indicando el estado actual y la cantidad de elementos procesados. Al finalizar, se muestra la fecha de inicio y fin de la última sincronización.

   Al comenzar, la sincronización aparece como "Preparando sincronización" mientras se revisa todo el catálogo. En catálogos grandes esta etapa puede tardar varios minutos sin mostrar avance; es normal y no requiere ninguna acción.

   Si una sincronización se queda detenida, se cancela sola después de unos 15 minutos y podrás iniciar una nueva. No necesitas hacer nada para desbloquearla.

Para mantener actualizados los datos de búsqueda en Empathy puedes activar el envió automático de información, para esto en la sección de configuración de "actualizaciones automáticas" puedes hacer clic en el botón "Editar Configuración" y habilitar la actualización automática, seleccionas la periodicidad de las actualizaciones (el mínimo es cada 5 minutos), y seleccionar la cantidad de reintentos en caso de suceder un fallo al actualizar, después de esto puedes guardar la configuración, con esto se habilitara las actualizaciones automáticas.

El buscador cuenta con la funcionalidad de regionalización, para esto es importante considerar que solo funciona con tiendas cuya regionalización se basa en el uso de whitelabels y cada cobertura solo es atendida por un white label, es decir que solo puede haber una franquicia vendiendo para cada zona determinada por su estrategia logística, si cumple con lo anterior puedes seguir los siguientes pasos para habilitarlo:

1. Realizar los pasos 1 y 2 de Instalación y configuración inicial, pero esta vez en cada uno de los ambientes de whitelabel, en el paso 2 es importante tener en cuenta que el "Endpoint de busca" también debe dirigir a al whitelabel en el que se este configurando.

2. En tu ambiente principal ingresa a la "Configuración de Empathy" y activa "Habilitar regionalización" y guarda los cambios.

3. Finalmente se puede ejecutar "Sincronizar todo el catálogo" desde el ambiente principal para actualizar los datos en empathy con las variaciones de cada white label.

La aplicación guarda registros de operación en Master Data: la bitácora de auditoría (una entrada por operación) y los trabajos de indexación completa. Estos documentos se acumulan con el tiempo y Master Data se cobra por documento almacenado, por lo que la aplicación los elimina automáticamente cuando superan el periodo de retención configurado.

Configuración: en http://{nombre de la cuenta}.myvtex.com/admin/apps/empathymx.empathy-feed-connector-mr/setup encontrarás el campo "log retention (months)", que define cuántos meses se conservan los registros antes de eliminarse.

• Si no se configura ningún valor, se usan 2 meses por defecto.
• El mínimo es 1 mes: cualquier valor menor se ajusta automáticamente a 1. Este límite protege los datos que necesitan los procesos de indexación externa y de cancelación, que dependen de registros recientes.

Programación: la limpieza se ejecuta todos los días a las 00:00 (hora UTC). La tarea se registra por sí sola al instalar la aplicación y cada vez que se guarda la configuración, y solo se registra en el ambiente master, ya que Master Data es compartido por toda la cuenta. Si la tarea ya existe, no se vuelve a crear ni se modifica.

Consideraciones de la limpieza:

• La eliminación es irreversible. Si necesitas conservar la bitácora por más tiempo para efectos de auditoría, aumenta el periodo de retención antes de que se ejecute la siguiente limpieza.
• La primera ejecución puede no alcanzar a eliminar todo el historial acumulado en una sola corrida; el proceso continúa en las ejecuciones siguientes hasta terminar.
• Un trabajo de indexación que aún esté en curso nunca se elimina.

Además de los registros de operación, la aplicación guarda un documento por cada producto que envía a Empathy. Con el tiempo se acumulan productos que ya no le sirven a nadie y que se siguen cobrando. La aplicación los elimina automáticamente en dos casos.

Productos inactivos antiguos. Un producto que lleva mucho tiempo desactivado ya fue reportado como inactivo a Empathy y no volverá a aparecer en las búsquedas, así que su documento se elimina. Solo se consideran productos que ya están marcados como inactivos: un producto activo nunca se elimina, sin importar cuánto tiempo lleve sin cambios.

Productos de white labels dados de baja. Cuando desactivas un white label, o cuando desactivas la regionalización por completo, los productos de esos white labels quedan huérfanos: nada volverá a actualizarlos y ninguna sincronización volverá a tocarlos. Antes de eliminarlos, la aplicación los marca como inactivos y no visibles y envía esa información a Empathy, de modo que dejen de aparecer en las búsquedas. Solo después de que Empathy confirma la recepción se eliminan los documentos. Los productos de tu catálogo principal nunca se ven afectados.

Configuración: en http://{nombre de la cuenta}.myvtex.com/admin/apps/empathymx.empathy-feed-connector-mr/setup encontrarás el campo "inactive product retention (months)", que define cuántos meses se conserva un producto inactivo antes de eliminarse.

• Si no se configura ningún valor, se usan 2 meses por defecto.
• El mínimo es 1 mes: cualquier valor menor se ajusta automáticamente a 1.
• Este valor es independiente del de retención de registros: cambiar uno no afecta al otro.

Cuándo se ejecuta:

• Junto con la limpieza diaria de registros, a las 00:00 (hora UTC).
• Al guardar la configuración desactivando "Habilitar regionalización", para retirar de las búsquedas los productos de white label que quedaron sin uso.

Consideraciones de la limpieza:

• La eliminación es irreversible. Para recuperar un producto eliminado hay que ejecutar "Sincronizar todo el catálogo".
• Si necesitas conservar los productos inactivos por más tiempo, aumenta el periodo de retención antes de la siguiente limpieza.
• Una sola ejecución puede no alcanzar a procesar todo el historial acumulado; el proceso continúa por sí solo hasta terminar.
• Mientras una limpieza está en curso, una nueva solicitud del mismo tipo no inicia otra en paralelo.

• Las actualizaciones pueden tener cierta demora en verse reflejadas en las búsquedas usando empathy, esto depende de la periodicidad configurada para la actualización automática y del tipo de cambio, los cambios en inventario pueden demorar hasta 5 minutos, mientras que las actualizaciones de precio o información propia del producto puede demorar de 5 a 15 minutos.

• En caso de realizarse actualizaciones masivas del catálogo de vtex, como por ejemplo por medio de archivo, se recomienda hacer uso de "Sincronizar todo el catálogo" desde el panel de la aplicación.

• La sincronización completa puede demorar alrededor de 2 minutos por cada 1000 SKU's.

• La integración puede empezar a perder actualizaciones si se registran mas de 2000 actualizaciones en vtex en menos de un minuto, esto incluye cambios en el inventario, en los precios o en la propia información de los SKU's