We (Nick and I) recently had to do some troubleshooting on a workflow for one of our ministries. After a quick look, we realized that we weren't immediately familiar with what this workflow was doing and how it was doing it. Looking at the details for the workflow, we noted that it was created by me 12 months prior and last edited by Nick 10 months prior. No wonder we couldn't remember any details!

If only we had a log of the changes that were made to this workflow during its life! What a great idea (that Nick had)! So, we went about implementing a Change Log for our workflow configurations. It proved to be a pretty simple, three-step process. Here's what we did.

Step 1: Add A New Note Type

  • Under 'Admin Tools', select 'System Settings'
  • Click 'Note Types'
  • At the bottom of your Note Types list, click the 'PLUS' to add a new one
  • We used the following configuration for our new Note Type
  • 2017-02-15 15_03_50-Note Types _ Rock RMS.png
  • Click 'Save'

Step 2: Add Notes Block To Workflow Configuration Page

  • Under 'Admin Tools', select 'General Settings'
  • Click 'Workflow Configuration'
  • Click the 'Page Zones' option on the Admin Menu that pops up in the lower-right corner of the page
  • 2017-02-15-PageZonesMenuOption.png
  • In the 'Main' zone, click 'Zone Blocks'
  • Click 'PLUS' to add a block, select 'Notes' as the Type and give it a Name
  • 20170215-AddBlock.png
  • Click 'Save'
  • Click 'Done'
  • Click the 'Block Configuration' option on the Admin Menu that pops up in the lower-right corner of the page
  • 20170215-BlockConfigMenuOption.png
  • Select 'Block Properties' from the slide-out menu for the 'Change Log' block you just added
  • We used these settings:
  • 20170215-BlockProperties.png
  •     Click 'Save'

Step 3: Add Context Parameters To Workflow Configuration Page Properties

  • Under 'Admin Tools', select 'General Settings'
  • Click 'Workflow Configuration'
  • Click the 'Page Properties' on the Admin Menu that pops up in the lower-right corner of the page
  • 20170215-PagePropertiesMenuOption.png
  • Select 'Advanced Settings' and add 'workflowTypeId' to the Context Parameters 'Workflow Type Parameter Name' field
  • 20170215-WorkflowConfigAdvSet.png
  •     Click 'Save'

Now, when you select a Workflow Configuration for editing, you will see the 'Change Log' under the actual workflow configuration. You can now easily note changes you make to your workflow during its life for future reference.

20170215-Example.png