If you are looking for the Reportance Desktop help, please click here.

Content Fields

Content fields allow entity specific details to be added into firm-wide templates. They can be set up so that the user is forced to interact with the field to ensure that the content is added to the report. Content fields can be added to page templates, accounting policies and disclosure templates and can only be created by those with Administrator access.


There are three components to a content field:



Creating a content field

To create a content field within a page template, policy or disclosure, click on the + New Content Field button. 



This will open up a dialogue screen with the following fields:


FieldDescriptionValidation
Code
Used by Reportance to identify the field.Required
NameWill appear in the relevant area in the Reports screen to identify the field.Required
Field Name
Used to create the appropriate fields for use in the contents section of the template (see below).Required
Group NameUsed to visually group related fields together in the template.Optional
Prompt User for Entry?
(checkbox)
If checked, a warning will appear if a report is generated without the user interacting with the field.

DescriptionDetails about the field that will appear in the Reports screen to give the user an idea of what the field is about.
Is Toggle?
(checkbox)
If checked, the user is able to nominate whether this field is relevant by 'toggling' it on and off with a tick box

Checked by Default?
(checkbox)
If checked, the field is turned on by default.Only available if 'Is Toggle?' is checked. Automatically checked if 'Prompt User for Entry?' is checked.
Value TypeCan be used to add information to the field (see below).Three options:
- Text
- Text Area
- Value


Value Type


The value type is used if you want the user to add information or values into the field when they are preparing the report. It determines the size of the area. You can set the value type to one of the following three options:

  1. Text: A single line
  2. Text area: A larger text area of roughly three lines
  3. Value: A small area for a single value


Selecting one of the above options will bring up two additional options:

  1. Default value: The default value will not appear in the report template, but if the user does not enter their own value, it will appear in the generated report.
  2. Placeholder text: Is text that will appear in grey in the content field to guide the user on how to fill in the field.



Once all details are complete, click Save. The content field will then appear in a list. You are able to enter as many fields as you require. The field then needs to be entered into the content of the template.




Adding the content field into a template

For the content field to appear in the report you will need to add certain fields to the Content section of the template.


Note: The content field can only be used in the same template that it was created and cannot be used across multiple templates.


In the relevant area of the content, create a new paragraph containing the following field:


{{CustomField.FieldName.Value}}


This will result in any information, that is entered into the value field in the Reports screen, being displayed in the generated report.


If the content field has a toggle present, you can add an 'If Statement' so that the field only appears if the toggle is turned on. To do this, enter the following field in the paragraph before the above field:


{{#if CustomField.FieldName.Checked}}Text to appear in report{{/if}}


Note: Be sure to change 'FieldName' in the two formula above to the field name you have created.

 

Below is an example of a content field, with the field name IndependenceClause, being used with a toggle in a page template.



For more information on using fields in general see the knowledge article: Reporting - Fields.

For more information on adding and editing content see the knowledge article: Report Content Editor.



Using content fields in reports

When a content field is created it will appear in the relevant area of the pages section in the Reports screen. A red exclamation mark will be present if the content field has been set to mandatorily interact with the field (see below) and will convert to a red asterisk once the field has been interacted with. The field may or may not have a checkbox to enable it to be turned on or off, and may or may not already be ticked, depending on the setup. 


Note: If you fail to interact with a mandatory field a warning will appear in the generated report.



Clicking on the checkbox (if present or unticked) will enable you to enter any relevant information that will appear in the generated report. The placeholder text should guide the input required.




Did you find it helpful? Yes No

Send feedback
Sorry we couldn't be helpful. Help us improve this article with your feedback.