Article Objective: To assist admin users in navigating Active Ledger & Reporting to create customised content fields at a firm level to enable standardisation. Context: 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. Please refer to the Glossary for definitions of key terms used in this article. TABLE OF CONTENTS |
Accessing the Admin Centre
Navigate to the Active Platform home page.
Click on your name icon and press Admin Centre.
Click on Ledger & Reporting Admin.
Click on Page Templates, Header Template or Notes.
Creating content fields
For this example, we will select Page Templates.
The below screen will pop up. Select the relevant template you wish to edit or click + New Page Template.
Once you have made your selection, the below screen will appear.
Under the 'Content' section, scroll to 'Content Fields' and click + New Content Field.
This will open up a dialogue screen as below.
These fields are as follows:
| Field | Description | Validation |
| Code | Used by Active Ledger to identify the field. | Required |
| Name | Will 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 more information below). | Required |
| Group Name | Used 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. | Optional |
| Description | Details about the field that will appear in the Reports screen to give the user an idea of what the field is about. | Optional |
| 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. | Optional |
| Checked by Default? (checkbox) | Only available if 'Is Toggle' is checked. If checked, the toggle field will be checked by default. | Optional |
| Value Type (dropdown menu) | Can be used to add information to the field (see more information below). There are three options:
| Optional |
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:
- Text: a single line
- Text area: a larger text area of roughly three lines
- Number: a small area for a single value
Selecting one of the above options will bring up two additional options:
- 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
- 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. For information on how to add content, see administrator article: Reporting - content editor.
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 below 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 formulas 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 administrator article: Reporting - fields.
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 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. When ticked, this enables you to enter any relevant information that will appear in the generated report. The placeholder text should guide the input required.
Note: Regardless whether you have or haven't interacted with a mandatory field, a warning will appear in the generated report to remind you that the field requires completion.