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 mediante Toolbox Script, la actualización y la desinstalación.

Instalación con toolbox #

El Clerk Toolbox Script ha sido creado para que sea fácil instalar la extensión Clerk en tu tienda Magento sin utilizar Magento Connect.

El Toolbox Script se ejecutará directamente desde un terminal.

Te sugerimos estos:

- Apple: iTerm, que deberás descargar de Internet;

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

El script también crea una copia de seguridad de la carpeta Magento2 para poder restaurarla si algo sale mal.

Lo que necesitas #

Para instalarlo, necesitas acceso SSH o SFTP a tu tienda online, incluyendo tu Username y Password.

Navegando a la carpeta #

1. Comienza iniciando sesión en tu servidor Magento a través de un terminal, usando tu Username y Domain de esta manera:

ssh Stefan@mywebshop.com

2. Se te pedirá que escribas la contraseña de tu usuario (el terminal no dará ninguna respuesta visual al escribir la contraseña, pero la está registrando igualmente).

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

cd /var/www/html

y luego 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 debes 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 número de la última versión de la extensión. Escribe esta línea:

sudo sh clerk_toolbox_magento2.sh -i

4. Ahora se te solicitará que ingreses tu contraseña. Al hacer esto, el script realizará 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 tu 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 vaya mal en tu tienda online, siempre puedes restaurarla usando 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 crea primero una copia de seguridad, pero también puedes crear una copia de seguridad por separado con esta línea:

sudo sh clerk_toolbox_magento2.sh -b

my.clerk.io settings #

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 para Magento 2, disponible a través del portal de administración de Magento, se encuentra 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 por defecto es “cuando sea necesario”).

Ajustes de la extensión #

Si estás usando la v6.7.0 o una versión posterior de la extensión, podrás acceder a los siguientes ajustes de dos formas luego 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 se sincronizará con cualquier cambio realizado 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” sobre cualquier ajuste para ver las opciones disponibles:

Visión general #

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 #

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

Para incluir Pages en tu sincronización de datos con Clerk, elige “Yes” en el siguiente desplegable y escribe los campos adicionales que desees incluir con los datos de tus páginas (como imágenes o tipo de página) 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 de Synchronization del plugin Clerk, tienes la opción de personalizar los datos sincronizados de clientes, pedidos, carritos y productos.

Las opciones están deshabilitadas y no se pueden actualizar cuando se usa la “website data”, indicado 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 activar actualizaciones en tiempo real en los datos sincronizados con Clerk.

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

• Collect Baskets: para recopilar los datos de los carritos y sincronizarlos con Clerk, selecciona “Yes” aquí.

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

• En los dos siguientes desplegables, selecciona “yes” para sincronizar solo productos vendibles y/o solo productos con visibilidad hacia 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 extra de clientes que desees incluir en la sincronización con Clerk, introduce sus valores en la caja de texto como una lista separada por comas.

Search #

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

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

• Puedes establecer el texto de " load more" y " no results" escribiendo la frase deseada en estos campos de texto.

Live search #

• Tras seleccionar “Enabled” en el desplegable para habilitar Live Search, selecciona si deseas que se muestren Categories dentro de tus resultados de búsqueda.

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

• También tienes la opción de elegir qué tipos de página 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.

• A continuación, proporciona el nombre del Element para tu live search, que puede encontrarse junto a data-template en el embed code de tu Element de Live Search en my.clerk.io. Lo más probable es que sea live-search.

• Por último, tienes la opción de proporcionar tu Live Search Input Selector y Form Selector, los cuales pueden encontrarse inspeccionando tu caja de búsqueda con el navegador e identificando el ID o clase asociado al input y formulario.

  • En este ejemplo, #search como el selector de input, y usar “website” para identificar el selector de formulario.

Navegación Facetada #

Para añadir facets 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 facets y haz clic en guardar configuración.

• Una vez añadidos, tus atributos aparecerán bajo Titles. En esta sección puedes crear el título que se mostrará para ese facet y la posición en la lista donde deseas que aparezca.

Nota: Ahora puedes solicitar los datos de categorías y páginas en tu Search page de la misma manera que lo harías en Live search, proporcionándote una mayor gama de información para interactuar con tus clientes. Para más información puedes consultar aquí.

Personalizando facets #

• Clerk permite estilizar los facets de tu search page desde el diseño y puedes mostrar esto haciendo referencia al ID de diseño.

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

Powerstep y exit intent #

De forma similar a Search, activa tu Clerk Powerstep seleccionando “Yes” en el desplegable y luego elige el tipo de powerstep que te gustaría mostrar (Page o Popup).

• Proporciona el nombre del Element para tu Powerstep, que se encuentra junto a data-template en el embed code dentro de tu Powerstep Element en my.clerk.io, por 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.

Recommendations #

También de forma similar a Search, habilita tus configuraciones de Product, Category y Cart Page de Clerk seleccionando “Enabled” en los desplegables correspondientes.

• Al igual que con las funcionalidades de Search, puedes encontrar el nombre del element al lado de data-template en el embed code dentro de my.clerk.io > Recommendations > Elements.

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

Registro de logs #

Lo primero que debes hacer para cambiar los ajustes de logs es ir a tu backend de Magento2 y elegir Stores => Configuration => Clerk => Configuration:

Busca el desplegable llamado Logging Settings y configura los ajustes de logs a tu preferencia.

Finaliza haciendo clic en Save:

Los ajustes de Logging incluyen:

Elige el nivel de registro (logging Level)

• Only Errors: Registrará cualquier error que impida que el módulo funcione correctamente.

• Error + Warn: También registra advertencias que no detienen el módulo, pero que podrían requerir intervención.

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

Elige dónde registrar

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

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

Actualización #

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

Importante: recuerda hacer backup de cualquier archivo modificado, ya que serán sobrescritos.

La actualización de la extensión Magento 2 se realiza vía commandline.

Estos son los pasos a seguir:

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

2. Navega a tu carpeta webroot (usualmente “/var/www/your_domain/public_html”)

3. Habilita el 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 la extensión termine el proceso.

Tu Magento 2 ahora estará 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 escribe los siguientes comandos en orden para eliminarla:

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

2. composer remove clerk/magento2