NF Tag Reference Guide for Forms

5 minutes

1 year ago

NF Tag Reference Guide for Forms

NF Tags are MERGEFIELD type Word Fields. For Newforma mail merge functionality, the available tag options and their usage are described here.

Reference Key

Merge Fields	«MergeField:Option:Option»
Required Variables	[Enclosed in Brackets]
Optional Variables	{Enclosed in Braces}

NFField – standalone fields

Usage	Description
NFField:[DataNode]:[Element orAttributeName]	NFField outputs the value of the element or attribute of a specific node to the form.
Example	Additional Information
«NFField:Project:Name» «NFField:ProjectName» «NFField:Transmittal:Type»	NFFields from the same data node cannot be specified on the same line. Use a NFSectionStart and NFSectionEnd to place multiple values from the same data node into the same line.

NFSectionStart, NFSectionEnd – sections

Usage	Description
NFSectionStart:[DataNode] NFSectionEnd:[DataNode]	Marks the beginning and end of a section.
Example	Additional Information
	The NFSectionStart tag must be closed with a matching NFSectionEnd field tag. NFSection can be nested.

NFOptionalStart, NFOptionalEnd – optional sections

Usage	Description
NFOptionalStart:[Data Node] NFOptionalEnd:[Data Node]	Marks the beginning of a conditional sections. Contents between the two tags only appear when the Data Node is present and not empty.
Example	Additional Information
«NFOptionalStart:ContentDescriptions» «NFOptionalEnd:ContentDescriptions»	The NFOptionalStart tag must be closed with a matching NFOptionalEnd tag. NFOptional can be nested.

NFField:Image – images

Usage	Description
NFField:[Data Node]:Image:[Element or AttributeName]	Outputs image in place of the merge field.
Example	Additional Information
«NFField:Transmittal:Image»	The Element or Attribute Name contains an https or http path to the image to be placed on the form. UNC paths will work on forms that are generated from Project Center, but are not supported for Info Exchange generated forms. URL paths are recommended when possible.
Scaling Images Option 1 – Place the image tag in a fixed width or height formatted table cell and the image will be scaled to fit those dimensions. Option 2 – Place the image tag in an AutoSpace text box (not a content control) and if leave the “Resize shape to fit contents” box unchecked. The image will be scaled to fit the text box.

NFField:Hyperlink – hyperlinks

Usage	Description
NFField:[Field]:Hyperlink:[Label Attribute]:[URL Attribute]	Outputs a hyperlink.
Example	Additional Information
«NFField:Link:Hyperlink:label:url»	Hyperlinks can only be created from data formatted to be a Hyperlink.

NFCount – value count

Usage	Description
NFCount:[Node]:[Field]:[Value]	Outputs the total number of times a particular value appears in a node.
Example	Additional Information
«NFCount:InternalPerson:OnSite:True»	When evaluating for values with spaces, replace spaces with and underscore “_”. Values are case sensitive. Use NF_EMPTY to evaluate for Null or Empty variables.

NFInsertWM – watermarks

Usage	Description
NFInsertWM:[Node]:[Field]:[Value]	Enables the watermark on templates that support a watermark (such as Daily Reports and Site Visit Forms).
Example	Additional Information
«NFInsertWM:DailyReport:Status:Draft»	The tag must be placed anywhere in the body of the template. When evaluating for values with spaces, replace spaces with and underscore “_”. Values are case sensitive. Use NF_EMPTY to evaluate for Null or Empty variables.

NFSort – custom sort

Usage	Description
NFSort:[Node]:{Sub Node:}[Field]	Sorts NFSection and NFOptSection data nodes for sections alphabetically based on a specific field.
Example	Additional Information
«NFSort:Pricing:Pricing:CostCodeNumber»	Sub node is optional.

NFField:Checkbox – checkboxes

Usage	Description
NFField:[Node]:Checkbox:[Field]:[Value]	Inserts a checkbox into the document. If the value specified is matched, the checkbox is placed as checked.
Example	Additional Information
«NFField:Transmittal:checkbox:Purpose:For_your_Review»	When evaluating for values with spaces, replace spaces with and underscore “_”. Values are case sensitive. Use NF_EMPTY to evaluate for Null or Empty variables.

NFOptSecByValStart and NFOptSecByValEnd – optional section by value

Usage	Description
NFOptSecByValStart:[DataNode]:[Field]:[Value] NFOptSecByValEnd:[DataNode]:[Field]:[Value]	Marks the beginning and end of an optional section based on the NOT TRUE condition of the value specified.
Example	Additional Information
«NFOptSecByValStart:Bulletin:Type:Supplemental_Instruction» Disclaimer for Bulletins that are not Supplemental Instructions. «NFOptSecByValEnd:Bulletin:Type:Supplemental_Instruction» Note: The following example would show the elements between the start and end tags when “Supplemental Instruction” is not the Bulletin type. To evaluate for an IS TRUE condition, it is necessary to nest NFOptSecByVal sections to evaluate NOT TRUE for all possible conditions.	The NFOptSecByValStart tag must be closed with a matching NFOptSecByValEnd field tag. NFOptSecByVal can be nested. When evaluating for values with spaces, replace spaces with and underscore “_”. Values are case sensitive. Use NF_EMPTY to evaluate for Null or Empty variables.

NFOptSecLTStart and NFOptSecLTEnd – optional section by value (less than)

Usage	Description
NFOptSecLTStart:[DataNode]:[Field]:[Numeric Value] NFOptSecLTEnd:[DataNode]:[Field]:[Numeric Value]	Marks the beginning and end of an optional section based on the NOT TRUE condition of the Field value being Less than the Numeric Value provided.
Example	Additional Information
«NFOptSecLTStart:Files:Filecount:501» There are more than 500 files in this transfer. «NFOptSecLTEnd:Files:Filecount:501»	The NFOptSecLTStart tag must be closed with a matching NFOptSecLTEnd field tag. NFOptSecLT can be nested. Use NF_EMPTY to evaluate for Null or Empty variables.

NFOptSecGTStart and NFOptSecGTEnd – optional section by value (greater than)

Usage	Description
NFOptSecGTStart:[DataNode]:[Field]:[Numeric Value] NFOptSecGTEnd:[DataNode]:[Field]:[Numeric Value]	Marks the beginning and end of an optional section based on the NOT TRUE condition of the Field value being Greater than the Numeric Value provided.
Example	Additional Information
«NFOptSecGTStart:Files:Filecount:499» There are less than 500 files in this transfer. «NFOptSecGTEnd:Files:Filecount:501»	The NFOptSecGTStart tag must be closed with a matching NFOptSecGTEnd field tag. NFOptSecGT can be nested. Use NF_EMPTY to evaluate for Null or Empty variables.