Issue #502 open
Emil Reisser-Weston
created an issue

Can we generate the code from inside the application (Admin > System Setup > Defaults > API Setup (move this from the defaults menu to give it its own entry).

Code-Generator.jpg

The interface above does not include the other [Copy Code] boxes...

Creating New e-learning with Jackdaw This code would be used to create a new e-learning resource attached to a New e-Learning link.

Editing e-learning with Jackdaw This code would usually be associated with an Edit link attached to an e-learning course. The Course Name variable must be defined prior to making this call.

Run e-Learning from Jackdaw Server This allows the third-party course to run the e-learning directly from the Jackdaw Server (no importing of e-learning is necessary). If this is successful the response value expected is 200.

Download Jackdaw Courses This call enables the user to add a link to download the SCORM zip file from the Jackdaw Cloud server for importing or distribution. If this is successful the response value expected is 200.

When implementing if there is a no course name match then the following error codes should be generated ...

If no authentication then ..

The system has not been authenticated with Jackdaw Cloud. Check that the user account is still valid? or The domain is no longer valid. You may need to regenerate the API code if the install has since been moved.

If no match of course name from the Open Elms database to the third-party LMS then open up a list of all courses in Jackdaw Cloud in a model box with the message ...

course-match.jpg

"An exact match of the course name could not be made with the list of courses currently stored in Jackdaw Cloud. Select the appropriate match (this will change the name of the selected course to COURSE_NAME)."

Let me know if I have missed anything out?

Comments (10)

  1. Emil Reisser-Weston reporter

    Capture.JPG

    1) Add caption saying "Copy the code samples into your Learning Management System (LMS) or e-Portfolio to integrate Jackdaw Cloud ..." 2) Run this text prior to editing Jackdaw e-learning, this authenticates the system. You will use the variable $SESSION_HASH in subsequent calls.

    Capture.JPG 1) Is not entering a session hash value here not confusing (the programmer would not do this when implementing.) Should we not instead use the global variable "$SESSION_HASH" in the code? To me this makes more sense. 2) Replace with "Use this code to c;lose the session, i,e, when closing the Jackdaw editor."
    3) can we place this option last in the drop down box as the last thing to implement.

    Capture.JPG 1) Again can we remove this and replace with the global variable. 2) Replace with "This code would be used to create a new e-learning resource attached to a [New e-Learning] link. The variable $SESSION_HASH has been used assuming it has be defined through the prior authentication process."

    Capture.JPG

    1) Again can we get rid of defining SESSION_HASH 2) Can we tweak the text to say "This code would usually be associated with an Edit link attached to an e-learning course. Select EITHER By ID or By Name - each variable must have a value assigned prior to making this call, as must $SESSION_HASH during authentication. If a match is not made the system simply lists all the courses available for editing." 3) List the By Name option first as this is the simplest to implement.

    Capture.JPG 1) Again can we lose the SessionHash box adn use the global variable name 2) This allows the third-party course to run the e-learning directly from the Jackdaw Server (no importing of e-learning is necessary). If no match is made then an error is returned. An alternative to this would be to import the SCORM zip file.

    IDEA FOR A FIX FOR THIS

    Person in third-party LMS runs this (and any other query which matches to a name or ID) - if no match is made then a list of all courses appears in a window asking the user to select the course that should be run. From this we can record in a separate table in Open Elms ...

    1) the value of the third-party courseID (that they are using) or Course Name 2) the value of the jackdaw courseID or Course Name that it matches to. 3) then next time a match is not made, it first uses this look-up table to find the course ID or Name used and then the translation of the Course Name or ID in Open Elms and run or edit the correct course.

    Capture.JPG 1) Again is this needed - use global variable instead 2) "This call will return a list of all courses in JSON format for easy display of this information in any third party system."

    Capture.JPG 1) Again is this needed - use global variable instead

  2. Lauris Mikulans

    You can check the MATCH problem on create site:

    Incorrect admin match:
    https://openlms.e-learningwmb.co.uk/create/jackdaw/play/COURSE_NAME?LMSSessionHash=lms58ebaad200c6d9.97662516

    Incorrect Trainee match:
    https://openlms.e-learningwmb.co.uk/create/jackdaw/play/COURSE_NAME?LMSSessionHash=lms58f749775b16c7.46198561

    Open them in incognito window and close to open other link.
    Session is created when you open this link, if you open admin link and then open trainee link in same browser, admin session is preserved.
    Will have to look into session reset later.

  3. Emil Reisser-Weston reporter

    A couple of minor text amends with this caption ..

    Capture.JPG

    Editing e-Learning with Jackdaw "This code would usually be associated with an Edit link attached to an e-learning course. Select EITHER By ID or By Name - each variable must have a value assigned prior to making this call, as must $SESSION_HASH during authentication. If a match is not made by the system, run the link from an administrator account - once a match is selected it will use this course in all future instances."

    Run e-Learning from Jackdaw Server "This code would usually be associated with an Edit link attached to an e-learning course. Select EITHER By ID or By Name - each variable must have a value assigned prior to making this call, as must $SESSION_HASH during authentication. If a match is not made, run the link from an administrator account - once a match is selected it will use this course in all future instances."

    Log Out "Use this code to close the session, i.e. when closing the Jackdaw editor." (you had "i,e,"

  4. Log in to comment