This guide describes how to manage the Tenant property in form instances. This property allows you to associate a tenant with a form, in order to trace the link between a form and the person occupying the relevant housing.
When a form contains an "Tenant" type property, it appears in the form instance alongside other properties.
You can only select one tenant per form.
The tenant property can be automatically pre-filled based on the plan on which the form is positioned. If a tenant has been associated with this plan in the project's tenant list, they will be automatically selected. If multiple tenants are linked to the same plan, the first one in alphabetical order by name is retained. You can always modify this selection later.
You can create a new tenant directly from a form instance without leaving the current form.
Open the tenant property of the form.
Click or tap the "Create a tenant" button.
The creation form appears (on web: in a modal; on mobile: in a new page).
Fill in the tenant’s information.
Click on "Create".
The tenant is then created in the list of tenants for the project and automatically associated with the form you are in. You are then returned to the form.
You can edit the information of an existing tenant directly from the form.
When an tenant is selected, a pencil button appears next to the field. This button is only visible if a tenant is selected.
Click on the pencil button.
A modal opens with the tenant editing form.
Make your changes and click on "Save".
The changes are saved and immediately visible in the tenant's file and in the form.
Tap on the Tenant property to open the list of tenants.
An edit button is available next to each tenant.
Tap on this button to access the edit page.
Edit the desired information, then tap on "Done".
You are then redirected to the list of tenants, with updated information. If you press the back button, a confirmation modal appears.
When forms in a module have a tenant property, a new Tenant column becomes available in the table.
By default, the column is hidden.
Click the "Columns" button in the table.
In the menu, dynamic properties (including tenant) appear in a dedicated section. Check "Tenant" to add the column.
A filter button "Tenants" appears following the existing filters.
Click on the "Tenant" filter.
The list of all tenants in the project is displayed
Select one or more tenants to filter the table.
Use the search bar to find a tenant by first or last name.
The "No tenant" option allows you to display forms with no tenant attached.
Tap on the "Tenants" filter.
The list displays the first name, last name and email of each tenant.
Select one or more tenants then tap "Apply"
The search bar allows you to search by first name, last name or email.
The Tenant filter is also available when generating PDF reports, from two locations.
Open the PDF report settings modal.
In the "Filter by properties" section, a dropdown menu "Tenants" is available in the last position.
Select one or more tenants.
In the module table, click on "Export" then "PDF Report".
The "Tenants" filter is available in the modal.
Tip: if you have already filtered the table by tenant, the report filter is automatically pre-filled with the same values.
From the module dashboard, press "…" then "PDF Report".
The "Tenants" filter appears in the "Filter" section, in the last position (after "Phase").
Pre-filling from the dashboard filters also works on mobile.
Filtering on "No tenant" includes both forms whose occupant property is empty and forms that do not have this property at all.
