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 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 estos:

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

- Windows: Símbolo del sistema, ya viene instalado en tu computadora.

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

Qué 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 Magento a través de un 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 (el terminal no mostrará ningún 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 ingresar a la carpeta, lo puedes hacer 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. Luego, escribe esta línea para ver una lista de las opciones disponibles dentro del Toolbox:

sh clerk_toolbox_magento2.sh

3. Como deseas instalar la extensión, utilizarás -i junto con el número de versión más reciente 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 hacerlo, 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 desde 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 algo salga mal en tu tienda, siempre puedes restaurarla mediante 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 de seguridad 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 ve a “Configuration”.

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

Aquí puedes establecer el 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 estás usando v6.7.0 o una versión posterior de la extensión, podrás acceder a los siguientes ajustes de dos maneras, 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, en Developers > Extensions

No importa dónde realices los cambios, la extensión se sincronizará con cualquier cambio realizado en my.clerk.io y viceversa.

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

Simplemente haz clic en “Edit” en cualquier ajuste para ver las opciones disponibles:

Descripción general #

Para acceder a tu extensión Clerk en Magento 2, inicia sesión en el portal de administración de tu tienda 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 las Páginas en tu sincronización de datos con Clerk, elige “Yes” en el siguiente desplegable y escribe cualquier campo adicional que desees incluir con los datos de tu página (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.

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 aparecerán en gris y no estarán disponibles para editar cuando se use la web de datos, indicado por la casilla marcada a la derecha de cada sección.

Simplemente desmarca la casilla correspondiente para modificar.

• Usar actualizaciones en tiempo real: elige “Yes” para habilitar actualizaciones en tiempo real de los datos sincronizados con Clerk.

• Recopilar Emails: selecciona “Yes” aquí para sincronizar los correos electrónicos de los clientes.

• Recopilar cestas: para recopilar los datos de cestas y sincronizarlos con Clerk, selecciona “Yes” aquí.

  • Para añadir campos adicionales de datos de cestas, inclúyelos como valores separados por comas en la sección “additional fields” de abajo.

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

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

Sincronización de clientes #

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

Si tienes atributos adicionales de cliente que deseas incluir en la sincronización de Clerk, escribe sus valores en el cuadro de texto como una lista separada por comas.

Search #

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

• Después de seleccionar “Enabled”, introduce el nombre de tu Search Page Element, que coincide con el campo data-template del código de integración de tu Element en my.clerk.io. En este ejemplo, search-page.

• Puedes establecer los textos de " load more" y " no results" que se mostrarán escribiendo la frase deseada en estos cuadros de texto.

Live search #

• Después de seleccionar “Enabled” en el desplegable para habilitar Live Search, selecciona si quieres mostrar Categories en tus resultados de búsqueda.

  • También puedes seleccionar 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é tipos de página mostrar como resultados de búsqueda, por ejemplo “CMS Pages”, “Blog Posts” o “All”.

• Puedes elegir la posición del desplegable de live search respecto al cuadro de búsqueda con Dropdown Positioning.

• Proporciona el nombre del Element para tu live search, que puedes encontrar junto a data-template en tu código de integración Live Search dentro de tu Element de my.clerk.io. Probablemente será live-search.

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

  • En este ejemplo, #search como selector de input, y se usa la web para identificar el selector del formulario.

Navegación facetada #

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

• Haz clic en los atributos que deseas 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 que se mostrará para esa faceta y la posición en la lista de facetas en la que deseas que aparezca ese atributo.

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

Personalización de facetas #

• Clerk te permite personalizar las facetas de tu Search Page desde el diseño y puedes mostrarlas haciendo referencia al campo design ID.

• 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ño y en la esquina inferior izquierda una vez hayas entrado al diseño para editarlo.

Powerstep y exit intent #

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

• Proporciona el nombre del Element para tu Powerstep, que se encuentra junto a data-template en el código de integración de tu Powerstep Element en my.clerk.io, power-step-others-also-bought en este ejemplo.

• Realiza el mismo proceso para habilitar tu Exit Intent e identificar y agregar el Exit Intent Element adecuado.

Recommendations #

También, como con Search, habilita las Product, Category y Cart Page Settings de Clerk seleccionando “Enabled” en los desplegables correspondientes.

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

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

Registro de actividad #

Lo primero que debes hacer para cambiar los ajustes de registro es entrar al backend de Magento2 y elegir Stores => Configuration => Clerk => Configuration:

Busca el desplegable llamado Logging Settings y establece tus preferencias de registro.

Finaliza haciendo clic en Save:

Las opciones de Logging incluyen:

Elige el nivel de registro

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

• Error + Warn: También registra advertencias que no hacen que el módulo deje de funcionar pero que tal vez deban corregirse.

• Error + Warn + Debug: Registra todo con lo que interactúa el módulo. Esto no debe habilitarse en una tienda activa ya que ralentizará el sitio.

Elige dónde registrar

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

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

Actualización #

Si utilizas una versión anterior a 3.0.0, la actualización romperá tus Diseños, ya que se usará Clerk.js 2. Si utilizas una versión más antigua, sigue mejor esta guía.

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

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

Se hace siguiendo estos pasos:

1. Inicia sesión en tu servidor mediante línea de comandos.

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

3. Habilita el acceso root 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 finalice la actualización de la extensión.

Ahora Magento 2 se ha actualizado a la última versión.

Desinstalación #

Al igual que cuando instalas extensiones en Magento 2, la desinstalación debe hacerse mediante 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