Instalación

Esta guía se basa en el código SFRA más reciente y en el sitio de referencia RefArchGlobal. Si su configuración de SFCC es diferente o si utiliza una configuración alternativa, algunos pasos pueden variar, pero el enfoque general de instalación sigue siendo el mismo.

Instalación paso a paso

1. Instalar las dependencias del lado del cliente y compilar los recursos

Este paso solo es necesario si utiliza SFRA y tiene previsto usar el cartridge int_dqe_sfra. Si no utiliza SFRA ni el cartridge int_dqe_sfra, puede omitir este paso.

Para completar este paso:

1. Instale las dependencias de npm ejecutando el siguiente comando:

   npm install

2. Abra el archivo package.json y modifique la propiedad paths.base para que apunte a su directorio SFRA local.

3. Ejecute los siguientes comandos para compilar JavaScript y SCSS. Esto creará los recursos del lado del cliente:

   npm run compile:js && npm run compile:scss

2. Subir los cartridges

Una vez instaladas las dependencias y compilados los recursos del lado del cliente, suba los cartridges a su instancia de SFCC.

Para subir los cartridges:

• Suba la carpeta cartridges a la ubicación WebDAV de su sandbox utilizando CyberDuck o cualquier otro cliente WebDAV.
• También puede utilizar B2C Commerce UX Studio o la extensión Prophet Debugger para VS Code.

Para obtener más instrucciones sobre cómo subir cartridges a SFCC, consulte la documentación oficial de SFCC.

3. Registrar el cartridge en cada sitio de SFCC

Para habilitar la integración de DQE en su storefront, registre el cartridge en SFCC Business Manager.

Para registrar el cartridge:

1. Vaya a Administration > Sites > Manage Sites en SFCC Business Manager.
2. Haga clic en el Site Name del sitio storefront en el que desea añadir la funcionalidad de DQE Engagement.
3. Seleccione la pestaña Settings.

4. Añada lo siguiente al Effective Cartridge Path:

   • Si utiliza SFRA, añada:

     int_dqe_sfra:int_dqe:

   • Si no utiliza SFRA, añada solamente:

     :int_dqe:

   Para un Site Path basado en SFRA, debería tener este aspecto:

   int_dqe_sfra:int_dqe:app_storefront_base

   

5. Haga clic en Apply.
6. Repita los pasos 2 a 5 para cada sitio storefront en el que se implementará DQE Engagement.

Registrar el cartridge BM globalmente en SFCC

Para utilizar la extensión de Business Manager (BM) de DQE, registre el cartridge BM en el sitio de Business Manager.

Para registrar el cartridge BM globalmente:

1. Vaya a Administration > Sites > Manage Sites en Business Manager.
2. Haga clic en el enlace Manage the Business Manager site del sitio en el que desea registrar el cartridge BM.
3. En la sección Effective Cartridge Path, añada bm_dqe: a la lista de cartridges.
4. Haga clic en Apply para guardar los cambios y registrar el cartridge BM globalmente.

Importar metadatos y servicios en SFCC

Para integrar los metadatos y servicios de DQE en su instancia de Salesforce Commerce Cloud (SFCC), importe las configuraciones necesarias como se describe a continuación.

1. Ir a Site Development

   Vaya a Administration > Site Development > Site Import & Export en SFCC Business Manager.

2. Preparar los archivos de metadatos

   Todos los metadatos se almacenan en la carpeta data/site_template.

   • La carpeta data/site_template contiene ejemplos de asignación de códigos DQE y configuraciones de validación para sitios SFRA, incluyendo RefArch y RefArchGlobal.
   • Si desea cambiar el sitio, vaya a data/site_template/sites y renombre la carpeta para que coincida con el ID de su sitio.
   • Para eliminar las configuraciones de ejemplo, abra data/site_template/sites y elimine todas las carpetas y su contenido.

3. Archivar la carpeta de metadatos

   Archive la carpeta data/site_template del repositorio y prepárela para su subida.

4. Subir el archivo

   En la sección Upload Archive de la página Site Import & Export, seleccione la carpeta archivada data/site_template y haga clic en Select Upload.

5. Recargar la página y seleccionar la plantilla del sitio

   Después de que la página se recargue, seleccione el botón de opción site_template para confirmar que está importando los metadatos correctos.

6. Importar

   Haga clic en Import para importar los metadatos y servicios de DQE en su instancia de SFCC.

Importar metadatos, servicios y objetos personalizados en SFCC

Según su entorno de Salesforce Commerce Cloud (SFCC), puede importar metadatos, servicios y objetos personalizados por separado.

1. Importar metadatos

Los archivos de metadatos se almacenan en la carpeta data/site_template/meta y deben subirse a través de Business Manager.

Pasos:

1. Vaya a BM > Administration > Site Development > Import & Export.
2. Suba los archivos XML de metadatos desde la carpeta data/site_template/meta.
3. Una vez subidos, haga clic en Import Meta Data para importar los archivos de metadatos.

2. Importar servicios

El archivo data/site_template/services.xml contiene servicios que se pueden importar por separado.

Pasos:

1. Vaya a BM > Administration > Operations > Import & Export.
2. Suba el archivo services.xml situado en data/site_template.
3. Una vez subido, haga clic en Import Services para importar los servicios.

3. Importar objetos personalizados

Las definiciones de objetos personalizados de cada sitio se encuentran en data/site_template/sites/[site_id]/custom-objects/[custom_object_type].xml.

Pasos:

1. Vaya a Merchant Tools > Custom Objects > Import & Export en Business Manager.
2. Suba los archivos XML de objetos personalizados situados en data/site_template/sites/[site_id]/custom-objects/.
3. Una vez subidos, haga clic en Import Custom Objects para importar los objetos personalizados.

Metadatos del cartridge tras la importación

Después de importar los metadatos, los servicios y los objetos personalizados, los siguientes atributos, definiciones y servicios deberían aparecer en el sistema.

Definiciones de objetos del sistema

• Site Preferences: grupo DQE con atributos. Los atributos específicos se detallan en la sección de documentación correspondiente.

Definiciones de objetos personalizados y asignación de ejemplo para los sitios

• dqeAddressValidationConfigs
• dqeEmailValidationConfigs
• dqePhoneValidationConfigs

Servicios

• dqe.http.address.suggestions.complete
• dqe.http.address.suggestions.search
• dqe.http.address.validate
• dqe.http.email.validate
• dqe.http.phone.validate

Conceder acceso a la extensión BM

Por defecto, ningún usuario de BM tiene acceso concedido a los módulos de Business Manager de DQE. Para conceder acceso, siga estos pasos:

1. Vaya a Administration > Organization > Roles en SFCC Business Manager.
2. Seleccione el rol de usuario al que desea conceder acceso.
3. Vaya a la pestaña Business Manager Modules.
4. Seleccione el Sites Context y elija todos los sitios o solo los sitios deseados.
5. Marque los módulos de la sección DQE.
6. Haga clic en Update para guardar los cambios.