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, 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 Magento sin utilizar Magento Connect.

El Toolbox Script se ejecutará directamente desde una terminal.

Te sugerimos estas opciones:

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

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

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

Qué necesitas #

Para instalarlo, necesitas acceso SSH o SFTP a tu tienda, 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 una terminal, utilizando tu Nombre de usuario y Dominio de esta manera:

ssh Stefan@mywebshop.com

2. Se te pedirá que ingreses la contraseña de tu usuario (la terminal no dará retroalimentación 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 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 NOMBRE_CARPETA

NOMBRE_CARPETA 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 pedirá que ingreses 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 tu panel de administración 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 usando la copia de seguridad que se creó 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 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 los ajustes de datos de Magento 2 en Clerk, dirígete a my.clerk.io, haz clic en “Data” en el menú lateral izquierdo, 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, 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 predeterminado es “cuando sea necesario”).

Configuración 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 maneras después de agregar tus Public y Private Keys a la extensión:

• A través del panel 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 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:

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 extensión Clerk, así como las claves públicas y privadas de la API de tu tienda en la sección General.

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

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

Sincronización #

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

Las opciones aparecen en gris y no están disponibles para actualizar cuando se usa la data del sitio web, tal como lo indica la casilla marcada a la derecha de cada sección.

Simplemente desmarca la casilla correspondiente para modificarla.

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

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

• Collect Baskets: para recoger datos de cesta y sincronizarlos con Clerk, selecciona “Sí” aquí.

  • Para agregar cualquier campo adicional de datos de la cesta, inclúyelos como valores separados por comas en la sección “additional fields” abajo.

• En los dos siguientes desplegables, selecciona “sí” para sincronizar sólo productos vendibles y/o sincronizar sólo productos con visibilidad para Clerk.

• Si necesitas deshabilitar la sincronización de pedidos, puedes hacerlo seleccionando “Sí” en este desplegable.

Sincronización de clientes #

Habilita la sincronización de datos de clientes seleccionando “Sí” en el desplegable de esta sección.

Si tienes atributos extra de clientes que quieras incluir en la sincronización con Clerk, escribe sus valores aquí como lista separada por comas.

Search #

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

• Tras elegir “Enabled”, introduce el nombre de tu Search Page Content, que debe coincidir con el campo data-template encontrado en el código de inserción de tu Content en my.clerk.io. En este ejemplo, search-page.

• Puedes definir el texto " load more" y " no results" que se visualizará escribiendo la frase deseada en estas cajas de texto.

Live search #

• Después de seleccionar “Enabled” en el desplegable para activar Live Search, selecciona si deseas o no que se muestren Categories dentro de los resultados de búsqueda.

  • También puedes elegir la cantidad de resultados de suggestions, categories y content mostrados en Live Search además de los resultados de productos.

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

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

• Proporciona el Content name para tu live search a continuación, que se encuentra junto a data-template en el código de inserción de Live Search dentro de tu Content en my.clerk.io. Normalmente será live-search.

• Por último, puedes proporcionar tu Live Search Input Selector y Form Selector, localizables inspeccionando el cuadro de búsqueda de tu tienda con el navegador, identificando el ID o clase vinculada a su input y formulario.

  • En este ejemplo, #search como input selector, y usando el sitio web para identificar el form selector.

Navegación facetada #

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 quieras agregar a tus facetas y haz clic en guardar configuración.

• Una vez agregados, tus atributos aparecerán bajo Titles. En esta sección puedes crear el Título que mostrará esa faceta y la posición en la lista de facetas en la que aparecerá ese atributo.

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

Personalización de facetas #

• Clerk te permite personalizar el diseño de las facetas de tu página de búsqueda desde el apartado de diseño y puedes mostrarlas refiriéndolas mediante el 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 vista general de diseños y en la esquina inferior izquierda de la página una vez que entras para editar el diseño.

Powerstep y exit intent #

Similar a Search, activa tu Clerk Powerstep seleccionando “Sí” en el desplegable y elige el tipo de powerstep que deseas que se muestre (Page o Popup).

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

• Repite el mismo proceso anterior para activar tu Exit Intent e identificar y agregar el Exit Intent Content adecuado.

Recommendations #

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

• Igual que en las funcionalidades de Search, puedes encontrar el nombre del elemento junto a data-template en el código de inserción 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 Category Page, product-page-alternatives y product-page-others-also-bought en nuestra Product Page, así como cart-others-also-bought como elemento en nuestra 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 define tu preferencia de configuración de logs.

Finaliza haciendo clic en Save:

La configuración de logs incluye:

Elegir nivel de registro

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

• Error + Warn: También registra advertencias que no detienen el funcionamiento del módulo, pero pueden requerir corrección.

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

Elige dónde registrar

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

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

Actualización #

Si usas una versión anterior a la 3.0.0, actualizar romperá tus Designs, ya que se utilizará 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 se sobreescribirán.

Actualizar la extensión de Magento 2 se realiza mediante la línea de comandos.

Hazlo siguiendo estos pasos:

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

2. Navega a tu carpeta webroot (normalmente " /var/www/tu_dominio/public_html")

3. Habilita Root Access escribiendo su y luego ingresa 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 finalice.

Ahora tu Magento 2 está actualizado a la última versión.

Desinstalación #

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