Within report templates, information is populated from the Reportance file by using special fields. These fields let you build a generic report that you can use for all entities. They can be used to perform simple tasks, such as returning a report title or entity name.
Fields can be used anywhere in Reportance that you can create or edit content (see the knowledge article: Report Content Editor). They can also be used in Titles and Footers. Below is an example of how fields have been used in a 'Paragraph' in the Compilation Report Template to return names and dates:
Note: Each field must be wrapped within two sets of curly braces as shown by: {{text}}
Note: To return subsets of properties, use the '.' syntax between each property. For example to return which state an office is in you would use: {{Office.Address.State}}
Note: All fields are case sensitive.
Reporting Fields
Below is a complete list of fields which can be used within a report to populate information:
| Field | Field | Return |
|---|---|---|
| Report Title | {{Title}} | String |
| DateTime* | {{DateTime d MMMM yyyy}} | String - Example Format of Date: 1 January 2020 (see below) |
| Office Id | {{Office.Id}} | GUID - Unique Office identifier |
| Office Name | {{Office.Name}} | String |
| Office Trading Name | {{Office.TradingName}} | String |
| Office ABN | {{Office.ABN}} | String |
| Office Address Line 1 | {{Office.Address.AddressLine1}} | String |
| Office Address Line 2 | {{Office.Address.AddressLine2}} | String |
| Office Address Line 3 | {{Office.Address.AddressLine3}} | String |
| Office Address Line State | {{Office.Address.State}} | String |
| Office Address Line Suburb | {{Office.Address.Suburb}} | String |
| Office Address Line PostCode | {{Office.Address.PostCode}} | String |
| Entity Name | {{Entity.Name}} | String |
| Entity Trading Name | {{Entity.TradingName}} | String |
| Entity ABN | {{Entity.ABN}} | String |
| Entity Type | {{Entity.EntityType}} | String |
| Entity Responsible | {{Entity.Responsible}} | String |
| Entity Extended Responsible | {{Entity.ExtendedResponsible}} | String |
| Entity Responsible Plural | {{Entity.ResponsiblePlural}} | True/False - Boolean |
| Entity Owner | {{Entity.Owner}} | String |
| Start Date* | {{StartDate:d MMMM yyyy}} | String - Example Format of Date: 1 January 2020 (see below) |
| End Date* | {{EndDate:d MMMM yyyy}} | String - Example Format of Date: 1 January 2020 (see below) |
| Partner Id | {{Partner.Id}} | GUID - Unique User Identifier |
| Partner Email | {{Partner.Email}} | String |
| Partner First Name | {{Partner.FirstName}} | String |
| Partner Last Name | {{Partner.LastName}} | String |
| Partner Display Name | {{Partner.DisplayName}} | String => First Name & Last Name |
| Page Title | {{Page.Title}} | String |
| User Id | {{User.Id}} | GUID - Unique User Identifier |
| User Email | {{User.Email}} | String |
| User First Name | {{User.FirstName}} | String |
| User Last Name | {{User.LastName}} | String |
*The following shows how date patterns can be used in the above fields to display in the format you require:
| Pattern | Result String |
| dd/MM/yy | 30/06/2020 |
| yyyy-MM-dd | 2020-06-30 |
| dd MMMM yyyy | 30 June 2020 |
| dddd, dd MMMM yyyy | Tuesday, 30 June 2020 |
| MMMM dd | June 30 |
Reporting If Statements
Within a report an If Statement can be used to return different text.
The following example takes a True/False variable and returns the text "Are" if True and "Is" if False:
{{#if Entity.ResponsiblePlural}}are{{#else}}is{{/if}}
The following example checks to see if a property exists and returns an ABN {{Entity.ABN}} if it does exist and blank if it does not exist:
{{#if Entity.ABN}}ABN {{Entity.ABN}}{{/if}}