Approval forms
  • 05 Jul 2023
  • 1 minute to read

Approval forms


Article Summary

Approval forms determine which form fields are available for use within an approval workflow, by using a hard-coded form schema. The schema defines field types, field labels, dropdown menu choices, and conditional dependencies between fields. The schema can optionally specify how fields are laid out on the application print preview screen.

Each approval form is an instance of an installed approvalform plugin, which defines the schema as part of its code. An approval form in Totara keeps a snapshot of the plugin’s schema at the time it was created, and it will not change as the plugin is updated unless it is manually refreshed.

To create a new approval form, follow these steps:

  1. Go to Quick-access menu > Approval workflows > Manage approval forms.
  2. Click Add form.
  3. Give the new form a Form title.
  4. Select the Form plugin to use from the list of installed and enabled approvalform plugins. 
  5. Click Add

You will then be taken back to the Manage approval forms page, where you can view and manage your approval forms. You can also edit an approval form's title by clicking the pencil icon (edit).

To manually refresh an approval form’s schema from a newer version in the plugin, click the refresh icon. 

There are safe schema changes (fixing typos in labels, changing print layout, adding new fields) and unsafe changes (removing or renaming fields). Refreshing an approval form schema with unsafe changes may appear to cause data loss, because applications which use the form will have stored answers to fields that no longer exist. 

Removing a field is best accomplished by leaving it in the approvalform schema, cloning any workflows which use the form, and publishing them with the field hidden from all form views.

If you need to rename a field (i.e. change its field_key value to something else), please contact your Totara Partner for assistance.

The Manage approval forms page with one form created.

© Copyright 2024 Totara Learning Solutions. All rights reserved.


Was this article helpful?

Changing your password will log you out immediately. Use the new password to log back in.
First name must have atleast 2 characters. Numbers and special characters are not allowed.
Last name must have atleast 1 characters. Numbers and special characters are not allowed.
Enter a valid email
Enter a valid password
Your profile has been successfully updated.