Visión general del archivo get-data-config.xml
El archivo get-data-config.xml se utiliza para configurar generadores de expresiones utilizado por el código getData de JSTL configurado por la acción getData de HCL Commerce. Cuando se utilizan los datos getData se especifica un nombre de generador de expresiones y un nombre de tipo de datos. Esa información se utiliza al examinar la configuración en el archivo get-data-config.xml para determinar qué expresión XPath se va a ejecutar.
Debe:
- Crear un nuevo archivo get-data-config.xml cuando cree un nuevo módulo de servicio y no se le haya proporcionado el archivo de configuración. La creación de un nuevo archivo de configuración le permite crear sus propios generadores de expresiones.
- Ampliar el archivo get-data-config.xml cuando se le haya proporcionado el archivo de configuración. Cuando realice cambios, no deberá modificar directamente el archivo get-data-config.xml, ya que dichos cambios se perderían al sustituir los archivos de configuración. Por ejemplo, cuando se actualiza HCL Commerce. Mediante la ampliación de la configuración, puede alterar las propiedades del generador de expresiones.
- Deben tener get-data-config como elemento raíz.
- Debe haber un archivo de configuración para cada componente que esté configurado para su uso con la acción getData.
- Se esperan archivos de configuración de componente base en WEB-INF/config/base/componente/get-data-config.xml, donde componente es un directorio que es exclusivo para el componente.
- Las extensiones de cliente ha de estar en WEB-INF/config/ext/.global/get-data-config. Las extensiones de cliente se cargan después de las configuraciones de componentes base.
Nota: Todas las vías de acceso de este archivo se refieren a la ubicación instalada de la de la aplicación web, por ejemplo, la Portlet WAR (MVCPortlet.war).
Todos los generadores de expresiones se definen en los archivos get-data-config.xml. El elemento data-type declara un tipo de datos soportado para la acción getData. El elemento client-facade declara la fachada de cliente de componente que invoca el servicio para recuperar los datos. El generador de expresiones maneja la creación de la expresión XPath con los parámetros de entrada publicados.
Cada generador de expresiones tiene las propiedades siguientes:
- El nodo <name> identifica de forma exclusiva el generador de expresiones y las etiquetas getData lo utilizan en las JSP de proyecto cuando se hace referencia a un generador de expresiones.
- El nodo <data-type-name> contiene el tipo de nombre que devuelve el generador de expresiones.
- El nodo <expression template> hace referencia a una consulta XPath definida en el archivo de plantilla de consulta, que se utiliza para recuperar información específica de la base de datos. Se pueden pasar parámetros como $projectID$ al generador de expresiones mediante un código getData.
- Cada nodo <param> contiene un par de nodos secundarios <name> y <value> que definen un parámetro que debe pasarse al archivo de plantilla de consulta. Aquí asociamos cada generador de expresiones con un perfil de acceso específico. Este perfil de acceso, junto con la consulta XPath definida más arriba, identifica de forma exclusiva una consulta en el archivo de plantilla de consulta.
El archivo get-data-config.xml creado previamente contiene:
- El elemento <data-type>, que define una interfaz Java para el SDO lógico.
- El elemento client-facade, que define una interfaz Java en el código de fachada de cliente.
- El elemento expression-builder que define una plantilla de expresión XPath, junto con un perfil de acceso y el tipo de datos de los nombres que se devuelven; es decir, el nombre de CustomAppProperties definido en el elemento anterior data-type.
La ampliación del archivo get-data-config también puede cambiar el comportamiento de los componentes del negocio. Por ejemplo, el componente Catálogo, de forma predeterminada, habilita la búsqueda por número de pieza y nombre (sensible a mayúsculas/minúsculas). Este comportamiento se puede cambiar para habilitar únicamente en el catálogo la búsqueda por número de pieza o la búsqueda por nombre a fin de mejorar el rendimiento de las búsquedas en el sitio.
Las aplicaciones web del Centro de gestión utilizan el archivo get-data-config.xml para configurar el
wcf:getData tag definido en los JSP del controlador de obtención (Get) y definen:- Las interfaces Java para los SDO lógicos.
- Las interfaces Java para que las fachadas cliente interactúen con los servicios de HCL Commerce.
- Una lista de plantillas de expresión de XPath utilizadas por la aplicación cliente del Management Center.