Registrar una plantilla de diseño de Commerce Composer

Utilice el programa de utilidad de carga de datos para registrar su plantilla de diseño personalizada dentro del marco de Commerce Composer y haga que su tienda se suscriba a la plantilla de diseño. Una tienda debe suscribirse a la plantilla para que los usuarios puedan seleccionar la plantilla para empezar a componer un diseño de página para dicha tienda.

Por qué y cuándo se efectúa esta tarea

Antes de poder utilizar una plantilla de diseño dentro de la herramienta Commerce Composer, debe registrar la plantilla en el marco de Commerce Composer. El marco mantiene un registro único, que incluye todas las plantillas y widgets registrados que se pueden usar en una página para una tienda. Cuando ejecuta el programa de utilidad de carga de datos para registrar una plantilla de diseño y suscribir una tienda a dicha plantilla de diseño, el programa de utilidad carga la siguiente información.
  • Puesto que el contenedor para una plantilla de diseño es un widget vacío, el programa de utilidad de carga de datos carga la información para registrar la plantilla en las tablas de base de PLWIDGETDEF y PLWIDGETDEFDESC.
  • Información para suscribir una tienda a la plantilla en la tabla de base de datos PLSTOREWIDGET.
  • Información para definir el mapa esquemático que se muestra en la herramienta Commerce Composer para la plantilla y las restricciones de ranura en la tabla de base de datos PLWIDGETSLOT.
    Nota: El mapa esquemático solo se muestra en la herramienta Commerce Composer como una representación visual de cómo se muestra una plantilla de diseño cuando se llenan todas las ranuras de plantilla. Esta estructura metálica no está conectada a la disposición real de los widgets en una página de tienda. En función de cómo un usuario de empresa construye un diseño, la visualización real del diseño puede diferir significativamente de la representación visual de la plantilla que proporciona un mapa esquemático. El mapa esquemático solo se utiliza en la herramienta Commerce Composer para ayudar a los usuarios de empresa a seleccionar la plantilla adecuada para construir un diseño y para seleccionar ranuras para incluir widgets en un diseño.
  • Información para definir la plantilla en la tabla de base de datos PAGELAYOUT.

Procedimiento

  1. Cree archivos CSV y archivos de configuración de programa de utilidad de carga de datos para cargar la información de plantilla de diseño. Para ayudarle a crear estos archivos, HCL Commerce proporciona archivos de ejemplo para cargar información de plantilla de diseño. Utilice estos archivos de ejemplo para modelar los archivos de configuración y CSV.
    1. Cree un directorio para incluir los archivos CSV y los archivos de configuración de programa de utilidad de carga de datos para cargar la información de plantilla de diseño. Puede crear este directorio en cualquier lugar del sistema de archivos; sin embargo, para los pasos siguientes, se crea un directorio template-MyCompany en el directorio WCDE_installdir\samples\DataLoad\CommerceComposer.
    2. Vaya al directorio WCDE_installdir\samples\DataLoad\CommerceComposer\template. Este directorio incluye los archivos CSV de muestra y el archivo de configuración de orden de carga para cargar información de plantilla.
    3. Copie los archivos siguientes:
      • registerWidgetdef.csv
      • slotDefinition.csv
      • subscribeWidgetdef.csv
      • template.csv
      • wc-dataload-template.xml
    4. Añada los archivos copiados al directorio para los archivos del programa de utilidad de carga de datos de plantilla de diseño.
    5. Opcional: Copie los archivos de configuración de objeto de negocio para cargar la información de plantilla de diseño del directorio WCDE_installdir\samples\DataLoad\CommerceComposer.
      Este directorio incluye los archivos de configuración de muestra restantes para cargar la información de la plantilla. Si no está personalizando estos archivos, puede utilizar los archivos del directorio CommerceComposer y no necesita copiar los archivos. Si no desea actualizar estos archivos, copie los archivos siguientes en el nuevo directorio.
      • wc-dataload-env.xml
      • wc-loader-registerWidgetdef.xml
      • wc-loader-subscribeWidgetdef.xml
      • wc-loader-template.xml
      • wc-loader-widgetslot.xml
Actualizar los archivos de entrada CSV para incluir la información de plantilla de diseño
  1. Prepare el archivo de entrada de carga de datos que contiene la información de identificación, descriptiva y de definición para registrar su contenedor de plantilla de diseño.
    1. Abra el archivo registerWidgetDef.csv para editarlo. De forma predeterminada, este archivo incluye las columnas necesarias para registrar una plantilla y datos para cargar contenedores de plantilla de ejemplo.
    2. Suprima los datos de ejemplo de este archivo. No elimine ninguna de las columnas. Añada los datos para el contenedor de plantilla de diseño personalizado en el archivo.
      En el archivo CSV, debe establecer los siguientes valores de columna
      • Establezca un valor que para WidgetDefIdentifier exclusivo dentro de la lista de todos los contenedores de plantilla de diseño y widgets de Commerce Composer.
      • Establezca el valor de la columna WidgetVendor para que sea el nombre de su empresa.
      • Establezca el valor WidgetType en 2. Esta columna identifica el tipo de widget que está registrando. Un widget puede ser un widget de Commerce Composer (valor de 1)) o un contenedor de plantilla de diseño (valor de 2).
      • Establezca el valor para WidgetPath que sea la vía de acceso relativa al archivo JSP de contenedor para la plantilla de diseño. Esta ruta es relativa al directorio workspace_dir\Stores\WebContent. Utilice barras inclinadas en la vía de acceso del archivo.
      • Establezca el valor de WidgetDefinitionxml para que sea un elemento vacío.
      • Establezca el valor de la columna WidgetState para 1 para indicar que el registro del contenedor está activo.
      Por ejemplo, su CSV registerWidgetDef.csv completado puede parecerse al siguiente código:
      WidgetDefIdentifier,WidgetVendor,WidgetType,WidgetPath,WidgetDefinitionxml,WidgetState,Delete
      MyCustomLayoutTemplateContainer,MyCompany,2,Container-vendor/MyCustomLayoutTemplate.jsp,<Definition></Definition>,1,
      Para obtener más información sobre la información que puede incluir en este archivo, consulte Archivo de entrada registerWidgetdef.
    3. Guarde y cierre el archivo.
  2. Prepare el archivo de entrada de carga de datos para suscribir una tienda a su contenedor de plantilla de diseño.
    1. Abra el archivo subscribeWidgetdef.csv para editarlo. De forma predeterminada, este archivo incluye las columnas necesarias para suscribir una tienda a una plantilla e incluye datos de ejemplo.
    2. Suprima los datos de ejemplo de este archivo. No elimine ninguna de las columnas. Añada los datos para el contenedor de plantilla de diseño personalizado en el archivo.
      En el archivo CSV, debe establecer los siguientes valores de columna
      • Establezca el valor para que WidgetDefIdentifier sea el mismo valor que ha establecido en el archivo registerWidgetDef.csv.
      • No establezca un valor para la columna WidgetDefinitionxml.
      • Establezca el valor de la columna WidgetState en 1 para indicar que la suscripción a la tienda está activa.
      • No es necesario que establezca el valor de ID para la tienda dentro de este archivo. De forma predeterminada, el programa de utilidad de carga de datos suscribe la tienda que está configurada en el archivo de configuración de entorno del programa de utilidad de carga de datos a la plantilla de diseño. Puede establecer una tienda diferente para suscribirse a la plantilla actualizando el archivo de configuración de entorno.
      Por ejemplo, su CSV subscribeWidgetdef.csv completado puede parecerse al siguiente código:
      WidgetDefIdentifier,WidgetDefinitionxml,WidgetState,Delete
      MyCustomLayoutTemplateContainer,,1
      Para obtener más información sobre la información que puede incluir en este archivo, consulte Archivo de entrada subscribeWidgetdef.
    3. Guarde y cierre el archivo.
  3. Prepare el archivo de entrada de carga de datos que define la información de plantilla. Esta información incluye el nombre y la descripción de la plantilla de diseño, que se visualizan para la plantilla en la herramienta Commerce Composer.
    1. Abra el archivo template.csv para editarlo. De forma predeterminada, este archivo incluye las columnas necesarias para definir la plantilla e incluye datos de ejemplo.
    2. Suprima los datos de ejemplo de este archivo. No elimine ninguna de las columnas. Añada los datos para la plantilla de diseño personalizado en el archivo.
      En el archivo CSV, debe establecer los siguientes valores de columna
      • Establezca el valor de la columna LayoutName para que sea el nombre de referencia para la plantilla para la que está definiendo el mapa esquemático. Este valor se muestra en Management Center para identificar la plantilla. El valor para esta columna debe coincidir con el valor que haya establecido dentro del archivo slotDefinition.csv.
      • Establezca el valor de la columna Description de modo que sea la serie de texto que desea visualizar para la plantilla de diseño dentro de la herramienta Commerce Composer. Esta descripción se visualiza dentro de la nueva ventana de Selección de plantilla de diseño para la plantilla de diseño personalizada.
      • Establezca el valor de la columna DeviceClasspara identificar el tipo o los tipos de clases de dispositivo que los usuarios pueden utilizar para diseñar un diseño de página cuando utilicen la plantilla de diseño personalizada. Puede definir una plantilla de diseño que se utilizará para crear diseños para Web, Mobile o Any dispositivos.
      • Establezca el valor de la columna State que va a 1 para activar la plantilla de diseño para utilizarla en la composición de un diseño de página.
      • Establezca el valor IsTemplate en TRUE. Este valor indica que está cargando una plantilla de diseño.
      • Establezca el valor IsDefault en FALSE. Este valor de columna indica si está cargando un diseño predeterminado.
      • Establezca el valor de las columnas ParentWidgetDefIdentifier y AdminName como nombre administrativo para el contenedor en esta plantilla. Establezca este nombre para que sea el mismo que WidgetDefIdentifier que ha establecido en el archivo registerWidgetDef.csv.
      Por ejemplo, su CSV template.csv completado puede parecerse al siguiente código:
      LayoutName,Description,DeviceClass,State,IsTemplate,IsDefault,ParentWidgetDefIdentifier,AdminName,Delete
      "Any page, seven slots, tabs","Seven-slot template with a row of four tabs. Can be used for any page.",Any,1,TRUE,FALSE,MyCustomLayoutTemplateContainer,MyCustomLayoutTemplateContainer,
      Para obtener más información sobre la información que puede incluir en este archivo, consulte Archivo de entrada template.
    3. Guarde y cierre el archivo.
  4. Prepare el archivo de entrada de carga de datos para cargar la información de definición de ranura
    1. Abra el archivo slotDefinition.csv para editarlo. De forma predeterminada, este archivo incluye las columnas necesarias para definir el mapa esquemático global de plantilla que se muestra para la plantilla dentro de la herramienta Commerce Composer. Este archivo también carga cualquier restricción de ranura para la plantilla. El archivo CSV de ejemplo también incluye datos para definir las ranuras para una plantilla de ejemplo.
    2. Suprima los datos de ejemplo de este archivo. No elimine ninguna de las columnas. Añada los datos para el contenedor de plantilla de diseño personalizado en el archivo.
      En el archivo CSV, debe establecer los siguientes valores de columna
      • Establezca el valor de la columna LayoutName para que sea el nombre de referencia para la plantilla para la que está definiendo el mapa esquemático. Este valor se muestra en Management Center para identificar la plantilla. El valor para esta columna debe coincidir con el valor que haya establecido dentro del archivo template.csv.
      • Establezca el valor de la columna AdminName como el nombre administrativo para el contenedor en esta plantilla. Establezca este nombre para que sea el mismo que WidgetDefIdentifier que ha establecido en el archivo registerWidgetDef.csv.
      • Establezca el valor de SlotAdminName para que sea el nombre de visualización de la ranura. El valor de esta columna se muestra en la herramienta Commerce Composer dentro del mapa esquemático para identificar la ranura.
      • Establezca el valor de la columna SlotID de forma que sea el valor del nombre de ranura interna.
      • Establezca la columna SlotType como 1. Esta columna se reserva para uso interno de IBM. El valor debe establecerse en1
      • Dentro del valor de la columna SlotProperty, defina las coordenadas para el mapa esquemático de la plantilla de diseño e identifique grupos de restricción para la plantilla. Utilice el formato siguiente:
        "xLocation:00;yLocation:00;width:00;height:00,allowedWidgetGroups:WidgetGroupIdentifier"
        Por ejemplo, para incluir un grupo de restricción para restringir una ranura para que solo utilice los widgets que están pensados para utilizarse como título de ranura con pestañas, utilice allowedWidgetGroups:WidgetForTabTitle. Para obtener más información sobre los grupos de restricción de widgets, consulte Crear grupos de restricción de widgets Commerce Composer.
        Para definir el mapa esquemático, la anchura máxima es 166 y la altura máxima es 218. Divida el mapa esquemático para que incluya las ranuras de plantilla de diseño. Para las ranuras con pestañas, añada dottedRightBorder:true al sistema de coordenadas para añadir una línea punteada a la columna. Esta línea punteada identifica la columna como una ranura con pestañas.
        Consejo: Considere la posibilidad de utilizar un editor de imágenes que muestre coordenadas para ayudarle a establecer las coordenadas para el mapa esquemático de la plantilla. En el editor de imágenes, dibuje el que desee que se visualice en la herramienta Commerce Composer. Utilice las coordenadas para esta imagen como las coordenadas del mapa esquemático en el archivo de entrada CSV.
      El código siguiente define el archivo CSV slotDefinition.csv para cargar la plantilla de diseño Cualquier página, siete ranuras, separadores :
      LayoutName,AdminName,SlotAdminName,SlotID,SlotType,SlotProperty
      "Any page, seven slots, tabs",MyCustomLayoutTemplateContainer,1,1,1,xLocation:0;yLocation:0;width:83;height:20
      "Any page, seven slots, tabs",MyCustomLayoutTemplateContainer,2,2,1,xLocation:83;yLocation:0;width:83;height:20
      "Any page, seven slots, tabs",MyCustomLayoutTemplateContainer,"Title 3",Title3,1,xLocation:0;yLocation:20;width:40;height:20;allowedWidgetGroups:WidgetForTabTitle
      "Any page, seven slots, tabs",MyCustomLayoutTemplateContainer,"Title 4",Title4,1,xLocation:40;yLocation:20;width:43;height:20;allowedWidgetGroups:WidgetForTabTitle
      "Any page, seven slots, tabs",MyCustomLayoutTemplateContainer,"Title 5",Title5,1,xLocation:83;yLocation:20;width:43;height:20;allowedWidgetGroups:WidgetForTabTitle
      "Any page, seven slots, tabs",MyCustomLayoutTemplateContainer,"Title 6",Title6,1,xLocation:126;yLocation:20;width:40;height:20;allowedWidgetGroups:WidgetForTabTitle
      "Any page, seven slots, tabs",MyCustomLayoutTemplateContainer,"Tab 3",3,1,xLocation:0;yLocation:40;width:40;height:50;dottedRightBorder:true
      "Any page, seven slots, tabs",MyCustomLayoutTemplateContainer,"Tab 4",4,1,xLocation:40;yLocation:40;width:43;height:50;dottedRightBorder:true
      "Any page, seven slots, tabs",MyCustomLayoutTemplateContainer,"Tab 5",5,1,xLocation:83;yLocation:40;width:43;height:50;dottedRightBorder:true
      "Any page, seven slots, tabs",MyCustomLayoutTemplateContainer,"Tab 6",6,1,xLocation:126;yLocation:40;width:40;height:50
      "Any page, seven slots, tabs",MyCustomLayoutTemplateContainer,7,7,1,xLocation:0;yLocation:90;width:166;height:128
      Para obtener más información sobre la información que puede incluir en este archivo, consulte Archivo de entrada slotDefinition.
    3. Guarde y cierre el archivo.
Configurar y ejecutar el programa de utilidad de carga de datos
  1. Configure los valores de variables de entorno para ejecutar el programa de utilidad de carga de datos.
    1. Para editar, abra el archivo de configuración del entorno de carga de datos wc-dataload-env.xml.
      Este archivo configura las variables de entorno de programa de utilidad de carga de datos, como los valores de base de datos, la resolución de ID y el grabador de datos.
    2. Actualice el archivo de modo que coincida con los valores de base de datos y entorno.
      Para más información, consulte Configurar los valores de entorno de carga de datos. Puede introducir un valor para su identificador de tienda en este archivo o introducir el identificador de tienda cuando ejecute el programa de utilidad de carga de datos para cargar los archivos CSV. El identificador de tienda se utiliza para identificar la tienda que se suscribe a la plantilla de diseño. El identificador de tienda es sensible a las mayúsculas y minúsculas. Puede encontrar el valor del identificador de tienda dentro de la columna IDENTIFIER de la tabla de base de datos STOREENT.
      Nota: Si está utilizando el modelo de negocio de sitios ampliados y desea que esta plantilla de diseño esté disponible para todos los sitios ampliados, utilice el identificador de tienda para la tienda con elementos de escaparate. Como alternativa, puede utilizar un identificador de tienda de un sitio ampliado específico si desea que la plantilla de diseño esté disponible solo para dicho sitio ampliado.
    3. Guarde el archivo.
  2. Opcional: Configure el orden de carga para cuando ejecute el programa de utilidad de carga de datos. Esta configuración identifica la secuencia que el programa de utilidad de carga de datos carga los archivos de entrada CSV. Si ha incluido el nuevo directorio para la información de plantilla de diseño dentro del directorio WCDE_installdir\components\foundation\samples\DataLoad\CommerceComposer, y no ha movido los archivos de configuración de objeto de negocio o renombrado los archivos de entrada CSV, no es necesario que actualice este archivo.
    1. Abra el archivo wc-dataload-template.xml para editarlo.
    2. Actualice los valores para los atributos businessObjectConfigFile y location para hacer referencia a la ubicación y los nombres correctos para los archivos.
    3. Guarde y cierre el archivo.
    Para obtener más información sobre cómo trabajar con este archivo, consulte Configuración del orden de carga de datos.
  3. Opcional: Configure los archivos de configuración de objeto de negocio para cargar la información de plantilla de diseño.
    De forma predeterminada, no es necesario actualizar estos archivos para cargar la información de plantilla de diseño. Para obtener más información si desea actualizar estos archivos, consulte Configurar el archivo de configuración de objeto de negocio. Los archivos siguientes son los archivos de configuración de objeto de negocio que se utilizan para cargar información de plantilla de diseño:
    • wc-loader-registerWidgetdef.xml
    • wc-loader-subscribeWidgetdef.xml
    • wc-loader-template.xml
    • wc-loader-widgetslot.xml
  4. Ejecute el programa de utilidad de carga de datos.
    1. En un programa de utilidad de línea de mandatos, vaya al directorio WCDE_installdir\bin.
    2. Ejecute el mandato siguiente para cargar los archivos de entrada a fin de registrar y definir la plantilla de diseño y para que la tienda se suscriba a la plantilla.

      dataload.bat ..\samples\DataLoad\CommerceComposer\template-MyCompany\wc-dataload-template.xml

      Donde
      template-MyCompany
      La carpeta que ha creado para incluir los archivos CSV de plantilla de diseño.
    3. Verifique los resultados de la carga de datos.
    Para obtener más información sobre cómo usar el programa de utilidad de carga de datos para cargar información de la plantilla de diseño, consulte Ejemplo: Cargar plantillas de diseño de Commerce Composer.

Qué hacer a continuación

Con la plantilla de diseño registrada, definida y suscrita por una tienda, la plantilla de diseño está disponible para su uso en la herramienta Commerce Composer y el escaparate. Utilice la herramienta Commerce Composer para componer un diseño de página que utilice la nueva plantilla de diseño y obtener una vista previa del diseño para asegurarse de que la plantilla de diseño se visualiza correctamente.