Enable Document Editing
To enable any sort of end user editing, start by enabling it from settings: Workflow - Document - Enable Editor
(setting Workflow - Document - Generate document
must be on).
For templates created before February 2024, enable end user editing in settings: Editable Content
Basic Editing Functions: Allows end-user editing.
Advanced Editing Functions: Allows end-user editing and the ability to add Dynamo Clauses.
By default, documents are non-editable. Therefore, any editable areas need to be specifically defined.
Editable areas can be either:
Short texts within a paragraph: inline text editing;
Multiple paragraphs: area editing.
The variable name (Model attribute) is automatically generated when a span or an area is set to be editable. This is a unique variable name as it will hold the editing value made by the users.
Inline text editing
An inline text editing area can be defined with a span
element. Inline text editing doesn’t support style formatting, such as indent, creating bulleted lists or bold texts; and is meant for editing short texts or sentences within a paragraph. Go for area editing (below) if you want the users to be able to format the text as they edit.
Adding an editable span
Click the
<>
button on Editing toolbar. After clicking, a new span element appears and can be seen in theElement
view.Scroll to the
Enable Editing
attribute and check it.
If later on you wish to disable editing, uncheck the Enable Editing
checkbox.
Area editing
A larger editing area can be defined with the group
(div) element. Everything inside the group element becomes editable. Area editing supports style formatting.
Adding an editable group
When selecting a certain document range (the left side element view will show controls for the current selection), click Create editable group
to mark this area as editable on the right panel. A group parent element will be added for the area and the Enable Editing
attribute is automatically checked.
This Group element can be accessed through the element breadcrumb.
Configure Edit Permissions
By default, anyone with the permission to generate a template will be allowed to edit the editable fields within it. However, you can choose to restrict editing for all or some of the editable fields.
For example, if you have made paragraphs containing legal terms editable, you could consider restricting the editing of those terms to a specific group of people.
Both group
and span
allow restricting edit permissions. The resolved value of the text entered here should be Boolean (true
or false
). For example, ${User.IsApprover__c}
where IsApprover is a custom checkbox field in Salesforce.
Edit model name
Every editable area has its own variable name that is automatically generated and is unique. The variable starts always with dynDocEdits
for documents and dynEmailEdits
for emails. Such prefixes should not be removed from the variable name. The name after the dot (.) can be changed when the editable area is added.
If a variable name is modified later on, it can affect how previously saved documents work.