Capítulo VIII: QWeb
QWeb es un motor (engine) de plantillas por odoo. Está basado en XML y es utilizado para generar fragmentos y páginas html. QWeb fue introducido por primera vez en la versión 7.0 para habilitar vistas kanban más ricas, y con las versión 8.0, también se usa para la generación de reportes y páginas web CMS (CMS: Sistemas Manejadores de Contenido).
Aquí aprenderás acerca de la sintaxis QWeb y como usarla para crear tus propias vistas kanban reportes personalizados.
Para entender los tableros kanban, kanban es una palabra de origen japonés que es usada para representar un método de gestión de colas (queue) de trabajo. Fue inspirado del Sistema de Producción y Fabricación Ligera (lean) de Toyota, y se ha vuelto popular en la la industria del software con su adopción en las metodologías Ágiles.
El tablero kanban es una herramienta para visualizar la cola de trabajo. Los artículos (items) de trabajo están representados por tarjetas que son organizadas en columnas represantando las etapas (stages) del proceso de trabajo. Nuevos artículos de trabajo inician en la columna más a la izquierda y viaja a través del tablero hasta que alcanzan la columna más a la derecha, representando el trabajo completado.
Iniciándose con el tablero kanban
La simplicidad y el impacto visual del tablero kanban los hace excelente para soportar procesos de negocio simples. Un ejemplo básico de un tablero kanban puede tener tres columnas, como se muestra en la siguiente imagen: “ToDo”, “Doing” y “Done” (Por hacer, haciendo y hecho), pero, por supuesto puede ser extendido a cualquier paso de un proceso específico que necesitemos:
Las vistas kanban una característica distintiva de Odoo, haciendo fácil implementar estos tableros. Aprendamos cómo usarlos.
Kanban views
En las vistas de formulario, usamos mayormente elementos XML específicos, tales como <field> y <group>, y algunos elementos HTML, tales como <h1> o <div>. Con las vistas kanban, es un poco lo opuesto; ellas son plantillas basadas en HTML y soportan solo dos elementos específicos de Odoo, <field> y <button>.
El HTML puede ser generado dinámicamente usando el motor de plantilla Qweb. Éste procesa los atributos de etiqueta especiales en los elementos HTML para producir el HTML final para ser presentado por el cliente web. Esto proporciona mucho control sobre cómo renderizar el contenido, pero también permite hacer diseños de vistas más complejas.
Las vistas kanban son tan flexibles que pueden haber muchas formas diferentes de diseñarlas, y puede ser difícil proveer una receta para seguir. Una buena regla general es encontrar un vista kanban existente similar a lo que queremos alcanzar, y crear nuestro nuevo trabajo de vista kanban basada en ella.
Observando las vistas kanban usadas en los módulos estándar, es posible identificar dos estilos de vistas kanban principales: viñeta y tarjeta
Ejemplos de las vistas kanban de estilo viñeta pueden ser encontrados en Clientes, Productos, y también, Aplicaciones y Módulos. Ellos usualmente no tienen borde y son decorados con imágenes en el lado de la izquierda, tal como se muestra en la siguiente imagen:
El estilo kanban tarjeta es usualmente usada para mostrar tarjetas organizadas en columnas para las etapas de procesos. Ejemplo de esto son las Oportunidades CRM y las Tareas de Proyectos. El contenido principal es mostrado en el área superior de la tarjeta y la información adicional puede ser mostrada en las áreas inferior derecha e inferior izquierda, tal como se muestra en la siguiente imagen:
Veremos el esqueleto y elementos típicos usados en ambos estilos de vistas tal que puedas sentirte cómodo adaptándolos a tus casos de usos particular.
Diseña vistas kanban
La primera cosa es crear un nuevo módulo agregando nuestras vistas kanban a la lista de tareas por hacer. En un trabajo del mundo real, una situación de uso de un módulo para esto podría ser, probablemente, excesiva y ellas podrían ser perfectamente agregadas directamente en el módulo todo_ui. Pero para una explicación más clara, usaremos un nuevo módulo y evitaremos demasiados, y posiblemente confusos, cambios en archivos ya creados. Lo nombraremos todo_kanban y crearemos los archivos iniciales tal como sigue:
Ahora, edita el archivo descriptor todokanban/_opernerp.py tal como sigue:
Next, create the XML file where our shiny new kanban views will go and set kanban as the default view on the to-do task
Lo que sigue es crear el archivo XML donde nuestras nuevas y brillantes vistas kanban irán y establecer kanban como la vista por defecto en la acción (action) de ventana de las tareas por hacer (to-do tasks), tal como se muestre a continuación:
Ahora tenemos ubicado el esqueleto básico para nuestro módulo. Las plantillas usada en las vistas kanban y los reportes son extendidos usando las ténicas regulares usadas para otras vistas, por ejemplos usandos expresiones XPATH. Para más detalles, ve al Capítulo 3, Herencia – Extendiendo Aplicaciones Existentes.
Antes de iniciar con las vistas kanban, necesitamos agregar un para de campos en el modelo tareas por hacer. (to-do tasks model)
Prioridad y estado (state) kanban
Los dos campos que son frecuentemente usados en las vistas kanban son: priority y kanban state. Priority permite a los usuarios organizar sus elementos de trabajo, señalando lo que debería estar ubicado primero. Kanban state señala cuando una tarea está lista para pasar a la siguiente etapa o si es bloqueada por alguna razón. Ambos son soportados por campos selection y tienen widgets específicos para ser usados en las vistas de formulario y kanban.
Para agrega estos campos a nuestro modelo, agregaremos al archivo todo_kanban/todo_task.py, tal como se muestra a continuación:
No olvidemos el archivo todokanban/_init.py que cargará el código precedente:
from . import todo model
Elementos de la vista kanban
La arquitectura de la vista kanban tiene un elemento superior y la siguiente estructura básica:
El elemento contiene las plantillas para los fragmentos HTML a usar —uno o más. La plantilla principal a ser usada debe ser nombrada kanban-box. Otras plantillas son permitidas para fragmentos HTML para se incluido en la plantilla principal.
Las plantillas usan html estandar, pero pueden incluir etiquetas <field> para insertar campos del modelo. También pueden ser usadas algunas directivas especiales de Qweb para la generación dinámica de contenido, tal como el t-name usado en el ejemplo previo.
Todos los campos del modelo usados deben ser declarados con una etiqueta <field>. Si ellos son usados solo en expresiones, tenemos que declararlos antes de la sección <templates>. Uno de esos campos se le permite tener un valor agregado, mostrado en en el área superior de las columnas kanban. Esto se logra mediante la adición de un atributo con la agregación a usar, por ejemplo:
<field name="effort_estimated" sum="Total Effort" />
Aquí, la suma para el campo de estimación de esfuerzo es presentada en el área superios de las columnas kanban con la etiqueta Total Effort. Las agregaciones soportadas son sum, avg, min, max y count.
El elemento superior también soporta algunos atributos interesantes:
default_group_by: Establece el campo a usar para la agrupación por defecto de columnas
default_order: Establece un orden por defecto para usarse en los elementos kanban
quick_create=”false”: Deshabilita la opción de creación rápida en la vista kanban
class: Añade una clase CSS al elemento raíz en la vista kanban renderizada.
Ahora démosle una mirada más de cerca a las plantillas Qweb usadas en las vistas kanban.
La vista kanban viñeta
Para las plantilas QWeb de las viñetas kanban, el esqueleto se ve así:
Puedes ver las dos clases CSS principales provistas para los kanban de estilo viñeta: oe_kanban_vignette para el contenedor superior y oe_kanban_details para el contenido de datos.
La vista completa de viñenta kanban para las tareas por hacer es como sigue:
Podemos ver los elementos discutidos hasta ahora, y también algunos nuevos. En la etiqueta , tenemos el atributo QWeb especial t-att-src. Esto puede calcular el contenido src de la imagen desde un campo almacenado en la base de datos. Explicaremos esto en otras directivas QWeb en un momento. También podemos ver el uso del atributo especial type en la etiqueta <a>. Echémosle un vistazo más de cerca.
Acciones en las vistas kanban
En las plantillas Qweb, la etiqueta para enlaces puede tener un atributo type. Este establece el tipo de acción que el enlace ejecutará para que los enlaces puedan actuar como los botones en los formularios regulares. En adición a los elementos <button>, las etiquetas <a> también pueden ser usadas para ejecutar acciones Odoo.
Así como en las vistas de formulario, el tipo de acción puede ser acción u objeto, y debería ser acompañado por atributo nombre, que identifique la acción específica a ejecutar. Adicionalmente, los siguentes tipos de acción también están disponibles:
open: Abre la vista formulario correspondiente
edit: Abre la vista formulario correspondiente directamente en el modo de edición
delete: Elimina el regitro y remueve el elemento de la vista kanban.
La vista kanban de tarjeta El kanban de tarjeta puede ser un poco más complejo. Este tiene un área de contenido principal y dos sub-contenedores al pie, alineados a cada lado de la tarjeta. También podría contener un botń de apertura de una acción de menú en la esquina superior derecha de la tarjeta.
El esqueleto para esta plantilla se vería así:
Un kanban tarjeta es más apropiada para las tareas to-do, así que en lugar de la vista descrita en la sección anterior, mejor deberíamos usar la siguiente:
Hasta ahora hemos visto vistas kanban estáticas, usando una combinación de HTML y etiquetas especiales (field, button, a). Pero podemos tener resultados mucho más interesantes usando contenido HTML generado dinámicamente. Veamos como podemos hacer eso usando Qweb.
Agrengano contenido dinámico Qweb
El analizador Qweb busca atributos especiales (directivas) en las plantillas y las reemplaza con HTML generado dinámicamente.
Para las vistas kanban, el análisis se realiza mediante Javascript del lado del cliente. Esto significa que las evaluaciones de expresiones hechos por Qweb deberían ser escritas usando la sintaxis Javascript, no Python.
Al momento de mostrar una vista kanban, los pasos internos son aproximadamente los siguientes:
Obtiene el XML de la plantilla a renderizar
Llama al método de servidor
read()para obtener la data de los campos en las plantillas.Ubica la plantilla
kanban-boxy la analisa usando Qweb para la salida de los fragmentos HTML finales.Inyecta el HTML en la visualización del navegador (el DOM).
Esto no significa que sea exacto técnicamente. Es solo un mapa mental que puede ser útil para entender como funcionan las cosas enlas vistas kanban.
A continuación exploraremos las distintas directiva Qweb disponibles, usando ejemplos que mejorarán nuestra tarjeta kanban de la tarea to-do.
Renderizado Condicional con t-if
La directiv t-if, usada en el ejemplo anterior, acepta expresiones JavaScript para ser evaluadas. La etiqueta y su contenido serán renderizadas si la condición se evalúa verdadera.
Por ejemplo, en la tajeta kanban, para mostrar el esfuerzo estimado de la Tarea, solo si este contiene un valor, después del campo date_deadline, agrega lo siguiente:
El contexto de evaluación JavaScript tiene un objeto de registro que representa el registro que está siendo renderizado, con las campos solicitados del servidor. Los valores de campo pueden ser accedidos usando el atributo raw_value o el value:
raw_value: Este es el valor retornado por el método de servidorread(), así que se ajusta más para usarse en expresiones condicionales.value: Este es formateado de acuerdo a las configuraciones de usuario, y está destiado a ser mostrado en la interfaz del usuario.
El contexto de evaluación de Qweb también tiene referencias disponibles para la instancia JavaScript del cliente web. Para hacer uso de ellos, se necesita una buena comprensión de la arquitectura de cliente web, pero no podremos llegar a ese nivel de detalle. Para propósitos referenciales, los identificadores siguientes están disponibles en la evaluación de expresiones Qweb:
widget: Esta es una referencia al objeto widget KanbanRecord, responsable por el renderizado del registro actual dentro de la tarjeta kanban. Expone algunas funciones de ayuda útiles que podemos usar.record: Este es un atajo parawidget.recordsy provee acceso a los campos disponibles, usando notación de puntos.read_only_mode:widget: This is a reference to the current KanbanRecord widget object, responsible for the rendering of the current record into a kanban card. It exposes some useful helper functions we can use.
record: This is a shortcut for widget.records and provides access to the fields available, using dot notation.
read_only_mode: This indicates if the current view is in read mode (and not in edit mode). It is a shortcut for widget.view.options.read_only_mode.
instance: This is a reference to the full web client instance.
It is also noteworthy that some characters are not allowed inside expressions. The lower than sign (<) is such a case. You may use a negated >= instead. Anyway, alternative symbols are available for inequality operations as follows:
lt: This is for less than.
lte: This is for less than or equal to.
gt: This is for greater than.
gte: This is for greater than or equal to.
Rendering values with t-esc and t-raw
We have used the element to render the field content. But field values can also be presented directly without a tag. The t-esc directive evaluates an expression and renders its HTML escaped value, as shown in the following:
In some cases, and if the source data is ensured to be safe, t-raw can be used to render the field raw value, without any escaping, as shown in the following code:
Loop rendering with t-foreach
A block of HTML can be repeated by iterating through a loop. We can use it to add the avatars of the task followers to the tasks start by rendering just the Partner IDs of the task, as follows:
The t-foreach directive accepts a JavaScript expression evaluating to a collection to iterate. In most cases, this will be just the name of a to many relation field. It is used with a t-as directive to set the name to be used to refer to each item in the iteration.
In the previous example, we loop through the task followers, stored in the message_follower_ids field. Since there is limited space on the kanban card, we could have used the slice() JavaScript function to limit the number of followers to display, as shown in the following:
The rec variable holds each iterations avatar stored in the database. Kanban views provide a helper function to conveniently generate that: kanban_image(). It accepts as arguments the model name, the field name holding the image we want, and the ID for the record to retrieve.
With this, we can rewrite the followers loop as follows:
We used it for the src attribute, but any attribute can be dynamically generated with a t- att- prefix.
String substitution in attributes with t-attf- prefixes.
Another way to dynamically generate tag attributes is using string substitution. This is helpful to have parts of larger strings generated dynamically, such as a URL address or CSS class names.
The directive contains expression blocks that will be evaluated and replaced by the result. These are delimited either by or by #{ and }. The content of the blocks can be any valid JavaScript expression and can use any of the variables available for QWeb expressions, such as record and widget.
Now lets rework it to use a sub-template. We should start by adding another template to our XML file, inside the element, after the <t t-name="kanban-box"> node, as shown in the following:
Calling it from the kanban-box main template is quite straightforwardfor eacht exist in the caller3s value when performing the sub-template call as follows:
The entire content inside the t-call element is also available to the sub-template through the magic variable 0. Instead of the argument variables, we can define an HTML code fragment that could be inserted in the sub-template using <t t-raw="0" />.
Other QWeb directives
We have gone through through the most important Qweb directives, but there are a few more we should be aware of. Weve seen the basics about kanban views and QWeb templates. There are still a few techniques we can use to bring a richer user experience to our kanban cards.
Adding a kanban card option menu
Kanban cards can have an option menu, placed at the top right. Usual actions are to edit or delete the record, but any action callable from a button is possible. There is also available a widget to set the card
It is basically an HTML list of elements. The Edit and Delete options use QWeb to make them visible only when their actions are enabled on the view. The widget.view.is_action_enabled function allows us to inspect if the edit and delete actions are available and to decide what to make available to the current user.
Adding colors to kanban cards
The color picker option allows the user to choose the color of a kanban card. The color is stored in a model field as a numeric index.
We should start by adding this field to the to-do task model, by adding to todo_kanban/todo_model.py the following line:
Here we used the usual name for the field, color, and this is what is expected in the data- field attribute on the color picker.
Next, for the colors selected with the picker to have any effect on the card, we must add some dynamic CSS based on the color field value. On the kanban view, just before the tag, we must also declare the color field, as shown in the following:
And, we need to replace the kanban card top element, , with the following:
The kanban_color helper function does the translation of the color index into the corresponding CSS class name.
And that). A helper function for this is available in kanban views.
For example, to limit our to-do task titles to the first 32 characters, we should replace the
element with the following:
Custom CSS and JavaScript assets
As we have seen, kanban views are mostly HTML and make heavy use of CSS classes. We have been introducing some frequently used CSS classes provided by the standard product. But for best results, modules can also add their own CSS.
We are not going into details here on how to write CSS, but itt work, since we havenWebkit HTML to PDF.s probably not what you will get now on your system. Lett display the You need Wkhtmltopdf to print a pdf version of the reports time library
user: This is the record for the user running the report
res_company: This is the record for the current user Designing the User Interface*, with an additional widget to set the widget to use to render the field.
A common example is a monetary field, as shown in the following:
A more sophisticated case is the contact widget, used to format addresses, as shown in the following:
By default, some pictograms, such as a phone, are displayed in the address. The no_marker="true" option disables them.
Enabling language translation in reports
A helper function, translate_doc(), is available to dynamically translate the report content to a specific language.
It needs the name of the field where the language to use can be found. This will frequently be the Partner the document is to be sent to, usually stored at partner_id.lang. In our case, we dons also a less efficient method.
If you cans growing in importance in the Odoo toolset. Finally, you had an overview on how to create reports, also using the QWeb engine.
In the next chapter, we will explore how to leverage the RPC API to interact with Odoo from external applications.
Last updated
