With the Save Draft Records feature, users can Save a Draft Record and can also restrict who can view that Draft Record. Draft Records do not need to be submitted for approval and no alerts will be sent out when a Draft Record is Saved. Similarly, most of the validation will be skipped, so users don't have to fill out all of the information usually required.
This may be useful if you have a lot of information to gather prior to submission, but haven't received all of it yet, or if you get interrupted and need to come back later to complete your record.
This article contains an overview of the entire feature, as well as the additional settings that you can use to enhance it. To jump to a specific section, click on one of the headings below.
- Enabling Draft Records
- View Draft Record Restrictions
- Saving a Draft Record
- Draft Indicators
- Filtering by Draft Records
- Tracking your Drafts in Other Modules
Enabling Draft Records
The Draft Records feature can be enabled on each individual Database. Once enabled, any user who has permission to Create Records will be able to save a record as a Draft.
To enable this feature on your Database, follow the steps below.
- Open the Database and click Database Settings option highlighted below
- Scroll down to the setting called Enable Draft Records. This will be located under the Copy Record options. Note that this setting may have a different name based on the Custom Name set on the Database. To activate this setting for all users, click the Enable Draft Records checkbox.
- Save your Database settings to apply the feature to the Database.
View Draft Record Restrictions
When you enable the Draft Records setting, another field called View Draft Record Restriction(s) will appear beneath the setting. The options selected in this field will determine which users will be able to View Draft Records. This applies to all Draft Records in the Records list view and in other areas of the site like Dashboards and Stats. These restrictions will be applied on top of a user's regular permissions.
If a user is not selected via the options in this setting, they will not be able to access Draft Records or Stages.
Only Main Admin users and those with Admin level permission on Records are exempt from this setting. They will always see Draft Records.
The options available for the View Draft Records Restriction include:
This option is permanent and cannot be unselected. This ensures that the Creator of the Record can always View and Edit their Draft.
- Creator Groups:
If enabled, users within the same Group as the Creator can View and Edit Draft Records (if they have permission to do so).
- User Lookup Fields:
All User Lookup fields from within the Form Builder for the Database will be displayed as an additional option. If a User Lookup field is enabled in the Database Settings, any users selected within it will able to View and Edit Draft Records (if they have permission to do so).
- Group Lookup Fields:
All Group Lookup fields from within the Form Builder for the Database will be displayed as an additional option. If a Group Lookup field is selected, any Groups selected (and consequently all Users within those Groups), will able to View and Edit Draft Records (if they have permission to do so).
A user with View Record permission requires a View Draft Record Restriction in order to View a Draft Record. If the user does not have permission to View a Record, but has the Draft Restrictions enabled, they will still not be able to view the Draft Record as they do not have the minimum permission required. The same applies for users with Edit Record permission. Reversely, if a user has View Record permission, but does not have Draft Restrictions, they will not be able to view the Draft Records.
What's Restricted on a Single Database
For Single Databases, users can see the Draft Records if they are an Admin on the Records Module, have a minimum of View Record Permission AND have a View Draft Restriction option applicable to them.
Depending on the setting, users can either view and access the entire Draft record or the Draft record will not appear in the Records list layouts at all. For Single Databases, the Draft status applies to the whole record, not specific pages or sections.
What's Restricted on a Staged Database
If you have a Staged Database, then the settings will be applied for Stages rather than the whole record (as it does in Single Database). Users can therefore submit a Draft for each new Stage.
When a new Staged Record is being created, ie Stage 1 is being filled out; the logic will copy what exists for Single Databases above. So if Stage 1 is saved as a Draft, only users with the correct permission + the Draft Restriction will be able to see the Draft in the Records List pages.
For Stage 2 and beyond, this differs slightly as there will be previous Stages which have been published. Here the View Draft Restrictions setting will be applied to which users can View the Current Draft Stage, rather than the Record disappearing from the list entirely. For example, if a User has View permission on the Record, but not the Draft Restriction and Stage 3 has been submitted as a Draft, the user will be able to View Stages 1 and 2 (as they would currently), but will not be able to view the Draft information entered in Stage 3. Users with the Draft Restriction will be able to View the Draft in Stage 3.
Edit Permission Exception
Note that for the Stage 2 and beyond scenario mentioned above, users with Edit permission will be able to Edit Draft Records, regardless of the Restriction setting. Consequently, the Draft Indicators will always be seen by these users.
Saving a Draft Record
Providing a user has permission to Create Records and the Create Draft Records setting is enabled, users will be able to Save Draft Records. When the user Add's a new Record or begins a new Stage, there will be an additional saving option at the bottom of the page called SAVE AS DRAFT (pictured below). When clicked, the Record will be saved as a Draft (and the View Draft Restrictions settings will apply).
Only a Record's Title Field needs to be filled out in order to successfully Save a Draft Record. No other mandatory validations will apply, however other types of validation, like accepted inputs for specific fields, will still apply. For example, if a user were to enter the wrong format for an email field, they will still receive a validation error, whereas if they were to skip a field entirely, they could still save the Draft.
Other Actions once a Draft is Saved
Below are a few important points that should be noted about what actions will or will not occur when a Draft Record is saved. The actions that are skipped for Draft Records will still apply as normal when the record is officially Submitted / Published.
- Sequence ID's will be generated
- No Alerts will be sent out
- Workflows / Approvals will not be submitted
- Auto-Created Folders will not be created
- Users can still use the following features with Draft Records: Related, Comments, Request Feedback, Email Link
Once a Draft Record has been Saved, users who have been included in the View Draft Restriction Settings will be able to View or Edit the Draft Record (according to their standard permissions) and will also see a Draft Indicator; to highlight that the Record is in a Draft Status. This appears on all of the Records list layout options, ie List, Cards, Kanban and Calendar views.
As well as the indicators on the Records list pages, they will also appear on View / Edit Record, as well as in Emails, Download PDF etc, that the Record involved is in Draft status.
Filtering by Draft Records
Once Draft Records are enabled on your Database, you can also choose to Filter by the Submission Status of a Record, ie whether it's in Draft Status or not. These options are only available on a Database Level and will not appear if you are searching the entire Databases area.
Filtering on Single Databases
On Single Databases, open your Filtering Options Side Panel. The first field available will be 'Record Submission Status'. This refers to whether your Record is Published, or has been Saved as a Draft Record. You can use these checkbox options to filter in / out by those options. The results will be automatically reflected on the page.
Filtering on Staged Databases
On a Staged Database, open your Filtering Options Side Panel. The first field available will be 'Record Current Stage Submission Status'. This refers to the Submission Status of your current Stage, ie where the Record is up too (Stage 1, Stage 2, etc). The filtering options included here allow you to filter your Records by:
- Not Started / Completed: This refers to Stages which have not been started (ie the Continue action is available but the records are not in Draft) or Records which have been Completed (so all Stages have been published).
- Pending Approval: This option allows you to filter out those Records which currently have a Stage pending approval. This is only available as an option when a Publish Approval has been enabled on the Database.
- Draft: This will filter your Records to either Display or hide those Records where the Current Stage is in Draft Status.
Tracking your Drafts in Other Modules
In addition to Filtering within your Databases, you can also use the same Filtering Options in Dashboards and Stats; allowing to you include or exclude Draft Records in your reporting.
When creating your Widget or Stats report, select Record Submission Status or Record Current Stage Submission Status as the Filtering Condition, as demonstrated below.
When you've saved your Widget or run your Report, Draft Records (if you have included them), will be displayed, with the Draft indicator visible to highlight they are in Draft status. In Stats, there will also be a column indicating whether the record is in Draft or not.
You can read more about your Databases module here.
Please note that the 'Database' and 'Records' terminology referenced above may appear differently in your platform as these are customisable terms.
If you have any further questions about Save Draft, please contact your Customer Success Manager.