Documentation
Feedback
Guides
VTEX IO Apps

VTEX IO Apps
Integrador empathy
Community extension
Version: 0.1.3
Latest version: 0.1.3

Integración de catalogo hacia empathy.

Tabla de contenidos

Características

  • 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

Instalación y configuración inicial

  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

    {"base64":"  ","img":{"width":1681,"height":304,"type":"png","mime":"image/png","wUnits":"px","hUnits":"px","length":14094,"url":"https://empathymx.vteximg.com.br/arquivos/localizacion-afiliaciones.png"}}

    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.

    {"base64":"  ","img":{"width":335,"height":551,"type":"png","mime":"image/png","wUnits":"px","hUnits":"px","length":8908,"url":"https://empathymx.vteximg.com.br/arquivos/Configuracion-afiliacion.png"}}

    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"

    {"base64":"  ","img":{"width":279,"height":747,"type":"png","mime":"image/png","wUnits":"px","hUnits":"px","length":11305,"url":"https://empathymx.vteximg.com.br/arquivos/empathy-location.png"}}

    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. Este proceso es exhaustivo y puede tardar varias horas dependiendo del tamaño del catálogo. Solo puede ejecutarse una vez cada hora.
    • 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.

Automatización de actualizaciones

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.

Regionalización

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.

Consideraciones

  • 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

See also
VTEX App Store
VTEX IO Apps
Was this helpful?