Difference between revisions of "Plantillas PDF"

From SinergiaCRM - Wikisuite
Jump to navigation Jump to search
(Página creada con «==Introducción== ==Crear registro Plantilla PDF== En el módulo de Plantillas PDF, tenemos que crear un registro de plantilla basado en el módulo al cual queremos generar…»)
 
m
 
(21 intermediate revisions by 4 users not shown)
Line 1: Line 1:
==Introducción==
+
== Introducción ==
==Crear registro Plantilla PDF==
 
En el módulo de Plantillas PDF, tenemos que crear un registro de plantilla basado en el módulo al cual queremos generar nuestro fichero PDF.
 
  
(Captura Lista de módulos en PDF)
+
El módulo ''Plantillas PDF'' permite generar documentos personalizados (cartas, certificados, diplomas, etc.) a partir de plantillas prediseñadas. Conceptualmente, la funcionalidad genérica es la misma que ofrece [[Mail_Merge_Reports_-_Combinar_correspondencia|Mail Merge Reports]] pero existen algunos matices diferenciales que pueden conducir a utilizar uno u otro módulo en función de las necesidades concretas (ver [[#Diferencias entre Plantillas PDF y Mail Merge Reports|Diferencias entre Plantillas PDF y Mail Merge Reports]] más abajo).
  
  
 +
== Creación de una plantilla ==
  
 +
El proceso de creación de una plantilla parte de la selección del módulo principal del cual se desea obtener datos.
  
Una vez seleccionado el módulo, podremos utilizar el selector de campos para ir construyendo nuestra plantilla:
 
  
 +
[[Archivo:ModulosPDF.png|center|frame]]
  
  
 +
De forma similar a cómo se realiza en las plantillas de correo, mediante las casillas ''Insertar campos'' se pueden introducir los campos deseados del módulo elegido así como de módulos relacionados mediante relaciones 1:1 o 1:N. En el caso de las relaciones 1:N, se mostrarán aquellas en las que el módulo principal de la plantilla esté en el lado N. Por ejemplo, si el módulo de la plantilla es ''Pagos'', se podrán obtener datos de la persona asociada. En sentido contrario, sin embargo, no será posible: si el módulo de la plantilla es ''Personas'', no podrán obtenerse datos de uno de sus pagos ni de todos sus pagos en general.
  
(Captura selección de campos)
 
  
 +
[[Archivo:CamposPDF.png|center|frame]]
  
  
 +
=== Encabezado y pie de página ===
  
==Envío de PDF por Email==
+
Es posible incorporar el número de página y/o la fecha al encabezado o al pie de la plantilla PDF. Para ello existen dos variables especiales:  
Es posible generar y enviar una plantilla PDF a un registro de uno de los módulos de SinergiaCRM que contenga el campo de Email, ya sean los de Persona, Organización o Interesado. Para ello hay que generar primero el registro de Plantilla PDF basado en el módulo que se quiere enviar el email (ver apartado "Crear registro Plantilla PDF"). Una vez generada la plantilla, desde el registro al que queremos enviar el fichero, en la lista de Acciones, seleccionaremos "Enviar por PDF":
 
  
 +
{PAGENO} muestra el número de página actual.
 +
 +
{DATE D.m.Y} muestra la fecha actual en el formato indicado.
  
  
 +
Por otro lado, cabe tener en cuenta que en función del contenido que se haya introducido en el encabezado o en el pie puede ser necesario ampliar los márgenes superior o inferior de página a fin de que el documento final muestre adecuadamente dicho contenido. Estos son los valores por defecto que aparecen al crear una plantilla:
  
(Captura envío por PDF en registro individual)
 
  
 +
[[Archivo:plantilla_pdf_margenes.png|center|frame]]
  
  
 +
y esta es su interpretación:
  
Nos aparecerá una ventana de popup para seleccionar la plantilla PDF que queramos incluir en el email:
 
  
 +
[[Archivo:plantilla_pdf_ejemplo.png|center|frame]]
  
  
 +
Así, si se quisiera disponer de más espacio en el encabezado para mostrar, por ejemplo, el logotipo de la entidad, debería incrementarse suficientemente el valor del margen superior. De esta forma, el cuerpo de la plantilla se desplazaría hacia abajo, quedando el espacio necesario en la parte superior para mostrar el contenido completo del encabezado.
  
(Captura Popup PDFs)
 
  
 +
== Envío de PDF por correo ==
  
 +
Existe la posibilidad de enviar un correo electrónico con un enlace que permita la descarga directa de una plantilla PDF personalizada con los datos del destinatario del correo. El documento PDF se genera al vuelo en el momento que el destinatario hace clic en el enlace y no se almacena en el CRM.
  
 +
Los módulos que disponen de esta funcionalidad son aquellos que cuentan con el campo ''Correo electrónico'': ''Personas'', ''Organizaciones'' e ''Interesados''. En el botón-menú de accoiones de la vista de detalle del registro destinatario debe seleccionarse la opción ''Enviar PDF por correo'':
  
Una vez seleccionada la plantilla, nos aparecerá el editor de correos electrónicos, con un enlace en el cuerpo del email para descargar el PDF. En este momento, podremos editar el email y realizar el envío:
 
  
 +
[[Archivo:EnvioIndividual.png|center|frame]]
  
  
 +
Aparecerá una ventana emergente en la que se deberá seleccionar la plantilla PDF sobre la que generar el enlace de descarga que se incluirá en el correo:
  
(Captura Cuerpo email PDF)
 
  
 +
[[Archivo:PopupPDF.png|center|frame]]
  
  
 +
A continuación aparecerá el editor de correo electrónico con el enlace de descarga ya incluido en el cuerpo del mensaje.
  
Si se desea utilizar una plantilla, el contenido del mensaje se sobrescribirá, borrando el enlace para descargar el PDF. En este caso, antes de carga la Plantilla de Email, se recomienda copiar el enlace para después volverlo a pegar una vez cargada la plantilla
 
  
 +
[[Archivo:CuerpoPDF.png|center|frame]]
  
  
 +
<pre style="white-space: pre-wrap; color: red">Para asegurar que todos los clientes de correo pueden interpretar correctamente este enlace, se recomienda copiar el texto del enlace, seleccionar el texto del enlace y añadir propiamente un enlace desde el editor de la plantilla que se esté utilizando. </pre>
  
<span>== Crear el enlace de descarga PDF manualmente ==</span>
 
  
 +
En este punto pueden darse dos opciones:
  
<span></span>
+
- Redactar el correo manualmente de forma convencional. En este caso no caben mayores precauciones que la de no alterar el enlace proporcionado.
  
 +
- Aplicar una plantilla de correo ya existente. En este caso el cuerpo del mensaje quedará sobrescrito, borrándose el enlace de descarga. Así pues, antes de cargar la plantilla de correo deberá copiarse el enlace para poderlo pegar de nuevo una vez cargada dicha plantilla.
  
<span>En algunas ocasiones, nos puede interesar generar el enlace de descarga manualmente, ya sea para poder enviarlo por otra vía, que no sea la específicada anteriormente, o para añadirlo a alguna plantilla de envío de Campañas.</span>
 
  
 +
== Creación manual del enlace de descarga ==
  
<span></span>
+
En ocasiones puede ser necesario generar el enlace de descarga manualmente para incorporarlo en una campaña, para enviarlo por vías no convencionales, etc.
  
  
<span>El enlace tendrá siempre esta estructura:</span>
+
=== Enlace genérico ===
  
 +
La estructura genérica del enlace de descarga es la siguiente:
  
<span></span>
+
https://<span style="color:#FF0000"><instancia></span>/index.php?entryPoint=sticGeneratePdf&task=pdf&module=<span style="color:#FF0000"><modulo></span>&uid=<span style="color:#FF0000"><id_registro></span>&templateID=<span style="color:#FF0000"><id_plantilla_pdf></span>
  
 +
donde:
  
<span><a href="https://<nombre_instancia>.sinergiacrm.org/index.php?entryPoint=sticGeneratePdf&task=pdf&module=<nombre_interno_modulo>&uid=<id_registro_datos>&templateID=>id_registro_plantilla_pdf>">https://<nombre_instancia>.sinergiacrm.org/index.php?entryPoint=sticGeneratePdf&task=pdf&module=<nombre_interno_modulo>&uid=<id_registro_datos>&templateID=>id_registro_plantilla_pdf></id_registro_datos></nombre_interno_modulo></nombre_instancia></a></span>
+
- <code><instancia></code> es el nombre de dominio de la instancia del CRM, normalmente algo del tipo ''entidad.sinergiacrm.org''.
  
 +
- <code><modulo></code> es el nombre interno del módulo indicado como principal de la plantilla que se va a usar: ''Contacts'' (''Personas''), ''Accounts'' (''Organizaciones'') o ''Leads'' (Interesados).
  
<span></span>
+
- <code><id_registro></code> es el identificador interno del registro sobre el cual se quiere generar el documento pdf.
 +
 +
- <code><id_plantilla_pdf></code> es el identificador interno de la plantilla PDF a utilizar.
  
 +
Sobre cómo obtener los identificadores internos mencionados, puede consultarse el apartado [[Estructura_de_datos:_m%C3%B3dulos_y_campos#Notas_acerca_de_los_ID_de_los_registros|Notas acerca de los ID de los registros]].
  
<span></span>
+
Ejemplo de enlace con los valores genéricos reemplazados, listo para ser utilizado:
  
 +
https://<span style="color:#FF0000">entidad.sinergiacrm.org</span>/index.php?entryPoint=sticGeneratePdf&task=pdf&module=<span style="color:#FF0000">Contacts</span>&uid=<span style="color:#FF0000">8cc42192-3d53-9895-49aa-6284a5cf24d2</span>&templateID=<span style="color:#FF0000">d22c47c0-db5e-49ef-146c-628e039687b1</span>
  
<span>Un ejemplo sería éste:</span>
 
  
 +
=== Enlace para campañas ===
  
<span><span>https://ejemplo<nombre_instancia>.sinergiacrm.org/</nombre_instancia></span>index.php?entryPoint=sticGeneratePdf&task=pdf&module=Contacts&uid=8cc42192-3d53-9895-49aa-6284a5cf24d2&templateID=d22c47c0-db5e-49ef-146c-628e039687b1</span>
+
En el caso de las campañas la estructura del enlace es la misma ya descrita, pero al valor de <code><id_registro></code>, en lugar de  asociarle un identificador concreto, se le asociará una variable tal y como se haría con cualquier otro campo en una plantilla de correo convencional. De este modo al enviarse la campaña se sustituirá esa variable por el identificador concreto de cada destinatario. En función del módulo sobre el que se aplique la plantilla se usará la variable ''$contact_id'', ''$account_id'' o ''$lead_id''. A modo de ejemplo:
 +
 
 +
https://<span style="color:#FF0000">entidad.sinergiacrm.org</span>/index.php?entryPoint=sticGeneratePdf&task=pdf&module=<span style="color:#FF0000">Contacts</span>&uid=<span style="color:#FF0000">$contact_id</span>&templateID=d22c47c0-db5e-49ef-146c-628e039687b1
 +
 
 +
 
 +
== Diferencias entre Plantillas PDF y Mail Merge Reports ==
 +
 
 +
* Las plantillas PDF, tal y como indica su nombre, permiten la generación de documentos en formato PDF directamente en el CRM. En el caso de Mail Merge Reports (MMR en adelante), los ficheros se generan en formato MS Office / Open Office y, de ser necesario, deben ser convertidos en PDF a posteriori.
 +
 
 +
* En MMR es posible introducir datos de módulos relacionados tanto "hacia arriba" (campos relacionados) como "hacia abajo" (subpaneles). Por ejemplo, se puede diseñar una plantilla basada en Personas que muestre tanto los pagos de una persona ("hacia abajo") como la organización a la que pertenece ("hacia arriba"). Por contra, en una plantilla PDF la opción de mostrar información "hacia abajo" no existe.

Latest revision as of 19:23, 2 November 2022

Introducción

El módulo Plantillas PDF permite generar documentos personalizados (cartas, certificados, diplomas, etc.) a partir de plantillas prediseñadas. Conceptualmente, la funcionalidad genérica es la misma que ofrece Mail Merge Reports pero existen algunos matices diferenciales que pueden conducir a utilizar uno u otro módulo en función de las necesidades concretas (ver Diferencias entre Plantillas PDF y Mail Merge Reports más abajo).


Creación de una plantilla

El proceso de creación de una plantilla parte de la selección del módulo principal del cual se desea obtener datos.


ModulosPDF.png


De forma similar a cómo se realiza en las plantillas de correo, mediante las casillas Insertar campos se pueden introducir los campos deseados del módulo elegido así como de módulos relacionados mediante relaciones 1:1 o 1:N. En el caso de las relaciones 1:N, se mostrarán aquellas en las que el módulo principal de la plantilla esté en el lado N. Por ejemplo, si el módulo de la plantilla es Pagos, se podrán obtener datos de la persona asociada. En sentido contrario, sin embargo, no será posible: si el módulo de la plantilla es Personas, no podrán obtenerse datos de uno de sus pagos ni de todos sus pagos en general.


CamposPDF.png


Encabezado y pie de página

Es posible incorporar el número de página y/o la fecha al encabezado o al pie de la plantilla PDF. Para ello existen dos variables especiales:

{PAGENO} muestra el número de página actual.

{DATE D.m.Y} muestra la fecha actual en el formato indicado.


Por otro lado, cabe tener en cuenta que en función del contenido que se haya introducido en el encabezado o en el pie puede ser necesario ampliar los márgenes superior o inferior de página a fin de que el documento final muestre adecuadamente dicho contenido. Estos son los valores por defecto que aparecen al crear una plantilla:


Plantilla pdf margenes.png


y esta es su interpretación:


Plantilla pdf ejemplo.png


Así, si se quisiera disponer de más espacio en el encabezado para mostrar, por ejemplo, el logotipo de la entidad, debería incrementarse suficientemente el valor del margen superior. De esta forma, el cuerpo de la plantilla se desplazaría hacia abajo, quedando el espacio necesario en la parte superior para mostrar el contenido completo del encabezado.


Envío de PDF por correo

Existe la posibilidad de enviar un correo electrónico con un enlace que permita la descarga directa de una plantilla PDF personalizada con los datos del destinatario del correo. El documento PDF se genera al vuelo en el momento que el destinatario hace clic en el enlace y no se almacena en el CRM.

Los módulos que disponen de esta funcionalidad son aquellos que cuentan con el campo Correo electrónico: Personas, Organizaciones e Interesados. En el botón-menú de accoiones de la vista de detalle del registro destinatario debe seleccionarse la opción Enviar PDF por correo:


EnvioIndividual.png


Aparecerá una ventana emergente en la que se deberá seleccionar la plantilla PDF sobre la que generar el enlace de descarga que se incluirá en el correo:


PopupPDF.png


A continuación aparecerá el editor de correo electrónico con el enlace de descarga ya incluido en el cuerpo del mensaje.


CuerpoPDF.png


Para asegurar que todos los clientes de correo pueden interpretar correctamente este enlace, se recomienda copiar el texto del enlace, seleccionar el texto del enlace y añadir propiamente un enlace desde el editor de la plantilla que se esté utilizando. 


En este punto pueden darse dos opciones:

- Redactar el correo manualmente de forma convencional. En este caso no caben mayores precauciones que la de no alterar el enlace proporcionado.

- Aplicar una plantilla de correo ya existente. En este caso el cuerpo del mensaje quedará sobrescrito, borrándose el enlace de descarga. Así pues, antes de cargar la plantilla de correo deberá copiarse el enlace para poderlo pegar de nuevo una vez cargada dicha plantilla.


Creación manual del enlace de descarga

En ocasiones puede ser necesario generar el enlace de descarga manualmente para incorporarlo en una campaña, para enviarlo por vías no convencionales, etc.


Enlace genérico

La estructura genérica del enlace de descarga es la siguiente:

https://<instancia>/index.php?entryPoint=sticGeneratePdf&task=pdf&module=<modulo>&uid=<id_registro>&templateID=<id_plantilla_pdf>

donde:

- <instancia> es el nombre de dominio de la instancia del CRM, normalmente algo del tipo entidad.sinergiacrm.org.

- <modulo> es el nombre interno del módulo indicado como principal de la plantilla que se va a usar: Contacts (Personas), Accounts (Organizaciones) o Leads (Interesados).

- <id_registro> es el identificador interno del registro sobre el cual se quiere generar el documento pdf.

- <id_plantilla_pdf> es el identificador interno de la plantilla PDF a utilizar.

Sobre cómo obtener los identificadores internos mencionados, puede consultarse el apartado Notas acerca de los ID de los registros.

Ejemplo de enlace con los valores genéricos reemplazados, listo para ser utilizado:

https://entidad.sinergiacrm.org/index.php?entryPoint=sticGeneratePdf&task=pdf&module=Contacts&uid=8cc42192-3d53-9895-49aa-6284a5cf24d2&templateID=d22c47c0-db5e-49ef-146c-628e039687b1


Enlace para campañas

En el caso de las campañas la estructura del enlace es la misma ya descrita, pero al valor de <id_registro>, en lugar de asociarle un identificador concreto, se le asociará una variable tal y como se haría con cualquier otro campo en una plantilla de correo convencional. De este modo al enviarse la campaña se sustituirá esa variable por el identificador concreto de cada destinatario. En función del módulo sobre el que se aplique la plantilla se usará la variable $contact_id, $account_id o $lead_id. A modo de ejemplo:

https://entidad.sinergiacrm.org/index.php?entryPoint=sticGeneratePdf&task=pdf&module=Contacts&uid=$contact_id&templateID=d22c47c0-db5e-49ef-146c-628e039687b1


Diferencias entre Plantillas PDF y Mail Merge Reports

  • Las plantillas PDF, tal y como indica su nombre, permiten la generación de documentos en formato PDF directamente en el CRM. En el caso de Mail Merge Reports (MMR en adelante), los ficheros se generan en formato MS Office / Open Office y, de ser necesario, deben ser convertidos en PDF a posteriori.
  • En MMR es posible introducir datos de módulos relacionados tanto "hacia arriba" (campos relacionados) como "hacia abajo" (subpaneles). Por ejemplo, se puede diseñar una plantilla basada en Personas que muestre tanto los pagos de una persona ("hacia abajo") como la organización a la que pertenece ("hacia arriba"). Por contra, en una plantilla PDF la opción de mostrar información "hacia abajo" no existe.