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, headers 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:
Name | Field | Return | Examples |
---|---|---|---|
Report Title | {{Title}} | String | |
DateTime* | {{DateTime d MMMM yyyy}} | String | e.g. 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 | {{Office.Address.AddressLine1}} {{Office.Address.AddressLine2}} {{Office.Address.AddressLine3}} {{Office.Address.State }} {{Office.Address.Suburb }} {{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 | e.g. 'Company', 'Trust', 'Partnership', 'Sole Trader' |
Entity Responsible | {{Entity.Responsible}} | String | e.g. 'Director', 'Directors', 'Trustee, 'Trustees' |
Entity Extended Responsible | {{Entity.ExtendedResponsible}} | String | e.g. 'Directors of ABC Company Pty Ltd', 'Trustees of ABC Trust', 'Proprietor' |
Entity Responsible Plural | {{Entity.ResponsiblePlural}} | True/False - Boolean | e.g. 'Shareholders', 'Beneficiaries', 'Members', 'Proprietor', 'Partners' |
Entity Owner | {{Entity.Owner}} | String | |
Principal Activities | {{Entity.PrincipalActivites}} | String | |
INot For Profit | {{Entity.NotForProfit}} | True/False - Boolean | |
Is Company | {{Entity.IsCompany}} | True/False - Boolean | |
Is Trust | {{Entity.IsTrust}} | True/False - Boolean | |
Is Association | {{Entity.IsAssociation}} | True/False - Boolean | |
Entity Registered Office | {{Entity.RegisteredOffice.AddressLine1}} {{Entity.RegisteredOffice.AddressLine2}} {{Entity.RegisteredOffice.AddressLine3}} {{Entity.RegisteredOffice.State}} {{Entity.RegisteredOffice.Suburb}} {{Entity.RegisteredOffice.Postcode}} | String | |
Entity Principal Place of Business | {{Entity.PrincipalPlaceOfBusiness.AddressLine1}} {{Entity.PrincipalPlaceOfBusiness.AddressLine2}} {{Entity.PrincipalPlaceOfBusiness.AddressLine3}} {{Entity.PrincipalPlaceOfBusiness.State}} {{Entity.PrincipalPlaceOfBusiness.Suburb}} {{Entity.PrincipalPlaceOfBusiness.Postcode}} | String | |
Start Date* | {{StartDate:d MMMM yyyy}} | String | e.g. format of date: 1 January 2020 (see below) |
End Date* | {{EndDate:d MMMM yyyy}} | String | e.g. format of date: 1 January 2020 (see below) |
IsWholeYear | {{IsWholeYear}} | True/False - Boolean | |
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 and 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 Tags
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}}
Uppercase/Lowercase
You can use 'uppercase' and 'lowercase' in a tag to convert the contents of a string to that case, for example:
{{#lowercase Entity.EntityType}}