Pre-publish checklist
Use this checklist to confirm that a scheme is ready to publish. It lists the settings that block publishing and the items that configurators often miss. It then gives checks for the scheme, the workflow and the form.
Roles work in two steps. You create roles for the scheme, then link each role to each form as a form role. A role that is not linked to a form cannot act on that form.
Publishing requirements
You cannot publish a form version without these.
| Area | Requirement |
|---|---|
| Scheme settings | A start date and an end date. |
| Scheme permissions | At least one user with both Manage Permissions and Publish. |
| States | Exactly one state set as the initial state. |
| Edges | At least one edge marked as a submission edge. |
| Form permissions | At least one role with the Create permission. |
Items that are often missed
| Item | Why it happens |
|---|---|
| Scheme roles have no users | You created the roles but did not add officers. |
| Form roles not added | You must link each scheme role to each form. |
| No initial state | You created states but did not mark one as initial. |
| No submission edge | You added edges but did not mark one as a submission edge. |
| No Create form permission | The permission sits outside the per-state configuration, so configurators often skip it. |
| Component permissions left as None | New roles and new states always start with no access. |
| Automations inactive after versioning | A new form version resets all automations to Inactive. |
Scheme setup checklist
- Start date, end date and invitation type are set. Refer to Scheme settings.
- At least one user has Manage Permissions and Publish. Refer to Assign scheme permissions.
- Every role exists and has users. Refer to Manage scheme roles.
Workflow checklist
- Scheme roles are added to the form as form roles. Refer to Add form roles.
- At least one state exists and one is the initial state. Refer to Add and edit states.
- At least one edge exists and one is a submission edge. Refer to Add and edit edges.
- Form permissions are set for each role in each state, and at least one role has Create. Refer to Set form permissions.
- Edge permissions are set for the roles that move submissions. Refer to Set edge permissions.
Form checklist
- The required fields are added. Refer to Add components to a form.
- Component permissions are set for every role and state combination. Refer to Set component permissions.
- You previewed the form as each role and state to check access and field visibility. Refer to Preview a form configuration.
- Document templates in any Document Generator component are uploaded again in production. Templates do not port from staging.
Optional checks
- Target systems are reviewed and updated for production. Refer to Set up a target system.
- Automations are set to Active. Refer to Activate or deactivate automations in bulk.
- Child forms are fully configured before you publish the parent.
When every item is complete, publish the form version. Refer to Publish a form version.
