Forum Discussion
lmsAPI Functionality in HTML5 Output
Hey all,
I've been searching through the forums and haven't been able to find anything solid. I'm using Storyline 360, outputting to both HTML5 and Flash to cover my bases, since the audience doesn't have dedicated machines that they are taking this from.
I'm relying heavily on external Javascript that I wrote, which I have tested thoroughly in the Flash version, and it works fine. But when it comes to the HTML5 version, it stops working. I've proven that I'm able to get into the Javascript functions, like I would expect, but it appears that lmsAPI is no longer available to the course.
Are there any similar functions to those of the lmsAPI functions in the HTML5 output?
Specifically, I'm looking for a way to do the following in HTML5:
- Get the StudentID from the LMS.
- Get the StudentName from the LMS.
- Manually call SetStatus("completed"); to pass a completion to the LMS on the last page of the course.
146 Replies
- AdamTrosperCommunity Member
Technically, every variable gets tracked to the LMS, but it's just a matter of whether or not the LMS can report on it in a readable fashion. Assuming you are using SCORM, everything gets stored in SuspendData, but quiz elements get stored as Interactions, which is why the LMS can report on the data more robustly. I would try Googling "Storyline Submit Interactions" and see what you can find as far as that goes. You might be able to restructure the questions to all be submitted as interactions, but then use the Complete Course method that Karuna suggested for the results.
- AstutisArtic013Community Member
I think the questions are currently being submitted as interactions, as they're using the built in quiz functionality. However, for them to work I need to track using quiz results, which overrides any complete course trigger or JavaScript code.
I may just have to sacrifice the success criteria, as everything else is working fine.
Thanks everyone for the suggestions and help though.
- AdamTrosperCommunity Member
What I was suggesting was to switch the tracking to "Complete Course Trigger" and then remove the quiz functionality but keep the questions (submitting each as interactions). Without actually testing this myself, I would think this would store the questions themselves in the LMS, but not require a results slide to submit the score. Then, you could keep your JS code to try to submit a passed/failed. Again, just thoughts, but I would think it could work.
If you do manage to get this to work, this thread could benefit from knowing your solution! Best of luck!
- AstutisArtic013Community Member
Ah okay. This sounds promising. I shall investigate this approach and let you know how I get on.
EDIT: It seems there's no way to submit an interaction without using the built-in quiz functionality. And they only get reported to the LMS when the results are submitted on a results slide. Is there something I'm missing?
- AdamBayliss-16aCommunity Member
OK, a further question here - The name works fine, but I need Gender / Salutation - any idea what the lmsAPI method is? Thanks
- AdamTrosperCommunity Member
I don't believe there is a method for getting that info. If I'm not mistaken, you can only get the Student's name and user ID. You may just need to ask the user their Gender/Salutation up-front at the beginning of the course.
- AdamBayliss-16aCommunity Member
Hi Adam – thanks for replying – but ha! I’m not giving up that easily, that data is stored by the LMS – there must be a way to get to it? – If I can open an LMS page that shows it, it is there…
We are using Ilias LMS – I’ll try the user forums there, will let you know if I find anything..
Cheers
Adam
- amityunger-53b6Community Member
Hi Matthew,
Thank you so much for the code you wrote, the LMS gets the score (after hours of searching...).
However, the success status remains unknown, instead of passed or failed.I tired to make the slide a question slide, tried different tracking settings...
What am I doing wrong?Many thanks,
Amit - AdamTrosperCommunity Member
Hi Amit,
I would try replacing all instances of
SetStatus("passed");
orSetStatus("failed");
with one of the following:lmsAPI.SetPassed();
or
lmsAPI.SetFailed();This should call the correct function directly.
- amityunger-53b6Community Member
It works GREAT!
Thanks a lot! :) - MariaErinAnneDoCommunity Member
Hi Adam,
I used a combination of your suggested codes:
var player = GetPlayer();
function findLMSAPI(win) {
if (win.hasOwnProperty("GetStudentID")) return win;
else if (win.parent == win) return null;
else return findLMSAPI(win.parent);
}
var lmsAPI = findLMSAPI(this);
lmsAPI.SetScore(player.GetVar("Results_ScorePoints"), 27, 0);var passingScore = "23";
if (player.GetVar("Results_ScorePoints") >= passingScore)
{
lmsAPI.SetPassed();
} else {
lmsAPI.SetFailed();
}Our LMS (Workday) reads this perfectly if the learner has passed the quiz which is set at 23 points (85%). The completion status is reflecting as Completed and the lesson grade as Pass.
On the other hand, if the learner gets below 23 points, the lesson grade is properly reflecting as Fail but the completion status is showing up as In Progress.
If I add this code:
lmsAPI.SCORM_CallLMSSetValue("cmi.core.lesson_status", "completed");
the completion status is properly showing as Completed, but the lesson grade does not reflect the Fail status.
The LMS Reporting is set to Completed/Failed, and the output option is SCORM 1.2.
Thank you so much!
Anne
- philMekCommunity Member
Hello everybody,
I read every single message in this thread , also here :(https://community.articulate.com/discussions/retrieve-lms-user-name-as-variable) , and in some others (https://community.articulate.com/discussions/getting-the-student-name-from-the-lms).... (https://community.articulate.com/discussions/getting-student-name-from-the-lms-and-using-it-in-articulate)
But couldn't find what I am looking for :
My client LMS (Talentsoft) in SCORM 2004, can display cmi.learner_name as a variable.
I tried many many many syntaxes to grab this data, but I guess the only working one wasn't in my scope !
Can anymone help me ? what is the syntax to grab this value ?
thank you for the help
Philippe
- philMekCommunity Member
Bravo Matthew !
it works !
Thank you very much.
I changed a few things, as I only need (at this time) the firstname.
Also, my LMS return no space after the comma in studentname().
Here is your code with small modificaitons :
function findLMSAPI(win) {
if (win.hasOwnProperty("GetStudentID")) return win;
else if (win.parent == win) return null;
else return findLMSAPI(win.parent);
}
var lmsAPI = findLMSAPI(this);
var name = lmsAPI.SCORM2004_GetStudentName();
var nameArray = name.split(',');
var firstName = nameArray[1];
// var lastName = nameArray[0];
// var fullName = firstName + ' ' + lastName;
var player = GetPlayer();
player.SetVar("Name",firstName);Do you know why in specification it is said : "cmi.learner_name", and in getting the value : GetStudentName() ?
I am not dying for the answer, just curiosity.
Anyway, you saved me, Talensoft support was unable to answer.
Have a nice day
Philippe
- StevenPascoe-ccCommunity Member
Hi, can anyone help me?
This code works for Scorm 1.2.
How do I convert this to Tin Can?var player = GetPlayer();
function findLMSAPI(win) {
// look in this window
if (win.hasOwnProperty("GetStudentID")) return win;// all done if no parent
else if (win.parent == win) return null;// climb up to parent window & look there
else return findLMSAPI(win.parent);
}
var lmsAPI = findLMSAPI(this);
var myName = lmsAPI.GetStudentName();
var array = myName.split(',');
var newName = array[1] + ' ' + array[0];
player.SetVar("newName", newName);Appreciated!
Related Content
- 3 months ago
- 4 months ago
- 10 months ago