Templates
Within the Partial Locking Framework, a Template specifies reusable configurations designed for the rendering or processing of platform data. These templates are categorised into several types:
-
Mail Templates
-
Document Templates
-
Record Templates
-
Quick Filter Templates
Templates derive their lock state from the parent object and adhere to the same Unlocked, Partially Locked, and Locked configuration principles. This framework ensures flexibility at the tenant level while maintaining compatibility during system upgrades.
Locking Behavior
The lock state of a Template is determined during application installation or upgrade based on its source definition. A Template may be in one of four states:
-
Unlocked (Custom) – Created in the destination tenant.
-
Unlocked – Originates from the source tenant but has no lock restrictions.
-
Partially Locked – Editable only in specific, controlled areas.
-
Locked – Fully protected from modification.
If a template is associated with multiple installed applications, the latest update from any source determines its effective lock status.
Tenant Admin Permissions
Tenant Admin permissions on Templates are scoped based on their lock state. The table below lists the supported actions.
Object-Level Object Actions
|
Action/Property |
Unlocked Object | Partially Locked Object | Locked Object |
|---|---|---|---|
|
New Template |
|
|
|
Field-Specific Actions & Properties
|
|
Built on Destination Tenant |
Built on Source Tenant & Pushed to Destination Tenant |
||
|---|---|---|---|---|
|
Action/Property |
Unlocked (Custom) Template | Unlocked Template | Partially Locked Template | Locked Template |
|
Clone |
|
|
|
|
|
Delete |
|
|
|
|
| Template Name |
|
|
|
|
| Integration Code |
|
|
|
|
Template Type-Specific Actions & Properties
Template Type: Mail Template
|
|
Built on Destination Tenant |
Built on Source Tenant & Pushed to Destination Tenant |
||
|---|---|---|---|---|
|
Action/Property |
Unlocked (Custom) Template | Unlocked Template | Partially Locked Template | Locked Template |
|
Private |
|
|
|
|
|
Format |
|
|
|
|
| Subject |
|
|
|
|
| Body |
|
|
|
|
Template Type: Document Template
|
|
Built on Destination Tenant |
Built on Source Tenant & Pushed to Destination Tenant |
||
|---|---|---|---|---|
|
Action/Property |
Unlocked (Custom) Template | Unlocked Template | Partially Locked Template | Locked Template |
|
Render as PDF |
|
|
|
|
|
Flatten Populated Form |
|
|
|
|
| Document Template Name |
|
|
|
|
| Content (Upload File / Free Text + Template Format) |
|
|
|
|
Template Type: Record Template
|
|
Built on Destination Tenant |
Built on Source Tenant & Pushed to Destination Tenant |
||
|---|---|---|---|---|
|
Action/Property |
Unlocked (Custom) Template | Unlocked Template | Partially Locked Template | Locked Template |
|
Template Name |
|
|
|
|
|
Record to Clone |
|
|
|
|
The record template has been revised to eliminate support for the Partially Locked status. As a result, any existing templates designated as Partially Locked within the destination application are hereby displayed as Fully Locked templates.
Template Type: Quick Filter Template
|
|
Built on Destination Tenant |
Built on Source Tenant & Pushed to Destination Tenant |
||
|---|---|---|---|---|
|
Action/Property |
Unlocked (Custom) Template | Unlocked Template | Partially Locked Template | Locked Template |
|
Columns |
|
|
|
|
|
Search Condition |
|
|
|
|
| Filter by Date Field |
|
|
|
|
| Fields to Search |
|
|
|
|
Super Admins have full administrative control over all templates, regardless of their lock status. This includes the ability to preview, clone, synchronize, rename, delete, and modify.
If a Super Admin modifies properties that are restricted for Tenant Admins, the component remains on the upgrade path. These changes are treated as temporary overrides and will be replaced by the source during the next application upgrade.
Upgrade Compatibility
When a permitted change is made to a Partially Locked Template, the system automatically sets a Modified flag. This flag indicates that the template has diverged from its source version and influences upgrade behaviour. This information is displayed on the template view page under the Application Setup section. Likewise, a red exclamation triangle icon is rendered within the template that undergoes any modification.
Restoring Upgrade Path
To revert a Partially Locked Template to its original state, use the Restore Upgrade Compatibility action. This is available only for templates marked as Modified components.
-
To restore the modified template to its original state, do the following:
-
Navigate to the template view page from the application setup page.
-
From the template view page, select Restore Upgrade Compatibility for the modified template that needs restoration.
-
A confirmation dialogue indicating that this action is irreversible. Confirm and proceed to restore the modified template to its original state, and the Modified flag is cleared.
-
During the next upgrade, all local configurations are overwritten, and the template is restored to its source version.