Home > For Designers > Streams > Stream Details > Stream Definition > Documents

Documents

document is a file that can be uploaded by stream designer and then use in various places in stream definition. A Document can be of two types:

 

Static Document

A static document will always be a file of type other than Microsoft word such as PDF instructions for completing a task, or a set of PDFs to be sent to a client. 

 

Dynamic Document

A Dynamic Document is a Word document that contains template variables--placeholders that are replaced with live data when the document is accessed. It can be either a .doc or .docx file. The template variables can be added manually, but it is much easier to generate a template from an existing form. Doing that creates a Word file that contains the labels and field-variables defined in the form. You can then edit the file to modify its layout, add images, and insert boilerplate text.

 

An example of such a document is Expense Report PDF or an Inspection Report generated based on submission details.

Such a Document can include fields of any type including Image fields and Child Document List Fields.

 

When used, the template is converted to a PDF document. 

 

To generate a dynamic document from a form:

  1. Go to a stream definition.
  2. Unlock it or check it out. 
  3. Edit a form.
  4. In the forms gear icon, choose Generate Print Template.
    A Word document is generated with the labels and fields defined in the form,
    and a dialog appears to let you modify the default name and specify the location to save it to.

To test a dynamic document:

  1. Go to a stream definition.
  2. Under the gear icon, choose Test Document Print Template.
  3. Select a record to use for generating the document.
  4. Browse to select the document template from your local file system.
    A PDF is generated using that template, and a dialog appears to let you save it.
  5. Save the PDF and examine the results. When satisfied, upload the template.

To upload a document:

  1. Go to a stream definition.
  2. Unlock it or check it out. 
  3. Hover over the Documents heading and click New.
  4. Specify settings:
    • File title - the name that will appear in the interface
    • File - browse for the file to upload
    • Usage Options
    • Available as Print Template for End Users for Individual Records from Record Details - This lets users select it when they choose the Print option while working with records.
    • Available as Print Template for End Users for Multiple Records from Reports - This lets users print a report from 'Reports' tab using the selected template. This is a special type of print template that can print multiple documents.

To use a document:

Once uploaded, a document template can be used in a variety of ways.
It can be: