Fields – Document

A document field allows the user to select a document template and create a PDF document based on the data in a particular concept. This PDF can then be downloaded, printed, viewed on the page, or emailed to a specified address. If the user has one of the Developer Roles specified in the field definition they will also have the ability to download the XML that is used to populate the documents XSLT into an XML file.

Here is an example of the document field:

A screenshot of the document field in trellispark. It displays a dropdown list of the available document templates and two buttons, one to download a PDF and one to print a PDF.

Below is the field definition for a document:

A screenshot of the field definition for a document field in trellispark.
  • Default Document
    • The document that will be loaded initially
  • Roles required to download XML
    • Determines the roles that will be allowed to see the Download XML button
  • Available Documents
    • Contains the available document templates that will be used by this field
  • Allow sending PDF to email address
    • Determines if the Email PDF button will be displayed
  • Storage PDF will be saved to
    • Only available when Allow sending PDF to email address is Yes.
    • Determines what storage container the PDF file will be uploaded to. Note: the selected storage must be available in the workspace the field is used in.
  • Email template to be used
    • Only available when Allow sending PDF to email address is Yes.
    • Determines what email template will be used to compose the email that will be sent
  • Allow PDF Download
    • Determines if the Download PDF button is visible
  • Override Download PDF Button Text
    • Allows you to override the default text on the Download PDF button
  • Email PDF Window Content
    • Determines the content displayed in the popup window when the Email PDF button is selected

Below is an example of the definition of a document template:

A screenshot of the page to create a new document template.
  • Document Name
    • Determines the name of the document
  • Document Template GUID
    • Contains the GUID of the document template, available as a reference if you need the GUID
  • Document Type
    • Determines what type of document this is
  • Enrichment Web API
    • Used in combination with Command Name.
    • Indicates the API to call that will enrich the document code
  • Command Name
    • Used in combination with Enrichment Web API
    • Indicates the command on the API that will be called to enrich the document code
  • Stylesheet
    • Contains the XSLT (only version 1.0 code is supported) for the document
Updated on March 25, 2024

Was this article helpful?

Related Articles

Need Support?
Can’t find the answer you’re looking for? Don’t worry we’re here to help!
Contact Support

Leave a Comment