Estructura plantillas MailMerge

From SinergiaCRM - Wikisuite
Jump to navigation Jump to search

Introducción

Las plantillas generadas mediante Mail Merge Reports tienen una estructura y una sintaxis determinadas, hecho que permite al CRM localizar y mostrar adecuadamente los datos deseados. Conocer dichas estructura y sintaxis permitirá reducir los posibles errores tanto en la creación como en la modificación de plantillas.

A continuación se muestra, a modo de ejemplo, la estructura de una plantilla y los diferentes elementos que la conforman. En este caso se trata de una plantilla basada en el módulo Eventos que incluye también información de los módulos Inscripciones y Sesiones.


Estructura plantillas MMR.jpg


Cabe tener en cuenta que las plantillas tan solo permiten mostrar información del módulo escogido como principal y de los que estén directamente relacionados con él. En este ejemplo no se podría mostrar información del módulo Asistencias pues, aunque está relacionado con Inscripciones y Sesiones, no lo está directamente con Eventos.


Encabezado

La primera línea de la plantilla debe contener siempre la siguiente marca de abertura.

En documentos de MS Word (.docx):

[a;block=w:body]

En documentos de OpenOffice (.odt):

[a;block=office:body]

Si la plantilla solo va a contener datos del módulo principal sobre el que se basa, esta primera línea no necesita nada más. En caso de que la plantilla vaya a contener datos de módulos relacionados, esta primera línea deberá incluir la declaración de las relaciones con estos módulos relacionados.

[a;block=w:body;sub1=<módulo_relacionado_1>;sub2=<módulo_relacionado_2>;etc.]

En el ejemplo del apartado anterior, esta primera línea quedaría así (para el caso de MS Word):

[a;block=w:body;sub1=stic_registrations_stic_events;sub2=stic_sessions_stic_events]

Cuando las variables de un subpanel se usen en más de un bloque de datos, la declaración de relaciones deberá ser repetida tantas veces como sea usada. Por ejemplo, si queremos sacar la lista de inscripciones en una tabla y en una lista de registros, se deberá declarar la relación dos veces, una vez por cada bloque en el que se use:

[a;block=w:body;sub1=stic_registrations_stic_events;sub2=stic_sessions_stic_events;sub_3=stic_registrations_stic_events]
En ningún caso debe omitirse o borrarse está primera línea, pues la plantilla dejaría de funcionar. Cabe tener en cuenta que al aplicar la plantilla sobre datos reales esta línea no se verá.


Tipos de variables

En una plantilla pueden aparecer tres tipos de variables:

1) Variables de campos del módulo principal: [a.<NombreCampo>]. Por ejemplo: [a.name] (nombre del registro)

2) Variables de campos del módulo principal de tipo Relacionado: [a.NombreRelación@@NombreCampo]. Por ejemplo: [a.assigned_user_link@@full_name] (nombre completo del usuario asignado al registro)

3) Variables de campos de módulos relacionados: [a_subX.NombreCampo], donde X será el índice asociado a la relación entre módulos según la declaración descrita en el apartado anterior. Por ejemplo: [a_sub1.stic_registrations_contacts_name] (donde sub1 se refiere a la relación stic_registrations_stic_events).


Bloques de datos

En la plantilla, la información extraída de módulos relacionados (que en el CRM se visualizaría a través de subpaneles) se mostrará en forma de bloques de datos.

Antes de cada bloque se debe declarar qué tipo de formato va a tener:

[a_subX;block=<elFormatoQueSeDesee>]

Existen diferentes tipos de bloques:

Tipo de bloque Word (.docx) OpenOffice (.odt)
Párrafo w:p text:p
Filas de tabla w:tr table:table-row
Tabla w:tbl table:table
Lista de elementos w:p text_list-item


Párrafo

Plantilla:

[a_sub1;block=w:p]

"El nombre de la inscripción es [a_sub1.name] y su fecha de inscripción es [a_sub1.registration_date]."

Resultado:

El nombre de la inscripción es María García - Curso de lengua de signos y su fecha de inscripción es 01/01/2022 10:34.


Filas de tabla

Plantilla:

Nombre inscripción Fecha de inscripción
[a_sub1;block=w:tr][a_sub1.name] [a_sub1.registration_date]

Resultado:

Nombre inscripción Fecha de inscripción
María García - Curso de lengua de signos 01/01/2022 10:34
Juan Sánchez - Curso de lengua de signos 30/12/2021 20:14


Tabla

Plantilla:

Nombre inscripción Fecha de inscripción
[a_sub1;block=w:tbl][a_sub1.name] [a_sub1.registration_date]

Resultado:

Nombre inscripción Fecha de inscripción
María García - Curso de lengua de signos 01/01/2022 10:34
Nombre inscripción Fecha de inscripción
Juan Sánchez - Curso de lengua de signos 30/12/2021 20:14


Lista de elementos

Plantilla:

[a_sub1;block=w:p]
* [a_sub1.name], [a_sub1.registration_date]

Resultado:

  • María García - Curso de lengua de signos, 01/01/2022 10:34
  • Juan Sánchez - Curso de lengua de signos, 30/12/2021 20:14


Bloques compuestos

Un bloque también puede estar constituido por varios bloques usando el símbolo "+" para unirlos. Así, dos párrafos se definirían de la siguiente forma:

w:p+w:p


Recursos adicionales

[http://wiki.sinergiacrm.org/images/MailMergeReports-2.5-GuíaUsuario.pdf ‎Mail Merge Reports - Guía de usuario - v2.5


Volver al índice