Getting Started
If you are new to the HTML document/canned email tag system, you can get an overview of tags, objects and loops here.
Accessing The Proof Object
Access to this object is dependent on what document or canned email type you are trying to access the object from. Start by finding the document or canned email type you are working with from the links provided below. Follow the chart for your specified document or canned email type to see if the object is accessible, and if so, where it is located. You may need to use a combination of loops and/or chaining to access this object.
Accessing The Proof Tags
Assuming you have access to the Proof object, you must do one of the following:
1. Prefix the object's name to the required tag
2. If the tag contains an 'Additional Sub Object', then the tag must prefix the sub-object tag and suffix the object
3. If the tag is a list type, then the tag must be looped. The sub-object tags should be nested within the loop.
Here is a chart displaying these use cases.
Syntax | Example | |
1 | {{Proof.TagName}} | {{Proof.CreatedDate}} |
2 | {{Proof.TagName.SubObjectTagName}} | {{Proof.File.Name}} |
3 | <!-- {{#each Proof.TagName}} --> {{SubObjectTagName}} <br /> <!-- {{/each}} --> | <!-- {{#each Proof.Files}} --> {{Name}} <br /> <!-- {{/each}} --> |
Overview
Tag Name | Description | Type | Additional Sub Object |
CreatedDate | The date the most current proof record was created. | Date/Time | |
File | The tags relating to a file can be accessed for the file on this proof record. | File Tags | |
FileId | The id of the file for the proof record. | Guid | |
Id | The id of the proof record. | Guid | |
LastModifiedDate | The date the proof record was last modified. | Date/Time | |
Notes | The notes that has been input on the proof record. | Text | |
OrderItemId | The id of the order item. | Guid | |
ProofApprovalUrl | The url of the proof record. | Text | |
Status | The tags relating to a proof status can be accessed for the current status on the proof record. | Proof Status Tags |