Creación de grupos de visualización de widget de Commerce Composer

Cree un widget grupo de visualización para organizar los widgets que están disponibles dentro de la ventana Añadir widgets a ranuras. Cuando los usuarios de empresa seleccionan añadir un widget a una ranura de plantilla de diseño, el usuario puede utilizar el widget Mostrar grupo para filtrar los widgets que se muestran en la ventana Añadir widgets a ranuras.

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

La ventana Añadir widgets a ranuras incluye todos los widgets a los que se suscribe una tienda y que están registrados en la infraestructura de Commerce Composer. De forma predeterminada, estos widgets están organizados en los siguientes widget grupos de visualización para filtrar los widgets que se visualizan en la ventana a la vez:
AnyPage
Conjunto de widgets que pueden utilizarse en cualquier página. Este grupo se muestra como la opción Widgets para cualquier página dentro de la ventana Añadir widgets a ranuras.
CategoryPage
Conjunto de widgets que pueden utilizarse en las páginas de categoría. Este grupo se muestra como la opción Widgets de página de categoría dentro de la ventana Añadir widgets a ranuras.
CatalogEntryPage
Conjunto de widgets que pueden utilizarse en las páginas de entradas de catálogo. Este grupo se muestra como la opción Widgets de la página de entrada de catálogo dentro de la ventana Añadir widgets a ranuras.
SearchPage
Conjunto de widgets que pueden utilizarse en una página de resultados de búsqueda. Este grupo se muestra como la opción Widgets de la página de resultados de búsqueda dentro de la ventana Añadir widgets a ranuras.
Figura 1. Ventana Añadir widgets a ranuras. La ventana incluye la lista desplegable con los grupos de visualización de widget disponibles.

Ventana Añadir widgets a ranuras.

Si está creando widgets personalizados, es posible que desee crear un grupo de visualización de widgets para incluir los widgets personalizados. Si está creando nuevos tipos de página para gestionar con la herramienta Commerce Composer, es posible que desee crear un grupo de visualización de widgets para dicho tipo de página. El nuevo grupo puede incluir todos los widgets que un usuario del Management Center puede añadir a ranuras de plantilla de diseño para ese nuevo tipo de página.

Para crear un widget grupo de visualización, debe crear una definición de objeto Management Center para el grupo y definir las propiedades de texto para el grupo. Después de definir la definición de objeto para el nuevo grupo y volver a crear el proyecto LOBTools, la infraestructura de Management Center se actualiza para incluir su grupo en la herramienta Commerce Composer. Para crear los archivos de código fuente para definir la definición de objeto de grupo de visualización de widgets y las propiedades de texto, puede utilizar una de las opciones siguientes:
  • Utilice una definición de objeto de grupo de visualización de widgets existente como modelo para crear la definición de objeto para el nuevo grupo de visualización de widgets. Los pasos siguientes describen el procedimiento para esta opción.
  • Utilice la transformación JET con un archivo de entrada de patrón para generar un nuevo paquete de código que incluya los archivos de código fuente para el nuevo grupo de visualización de widgets. Si elige utilizar este método, debe mover o fusionar los archivos generados en el proyecto de LOBTools existente. Cuando cree el archivo de entrada de patrón para utilizarlo con la transformación JET, asegúrese de incluir el elemento <widgetGroup> y los atributos correspondientes para generar los archivos para el grupo de visualización de widgets. Si solo va a crear los archivos de código fuente para un grupo de visualización widget, no incluya el elemento <widgetDef>. Puede utilizar la transformación JET para crear los archivos de código fuente solo para un único grupo de visualización de widget cuando ejecute la transformación.

    Para obtener más información sobre cómo utilizar la transformación JET para generar archivos de código fuente, consulte Generar código fuente de widget de Commerce Composer. Para obtener más información sobre cómo mover los archivos generados al proyecto de LOBTools, consulte Añadir soporte del Management Center para un widget de Commerce Composer.

Procedimiento

  1. Inicie HCL Commerce Developer. Vaya a la vista Explorador de empresa.
  2. Opcional: Si la estructura de archivos no existe, cree la estructura de archivos para incluir los elementos personalizados de Commerce Composer.
    1. Vaya al directorio LOBTools\WebContent\WEB-INF\src\xml.
    2. Cree una carpeta que contenga los elementos personalizados.
      Por ejemplo, puede denominar el directorio MyCompany.
    3. Dentro de este directorio, cree la estructura de carpetas pagelayout\widgetDefinitions.
    4. Vaya al directorio LOBTools\src\com.
    5. Cree una carpeta que contenga los elementos personalizados.
      Por ejemplo, puede denominar el directorio MyCompany.
    6. Dentro de este directorio, cree la estructura de carpetas commerce\pagelayout\client\lobtools\properties.
    7. Vaya al directorio LOBTools\WebContent\WEB-INF\src\xml.
    8. Cree una carpeta que contenga los elementos personalizados.
      Por ejemplo, puede denominar el directorio MyCompany.
    9. Cree el directorio pagelayout en este directorio.
  3. Cree el archivo de definición de objeto para el nuevo grupo de visualización de widgets.
    1. Vaya al directorio LOBTools\WebContent\WEB-INF\src\xml\commerce\pagelayout\widgetDefinitions.
    2. Copia de uno de los archivos de definición de objeto de grupo de widget que se proporciona de forma predeterminada.
      Por ejemplo, copie el archivo AnyPageWidgetGroup.xml.
    3. Vaya al directorio LOBTools\WebContent\WEB-INF\src\xml\MyCompany\pagelayout\widgetDefinitions.
    4. Añada el archivo de definición de objeto copiado en este directorio.
    5. Cambie el nombre del archivo de definición de objeto copiado. Utilice el formato WidgetGroupIdentifierWidgetGroup.xml, donde WidgetGroupIdentifier es el valor del identificador para el nuevo grupo de visualización de widgets
      Por ejemplo, si está creando un grupo de visualización de widgets para widgets personalizados creados por su empresa, puede denominar el archivo, MyCompanyCustomPageWidgetGroup.xml.
    6. Abra el archivo para editarlo.
      De forma predeterminada, el archivo incluye el código siguiente para definir un grupo de visualización de widgets:
      <?xml version="1.0" encoding="UTF-8"?>
      <!--
       =================================================================
        Licensed Materials - Property of IBM
      
        HCL Commerce
      
        (C) Copyright IBM Corp. 2015 All Rights Reserved.
      
        US Government Users Restricted Rights - Use, duplication or
        disclosure restricted by GSA ADP Schedule Contract with
        IBM Corp.
       =================================================================
      -->
      <Definitions>
      	<LayoutWidgetGroup definitionName="cmc/pagelayout/AnyPageWidgetGroup" 
                                displayName="${pageLayoutResources.widgetGroupDisplayName_AnyPage}" 
                                identifier="AnyPage" 
                                package="cmc/pagelayout" 
                                parentDefinition="cmc/pagelayout/NewPageLayoutWidgetDialog">
      		<dependency localName="pageLayoutResources" moduleName="cmc/pagelayout/PageLayoutResources"/>
      	</LayoutWidgetGroup>
      </Definitions>
      
      Donde
      definitionName
      El nombre de la definición para la definición de objeto del grupo de visualización de widgets.
      displayName
      El nombre del grupo de visualización de widgets que se muestra en la ventana Añadir widgets a ranuras dentro de la herramienta Commerce Composer. El valor de este atributo está definido dentro del archivo de propiedades de texto PageLayoutLOB.properties. Este archivo se encuentra en el directorio LOBTools\src\com\ibm\commerce\pagelayout\client\lobtools\properties.
      identifier
      El nombre identificativo para el grupo de visualización de widgets.
      package
      El nombre del paquete para grupos de visualización de widgets dentro del espacio de trabajo.
      parentDefinitionName
      El nombre de la definición de objeto padre.
    7. Actualice los valores de la definición de objeto para definir el nuevo grupo de widget
    8. Guarde y cierre el archivo.
  4. Cree o actualice un archivo de propiedades para incluir el texto de su grupo de visualización de widgets.
    1. Vaya al directorio LOBTools\src\com\ibm\commerce\pagelayout\client\lobtools\properties.
    2. Opcional: Si no existe un archivo de propiedades para los elementos personalizados, cree un archivo de propiedades. Llame al archivo PageLayoutLOB.properties.
    3. Abra el archivo PageLayoutLOB.properties para editarlo.
    4. Añada el código siguiente para definir el nombre de visualización para el grupo de visualización de widget:
      widgetGroupDisplayName_WidgetGroupIdentifier=widgetGroupDisplayName
      Donde WidgetGroupIdentifier es el valor del identificador para el nuevo grupo de visualización de widget. Por ejemplo,
      widgetGroupDisplayName_MyCompanyCustomPage=Custom widgets for any page
    5. Guarde y cierre el archivo.
  5. Registre la propiedad Text para el grupo de visualización widget dentro de un paquete de recursos.
  6. Si ha creado un archivo de paquete de recursos para registrar sus widget propiedades de texto de grupo de visualización, incluya el nuevo paquete de recursos donde se utilice.
  7. Incluya cualquier widget adecuado dentro del nuevo grupo de visualización de widget. Para cada widget que desee incluir dentro del grupo, actualice la definición de objeto para el widget.
    1. Vaya al directorio que incluye las definiciones de objeto para los widgets de tienda.
      • Si desea incluir un widget que esté disponible de forma predeterminada, vaya al directorio siguiente:
        • LOBTools\WebContent\WEB-INF\src\xml\commerce\pagelayout\widgetDefinitions
      • Si desea incluir un widget personalizado, vaya al directorio siguiente:
        • LOBTools\WebContent\WEB-INF\src\xml\MyCompany\pagelayout\widgetDefinitions
    2. Expanda el directorio que incluye las definiciones de los widget que desea incluir dentro del grupo de visualización de widget.
    3. Abra el archivo de definición de objeto del widget para editarlo.
    4. Localice el atributo widgetDisplayGroups dentro del elemento de definición de objeto widget.
    5. Actualice los valores del atributo para incluir el widget grupo de visualización.
      Por ejemplo, para un widget que se incluye dentro del grupo de visualización del widget CatalogEntryPage, el atributo actualizado puede parecerse al código siguiente:
      widgetDisplayGroups="CatalogEntryPage,MyCompanyCustomPage"
    6. Guarde y cierre el archivo.
  8. Verifique que su grupo de visualización de widgets esté disponible dentro de la ventana Añadir widgets a ranuras en la herramienta Commerce Composer. Crear un diseño. Cuando selecciona Añadir un widget a una ranura de plantilla, asegúrese de que puede filtrar por el nuevo grupo de visualización de widget. Asegúrese de que solo aparecen los widgets que ha incluido dentro de este grupo cuando selecciona el widget grupo de visualización.