...

...

...

...

...

...

...

...

...

...

...

...

...

...

Overview

In order to provide the ability to generate highly formatted documents, Windsor has implemented a feature that allows Form Designers to:

...

The following example returns a formatted Submission # and is an example of the syntax for a basic standard data attribute.

Formatting a date

The following example returns the date of the submission, formatted as a date as specified.

You can manipulate the format using the following format codes.

Some examples

Amount Due Example

The following example returns the amount currently due, formatted as a currency.

Dynamic Data Attributes

When accessing dynamic data in the submission (e.g., custom data points defined in form sections by a form designer), there are a few steps that should be followed, such as:

...

In this example, the template is attempting to access text from a Short Text or Paragraph Control, the “Site Name”, that the user entered in the submission. The Short Text or Paragraph (e.g., Site Name) Control in the submission has a Tag value of “SITE_NAME”. The first step is to define the siteName variable. Assuming Site Name control will always be available on the Submissions, use the following syntax to define the siteName control:

Once defined, siteName can be referenced from anywhere in the template using the following syntax:

...

• Defines the siteAddressCtrl variable to simplify the many references to this control.

• Performs error handling to handle the situation where the site address is null.

• The siteAddress variable is established by concatenating all the constituent parts of the address control (e.g., street address, secondary address, city, state, zip, etc.) and to improve formatting. HTML break tags are added where needed.

See example below:

...

One defined, the siteAddress can be referenced from anywhere in the template using the following syntax:

...

• Defines the submitterCtrl variable so simplify the many references to this control.

• Performs error handling to handle the situation where the company name is null.

• The submitterInfo variable is established by concatenating some of the constituent parts of the submitter control (e.g., name, street address, secondary address, city, state, zip, etc.) and to improve formatting, HTML break tags are added where needed.

See example below:

Once defined, the submitterInfo can be referenced, in uppercase, from anywhere in the template using the following syntax:

Other Considerations

Below are some additional considerations when presenting dynamic data attributes:

• When defining the variables for the data to be accessed:

  • Perform this work at the top of the page (prior to the data attribute being referenced).

  • Do NOT add carriage returns in or between these definitions as the template will include these carriage returns in the presented document.

• If a referenced control in the template does not contain data within the submission, we must trap that to avoid a template failure. To trap for potentially absent data in a control, the following format of code can be used.

• If a Control is empty (e.g., not entered), the value returned to the template will be a blank. In some cases, blank values are saved in controls as a “?” to help with URL encoding. In these cases, the “?” will need to be replaced with a blank value during display.

• Case does matter when referencing variables so be sure that your casing is in sync.

• Configuration values (in the Vars.config, VarsOverrides.config, etc.) can be exposed to the document generator. These can be exposed by referencing the existing configuration properties in the following format:

Any attributes referenced here can be accessed from within the document by referencing the configuration value without periods and capitalizing secondary words. So, the app.Title configuration setting will be referenced as:

The message.email.appBaseUrl configuration setting will be referenced as:

Internal values can be exposed to the document generator. They can be exposed by referencing the existing internal data element in the following format:

Once the variable is set you can reference it using the following structure:

Anchor
TemplateAssignmentWorkflow TemplateAssignmentWorkflow

Template Assignment to Workflow

...

• User Information:

  • Name:

    • Full Name: <<[loggedInUser.displayName]>>

    • Username: <<[loggedInUser.login]>>

    • Email: <<[loggedInUser.primaryEmail]>>

  • Company: <<[loggedInUser.company]>>

    • Address: <<[loggedInUser.addresses.FirstOrDefault(a => a.addressType.Name =="home")]>> This is not yet available.

...

Submission attributes that are custom to a form or dynamically generated can also be referenced on a template. Control values can be referenced in a format such as below; here Tag Value is the Tag assigned to the control, and Control Type is the control type of the attribute being accessed. Please see the Control Value Properties Appendix within the nFORM Integration Guide for available Control Types that can be referenced for a Control. More properties may be available. Please see the nFORM Control Attributes Reference Guide for guidance if an attribute needed is not referenced.

The following describe how you would normally reference each control. Your Variable name is set to what you want to name the variable, the tag should be set to the tag within the control you wish to access.

...

Establish Variable Example

Reference Variable Example

Paragraph

Establish Variable Example

Reference Variable Example

Instructions

No attributes are returned from this control.

...

Establish Variable Example

Reference Variable Example

Multi Selection

Establish Variable Example

Reference Variable Example

Formatted

Number

Establish Variable Example

Reference Variable Example

Date

Establish Variable Example

Email

Establish Variable Example

Reference Variable Example

URL

Establish Variable Example

Reference Variable Example

Phone

Establish Variable Example

Reformatting the input phone number:

Reference Variable Example

Advanced

Name

Establish Variable Example

Reference Variable Example

Location

Establish Variable Example

Reference Variable Example

Address

Reference Variable Example

Attachment

Establish Variable Example

Reference Variable Example

Table

Establish Variable Example

Advanced Table Example

DataGrid Summary Data

Contact

Establish Variable Example

Reference Variable Example

Hidden Text

Establish Variable Example

Reference Variable Example

Calculated

Establish Variable Example

Reference Variable Example

Repeaters

If references to data found within a form repeater are desired, consulting services will be required to perform advanced configuration of the document template. However, an example below could provide insight into the proper syntax depending on experience level:

Markup

If you are uploading a document that is in review, be sure and turn off track changes before you save it to upload. Markup will be considered part of the document and will impact rendering.