Our new custom tabs & fields release allows you to make AgentOS more personalised. We've added the ability to merge the custom fields into your documentation. The following guide shows you how.
If you've never set up your own documents before and want to find more information, please click here for System Letter Templates, or here for Custom Document Templates. Alternatively, please contact Support@agentos.com for assistance.
Overview
This guide shows you how to display Custom Fields within the following:
- System Letter Templates
- Custom Document Templates
- Email Templates
Finding the API ID
For Custom fields to display in your documents, you will need the API ID. The API ID can be found by selecting 'Customise Record' on the right hand side of the screen.
and then selecting 'Add Your Custom Fields'. The API ID can be found under the relevant heading.
System Letter Templates
Tags are currently available for the following System Letter Templates:
- Tenancy Agreements
- Landlord instructions
- Rent Chase (this document is currently hard-coded - if you'd like to include your custom fields in this document then please contact Support)
The tag for System Letter Templates will appear as the following example:
Tag Example: [[CustomDataSystemAPIID]]
[[CustomDataSystemF576216788707018896]]
Note: whilst the tag does not need to be inserted into a table, it needs to be in one string, unlike the custom document tag presented below.
Custom Document Templates
The custom field tag has been included for all documentation types within Custom Document Templates. The tags would appear in the same format for all document types, the only part of the tag that needs to be changed is the type of document that is being generated.
Here are some examples:
Tag Format | Generate For | Example
--- | --- | ---
[[Tenancy.CustomDataSystem.APIID]] | Tenancies | [[Tenancy.CustomDataSystem.F576179486900504821]]
[[Tenant.CustomDataSystem.APIID]] | Tenants | [[Tenant.CustomDataSystem.F576179486900504821]]
[[Instruction.CustomDataSystem.APIID]] | Sales Instructions | [[Instruction.CustomDataSystem.F576179486900504821]]
Emails
Custom tags for emails work in the same manner that email tags currently work in and all tags will be in the same format. The only part of the tag that will change is who the email is generated for.
Tag Format | Generate For | Example
--- | --- | ---
[Tenancy.APIID] | Tenancy - Tenants | [Tenancy.F576427513096596556]
[Tenant.APIID] | Tenants | [Tenant.F576427513096596556]
Additional Custom Field Types
For DropDown custom field types, use the following format:
[[CustomDataSystemF576216788707018896.Value]]
Support
Please contact Support@agentos.com if you need any assistance with custom fields in your documentation templates.