Informes automatizados

Esta documentación se está actualizando.

Documentación completa de DDB- hotdocs. Este servicio permite el desarrollo de plantillas de palabras capaces de recibir datos directamente de DDB.

Nota para usuarios externos - Muchos de los enlaces en la siguiente sección se refieren a aplicaciones internas. Hable con su equipo de proyecto para obtener apoyo.

Requisitos previos

• Instalar Hotdocs Author (opens new window)

  • Nota: El costo que se muestra en la tienda ARUP App Store es indicativa de los costos de software. No hay carga directa para el usuario.

• Obtenga una licencia de HotDocs

  • Necesitará una licencia para publicar su plantilla en el servidor HotDocs y vincularla a DDB. Envíe un servicio ahora solicite con la descripción "solicitud Hotdocs Licencia para usar con DDB" a través de Servicio DDB ahora (opens new window)
  • Nota: Una licencia solo es necesaria para realizar el enlace final de la plantilla a DDB, puede trabajar en su plantilla tan pronto como HotDocs se descarga incluso sin una licencia.

• Completar la Digital Design Brief Course de Moodle (opens new window)

  • Será necesario una comprensión de los principios básicos de la estructura de datos de DDB (jerarquía de activos) para desarrollar plantillas.

• Docs Course de Moodle (opens new window)

  • Esto es opcional para un contexto adicional.

  • Descargue el último archivo ddbComponent-master.cmp.

    Comuníquese con [email protected] para recibir el archivo más reciente.

Guía paso por paso

Configuración

1. Autor abierto de Hotdocs
2. Especifique una ubicación para su espacio de trabajo HotDocs. Tenga en cuenta que esto debe estar en su unidad local C://, no puede abrir y editar plantillas almacenadas en la nube.

Ahora estás listo para construir tu plantilla.

Creando una plantilla

Punta superior: ¡Puede crear una plantilla a partir de un documento existente! Comience con una versión de ejemplo del informe que desea automatizar.

1. Abra su informe de ejemplo en Word y navegue a la pestaña HotDocs de la cinta.
2. Haga clic en Create Template
3. En la ventana emergente, complete el nombre de la plantilla y complete.

Ahora debería ver que Hotdocs Field Editor aparece en un panel de la derecha.

Diseño de la plantilla

Antes de comenzar a construir su plantilla usando Field Editor, trabaje a través de su informe de ejemplo con un resaltador e identifique lo siguiente:

1. Elementos estáticos: elementos como bloques de texto, encabezados, imágenes que queremos ver cada vez que se usa la plantilla.
2. Elementos dinámicos: elementos que deseamos reemplazar con los datos almacenados en DDB. Por lo general, estos son elementos que probablemente varían de proyecto a proyectos. Por ejemplo:
   • Valores numéricos en una tabla de criterios de diseño
   • Información específica del proyecto, p. Nombre del cliente, nombre del edificio, ubicación del proyecto.
3. Elementos condicionales: oraciones específicas, cláusulas, párrafos, secciones, imágenes que pueden ser estáticas, pero solo podemos incluirlas en el informe si se cumplen ciertos criterios. Por ejemplo:
   • Quiero incluir 'esta tabla' si el proyecto está en la etapa de diseño 4 o más allá.
   • Quiero incluir 'este párrafo', pero solo si el proyecto se encuentra en Escocia.

Construyendo la plantilla

Nota: para esta sección, necesitará la última versión del Archivo de componentes maestros ddb . Ver Requisitos previos para detalles.

Enlace el archivo del componente maestro

Navegue a su espacio de trabajo HotDocs en su explorador de archivos y pegue una copia del último archivo ddbComponent-master.cmp. Cambie el nombre del archivo y agregue el nombre de su plantilla.

Abra su espacio de trabajo de HotDocs, haga clic en su plantilla y seleccione Template Properties. Actualice el archivo de componente al nuevo archivo ddbComponent-master-Your_Template.cmp.

¡Ahora tendrá todos los últimos parámetros DDB y tipos de activos precargados en su plantilla!

Trabajar con parámetros DDB | Marcador de posición

Insertar el valor del parámetro

Utilizamos variables de marcador de posición HotDocs para identificar campos que se reemplazarán con los valores de los parámetros DDB. Puede insertar variables de marcador de posición en su plantilla usando Field Editor.

Seleccionar uno de los tipos de variables mostrará una lista desplegable de todos los elementos DDB de este tipo de datos disponible para su uso. Puede comenzar a escribir un nombre de parámetro para filtrar la búsqueda. Asegúrese de seleccionar el parámetro con el tipo de activo correcto, ya que es común encontrar parámetros disponibles para su uso en múltiples tipos de activos en DDB.

Por ejemplo, Client name está disponible en el nivel project y site, si se refiere al cliente del proyecto, asegúrese de seleccionar el primero como se muestra a continuación.

Insertar las unidades de parámetros

Podemos acceder a algunos metadatos de parámetros adicionales utilizando sufijos de marcador de posición específicos. Para extraer las unidades para un parámetro, puede agregar manualmente units al nombre del marcador de posición del parámetro. Esto es particularmente útil si usa diferentes unidades para cuantificar un parámetro entre proyectos o versiones de informes (por ejemplo, métrica vs imperial). En general, es una buena práctica usar esta función, ya que asegurará que el parámetro siempre refleje su valor asignado en DDB.

Asegúrese de hacer todas las ediciones a los campos a través de Field Editor y no en los campos mismos.

Insertar la fuente de parámetros

Podemos acceder a la información de la fuente de parámetros de la misma manera que las unidades de parámetros. Añadir source generará información de origen clave.

Trabajando con activos DDB | Regiones repetidas

Mesa repetida

A menudo queremos informar parámetros en el contexto del activo DDB que están describiendo. Para hacer esto, debemos señalar la plantilla a la rama correcta de la jerarquía de activos. En el siguiente ejemplo, queremos informar algunos parámetros de carbono incorporados para los activos DDB en la rama product type de la jerarquía. En nuestro proyecto DDB, tenemos dos product types, cada uno con parámetros que se incluirán una tabla.

En nuestra plantilla, insertamos nuestros marcadores de posición de parámetros como antes. En este caso, también queremos informar el nombre de los activos. Para hacer esto, insertamos un marcador de posición text variable que coincide con el nombre de nuestro tipo de activo: product type.

Nota: los marcadores de posición de activos deben ser completamente minúscula .

Ahora, insertamos un repeated region. Para hacer esto, destacamos la extensión de la fila de la tabla a repetir (incluido el límite de columna final), y creamos un marcador de posición repeated dialog como se muestra.

Nota: El nombre del repeated dialog debe ser del formulario <asset type> repeat .

El paso final es garantizar que el contenido de la tabla de repetición esté vinculado al repeated dialog. Podemos hacer esto haciendo clic en cada campo y vinculando los marcadores de posición con el cuadro de diálogo en Field editor como se muestra.

Si tuviéramos que ejecutar esta plantilla con nuestro proyecto de ejemplo, obtendríamos el siguiente resultado:

Punta superior : Si bien solo podemos aplicar una región repetida dentro de una tabla a una sola fila como se muestra arriba, podemos aplicar una región repetida a muchos otros elementos de informe. Por ejemplo, ¡una línea de una lista numérica, una página completa o una sección de un informe!

Cálculo de filtro

Es posible que deseemos aplicar criterios más estrictos a nuestras regiones repetidas. Por ejemplo, aquí quiero producir una lista de puntos de bala de los activos space type, pero solo quiero atraer el DDB space types que tienen ventilación mecánica. O, más específicamente, space types para el cual el parámetro DDB True/False Mechanical ventilation required es TRUE.

En la pestaña HotDocs, abra la Component Studio y cree un nuevo Computation variable de tipo de resultado True/False.

Volviendo a nuestra región de repetición, haga clic en ella y aplique un Repetition filter computation en el desplegable Field editor Advanced properties.

Probar su plantilla

Puede usar la función Test para abrir la hoja de entrevista y probar manualmente la funcionalidad de su plantilla fuera de línea antes de pasar por el proceso de activación. Esta característica es útil para probar el formato de la salida renderizada, y la hoja de entrevista también proporciona una visualización adicional de la estructura de sus variables y diálogos repetidos.

Activando tu plantilla

Antes de poder enviar datos DDB a su plantilla, será necesario serializarlos y ponerlos a disposición en el servidor. Envíe su plantilla a un miembro del equipo de DDB a [email protected] para que realice este procedimiento.

Generando su informe

Ahora su plantilla está activa, podrá imprimir informes desde el servicio de documentos DDB.

Esta sección se está desarrollando