Tipos de plantillas y sintaxis

Tipos de plantillas

Mobee admite dos tipos de plantillas:

Plantilla de documento simple

Cuando la casilla Documento Combinado no está marcada, la plantilla está diseñada para una generación unitaria. Esto significa que la plantilla incluye información de un único registro. Por ejemplo, si creas una plantilla simple para el objeto "Contacto", incorporará la información de un solo contacto y sus datos relacionados.

Plantilla de documento combinado

Cuando la casilla Documento Combinado está marcada, indica que la plantilla se generará para múltiples registros simultáneamente. Esta plantilla utiliza una sintaxis especial para recorrer una lista de registros. Para acceder a los campos de cada registro en un documento combinado, tu plantilla debe comenzar recorriendo la lista de elementos utilizando la etiqueta {#items}{/}. Consulta la sección de bucles para más detalles.

Sintaxis

La sintaxis de las etiquetas utilizadas en las plantillas de Mobee se inspira en la especificación Mustache, que no depende de un lenguaje específico.

Las etiquetas normales comienzan con un carácter alfabético.
Otros tipos de etiquetas comienzan con prefijos especiales.

Por ejemplo:

Acceder a campos de combinación en el objeto: {Salutation} {firstName} {lastName}
Acceder a datos de listas relacionadas: {#cases} y {/} para abrir y cerrar una etiqueta. Consulta la sección bucles para más detalles.
Insertar imágenes dinámicas: {%ImageUrl__c} agregará la imagen del campo "ImageUrl__c". Consulta la sección Imágenes dinámicas para más detalles.

Por ejemplo, para acceder a los datos del objeto "Contacto" usando la sintaxis proporcionada en tu plantilla:

Hola {Salutation} {FirstName} {LastName}!

Salida:

Hola Sr. John Doe!

Condiciones

Las condiciones comienzan con el carácter # y terminan con una barra. Por ejemplo, {#Salutation == "Mr."} inicia una condición y {/} la cierra.

Nota: Para verificar campos de casillas de verificación (true o false), utiliza la siguiente sintaxis:

El contacto {Name} {#HasOptedOutOfEmail == 1}ha{/}{#HasOptedOutOfEmail == 0}no ha{/} optado por no recibir correos electrónicos.

Salida:

El contacto Sr. John Doe ha optado por no recibir correos electrónicos.

Expresiones lógicas

Puedes utilizar los siguientes operadores para expresiones lógicas más complejas:

AND a && b
OR a || b
SUMA a + b
RESTA a - b
MULTIPLICACIÓN a * b
MÓDULO a % b
DIVISIÓN a / b
TERNARIO a ? b : c
ASIGNACIÓN a = 1
IGUALDAD/DESIGUALDAD a == 1, a != 1
RELACIONAL a > 1, a < 1, a >= 1, a <= 1
PRECEDENCIA DE OPERADORES con paréntesis (a && b) || c
NOTACIÓN EXPONENCIAL: 12e3 => retorna 12000

Ejemplo:

{#products.length > 1}Hay varios productos{/}
{#firstName == "John"}Hola John{/}

La primera condición mostrará la sección solo si hay 2 o más productos.

La segunda condición mostrará la sección solo si el nombre del usuario es la cadena "John".

Salida:

Hay varios productos
Hola John

Bucles

Como se mencionó anteriormente, los bucles comienzan con el símbolo "#". Ejemplo:

{#Cases}
{CaseNumber}: {Description}.
{/}

Salida:

00001299: Necesita permiso de acceso para visitar la ubicación.
00001624: Soporte al cliente.
00001836: Falta el cable del cargador de batería.

Nota: Cada campo de combinación utilizado en la sección de bucle se refiere a los campos del objeto relacionado actual. Si el campo no se encuentra en el objeto relacionado, el motor lo referencia desde el objeto principal.

Imágenes dinámicas

Las imágenes dinámicas pueden integrarse fácilmente en tus documentos generados mediante el uso de marcadores dinámicos. Por ejemplo, si posees un campo llamado ProfilePicture__c que contiene la URL de una imagen o la imagen codificada como una cadena Base64, puedes incorporarla en tu documento usando la etiqueta designada: {%ProfilePicture__c} (comenzando con el símbolo %).

Imágenes Base64

Para incluir una imagen usando datos en formato Base64, simplemente codifica la imagen en Base64 y almacénala directamente en el campo de Salesforce.

Imágenes por URL

Para incorporar una imagen usando una URL, sigue estos pasos:

Ve a "Configuración" dentro de Salesforce.
En el cuadro de búsqueda rápida, ubica y selecciona "Configuraciones de sitios remotos."
Haz clic en el botón "Nuevo Sitio Remoto."
Asigna un nombre al sitio (por ejemplo, "Sitio Imgur").
En el campo "URL del Sitio Remoto," introduce la URL base de la ubicación de la imagen, como "https://i.imgur.com."
Habilita la casilla "Deshabilitar Seguridad de Protocolo" para permitir la recuperación mediante HTTP.
Selecciona "Guardar" para guardar los cambios.
Realiza los siguientes pasos para incorporar la URL en los sitios de confianza con todas las directivas de Política de Seguridad de Contenidos (CSP) habilitadas:
1. En la página de configuración, ubica "URLs de confianza" utilizando el cuadro de búsqueda rápida.
2. Selecciona el botón "Nuevo Sitio de Confianza."
3. Asigna un nombre al sitio de confianza (por ejemplo, "Imgur Confiable").
4. En el campo "URL del Sitio," introduce la misma URL base que antes, es decir, "https://i.imgur.com."
5. Habilita todas las directivas CSP: "Connect," "Font," "Img," "Media," "Object," "Script," "Style."
6. Confirma los cambios haciendo clic en "Guardar."

Ejemplo de Imagen

Ahora has configurado las configuraciones de sitio remoto y URLs confiables para recuperar la imagen de manera segura mediante HTTP. Luego, puedes usar la etiqueta {%ProfilePicture__c} para incluir dinámicamente la imagen en los documentos generados.

Funcionalidades adicionales

Mobee proporciona varias etiquetas y filtros para ayudar a los usuarios a personalizar sus documentos.

Fechas

La etiqueta {docUtils.today} es un elemento predefinido que permite incluir la fecha actual en una plantilla de documento durante el proceso de generación. Además de los filtros descritos a continuación, los usuarios tienen la flexibilidad de manipular esta fecha según sus necesidades específicas.

Filtros

Con los filtros, es posible manipular cualquier campo de datos proporcionado. Mobee sugiere múltiples filtros diseñados para formatear, manipular y personalizar contenido dinámico dentro de las plantillas de documentos. Estos filtros ayudan a los usuarios a formatear fechas, cambiar la capitalización del texto y generar contenido personalizado.

Ejemplo de uso

Escenario:
Un usuario está generando un documento de contrato que incluye un formato de fecha personalizado y nombres formateados dinámicamente. El sistema debe devolver fechas en diferentes formatos y convertir los nombres a mayúsculas o minúsculas según sea necesario.

Plantilla:

Hola {Salutation} {FirstName} {LastName | upper}!  
La fecha de hoy es {docUtils.today | formatDate: '[["year": "numeric", "month": "long", "day": "numeric"]]'} .  
La fecha de inicio del contrato es {StartDate | shortDate}.  
El próximo año, esta fecha será {StartDate | followingYear}.  

Datos de entrada:

Campo	Valor
Salutation	Sr.
FirstName	John
LastName	Doe
StartDate	2022-01-21

Salida esperada:

Hola Sr. John DOE!  
La fecha de hoy es 21 de enero de 2022.  
La fecha de inicio del contrato es 21/01/2022.  
El próximo año, esta fecha será 2023.  

Filtros de cadenas de texto

lower: Convierte el texto a minúsculas.
Ejemplo:
```
{"Hello World" | lower}
```
Salida:
```
hello world
```
upper: Convierte el texto a mayúsculas.
Ejemplo:
```
{"hello world" | upper}
```
Salida:
```
HELLO WORLD
```

Filtros de fechas

shortDate: Formatea la fecha en un formato conciso.
Ejemplo:
```
{StartDate | shortDate}
```
Salida:
```
21/01/2022
```

followingMonth: Devuelve el mes siguiente a la fecha dada.

Ejemplo:

{StartDate | followingMonth: '[["year": "numeric", "month": "long"]]'}

Salida:

febrero de 2022

followingYear: Devuelve el año siguiente a la fecha dada.
Ejemplo:
```
{StartDate | followingYear: '[["year": "numeric"]]'}
```
Salida:
```
2023
```
lastWorkingDayOfMonth: Devuelve el último día hábil del mes de la fecha dada.
Ejemplo:
```
{StartDate | lastWorkingDayOfMonth}
```
Salida:
```
31/01/2022
```

formatDate: Formatea la fecha según las opciones especificadas.

Ejemplo:

{StartDate | formatDate: '[["year": "numeric", "month": "short", "day": "2-digit"]]'}

Salida:

21 ene 2022

Opciones de formato para filtros de fechas

Los filtros de fechas (followingMonth, followingYear, lastWorkingDayOfMonth y formatDate) admiten opciones de formato personalizables como las siguientes:

[[
  "weekday": "narrow" | "short" | "long",
  "era": "narrow" | "short" | "long",
  "year": "numeric" | "2-digit",
  "month": "numeric" | "2-digit" | "narrow" | "short" | "long",
  "day": "numeric" | "2-digit",
  "hour": "numeric" | "2-digit",
  "minute": "numeric" | "2-digit",
  "second": "numeric" | "2-digit",
  "timeZoneName": "short" | "long",
  "timeZone": "Asia/Shanghai",
  "hour12": true | false,
  "hourCycle": "h11" | "h12" | "h23" | "h24",
  "formatMatcher": "basic" | "best fit"
]]

Esto garantiza que los usuarios puedan personalizar fácilmente los formatos de fecha según sus necesidades específicas, haciendo que los documentos sean precisos y localizados.

Filtros de números

Función `currency`

La función currency está diseñada para formatear valores numéricos como monedas, lo que facilita la presentación de datos financieros en los documentos. Al especificar un código ISO de 3 letras de la moneda, la función formatea el número y añade el símbolo de la moneda correspondiente según el idioma del modelo de documento.

Para manejar los requisitos de moneda dinámica, como utilizar la moneda asociada al registro actual (por ejemplo, una factura o una cuenta), la función permite pasar valores dinámicos como $record.CurrencyIsoCode.

Devuelve
La función devuelve una cadena formateada que representa el número como una moneda, incluyendo:

El símbolo de la moneda correspondiente.
El formato del número (separadores de miles y puntos decimales) según el idioma del documento.

Ejemplo de uso

Escenario:
Una empresa genera facturas en varias monedas según el país del cliente. El símbolo de la moneda debe ajustarse dinámicamente en función de la moneda específica de la factura.

Plantilla:

Ingresos anuales de la cuenta: { Account.AnnualRevenue | currency: '$record.Account.CurrencyIsoCode'}  
Monto de la factura: {Amount | currency: '$record.CurrencyIsoCode'}

Datos de entrada:

Campo	Valor
AnnualRevenue	13000000
CurrencyIsoCode	USD
Amount	15123
CurrencyIsoCode	JPY

Salida esperada:

Ingresos anuales de la cuenta: $13,000,000.00  
Monto de la factura: ¥15,123

Filtros de listas

Documentación de la función `groupBy`

La función groupBy organiza los elementos de una colección agrupándolos según claves especificadas. Se pueden lograr múltiples niveles de agrupación proporcionando varias claves separadas por punto y coma. El orden de agrupación sigue la secuencia de las claves especificadas.

Devuelve
La función devuelve un objeto que contiene las siguientes propiedades:

$groupedKey#: Representa la clave de agrupación en cada nivel, donde # denota el nivel de agrupación, comenzando desde 1.
$groupedItems#: Contiene los elementos asociados a cada clave de agrupación. Cuando se aplican múltiples niveles de agrupación, cada nivel tiene su propia clave $groupedKey# y $groupedItems#.

Ejemplo de uso

Escenario:
Agrupar los artículos de una factura por Category y Subcategory.

Plantilla:

Número de factura: {InvoiceNumber}  

{#InvoiceItems | groupBy: 'Category;Subcategory'}  
- Categoría: {$groupedKey1}  
  {#$groupedItems1}  
  - Subcategoría: {$groupedKey2}  
    {#$groupedItems2}  
    - Artículo: {ItemName}  
      Cantidad: {Quantity}  
      Precio: {Price | currency: 'USD'}  
    {/}  
  {/}  
{/}  

Datos de ejemplo (Formato de tabla):

Categoría	Subcategoría	Nombre del artículo	Cantidad	Precio
Electrónica	Portátiles	Dell XPS 13	2	1200
Electrónica	Portátiles	MacBook Pro	1	2000
Electrónica	Teléfonos	iPhone 14	3	999
Muebles	Sillas	Silla de oficina	5	150

Salida esperada:

Número de factura: INV-2024-001

Categoría: Electrónica
- Subcategoría: Portátiles
  - Artículo: Dell XPS 13
    Cantidad: 2
    Precio: $1,200.00
  - Artículo: MacBook Pro
    Cantidad: 1
    Precio: $2,000.00
- Subcategoría: Teléfonos
  - Artículo: iPhone 14
    Cantidad: 3
    Precio: $999.00
Categoría: Muebles
- Subcategoría: Sillas
  - Artículo: Silla de oficina
    Cantidad: 5
    Precio: $150.00

Este ejemplo muestra cómo se puede usar la función groupBy para organizar los datos de manera efectiva según categorías jerárquicas.

Función `sortBy`

La función sortBy permite ordenar los elementos de una lista según campos específicos, como categoría o precio.

Ejemplo de uso

Plantilla:

{#InvoiceItems | sortBy: 'Category;Price'}  
- {ItemName}: {Price}  
{/}

Datos de ejemplo (Formato de tabla):

Categoría	Nombre del artículo	Precio
Muebles	Silla de oficina	150
Electrónica	Dell XPS 13	1200
Electrónica	MacBook Pro	2000

Salida esperada:

- Silla de oficina: 150  
- Dell XPS 13: 1200  
- MacBook Pro: 2000  

Función `htmlList`

La función htmlList convierte una cadena HTML en una lista simple.

Ejemplo de uso

Plantilla:

{richTextField: htmlList}

Datos:

{richTextField: '<ul><li>Artículo 1</li><li>Artículo 2</li></ul>'}

Salida esperada:

- Artículo 1  
- Artículo 2  

Función `multiPicklist`

La función multiPicklist convierte una cadena delimitada en una lista utilizando opciones específicas, como un separador y un símbolo de viñeta.

Ejemplo de uso

Datos:

{fruits: 'Manzana;Naranja;Plátano'}

Plantilla:

{fruits | multiPicklist: '[["separator": ";", "bulletSymbol": "-"]]' }

Salida esperada:

- Manzana  
- Naranja  
- Plátano  

Función `where`

La función where permite filtrar elementos que cumplan ciertas condiciones, por ejemplo, seleccionar únicamente artículos electrónicos.

Ejemplo de uso

Plantilla:

{#InvoiceItems | where: 'Category=="Electrónica"'}  
- {ItemName}  
{/}

Datos de ejemplo (Formato de tabla):

Categoría	Nombre del artículo	Precio
Electrónica	Dell XPS 13	1200
Electrónica	MacBook Pro	2000
Electrónica	iPhone 14	999
Muebles	Silla de oficina	150

Salida esperada:

- Dell XPS 13  
- MacBook Pro  
- iPhone 14  

Función `sum`

La función sum permite calcular la suma de los valores de un campo específico en una lista. El resultado de este cálculo se puede acceder utilizando el marcador $result. Al igual que con otros marcadores, puedes aplicar diversos filtros numéricos, como el filtro currency.

Ejemplo

Plantilla:

{#Opportunities | sum: 'Amount'}{$result | currency: 'EUR'}{/}

Resultado esperado:

15 123,00 €

Función `product`

La función product permite calcular el producto (multiplicación) de los valores de un campo específico en una lista. El resultado de este cálculo se puede acceder utilizando el marcador $result. Al igual que con otros marcadores, puedes aplicar diversos filtros numéricos.

Ejemplo

Plantilla:

{#Items | product: 'Value'}{$result | formatNumber: '[["maximumSignificantDigits": 3]]'}{/}

Resultado esperado:

123.000

Tipos de plantillas y sintaxis