How do I filter a program card based on enrollments data from my LMS?

When a specific group of people are enrolled in a specific set of activities. the Program card can be configured to target a group of people defined in Your Organization and look at which of those people have completed the configured milestones.

But what if your program has open enrollment, or if those enrolled in the program cannot be neatly defined using the groups you have in Watershed? You might be tracking who is enrolling into the program on your LMS, so how can you configure Watershed to use that data to inform the enrollments for a program card?

This guide walks you through how to use the peopleFilter to do just that.

1. Create a Program Card

Start with a program card you’ve already configured to look at a particular course. Make sure that the course you’re looking at has both completion and registration data and that the completion milestone is configured to look at the “completed” verb (you will need to use Advanced Configuration to add the verb to the milestone).

For example, if the course you are looking at has an activity id of “http://example.com/some-course” your advanced configuration would look like this:

{
  "filter": {
    "activityIds": {
      "ids": [
        "http://example.com/some-course"
      ],
      "regExp": false
    }
  },
  "program": {
    "name": "explorer-configured",
    "primaryPathId": "main",
    "learningPaths": [
      {
        "id": "main",
        "name": "",
        "type": "learningPath",
        "steps": [
          {
            "name": "Some Example Course",
            "filter": {
              "activityIds": {
                "ids": [
                  "http://example.com/some-course"
                ]
              },
              "verbIds": {
                "ids": [
                  "http://adlnet.gov/expapi/verbs/completed"
                ]
              }
            },
            "type": "match"
          }
        ],
        "ordered": false
      }
    ],
    "competencies": [],
    "assessments": []
  }
}

2. Add the People Filter

Now add the people filter to include only people who have registered on the course. The program card will then show how many people have completed out of those who have registered.

Including the people filter, the filter part of your configuration should now look like this:

filter": {
  "activityIds": {
    "ids": [
      "http://example.com/some-course"
    ],
    "regExp": false
  },
  "peopleFilter": {
    "activityIds": {
      "ids": [
        "http://example.com/some-course"
      ],
      "regExp": false
    },
    "verbIds": {
      "ids": [
        "http://adlnet.gov/expapi/verbs/registered"
      ]
    }
  }
}

That’s it! Your program card will now tell you who completed the course out of those people that registered for it.

Was this article helpful?
0 out of 0 found this helpful

Comments

0 comments

Please sign in to leave a comment.

If you can't find what you need or you want to ask a real person a question, please contact customer support.