Using Custom Launch Data in Content Controller

Configuring custom launch data allows you to specify a set of data that will be made available to the course when it is launched by a learner. It really only works with courses that have been specifically designed to look for and use that custom launch data, so if you wanted to take advantage of this, it would require some changes to your courses.

To add the ability to use custom launch data to a piece of content in an account, you should navigate to the course in the account's sharing pool then click the course title to expose the Course Details Pane.  From there, you should see an Advanced section where you can get started on the Content Controller side of things.

We most commonly see this feature used as a way to slightly differ a course's presentation or behavior between accounts. You could pass in different company names to display, alternative verbiage, flags to enable/disable certain chapters, etc.

Content Controller provides the custom launch data you've configured as a query parameter on the URL of your course content. The query parameter is named "cp", and the value is a URL. For example, this is some test content I've got locally:

https://cc.example.com/courses/9b4c0391-775e-47f6-a4e6-b8896818fa3f/0/shared/launchpage.html?accountId=5&cp=https://cc.example.com/api/launch/customParams/764ae7b2-df36-489e-8b60-66a0115368ce

Then, your content will need to make an AJAX call to that URL for your custom parameters. This is how I retrieved the launch data from my test content:

var customParamUrl = new URLSearchParams(window.location.search).get('cp')

var xhttp = new XMLHttpRequest();

xhttp.open("GET", customParamUrl, true);

xhttp.send()

xhttp.onreadystatechange = function() {

    if (this.readyState == 4 && this.status == 200) {
       // wait for the response, then parse the response as JSON
       // and check the "custom_param" property

       alert(JSON.parse(xhttp.responseText).custom_param)

    }

};