tl-its-umich-edu / my-learning-analytics

My Learning Analytics (MyLA)
Apache License 2.0
36 stars 39 forks source link

Pass user info in link to survey #1216

Closed jennlove-um closed 3 years ago

jennlove-um commented 3 years ago

Describe your problem or feature you'd like added

Explore using parameters to capture more about the survey taker, course, etc.

Describe the solution you'd like

Include information about the logged in user who is submitting the survey when they submit survey responses.

Information to collect:

This was the information about Qualtrics passing to the Survey https://www.qualtrics.com/support/survey-platform/survey-module/survey-flow/standard-elements/passing-information-through-query-strings/

The initial idea was that we would append fixed parameters generated by MyLA to the URL like ?userID=<user>&courseID=<course>&view=<assignment|grades|resources>

We may also want to look at Q_EED encoding as mentioned on this page.

Would have to see how to embed this into qualtrics and document this and test out how it works.

Requirements Update

(Added by @lsloan.)

After @jonespm and @ssciolla tested my initial implementation attempt, they noticed that when MyLA wasn't launched via LTI, the value I chose to use for userID was not set. So I added userName as well. My reasoning is that rather than add logic to the app to choose to send the users' LTI ID or name, always send both. One or the other may not have a value, but usually at least one of them will. Also, using the same column to hold ID for some respondents and name for others isn't a good data processing practice. It's better to have column names that accurately describe their contents.

Implementation

(Copied from comment below.)

The test survey has a lot of logic in the "Survey Flow" view that seems to be unrelated to MyLA. I was tempted to delete it, but it doesn't affect how the survey works or the implementation of this feature. So, I decided to leave the logic for someone else to decide whether it should be deleted.

lsloan commented 3 years ago

(Note: Moved to issue description.)

~Implementation~

~The test survey has a lot of logic in the "Survey Flow" view that seems to be unrelated to MyLA. I was tempted to delete it, but it doesn't affect how the survey works or the implementation of this feature. So, I decided to leave the logic for someone else to decide whether it should be deleted.~

jennlove-um commented 3 years ago

Testing passes for these data elements:

userID is currently passing only Undefined, which is okay for this release.

I was able to create a new Qualtrics survey, add those embedded data elements, configure MyLA to use the survey, and get data from the survey responses.