Extension

Configura los ajustes de tu extensión de Magento 2, gestiona las opciones de sincronización de datos y personaliza las funciones de search, recommendations y registro de actividad. Esta guía también cubre la instalación mediante Toolbox Script, actualización y desinstalación.

Instalación con toolbox #

El Clerk Toolbox Script ha sido creado para facilitar la instalación de la extensión de Clerk en tu tienda web de Magento sin utilizar Magento Connect.

El Toolbox Script se ejecutará directamente desde una terminal.

Sugerimos estos:

- Apple: iTerm, tendrás que descargarlo de Internet;

- Windows: Símbolo del sistema, ya está instalado en tu ordenador.

El script también crea una copia de seguridad de la carpeta Magento2 para que pueda restaurarse si algo sale mal.

Lo que necesitas #

Para instalarlo, necesitas acceso SSH o SFTP a tu tienda web, incluyendo tu Nombre de usuario y Contraseña.

Navegando a la carpeta #

1. Comienza iniciando sesión en tu servidor de Magento a través de una terminal, utilizando tu Nombre de usuario y Dominio así:

ssh Stefan@mywebshop.com

2. Se te pedirá que escribas la contraseña de tu usuario (la terminal no dará ninguna indicación mientras la escribes, pero la está registrando igualmente).

Navega hasta la carpeta raíz de Magento2. Puedes hacerlo escribiendo:

cd /var/www/html

y escribiendo:

ls

El comando ls lista las carpetas para que puedas encontrar tu directorio raíz de Magento.

En la lista de carpetas busca la correcta, en este caso sería magento2.

En este punto, lo que necesitas hacer es entrar en la carpeta, puedes hacerlo escribiendo:

cd NAME_FOLDER

NAME_FOLDER se sustituye por el nombre real de la carpeta.

Instalando la extensión #

1. Cuando estés en tu Carpeta Raíz, necesitas descargar el Toolbox Script con esta línea:

sudo wget https://raw.githubusercontent.com/clerkio/clerk-magento2/master/clerk_toolbox_magento2.sh

2. Después, escribe esta línea para ver una lista de las opciones disponibles dentro del Toolbox:

sh clerk_toolbox_magento2.sh

3. Como quieres instalar la extensión, usarás -i junto con el último número de versión de la extensión. Escribe esta línea:

sudo sh clerk_toolbox_magento2.sh -i

4. Ahora se te pedirá tu contraseña. Tras hacer esto, el script hará una copia de seguridad de tu carpeta Magento2 y comenzará a instalar la extensión:

5. ¡Listo! Ahora la extensión está instalada y puedes configurarla en el backend de Magento2.

Comandos opcionales #

Desinstalación

El Toolbox también te permite desinstalar la extensión. Puedes hacerlo con esta línea:

sudo sh clerk_toolbox_magento2.sh -u

Restauración

Por si acaso algo sale mal en tu tienda web, siempre puedes restaurarla usando la copia de seguridad que se crea al instalar la extensión.

Usa esta línea para hacerlo:

sudo sh clerk_toolbox_magento2.sh -r

Copia de seguridad

Al instalar la extensión, el script siempre creará una copia de seguridad primero, pero también puedes crear una copia independiente con esta línea:

sudo sh clerk_toolbox_magento2.sh -b

Ajustes en my.clerk.io #

Para acceder y modificar los ajustes de datos de tu Magento 2 en Clerk, ve a my.clerk.io, haz clic en “Data” en el menú lateral izquierdo y luego ve a “Configuration”.

Nota: La información sobre la extensión Clerk de Magento 2, disponible a través del portal de administración de Magento, aparece más adelante en este artículo.

Aquí puedes establecer la URL de tu tienda, el tamaño de página de tus sincronizaciones de datos, así como la hora del día en que tus datos deben sincronizarse con Clerk (el ajuste predeterminado es “cuando sea necesario”).

Ajustes de la extensión #

Si usas la v6.7.0 o una versión posterior de la extensión, podrás acceder a los siguientes ajustes de dos formas después de agregar tus Llaves Pública y Privada a la extensión:

• A través del backend de Magento2 en Stores > Settings > Configuration > Clerk > Configuration

• A través de my.clerk.io, en Developers > Extensions

No importa dónde realices los cambios, ya que la extensión sincronizará cualquier cambio hecho en my.clerk.io y viceversa.

En my.clerk.io también podrás ver tu versión actual de la extensión, tu plataforma y la versión de PHP.

Haz clic en Edit en un ajuste para ver las opciones disponibles.

Resumen #

Para acceder a tu extensión Clerk en Magento 2, inicia sesión en el portal de administración de tu tienda web y sigue la ruta Stores > Settings > Configuration > Clerk > Configuration

General #

Encontrarás el número de versión de tu extensión Clerk, así como las claves públicas y privadas de la API de tu tienda en la sección General.

Para incluir Páginas en tu sincronización de datos con Clerk, elige “Yes” en el siguiente desplegable y escribe cualquier campo adicional que quieras incluir con tus datos de página (como imágenes o tipo de página) en valores separados por comas.

También puedes establecer el idioma predeterminado para los datos sincronizados de tu tienda en el último desplegable en General.

Autenticación heredada #

Esta opción controla si la extensión utiliza autenticación JWT en el encabezado o el método antiguo de clave privada. Se recomienda deshabilitarlo, ya que JWT proporciona un flujo de autenticación más seguro y moderno para todas las solicitudes API entre Magento 2 y Clerk.io.

ID de tienda #

Este es un campo de configuración heredado que ya no se utiliza en instalaciones modernas de Clerk.io. Puede ignorarse con seguridad, ya que la extensión identifica y gestiona automáticamente los ámbitos de tienda usando las APIs nativas de tienda y sitio web de Magento.

Sincronización #

En la sección de Synchronization del plugin de Clerk, tienes la opción de personalizar los datos sincronizados de clientes, pedidos, cestas y productos.

Las opciones están atenuadas y no son modificables al usar datos de sitio web, lo que se indica con la casilla marcada a la derecha de cada sección.

Simplemente desmarca la casilla correspondiente para modificar.

• Use Real-time Updates: elige “Yes” para habilitar actualizaciones en tiempo real de los datos sincronizados con Clerk.

Con las actualizaciones en tiempo real activadas, el stock ahora se actualiza después de los pedidos, así como después de guardar productos en el administrador de Magento 2.

• Collect Emails: selecciona “Yes” aquí para sincronizar los emails de clientes.

• Collect Baskets: para recolectar datos de cestas y sincronizar con Clerk, selecciona “Yes” aquí.

• En los dos siguientes desplegables, selecciona “yes” para sincronizar solo productos vendibles, y/o solo sincronizar productos con visibilidad en Clerk.

• Si necesitas desactivar la sincronización de pedidos, puedes hacerlo seleccionando “Yes” en este desplegable.

Campos adicionales #

Una lista separada por comas de atributos adicionales de productos que deseas sincronizar con Clerk.io (por ejemplo, color, size, material). Esto te permite utilizar estos atributos personalizados en tus diseños de recomendaciones de Clerk.io, filtros de búsqueda o campañas de email.

Buscar atributos no indexados #

Al activar esto, Clerk.io realizará una consulta más profunda para obtener valores de atributos personalizados que no han sido preindexados en la colección estándar de productos de Magento. Esto garantiza que todos los campos personalizados solicitados se sincronicen correctamente, aunque puede requerir un poco más de recursos del servidor.

Piénsalo como enviar a un asistente muy educado a rebuscar en los estantes polvorientos del almacén en lugar de solo leer la hoja de control junto a la puerta.

Seguimiento de pedidos devueltos #

Activar esta opción permite que la extensión escuche la creación de notas de crédito en Magento 2. Las notas de crédito sincronizan los cambios de stock y rastrean los artículos devueltos en Clerk.io.

Tipo de imagen #

Este desplegable te permite seleccionar qué tipo y dimensiones de imagen de Magento (como imagen base, imagen pequeña o miniatura) deben enviarse a Clerk.io. Esto es muy útil para igualar la calidad y proporción de la imagen con el tema y diseño específicos de tu tienda.

Sincronización de clientes #

Activa la sincronización de datos de cliente seleccionando “Yes” en el desplegable de esta sección.

Si tienes atributos adicionales de cliente que quieras incluir en la sincronización con Clerk, introdúcelos en el cuadro de texto como una lista separada por comas.

Sincronizar suscriptores #

Activar esta opción sincroniza los suscriptores al boletín de tu tienda con Clerk.io.

Para clientes registrados que también están suscritos al boletín, la extensión actualiza automáticamente su perfil de cliente existente con subscribed: true e incluye su enlace único de baja.

Para suscriptores invitados (que se inscribieron en el boletín pero no tienen una cuenta de cliente registrada), la extensión los sincroniza como perfiles independientes—que en Clerk.io se identifican simplemente por su dirección de correo electrónico—con un prefijo SUB en el ID. Esto asegura que toda tu audiencia de suscriptores quede capturada sin crear perfiles duplicados para clientes registrados. Esto es extremadamente útil para construir audiencias integrales de marketing por email y realizar campañas personalizadas.

Search #

Activa la Search Page de tu tienda seleccionando “Yes” en este desplegable.

• Tras habilitar Search Page, introduce el nombre del Element desde el campo data-template de su código de inserción. Por ejemplo, utiliza search-page si ese es el nombre de tu Element.

• Puedes configurar los textos de " load more" y " no results" escribiendo la frase deseada en estos cuadros de texto.

Incluir categorías #

Al activar esta opción, se incluyen resultados de categorías directamente en tu página principal de búsqueda junto a los resultados de productos. Esto ayuda a los clientes a navegar más fácilmente mostrando colecciones y categorías relevantes que coinciden con la búsqueda.

Número de categorías #

Establece el número máximo de resultados de categoría a mostrar en la página de búsqueda. Por ejemplo, configurarlo en 5 mostrará hasta cinco categorías coincidentes, permitiendo que los usuarios accedan rápidamente a secciones relevantes de tu catálogo.

Número de páginas #

Establece el número máximo de resultados de páginas CMS o de contenido a mostrar en la página de búsqueda. Esto es ideal para mostrar publicaciones de blog, guías o páginas informativas (como políticas de devolución) junto a los productos.

Tipo de páginas #

Filtra los tipos de páginas CMS o de contenido que deben mostrarse en los resultados de búsqueda. Puedes elegir mostrar solo páginas CMS estándar, entradas de blog específicas o todas las páginas de contenido sincronizadas con Clerk.io.

Búsqueda en vivo #

• Después de seleccionar “Enabled” en el desplegable para activar la búsqueda en vivo (Live Search), selecciona si deseas mostrar Categorías dentro de los resultados de búsqueda.

  • También puedes seleccionar la cantidad de resultados de sugerencias, categorías y contenido para mostrar en la Búsqueda en Vivo, además de los resultados de productos.

• También tienes la opción de elegir qué tipos de páginas mostrar como resultados de búsqueda, por ejemplo “CMS Pages”, “Blog Posts” o “All”.

• Puedes elegir la posición del desplegable de búsqueda en vivo desde tu campo de búsqueda con Dropdown Positioning.

• Proporciona el nombre del Element para tu búsqueda en vivo, que se encuentra junto a data-template en el código de inserción de Live Search dentro de tu Element en my.clerk.io. Probablemente será live-search.

• Por último, tienes la opción de indicar tu Live Search Input Selector y Form Selector, que puedes encontrar inspeccionando el campo de búsqueda de tu tienda con tu navegador, identificando el ID o clase asociado a su input y formulario.

  • Para un input con ID search, utiliza #search como selector de input. Elige la opción adecuada de selector de formulario para tu tienda.

Navegación facetada #

Para agregar facetas a tu Search Page, primero asegúrate de seleccionar la casilla “Enabled” bajo Faceted Navigation.

• Haz clic en los atributos que desees agregar a tus facetas y guarda la configuración.

• Una vez añadidos, aparecerán bajo Titles. En esta sección puedes crear el título a mostrar para esa faceta y la posición en la lista de facetas donde quieres que aparezca ese atributo.

Facetas en la URL #

Al habilitar esto, se agregan las facetas de búsqueda seleccionadas directamente a los parámetros de consulta de la URL del navegador. Esto permite que los clientes puedan guardar en marcadores, refrescar o compartir sus resultados filtrados conservando el estado exacto del filtro.

Atributos multiselección #

Permite seleccionar qué facetas de búsqueda admitirán la selección de múltiples opciones simultáneamente (como filtrar por “Rojo” y “Azul”). Esto proporciona una experiencia de filtrado más flexible y cómoda.

Nota: Ahora puedes solicitar los datos de categorías y páginas en tu Search page de la misma forma que en la Live search, dándote un rango más amplio de información para captar a tus clientes. Para más información puedes consultar aquí.

Personalización de facetas #

• Clerk permite personalizar el estilo de las facetas de búsqueda desde el diseño y puedes mostrarlo haciendo referencia al campo de ID de diseño.

• El ID de diseño se encuentra en el backend de Clerk, en la columna izquierda de cada diseño en la vista general de diseños y en la esquina inferior izquierda de la página una vez que entras en el diseño para editar.

Powerstep y exit intent #

Al igual que Search, activa tu Clerk Powerstep seleccionando “Yes” en el desplegable, luego elige el tipo de powerstep que quieres que aparezca (Page o Popup).

• Introduce el nombre del Element de Powerstep desde el campo data-template del código de inserción. Por ejemplo, usa power-step-others-also-bought si ese es el nombre de tu Element.

• Sigue el mismo proceso para habilitar tu Exit Intent, e identificar y agregar el Element de Exit Intent correspondiente.

Filtrar duplicados en Powerstep #

Al activar esta función se evitan productos duplicados en las recomendaciones de diferentes sliders dentro del Powerstep. Si un producto ya se muestra en un slider, Clerk.io lo filtrará automáticamente de los siguientes sliders en la misma página.

Recommendations #

De forma similar a Search, habilita los ajustes de página de producto, categoría y carrito de Clerk seleccionando “Enabled” en los desplegables correspondientes.

• Como con las funcionalidades de Search, puedes encontrar el nombre del elemento junto a data-template en el código de inserción dentro de my.clerk.io > Recommendations > Elements.

  • Por ejemplo, puedes habilitar los ajustes de Category, Product y Cart Page y asignar category-page-popular, product-page-alternatives, product-page-others-also-bought y cart-others-also-bought a sus respectivas páginas.

Filtrar duplicados en categoría #

Activar esto evita productos duplicados en las recomendaciones de diferentes sliders en las páginas de categoría. Así los clientes ven una variedad de productos en vez de que se repita el mismo en diferentes secciones.

Filtrar duplicados en producto #

Activar esto evita productos duplicados en las recomendaciones de diferentes sliders en la página de detalle del producto. Así mantienes tus recomendaciones frescas y aumentas la posibilidad de captar el interés del cliente con distintos artículos.

Filtrar duplicados en carrito #

Activar esto evita productos duplicados en las recomendaciones de diferentes sliders en la página del carrito. Esto es muy efectivo para ventas cruzadas, pues garantiza una variedad más amplia y atractiva de sugerencias de última hora.

Después de todo, si un cliente ya ha decidido no comprar una tostadora verde neón en el primer slider, mostrarla tres veces más antes de pagar difícilmente cambiará de opinión, y podría hacerle cuestionar la cordura de tu tienda.

Registro de actividad #

Para cambiar los ajustes de registro, abre Stores > Configuration > Clerk > Configuration en el backend de Magento 2.

Busca el desplegable Logging Settings y configura tu opción preferida.

Haz clic en Save para aplicar los cambios.

Los ajustes de Logging incluyen:

Elige el nivel de registro

• Solo errores: Registrará solo los errores que impidan el funcionamiento correcto del módulo.

• Error + Warn: También registra advertencias que no hacen que el módulo deje de funcionar, pero podrían requerir ser solucionadas.

• Error + Warn + Debug: Registra todo lo que el módulo procesa. Esto no debe activarse en una tienda web en producción, ya que ralentizará el sitio.

Elige dónde registrar

• Archivo: Guardará el registro en un archivo en el servidor Magento2.

• my.clerk.io: Registrará todo en Developers->Logs en el backend de my.clerk.io.

Enlace de archivo de registro #

Muestra la ruta absoluta al archivo local de registro en tu servidor Magento (por lo general /var/log/clerk_log.log). Esto facilita a desarrolladores o administradores localizar e inspeccionar los archivos de registro al depurar el comportamiento de la extensión.

Actualización #

Si estás usando una versión anterior a la 3.0.0, la actualización romperá tus Designs, ya que se usará Clerk.js 2. Si usas una versión más antigua, sigue esta guía en su lugar.

Importante: Recuerda hacer copias de seguridad de cualquier archivo modificado, ya que serán sobrescritos.

La actualización de la extensión de Magento 2 se realiza por línea de comandos.

Se hace siguiendo estos pasos:

1. Accede a tu servidor a través de línea de comandos.

2. Navega a la carpeta raíz de tu sitio web (por lo general " /var/www/your_domain/public_html")

3. Habilita Root Access escribiendo su y luego tu contraseña.

4. Introduce los siguientes comandos en orden:

   composer update clerk/magento2

   php bin/magento setup:upgrade

   php bin/magento setup:di:compile

5. Espera a que termine la extensión.

Tu Magento 2 ahora está actualizado a la última versión.

Desinstalación #

Al igual que cuando instalas extensiones en Magento 2, la desinstalación debe hacerse a través de Command Line.

Simplemente introduce los siguientes comandos en orden para eliminarla:

1. php bin/magento setup:module:disable Clerk_Clerk

2. composer remove clerk/magento2