Documentos dinámicos y API

Referencia de las ventanas del Terminal para crear y editar documentos dinámicos y funciones API, con el asistente que genera el código de escritura.

El Terminal trae un editor para crear y editar documentos dinámicos y funciones API. Esta página es la referencia de esas ventanas: el diálogo de alta rápida, el editor del documento y el asistente que escribe el código de un endpoint por ti. Para saber qué es un documento dinámico y sus tipos, ve a documentos dinámicos. Para el lenguaje, ve a DinaScript.

Elegir tipo de plantilla

Al dar de alta un documento se abre el diálogo Agregar Documentos dinámicos. Ofrece cuatro atajos que crean directamente un documento de lectura libre y le cargan un ejemplo listo para editar:

Botón	Extensión de salida
Plantilla A4	`.pdf`
Reporte HTML	`.html`
Archivo CSV	`.csv`
Archivo JSON	`.json`

Los cuatro crean el tipo Documento de lectura libre; solo cambia la extensión y el ejemplo inicial. Cada botón descarga su plantilla y abre el editor con ese código puesto. Cancelar cierra sin crear. Para crear otros tipos (API de escritura, diseño de informe) fijas el campo Clase dentro del editor.

Si no hay conexión y la descarga del ejemplo falla, el editor se abre igual, pero vacío.

El editor del documento

La ventana se titula Agregar documento dinámico al crear y Editor documento dinámico al editar. Es grande y redimensionable, y en ella defines todo el documento.

Identificación

Campo	Qué es
Título	Nombre del documento en el listado.
Categoría · Subcategoría	Agrupan el documento en el listado.
Descripción	Texto libre que explica para qué sirve.
Ruta Keyword · ID	Identificadores para invocar el documento.

Las categorías predefinidas son Páginas / Informes, Exportación, Librerías, API, Ejemplos / Plantillas, Otros, Tareas programadas y Webhook. Puedes añadir las tuyas.

Tipo y salida

Campo	Qué controla
Clase	El tipo de documento. Fija el título, el icono y el ejemplo de código inicial.
Extensión	Extensión del archivo generado (`.html`, `.pdf`, `.csv`, `.txt`, `.xml`, `.json`, `.css`, `.js`, `.svg`, `.md`, `.yaml` y más).
Encoding	Codificación del documento generado.
Protección	Nivel de acceso al documento (por ejemplo, Cualquier empleado).

Los tipos disponibles en Clase y qué hace cada uno están en la tabla de tipos de documento dinámico.

Pestañas de trabajo

Pestaña	Para qué
Inicio	Configuración general del documento.
Código	Editor DinaScript: colorea la sintaxis, detecta errores en vivo y lleva un contador.
Variables	Variables del documento con su formato, valor por defecto y etiqueta.
Previa	Vista previa del HTML renderizado.

La barra de variables

Bajo el editor de código, una barra muestra cada variable definida (V.NombreVariable) con su número de usos. Si una variable no se usa en ningún sitio, aparece en rojo.

Bloque Script: inserta un bloque de script vacío donde está el cursor.
Menú +: Formatear el código, Convertir a Nativo, Convertir a Keyword, Reiniciar Código HTML y Reiniciar Código VUE (regenera el ejemplo desde cero).
Presets: al pulsar sobre las zonas de la barra insertas código de lectura (Registro o Informe: eliges una sección o un informe y vuelca sus campos) o abres el asistente de escritura (Edición).
ERRORES: al hacer clic en el contador se despliega la lista de errores del script sobre el editor.

Disponibilidad

Este bloque marca dónde puede usarse el documento. Las casillas Ticket, Impresión y la de informe solo aparecen cuando la Clase es Documento de lectura libre; para otros tipos están ocultas.

Email: marca el documento como válido para envío por email.
Obsoleto: retira el documento sin borrarlo.

Asistente de escritura API

El asistente Asistente Agregar registro / Asistente modificador genera automáticamente el código de un endpoint que crea o modifica un registro, para que no lo escribas a mano. Se abre desde el editor con el preset Edición: primero eliges Agregar o Modificar, y luego la sección de destino con el selector de secciones.

El asistente lista los campos de la sección como casillas, agrupados por pestaña y con un icono por tipo. Puedes filtrar qué campos ves:

Filtro	Muestra los campos de tipo
Textos	Texto.
Sí/No	Casilla verdadero/falso.
Relaciones	Enlace a otra sección.
Numéricos	Número o moneda.
Hora	Hora.
Fecha	Fecha.
Fech y Hora	Fecha con hora.

También hay un buscador por nombre. Los campos obligatorios y el texto principal salen marcados y bloqueados. Los campos que no se pueden modificar desde REST salen deshabilitados, con el motivo.

Dos botones de salida:

Aceptar: inserta solo el código (las funciones API_BeginAddRecord / API_BeginModifyRecord, un API_SetRecordFieldValue por campo, API_CommitSaveRecord y el bloque de respuesta JSON).
Aceptar y Crear variables: además da de alta las variables V.* correspondientes a cada campo.

El detalle de esas funciones está en la referencia de funciones.

Botones de la ventana

Botón	Qué hace
Aceptar	Guarda el documento y cierra.
Aplicar	Guarda sin cerrar (solo al editar un documento existente).
Duplicar	Crea una copia con toda su configuración, código y variables.
Exportar	Exporta el documento.
Cancelar	Cierra sin guardar.

Al aceptar, el código keyword se convierte a nativo y se validan las variables. Si la configuración de variables ocupa demasiado, el editor avisa y no guarda.