En esta sección se describe cómo desarrollar la herramienta de edición masiva y cómo ampliar el componente Lista de productos, que se basa en el editor masivo.
Al trabajar con el editor por lotes, hay varios parámetros de consulta que puede añadir a la URL para llamar al editor por lotes con una configuración específica. Si desea que el editor por lotes se utilice siempre con una configuración determinada, por ejemplo, como en el componente Lista de productos, debe modificar bulkeditor.jsp (ubicado en /libs/wcm/core/components/bulkeditor) o crear un componente con la configuración específica. Los cambios realizados mediante parámetros de consulta no son permanentes.
Por ejemplo, si escribe lo siguiente en la dirección URL del explorador:
https://<servername><port_number>/etc/importers/bulkeditor.html?rootPath=/content/geometrixx/en&queryParams=geometrixx&initialSearch=true&hrp=true
el editor masivo se muestra sin la variable Ruta raíz como hrp=true oculta el campo. Con el parámetro hrp=false, se muestra el campo (el valor predeterminado).
A continuación se muestra una lista de los parámetros de consulta del editor por lotes:
Cada parámetro puede tener un nombre largo y corto. Por ejemplo, el nombre largo de la ruta raíz de búsqueda es rootPath
, el corto es rp
. Si no se define el nombre largo, se lee el corto de la solicitud.
Parámetro (nombre largo/nombre corto) |
Tipo |
Descripción |
rootPath/rp |
Cadena | ruta raíz de búsqueda |
queryParams/qp |
Cadena | consulta de búsqueda |
contentMode / cm |
Booleano | cuando el valor es true, el modo de contenido está activado |
ProtocolosValue/cv |
Cadena[] | propiedades de búsqueda (valores marcados de fucSelection mostrados como casillas de verificación) |
extraCols/ec |
Cadena[] | propiedades de búsqueda extra (se muestran en un campo de texto separado por comas) |
initialSearch / is |
Booleano | cuando es true, la consulta se realiza al cargar la página |
olesSelection/cs |
Cadena[] | selección de propiedades buscadas (se muestran como casillas de verificación) |
showGridOnly/sgo |
Booleano | cuando es true, muestra solo la cuadrícula y no el panel de búsqueda |
searchPanelCollapsed / spc | Booleano | cuando es true, el panel de búsqueda se contrae durante la carga |
hideRootPath/hrp | Booleano | cuando es true, oculta el campo de ruta raíz |
hideQueryParams/hqp | Booleano | cuando es true, oculta el campo de consulta |
hideContentMode/hcm | Booleano | cuando es true, oculta el campo de modo de contenido |
hideColsSelection / hcs | Booleano | cuando es true, oculta el campo de selección de columnas |
hideExtraCols / hec | Booleano | cuando es true, oculta el campo de columnas adicionales |
hideSearchButton | Booleano | cuando es true, oculta el botón de búsqueda |
hideSaveButton / hsavep | Booleano | cuando es true, oculta el botón guardar |
hideExportButton/hexpb | Booleano | cuando es true, oculta el botón de exportación |
hideImportButton/hib | Booleano | cuando es true, oculta el botón importar |
hideResultNumber / hrn | Booleano | cuando es true, oculta el texto del número de resultado de búsqueda de la cuadrícula |
hideInsertButton/hinsertb | Booleano | cuando es true, oculta el botón de inserción de la cuadrícula |
hideDeleteButton/hdelb | Booleano | cuando es true, oculta el botón eliminar cuadrícula |
hidePathCol / hpc | Booleano | cuando es true, oculta la columna "ruta" de la cuadrícula |
Esta sección proporciona información general sobre cómo utilizar el editor por lotes y proporciona una descripción del componente de Geometrixx existente basada en el editor por lotes: el componente Lista de productos .
El componente Lista de productos permite a los usuarios mostrar y editar una tabla de datos. Por ejemplo, puede utilizar el componente Lista de productos para representar los productos de un catálogo. La información se presenta en una tabla de HTML estándar y cualquier edición se realiza en la variable Editar , que contiene un widget Editor masivo. (Este Editor por lotes es exactamente el mismo que el accesible en /etc/importers/bulkeditor.html o a través del menú Herramientas). El componente Lista de productos se ha configurado para la funcionalidad específica y limitada del editor por lotes. Se pueden configurar todas las partes del editor por lotes (o los componentes derivados del editor por lotes).
Con el editor por lotes, puede agregar, modificar, eliminar, filtrar y exportar las filas, guardar las modificaciones e importar un conjunto de filas. Cada fila se almacena como nodo en la propia instancia del componente Lista de productos. Cada celda es una propiedad de cada nodo. Esta es una opción de diseño y se puede cambiar fácilmente, por ejemplo, puede almacenar nodos en otro lugar del repositorio. La función del servlet de consulta es devolver la lista de los nodos que se van a mostrar; la ruta de búsqueda se define como una instancia de lista de productos.
El código fuente del componente Lista de productos está disponible en el repositorio en /apps/geometrixx/components/productlist y se compone de varias partes como todos los componentes de AEM:
Esta es una representación XML de los subnodos del cuadro de diálogo:
<editor
jcr:primaryType="cq:Widget"
colsSelection="[ProductId,ProductName,Color,CatalogCode,SellingSku]"
colsValue="[ProductId,ProductName,Color,CatalogCode,SellingSku]"
contentMode="false"
exportURL="/etc/importers/bulkeditor/export.tsv"
extraCols="Selection"
hideColsSelection="false"
hideContentMode="true"
hideDeleteButton="false"
hideExportButton="false"
hideExtraCols="true"
hideImportButton="false"
hideInsertButton="false"
hideMoveButtons="false"
hidePathCol="true"
hideRootPath="true"
hideSaveButton="false"
hideSearchButton="false"
importURL="/etc/importers/bulkeditor/import"
initialSearch="true"
insertedResourceType="geometrixx/components/productlist/sku"
queryParams=""
queryURL="/etc/importers/bulkeditor/query.json"
saveURL="/etc/importers/bulkeditor/save"
xtype="bulkeditor">
<saveButton
jcr:primaryType="nt:unstructured"
text="Save modifications"/>
<searchButton
jcr:primaryType="nt:unstructured"
text="Apply filter"/>
<queryParamsInput
jcr:primaryType="nt:unstructured"
fieldDescription="Enter here your filters"
fieldLabel="Filters"/>
<searchPanel
jcr:primaryType="nt:unstructured"
height="200">
<defaults
jcr:primaryType="nt:unstructured"
labelWidth="150"/>
</searchPanel>
<grid
jcr:primaryType="nt:unstructured"
height="275"/>
<store jcr:primaryType="nt:unstructured">
<sortInfo
jcr:primaryType="nt:unstructured"
direction="ASC"
field="CatalogCode"/>
</store>
<colModel
jcr:primaryType="nt:unstructured"
width="150"/>
<colsMetadata jcr:primaryType="nt:unstructured">
<Selection
jcr:primaryType="nt:unstructured"
checkbox="true"
forcedPosition="0"
headerText=""/>
<ProductId
jcr:primaryType="nt:unstructured"
cellCls="productlist-cell-productid"
headerText="Product Id"/>
<ProductName
jcr:primaryType="nt:unstructured"
cellStyle="background-color: #FFCC99;"
headerText="Product Name"/>
<CatalogCode
jcr:primaryType="nt:unstructured"
cellStyle="background-color: #EDEDED;"
headerText="Catalog Code"/>
<Color jcr:primaryType="nt:unstructured">
<editor
jcr:primaryType="nt:unstructured"
store="[Blue,Red,Yellow]"
triggerAction="all"
typeAhead="true"
xtype="combo"/>
</Color>
<SellingSku
jcr:primaryType="nt:unstructured"
headerText="Sku Id"/>
</colsMetadata>
</editor>
Se pueden configurar todas las partes del editor por lotes. En la tabla siguiente se enumeran todas las propiedades de configuración del editor por lotes.
Nombre de la propiedad | Definición |
rootPath | Buscar ruta raíz |
queryParams | Consulta de búsqueda |
contentMode | True para habilitar el modo de contenido: las propiedades se leen en el nodo jcr:content y no en el nodo de resultados de búsqueda |
ProtocolosValue | Propiedades de búsqueda (valores marcados de la selección de protocolos mostrados como casillas de verificación) |
extraCols | Propiedades de búsqueda extra (se muestran separadas por coma en un campo de texto) |
initialSearch | True para realizar consultas al cargar la página |
olesSelection | Selección de propiedades de búsqueda (mostradas como casillas de verificación) |
showGridOnly | True para mostrar solo la cuadrícula y no el panel de búsqueda (no olvide establecer initialSearch en true) |
searchPanelCollapsed | True para contraer el panel de búsqueda de forma predeterminada |
hideRootPath | Ocultar campo de ruta raíz |
hideQueryParams | Ocultar campo de consulta |
hideContentMode | Ocultar campo de modo de contenido |
hideColsSelection | Ocultar campo de selección de protocolos |
hideExtraCols | Ocultar campo de protocolos adicionales |
hideSearchButton | Ocultar botón de búsqueda |
hideSaveButton | Ocultar botón Guardar |
hideExportButton | Ocultar botón de exportación |
hideImportButton | Ocultar botón de importación |
hideResultNumber | Ocultar texto de número de resultado de búsqueda de cuadrícula |
hideInsertButton | Ocultar botón de inserción de cuadrícula |
hideDeleteButton | Ocultar botón de eliminación de cuadrícula |
hidePathCol | Ocultar columna "ruta" de cuadrícula |
queryURL | Ruta al servlet de consulta |
exportURL | Ruta para exportar servlet |
importURL | Ruta para importar servlet |
insertResourceType | Tipo de recurso agregado al nodo cuando se inserta una fila |
saveButton | Configuración del widget de botón Guardar |
searchButton | Configuración del widget de botón de búsqueda |
exportButton | Configuración del widget de botón de exportación |
importButton | Configuración del widget del botón de importación |
searchPanel | Configuración del widget del panel de búsqueda |
cuadrícula | Configuración de widget de cuadrícula |
almacenar | Configuración del almacén |
colModel | Configuración del modelo de columna de cuadrícula |
rootPathInput | configuración del widget rootPath |
queryParamsInput | configuración del widget queryParams |
contentModeInput | configuración del widget contentMode |
olesSelectionInput | Configuración del widget de la selección de protocolos |
extraColsInput | Configuración del widget extraCols |
ProtocolosMetadata | Configuración de metadatos de columna. Las propiedades posibles son (aplicadas a todas las celdas de la columna):
|
Puede configurar para cada columna:
propiedades de visualización: estilo html, clase CSS y solo lectura
una casilla de verificación
una posición forzada
CSS y columnas de solo lectura
El editor masivo tiene tres configuraciones de columna:
La configuración debe definirse como la siguiente:
"colsMetadata": {
"Column name": {
"cellStyle": "html style",
"cellCls": "CSS class",
"readOnly": true/false
}
}
El siguiente ejemplo se puede encontrar en el componente de lista de productos (/apps/geometrixx/components/productlist/dialog/items/editor/colMetadata?lang=es):
<colsMetadata jcr:primaryType="nt:unstructured">
<Selection
jcr:primaryType="nt:unstructured"
checkbox="true"
forcedPosition="0"
headerText=""/>
<ProductId
jcr:primaryType="nt:unstructured"
cellCls="productlist-cell-productid"
headerText="Product Id"/>
<ProductName
jcr:primaryType="nt:unstructured"
cellStyle="background-color: #FFCC99;"
headerText="Product Name"/>
<CatalogCode
jcr:primaryType="nt:unstructured"
cellStyle="background-color: #EDEDED;"
headerText="Catalog Code"/>
<Color jcr:primaryType="nt:unstructured">
<editor
jcr:primaryType="nt:unstructured"
store="[Blue,Red,Yellow]"
triggerAction="all"
typeAhead="true"
xtype="combo"/>
</Color>
<SellingSku
jcr:primaryType="nt:unstructured"
headerText="Sku Id"/>
</colsMetadata>
Casilla de verificación
Si la propiedad de configuración de casilla de verificación se establece en true, todas las celdas de la columna se procesan como casillas de verificación. Una casilla de verificación envía true al servidor Guardar servlet, false en caso contrario. En el menú del encabezado, también puede seleccionar todo o select none. Estas opciones se activan si el encabezado seleccionado es el encabezado de una columna de casilla de verificación.
En el ejemplo anterior, la columna de selección solo contiene casillas de verificación como casilla de verificación="true".
Posición forzada
Los metadatos de posición forzada forcedPosition permiten especificar dónde se coloca la columna dentro de la cuadrícula: 0 es el primer lugar y <number of="" columns="">-1 es la última posición. Se ignora cualquier otro valor.
En el ejemplo anterior, la columna de selección es la primera columna como forcedPosition="0".
De forma predeterminada, el servlet Query se encuentra en /libs/wcm/core/components/bulkeditor/json.java
. Puede configurar otra ruta para recuperar los datos.
El servlet Query funciona de la siguiente manera: recibe una consulta GQL y las columnas que se van a devolver, calcula los resultados y envía los resultados al editor en bloque como un flujo JSON.
En el caso del componente Lista de productos , los dos parámetros enviados al servlet Consulta son los siguientes:
y el flujo JSON devuelto es el siguiente:
{
"hits": [{
"jcr:path": "/content/geometrixx/en/products/jcr:content/par/productlist/1258674828905",
"ProductId": "21",
"ProductName": "Cube",
"Color": "Blue",
"CatalogCode": "43244",
"SellingSku": "32131"
}
],
"results": 1
}
Cada visita corresponde a un nodo y sus propiedades, y se muestra como una fila en la cuadrícula.
Puede ampliar el servlet Query para devolver un modelo de herencia complejo o nodos de retorno almacenados en un lugar lógico específico. El servlet Query se puede utilizar para realizar cualquier tipo de cálculo complejo. La cuadrícula puede mostrar filas que sean un agregado de varios nodos en el repositorio. La modificación y el guardado de estas filas deben ser administrados en ese caso por el servlet Guardar.
En la configuración predeterminada del editor por lotes, cada fila es un nodo y la ruta de este nodo se almacena en el registro de fila. El editor masivo mantiene el vínculo entre la fila y el nodo a través de la ruta jcr. Cuando un usuario edita la cuadrícula, se crea una lista de todas las modificaciones. Cuando un usuario hace clic en Guardar, se envía una consulta POST a cada ruta con los valores de propiedades actualizados. Esta es la base del concepto de Sling y funciona bien si cada celda es una propiedad del nodo . Pero si el servlet Query está implementado para realizar el cálculo de la herencia, este modelo no puede funcionar como una propiedad devuelta por el servlet Query puede heredarse de otro nodo.
El concepto de servlet Guardar es que las modificaciones no se publican directamente en cada nodo, sino que se publican en un servlet que realiza el trabajo de guardado. Esto ofrece a este servlet la posibilidad de analizar las modificaciones y guardar las propiedades en el nodo derecho.
Cada propiedad actualizada se envía al servlet en el siguiente formato:
Nombre del parámetro: <jcr path="">/<property name="">
Ejemplo: /content/geometrixx/es/products/jcr:content/par/productlist/1258674859000/SellingSku
Valor: <value>
Ejemplo: 12123
El servlet debe saber dónde se almacena la propiedad catalogCode.
La implementación predeterminada del servlet Guardar está disponible en /libs/wcm/bulkeditor/save/POST.jsp y se utiliza en el componente Lista de productos . Toma todos los parámetros de la solicitud (con un <jcr path="">/<property name=""> ) y escribe propiedades en nodos usando la API de JCR. También crea nodos si no existen (filas insertadas en la cuadrícula).
El código predeterminado no debe usarse tal cual, ya que vuelve a implementar lo que el servidor hace de forma nativa (un POST en <jcr path="">/<property name="">) y, por lo tanto, es solo un buen punto de partida para crear un servlet Save que administrará un modelo de herencia de propiedades.