Foorm: Update Variables

[molly-moen]

Update variables we send to Foorm surveys. The variables we now send are:

workshop_course
workshop_subject
regional_partner_name
is_virtual
num_facilitators 

facilitators: array of:
{
  facilitator_name (renamed from facilitatorName)
  facilitator_position
  facilitator_id (renamed from facilitatorId)
}

The facilitator data is accessible in Foorm if you create a dynamic panel called facilitators. The variables will then be panel.facilitator_name etc.

Future work

We may need a is_friday_institute variable later.

Testing story

Validated that new variables work as expected and are stored with survey submissions. The change from facilitatorId/facilitatorName-> facilitator_id/facilitator_name caused a change to be needed to our CSF Intro configuration to use those new variable names. Existing survey submissions and their views are not impacted by this change. The only long term impact could be in trying to parse all survey submissions from the database--the ones from last week use the camelCase variable names while the ones from this week onward will use underscore. However this shouldn't be a big impact since we already store facilitator_id as a column in our pd_workshop_survey_foorm_submissions table so any analysis on facilitator data should use that column.

Reviewer Checklist:

• Tests provide adequate coverage
• Code is well-commented
• New features are translatable or updates will not break translations
• Relevant documentation has been added or updated
• User impact is well-understood and desirable
• Pull Request is labeled appropriately
• Follow-up work items (including potential tech debt) are tracked and linked

[breville]

Looks great. Having submissions change partway through the life of a form would normally be a good candidate for a version bump, though it's a little different because it's not actually a change in the source form's definition, but given the better way to get the same information that you describe, it's not required here.

[molly-moen]

Agree, it is only used in the survey itself for a couple question titles, so it didn't seem necessary to bump the version. It would also cause headaches to need to support both casings of the variable going forward.

Looks great. Having submissions change partway through the life of a form would normally be a good candidate for a version bump, though it's a little different because it's not actually a change in the source form's definition, but given the better way to get the same information that you describe, it's not required here.