Configurar las plantillas de documentos (formularios)

TrakIT crea sus documentos, como las órdenes de entrega, las facturas, los presupuestos y los justificantes de cobro, a partir de formularios. Un formulario es una página de HTML con códigos. Cuando un usuario genera un documento, TrakIT sustituye cada código por los datos de la orden de trabajo, el expediente, la factura u otro registro, y guarda el resultado como PDF. Esta guía lleva un formulario desde una página en blanco hasta los documentos que los usuarios generan con él. Está dirigida a los administradores del sistema: solo ellos crean y modifican formularios.

El ejemplo que se sigue es una orden de entrega: un formulario de orden de trabajo para su flujo de trabajo de importación, generado para el contenedor ABCU1234560 del expediente EXBL2610045. Los mismos pasos se aplican a los demás tipos de formulario, con las diferencias que se indican.

Los menús que ve dependen de su rol y de cómo ha configurado TrakIT su empresa. Las rutas de esta página son las del menú estándar; consulte Moverse por TrakIT.

1. Elegir el tipo de formulario

El tipo de formulario determina lo que puede mostrar, dónde lo generan los usuarios y cómo se pone a disposición. No se puede cambiar una vez creado el formulario. Cada tipo tiene su propia pestaña en Admin > Form Definitions:

Pestaña	Crea documentos sobre	Se genera desde	Se pone a disposición mediante
For Work Orders	Una orden de trabajo.	La pestaña Forms de la orden de trabajo, o una acción del flujo de trabajo.	Is Global, o la pestaña Forms del flujo de trabajo.
For Jobs	Todo un expediente, con un bloque repetido para cada orden de trabajo.	La pestaña Forms de cualquier orden de trabajo del expediente.	Is Global, o la pestaña Forms del flujo de trabajo.
For Reports	Las filas de un informe avanzado.	Una suscripción a un informe.	Se ofrecen todos los formularios de informe activos.
For Finance	Una factura, una nota de cargo o una factura rectificativa, otro documento de factura, un presupuesto, un justificante de cobro o de pago, o una factura de proveedor: el Sub Type del formulario.	El registro financiero.	Las empresas marcadas en el formulario.
For Yard Ops	Un movimiento de patio.	La aplicación para dispositivos móviles.	El Yard y el Move Type del formulario.

Los formularios de correo electrónico, el diseño de los correos electrónicos que envía TrakIT, los gestiona el soporte de TrakIT. Una empresa usa el elegido como su Email Template (consulte Empresa).

2. Crear el formulario

Seleccione Admin > Form Definitions y, después, la pestaña del tipo de formulario, aquí For Work Orders.
Seleccione Create.
Introduzca el Form Name, por ejemplo Delivery Order, y un Form Code, como DO.
Rellene los demás campos del formulario que necesite el formulario.
Seleccione Create.

Se abre el nuevo formulario. Es A4, y su contenido es solo su nombre, como título. Los ajustes más importantes:

Orientation, Page Numbers y Margins definen el diseño de la página. Language es el idioma de los títulos y de las palabras traducidas del formulario.
File Name Syntax da nombre al PDF, por ejemplo [CODE]-[JOB]-[GENCOUNT].
Formularios de orden de trabajo y de expediente: Prevent Re-generation permite un solo documento por orden de trabajo o por expediente hasta que se cancela; WO Data Ref. escribe el número de referencia del formulario en un campo de datos; Default External Access hace que los documentos sean visibles de forma predeterminada para los usuarios externos, como el cliente. El Entity Filter de un formulario de expediente lo convierte en un documento para una entidad del expediente, como un transportista por carretera.
Formularios financieros: Sub Type indica para qué es el formulario. Para las facturas, las notas de cargo y las facturas rectificativas, Pro-forma/Final indica si imprime facturas proforma, documentos finales o ambos. Message Template da el cuerpo del correo electrónico que se envía con una factura o un presupuesto, y Require Live Signature obliga al usuario a firmar el documento antes de generarlo.
Formularios de patio: el Yard, el Move Type y Auto-Generate.

Para partir de un formulario que ya tiene, ábralo y seleccione el icono del signo más (Clone Form). La copia conserva el contenido, el encabezado, el pie de página y los roles, pero no se añade a ningún flujo de trabajo, y un formulario financiero no tiene ninguna empresa marcada.

Quién: los administradores del sistema crean, clonan y modifican los formularios. Para verlos se necesita View Form Definitions en la sección Form Definitions.

3. Redactar el contenido con códigos

En la pestaña Form Preview del formulario, seleccione Open Editor.
Escriba el HTML en HTML Code. Form Preview, a la derecha, muestra el resultado mientras escribe.
Seleccione Save y, después, Close Editor.

TrakIT rechaza el HTML que no está bien formado, e indica la línea. Consulte El editor de formularios.

Los códigos siguen unos pocos patrones:

Código	Da
`%%%0,COLUMN;`	Un campo de cabecera de la orden de trabajo, por su columna de la base de datos, como `BOLNUM` (la referencia del expediente), `CONTNUM` (el contenedor) o `CONTCUSNAME` (el nombre del cliente). Consulte Referencia de códigos de formulario.
`%%%1,CODE;`, `%%%2,CODE;`	La fecha de un evento, o el valor de un campo de datos, por su código en el flujo de trabajo. Añada un formato después de `\|`, por ejemplo `%%%1,DEL\|dd MMM yyyy;`.
`[ED:CODE:NAME]`	El nombre de un evento o campo de datos en el flujo de trabajo.
`##NAME##`	Un valor, como `##REFNO##` (el número de referencia único del documento), `##DATE##` o `##USERNAME##`. Los formularios financieros tienen los suyos, como `##INVNUM##`, y una tabla de las líneas, como `##INVTABLE##`.
`%%%LOOP;` … `%%%END;`	En un formulario de expediente, un bloque repetido para cada orden de trabajo del expediente que no está cancelada.

Estos son los principales: la Referencia de códigos de formulario los lista todos, la Referencia de código de la página del formulario lista los patrones, y el botón ? (Code Reference) del editor lista los códigos del tipo de formulario, y del subtipo en el caso de un formulario financiero, con un ejemplo de cada uno.

Para la orden de entrega, siendo DEL el código del evento de entrega en su flujo de trabajo:

<h1>Delivery Order</h1>
<p>Reference: ##REFNO## - Date: ##DATE##</p>
<table>
  <tr><td>Job</td><td>%%%0,BOLNUM;</td></tr>
  <tr><td>Customer</td><td>%%%0,CONTCUSNAME;</td></tr>
  <tr><td>Container</td><td>%%%0,CONTNUM;</td></tr>
  <tr><td>[ED:DEL:NAME]</td><td>%%%1,DEL|dd MMM yyyy;</td></tr>
</table>
<p>Issued by ##USERNAME##</p>

Generado para la orden de trabajo de ABCU1234560, muestra EXBL2610045, Example Trading Co, el número de contenedor y la fecha de entrega. Un formulario de expediente pone las órdenes de trabajo en un bloque repetido, y debe dar a un elemento del bloque el data-id ##WOID##; si no, TrakIT no permite guardarlo:

<table>
  %%%LOOP;
  <tr data-id="##WOID##"><td>##SERIAL##</td><td>%%%0,CONTNUM;</td><td>%%%0,WEIGHT|#,##0;</td></tr>
  %%%END;
</table>
<p>##NUMALL## containers, ##TOTALWEIGHT## kg</p>

Los códigos fuera del bloque toman los datos de la primera orden de trabajo del expediente.

4. Añadir el encabezado y el pie de página

El encabezado y el pie de página se imprimen en la parte superior y en la parte inferior de cada página. Úselos para lo que es igual en todas las páginas, como su membrete y su dirección, y mantenga los códigos en el cuerpo del formulario.

Abra la pestaña Header/Footer del formulario.
Escriba el HTML en Custom Header o Custom Footer, hasta 1000 caracteres cada uno.
Introduzca su Height: en puntos, y seleccione Update debajo.

Con Default Footer activado y sin pie de página personalizado, TrakIT imprime su pie de página estándar, que indica quién generó el documento y cuándo. Un pie de página personalizado lo sustituye. Los números de página proceden del ajuste Page Numbers del formulario. Consulte Pestaña Header/Footer.

5. Probar el formulario

Compruebe el formulario en tres pasos, del diseño a los datos reales:

El diseño. La pestaña Form Preview muestra el contenido con los códigos tal como están escritos, y el encabezado y el pie de página en cuadros de línea discontinua.
El PDF. En el editor, Test PDF guarda el formulario y lo descarga como PDF, con sus márgenes, encabezado, pie de página y números de página. Los códigos no se rellenan, y la prueba no cuenta como generación. Consulte Test PDF.
Datos reales. Ponga el formulario a disposición (paso 6) y, después, abra el registro sin generar nada:
- un formulario de orden de trabajo o de expediente: en una orden de trabajo del flujo de trabajo, abra la pestaña Forms y elija el formulario. La vista previa lo muestra rellenado con los datos de esa orden de trabajo. No se crea ningún documento hasta que selecciona Generate.
- un formulario financiero: abra la ventana emergente Generate de un registro de la empresa, por ejemplo Approve en una factura en borrador, y elija el formulario. La vista previa muestra el documento con el número que recibirá. Cierre la ventana emergente sin seleccionar Generate.

Mientras hace las pruebas, puede mantener un formulario de orden de trabajo o de expediente fuera del alcance de los usuarios: añádalo solo a un flujo de trabajo que se use para pruebas, o marque en su pestaña User Access solo un rol que sus usuarios no tengan. Los administradores del sistema siempre pueden generarlo.

En el resultado, busque:

un código impreso tal cual, por ejemplo sin su ; de cierre: no está bien escrito;
un valor vacío: el registro aún no tiene valor, el código del evento o del campo de datos no está en el flujo de trabajo, o un código nombra una columna de la base de datos que no existe. Un código solo admite el nombre de una columna, no un cálculo.

6. Elegir quién usa el formulario

Formularios de orden de trabajo y de expediente. Active Is Global para ofrecer el formulario en todos los flujos de trabajo. Si no, en la pestaña Forms de cada flujo de trabajo, seleccione Add New, elija el formulario y defina:

Requires: un campo de cabecera, un evento o un campo de datos que debe estar rellenado antes de poder generar el formulario, como el transportista por carretera para una orden de entrega.
Trigger Event Code: un evento que TrakIT registra en la orden de trabajo cuando se genera el formulario.
Do Not Attach To Work Order, Allow Deletion From Work Order y Services.

Un formulario nuevo está abierto a todos los roles. Para limitarlo, marque los roles en su pestaña User Access. Un formulario de expediente también puede definir el diseño de los correos electrónicos de actualización de estado que se envían al cliente del expediente: elíjalo como Status Email Template del flujo de trabajo en Configuración del flujo de trabajo.

Formularios financieros. En la pestaña User Access del formulario, marque las empresas en Select Companies y seleccione Update. Un formulario financiero nuevo no tiene ninguna empresa marcada, por lo que no se ofrece en ningún sitio hasta que lo haga. Cada vez que generan un documento, los usuarios eligen entre los formularios activos de la empresa con el subtipo adecuado, por lo que la empresa necesita al menos un formulario de cada subtipo que imprime: factura, factura rectificativa, presupuesto, justificante, factura de proveedor.

Los formularios de informe se ofrecen en todas las suscripciones a informes. Los formularios de patio se ofrecen para su patio y sus tipos de movimiento.

Para dejar de usar un formulario, desactive Active en Modify. Un formulario en uso, por ejemplo uno con el que se han generado documentos, no se puede eliminar.

7. Generar documentos

Documento	Los usuarios lo generan desde	El PDF se guarda en
Formulario de orden de trabajo	La pestaña Forms de la orden de trabajo: Generate o Generate & Email.	Los documentos de la orden de trabajo.
Formulario de expediente	La pestaña Forms de cualquier orden de trabajo del expediente. Con un Entity Filter, el usuario elige la entidad en Filter.	Los documentos del expediente.
Presupuesto	Generate en un presupuesto aprobado.	La pestaña Documents del presupuesto.
Factura, nota de cargo, factura rectificativa	Pro-Forma, Approve, Generate Doc y Reverse Invoice en la factura.	La pestaña Files de la factura.
Justificante de cobro o de pago	Generate Voucher en un cobro o un pago aprobado.	Su pestaña Documents.
Factura de proveedor	Generate PDF en una factura de proveedor validada.	La pestaña Files de la factura de proveedor.
Documento de patio	En la aplicación para dispositivos móviles, la lista Forms de un movimiento guardado, o automáticamente cuando se realiza el movimiento, con Auto-Generate.	La pestaña Files del movimiento.
Informe	Una suscripción a un informe del tipo Form Template PDF o Plain Text (TXT).	Lo envía la suscripción, por correo electrónico, FTP o Web API.

Un formulario de orden de trabajo o de expediente no se adjunta cuando el flujo de trabajo tiene definido Do Not Attach To Work Order: en su lugar, se descarga. Un flujo de trabajo también puede enviar formularios de orden de trabajo por sí solo: una acción de evento o de campo de datos del tipo Send Email, con el contenido Form PDF, genera el formulario cada vez que se ejecuta la acción y lo envía por correo electrónico, y Attach Document to WO conserva una copia.

Cada formulario de orden de trabajo y de expediente generado aparece en Admin > Logs > Form History, con el número de referencia que imprimió con ##REFNO##. Los documentos ya generados conservan su PDF cuando modifica el formulario más adelante.

Quién: generar un formulario de orden de trabajo o de expediente necesita Generate Form en la sección Work Orders, y uno de los roles del formulario. Las páginas de finanzas necesitan sus propios permisos, como Generate en la sección Quotations o Approve en la sección Invoices.

Cuando un formulario no aparece

Lo que ve	Por qué, y qué hacer
El formulario no está en Select Form en la orden de trabajo	No está activo, no es global y no se ha añadido al flujo de trabajo, está limitado a servicios que la orden de trabajo no tiene, o está limitado a roles que el usuario no tiene. O el rol del usuario no tiene Generate Form.
This form requires … to be completed	El Requires del formulario en la pestaña Forms del flujo de trabajo: rellene ese campo en la orden de trabajo.
El formulario financiero no está en Select Template	Su empresa no está marcada, no está activo, o su subtipo o su ajuste Pro-forma/Final es para otro tipo de documento.
No ##WOID## attribute found. al guardar un formulario de expediente	Dé a un elemento del bloque repetido el `data-id` `##WOID##`.
Cannot delete Form in use	En su lugar, desactive Active.