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 logs. Esta guía también cubre la instalación por medio del Toolbox Script, actualización y desinstalación.

Instalación con toolbox #

El Clerk Toolbox Script está diseñado para facilitar la instalación de la extensión Clerk en tu tienda Magento sin usar Magento Connect.

El Toolbox Script se ejecutará directamente desde un terminal.

Sugerimos lo siguiente:

- Apple: iTerm, debes descargarlo de Internet;

- Windows: Command Prompt, ya está instalado en tu computadora.

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

Lo que necesitas #

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

Navegar a la carpeta #

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

ssh Stefan@mywebshop.com

2. Se te pedirá que introduzcas la contraseña de tu usuario (el terminal no te dará feedback mientras escribes la contraseña, pero la está registrando igualmente).

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

cd /var/www/html

y escribiendo:

ls

Esto te dará una lista de carpetas para ayudarte a encontrar la correcta:

En la lista de carpetas, busca la carpeta 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.

Instalación de la extensión #

1. Cuando estés en tu Root Folder, 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, utiliza -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á que escribas tu contraseña. Después de 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 #

Desinstalar

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

sudo sh clerk_toolbox_magento2.sh -u

Restaurar

En caso de que ocurra un problema en tu tienda, siempre puedes restaurarla mediante la copia de seguridad que se crea al instalar la extensión.

Utiliza esta línea para hacerlo:

sudo sh clerk_toolbox_magento2.sh -r

Backup

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

sudo sh clerk_toolbox_magento2.sh -b

Configuración en my.clerk.io #

Para acceder y modificar la configuración de datos de Magento 2 en Clerk, dirígete a my.clerk.io, haz clic en “Data” en el menú lateral izquierdo y luego en “Configuration”.

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

Aquí puedes configurar 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 valor predeterminado es “cuando sea necesario”).

Configuración de la extensión #

Si utilizas la v6.7.0 o una versión posterior de la extensión, podrás acceder a la siguiente configuración de dos formas después de añadir tus Public y Private Keys a la extensión:

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

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

No importa dónde realices los cambios, ya que la extensión sincroniza 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.

Simplemente haz clic en “Edit” en cualquier configuración 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, luego sigue la ruta Stores > Settings > Configuration > Clerk > Configuration

General #

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

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

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

Legacy Authentication #

Esta configuración controla si la extensión utiliza autenticación JWT header o el método anterior de clave privada. Es muy recomendable desactivarlo, 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.

Store ID #

Este es un campo de configuración heredado que ya no se utiliza en instalaciones modernas de Clerk.io. Puede ignorarse sin problema, ya que la extensión identifica y maneja automáticamente los alcances de la tienda usando las API nativas de tienda y web de Magento.

Sincronización #

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

Las opciones aparecen atenuadas y no están disponibles para actualizar cuando se utiliza la data del website, lo indicado por la casilla verificada a la derecha de cada sección.

Simplemente desmarca la casilla correspondiente para modificarla.

• Use Real-time Updates: elige “Yes” para habilitar la actualización en tiempo real de tus datos sincronizados con Clerk.

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

• Collect Baskets: para recolectar información de cestas y sincronizarlo con Clerk, selecciona “Yes”.

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

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

Campos adicionales #

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

Search Non-Indexed Attributes #

Al activarlo, Clerk.io realizará una consulta más profunda para obtener valores para atributos personalizados que no estén pre-indizados en la colección estándar de productos de Magento. Esto asegura que se sincronicen todos los campos personalizados solicitados, aunque puede requerir un poco más de recursos de servidor.

Piensa en ello como enviar a un asistente muy educado a rebuscar entre los estantes polvorientos del almacén en lugar de leer la carpeta de la puerta.

Track Returned Orders #

Al habilitar esta opción, la extensión escuchará la creación de credit memos en Magento (reembolsos y devoluciones). Enviará automáticamente la información sobre los productos y cantidades devueltos a Clerk.io para mantener sus recomendaciones y análisis perfectamente precisos.

Image Type #

Este desplegable te permite seleccionar qué tipo de imagen de Magento y dimensiones (por ejemplo, base image, small image o thumbnail) deben enviarse a Clerk.io. Esto es muy útil para ajustar la calidad y relación de aspecto de las imágenes al tema y diseño específicos de tu tienda.

Sincronización de clientes #

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

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

Sync Subscribers #

Al activar esta opción se sincronizan los suscriptores del boletín de tu tienda con Clerk.io.

Para los clientes registrados que también son suscriptores, la extensión actualiza automáticamente su perfil de cliente existente con subscribed: true e incluye su enlace único de desuscripción.

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

Search #

Activa la Search Page de tu tienda eligiendo “Yes” en el desplegable aquí.

• Tras seleccionar “Enabled”, ingresa el nombre de tu Search Page Element, que coincide con el campo data-template encontrado en el código de inserción de tu Element en my.clerk.io. En este ejemplo, search-page.

• Puedes establecer el texto que aparece como " load more" y " no results" escribiendo las frases deseadas en estas cajas 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 con los resultados de productos. Esto ayuda a los clientes a navegar tu tienda más fácilmente mostrando colecciones y categorías relevantes que coincidan con su consulta de búsqueda.

Número de categorías #

Establece el número máximo de resultados de categorías a mostrar en la página de búsqueda. Por ejemplo, si estableces esto en 5, se mostrarán hasta cinco categorías coincidentes, permitiendo a los usuarios saltar 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 blogs, guías o páginas informativas coincidentes (como políticas de devoluciones) junto a productos.

Pages Type #

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

Live search #

• Tras seleccionar “Enabled” en el desplegable para activar Live Search, selecciona si quieres mostrar Categorías dentro de tus resultados de búsqueda.

  • También puedes elegir el número de resultados de suggestions, categories y content a mostrar en Live Search además de los resultados de productos.

• También tienes la opción de elegir qué page types se muestran como resultados de búsqueda, por ejemplo “CMS Pages”, “Blog Posts” o “All”.

• Puedes elegir la posición del desplegable de live search desde tu caja de búsqueda con Dropdown Positioning.

• Luego proporciona el nombre del Element para tu live search, que puedes encontrar junto a data-template en el código embed de tu Live Search en tu elemento my.clerk.io. Probablemente sea live-search.

• Finalmente, tienes la opción de proporcionar tu Live Search Input Selector y Form Selector, que se pueden identificar inspeccionando la caja de búsqueda de tu tienda con tu navegador y localizando el ID o clase asociado con su input y form.

  • En este ejemplo, #search como input selector y usar el website es elegido para identificar el selector del formulario.

Faceted navigation #

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

• Haz clic en los atributos que deseas añadir a tus facetas y haz clic en guardar configuración.

• Una vez añadido, tus atributos aparecerán bajo Titles. En esta sección puedes crear el Título que se mostrará para esa faceta y qué posición tendrá en la lista de facetas.

Facets In Url #

Al habilitarlo, esto añade las facetas de búsqueda seleccionadas (filtros) directamente a los parámetros de la URL del navegador. Así, los clientes pueden marcar, actualizar o compartir sus resultados de búsqueda filtrados con otros, conservando el estado exacto del filtro.

Multiselect Attributes #

Permite seleccionar qué facetas de búsqueda deben soportar la selección de múltiples opciones simultáneamente (por ejemplo, filtrando tanto por “Rojo” como por “Azul”). Esto proporciona una experiencia de filtrado mucho más flexible y amigable.

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

Personalizar facetas #

• Clerk te permite personalizar tus facetas de búsqueda desde el diseño y puedes mostrarlas refiriéndote al id del diseño.

• El design ID se encuentra en el backend de Clerk, en la columna más a la izquierda de cada diseño en la página de resumen de diseños y en la esquina inferior izquierda de la página cuando entras a editar el diseño.

Powerstep y exit intent #

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

• Proporciona el nombre del Element para tu Powerstep, que se encuentra junto a data-template en el embed code del Element correspondiente en my.clerk.io, en este ejemplo power-step-others-also-bought.

• Sigue el mismo proceso anterior para habilitar tu Exit Intent e identificar y añadir el Exit Intent Element correspondiente.

Powerstep Filter Duplicates #

Al activarlo se evita que los productos duplicados sean recomendados en varios sliders dentro de Powerstep. Si un producto ya aparece en un slider, Clerk.io lo filtrará automáticamente de los siguientes sliders de la misma página.

Recommendations #

De forma similar a Search, activa tus ajustes de Product, Category y Cart Page seleccionando “Enabled” en los desplegables correspondientes.

• Igual que en las funcionalidades de Search, puedes encontrar el nombre del element junto a data-template en el código embed en my.clerk.io > Recommendations > Elements.

  • En este ejemplo, hemos habilitado ajustes para Product Page, Category Page y Cart Page, e incluido category-page-popular como nuestro Category Page element, product-page-alternatives y product-page-others-also-bought en Product Page, así como cart-others-also-bought como Category Page element.

Category Filter Duplicates #

Al activar esta opción, se evita que productos duplicados sean recomendados en varios sliders de tus páginas de categoría. Así los clientes ven una gama más diversa de productos en lugar de ver el mismo producto en diferentes apartados.

Product Filter Duplicates #

Al activarlo se evita que productos repetidos aparezcan en varios sliders de tus páginas de producto. Así las recomendaciones se mantienen frescas y se maximizan las posibilidades de captar el interés de los clientes con variedad.

Cart Filter Duplicates #

Al habilitarlo se evita que aparezcan productos duplicados en los sliders de la página del carrito. Esto es muy eficaz para la venta cruzada, garantizando una variedad más atractiva de recomendaciones de última hora.

Al fin y al cabo, si un cliente ya rechazó comprar una tostadora verde neón en el primer slider, mostrársela tres veces más antes del checkout probablemente no cambiará su decisión y puede hacer que dude de la cordura de tu tienda.

Logging #

Lo primero que tienes que hacer para cambiar la configuración de logging es entrar en el backend de Magento2 y elegir Stores => Configuration => Clerk => Configuration:

Busca el desplegable llamado Logging Settings y configura tu preferencia.

Termina haciendo clic en Save:

La configuración de Logging incluye:

Elige nivel de logging

• Only Errors: Registrará solo los errores que impiden que el módulo funcione correctamente.

• Error + Warn: También registra advertencias que no hacen que el módulo deje de funcionar pero que pueden requerir atención.

• Error + Warn + Debug: Registra todo con lo que interactúa el módulo. No debe habilitarse en una tienda en vivo porque enlentecerá el sitio.

Elige dónde registrar los logs

• File: Guardará el log en un archivo en el servidor Magento2.

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

Log File Link #

Muestra la ruta absoluta al archivo de log local en tu servidor Magento (típicamente /var/log/clerk_log.log). Esto facilita para desarrolladores o administradores localizar e inspeccionar los logs crudos al depurar el comportamiento de la extensión.

Actualización #

Si utilizas 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 antigua, sigue esta guía.

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

La actualización de la extensión de Magento 2 se realiza por commandline.

Sigue estos pasos:

1. Inicia sesión en tu servidor por commandline.

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

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

4. Escribe 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 actualización.

Tu Magento 2 ya está actualizado a la versión más reciente.

Desinstalar #

Al igual que cuando instalas extensiones en Magento 2, desinstalar debe hacerse por Command Line.

Simplemente escribe los siguientes comandos, en orden, para eliminarla:

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

2. composer remove clerk/magento2