Saltar al contenido principal

Resumen

Un Document Template es el blueprint de una familia de Documents — registros estructurados y basados en attributes que siempre pertenecen a un contact (acuerdos, solicitudes, certificados). Un template define el esquema de attributes del documento, cómo se poseen sus documents, y si los contacts deben autenticarse para leerlos. Cada document se crea desde un template. Para el panorama completo, consulta el overview de Customer Data.

Dónde encontrarlo

Los document templates están en Customer Data → Document Templates; cada template tiene su propia lista de Documents.

Properties

PropertyTipoRequeridoDescripción
titlestringNombre visible del template.
slugstringIdentificador — único (a–z, 0–9, -); agrupa los documents del template.
descriptionstringNoDescripción opcional.
ownership_modeenumNoindependent (por defecto) o sync_with_contact — ver Modos de ownership.
requires_authenticationbooleanNoSi el acceso de cara al contacto requiere que el contact esté autenticado (por defecto activado).

Esquema de attributes

Un template es dueño de los attributes que se aplican a sus documents. A diferencia de los Content Templates, no hay versions — los valores de attributes se guardan directamente en cada document.

Modos de ownership

Un template define cómo se poseen sus documents:
  • Independent (por defecto) — el owner de un document se define en el document mismo.
  • Sync with contact — los documents heredan el ownership de su contact; el owner es de solo lectura en el document y sigue al contact. Cambiar un template a este modo rellena el ownership en sus documents existentes.

Autenticación

requires_authentication controla el acceso de cara al contacto: cuando está activado, un contact debe estar autenticado para leer sus propios documents (el flujo “my documents” de cara al contacto).

Comportamiento y reglas

  • El tipo lo fija el template — cada document hereda el esquema de attributes del template.
  • Renombrar un template es seguro — las referencias a los documents del template se mantienen en sincronía.
  • Documents en bulk — los documents de un template se pueden importar en bulk (ver Documents → Seeds).

Seeds

Los document templates viajan entre entornos como Seeds estructurales. Sus documents se cargan aparte como seeds de instance.
Tipo de seedSoportadoNotas
StructuralEl template y sus attributes.
InstanceVía documentsLos instance seeds apuntan a los documents de un template, no al template.

Gobernanza y permisos

Un super admin o un Master puede crear, editar y eliminar document templates.

Acceso por API

Los document templates tienen CRUD completo, más operaciones para leer y fijar el workflow por defecto y para seguir el progreso de ownership-sync. Consulta la API reference.

Relacionado

Documents

Los registros creados desde un template.

Contacts

El contact al que pertenece todo document.

Content Templates

El blueprint de contenido análogo, con versions.

Attributes

El esquema de attributes del document.