Webform Submission Change History

Edit (2020-01-07): I will no longer maintain this module and it is no longer compatible as per Webform 6.x. See this issue for details.

A Drupal 8 module which allows administrators to track notes on webform submissions. For example, if a user requests an appointment through a webform submission, we might want to track what we did with that appointment request, something like:

• status changed from Left Voicemail to Scheduled - May 10, 2018, 11:32 am - user_a
• status changed from Left Scheduled to Canceled - May 12, 2018, 10:20 am - user_a

Which version to use?

• If you are using Webform 8.x-5.0-rc30 or after: 8.x-2.x and this webform patch
• If you are using Webform 8.x-5.0-rc29 or before: 8.x-1.x and this webform patch

Upgrading from version 8.x-1.x to 8.x-2.x

• Make sure you have version 8.x-5.0-rc30 or later of Webform
• Run drush updb -y
• The previous command should enable webform_submission_log; but if you're having trouble you can enable manually: drush en -y webform_submission_log

Usage

Step 1: Install as you would any Drupal module:

drush dl webform_submission_change_history
drush en -y webform_submission_change_history

(Or see the section, "To install a local version for development or evaluation", below.)

Step 2: Set up logging

Taking the contact form as an example, make sure event logging is set up for that form's submissions (Submission Behaviors - Log submission events) at /admin/structure/webform/manage/contact/settings/submissions, or globally at
/admin/structure/webform/config/submissions.

Step 3: Patch the Webform module

In order for update events to be logged for Webform submissions, you need to apply the patch appropriate for your version:

• 8.x-5.0-rc30 or after: 8.x-2.x and this webform patch
• 8.x-5.0-rc29 or before: 8.x-1.x and this webform patch

Step 4: Use the right permissions

Make sure your users who need to access the log have the "Access the webform submission log" (access webform submission log) and "View any webform submission" (view any webform submission) permission.

Step 5: Modify a submission

• submit a Contact form submission at /webform/contact/test;
• modify something in that submission at /admin/structure/webform/manage/contact/submission/1/edit;

Step 6: Go back to the submission edit form

If you go back to /admin/structure/webform/manage/contact/submission/1/edit you will see the history of modifications to that submission.

Issue queue and pull requests

Please use the Drupal issue queue for this project.

Please run tests by running ./scripts/test.sh (you do not need to install or configure anything except Docker to run this) on your proposed changes before suggesting patches. Use GitHub for pull requests.

Development

The code is available on GitHub and Drupal.org.

Automated testing is on CircleCI.

To install a local version for development or evaluation

Install Docker and run ./scripts/deploy.sh.