Deep Link Support

Follow

Introduction

In Absorb LMS, Deep Links or Deep Linking refers to the ability to redirect Users to a specific user content page within the system, given that the individual is logged into the LMS via a hyperlink they have selected.

Keep in mind...

  • Deep Links will be dependent on Availability Rules; which may restrict certain Users from accessing content.
  • Deep Links are not available for Courses and/or Sessions that do not have Self Enrollment functionality enabled if the User is not already enrolled.
  • For Portal IDs, Please make sure to change the domain to your specific region. ex: myabsorb.CA/.EU/.COM.AU/.CN

. Table of Contents

 

Login Methods

Please note that the following methods are not intended for secure information, and should only be used with non-private details. 

Enrollment Key

The following link will bypass the enrollment Key Name entry screen. New users will be directed to the signup page, while logged in users will be enrolled in any courses offered by the enrollment key. 

This link can also be found in the Enrollment Key as the "Direct Link URL".

https://yourdomain.myabsorb.com?keyname=enrollmentkeyname

Log out

The following link will log a user out of Absorb LMS. 

https://yourdomain.myabsorb.com/#/logout

 

Automation

Launch a Lesson

The following link will open a course and launch a particular lesson within it.  This link also allows a check for prerequisites (i.e., Terms & Conditions, course prerequisites, proctor login, etc.) 

The courseid can be found in the Courses report in the admin interface. More information on how to retrieve a lessonid can be found here. 

https://yourdomain.myabsorb.com/#/online-courses/courseid?lessonId=lessonid

 

Set the Learner Interface Language

The following link will translate the learner interface and ensures that the language is updated as per the deep link. Note that this link will only work with the available languages specified in your portal settings. The languagecode will be a 2 character ISO 639-1 value (EN, FR, ES, etc.). 

https://yourdomain.myabsorb.com?Language=languagecode

 

Navigation

Online Course Page

The following link will take users to a specific online course page. The courseid can be found in the Courses report in the admin interface. 

https://yourdomain.myabsorb.com/#/online-courses/courseid

Instructor-Led Course Page

The following link will take users to a specific ILC course page. The courseid can be found in the Courses report in the admin interface. 

https://yourdomain.myabsorb.com/#/instructor-led-courses/courseid

Curriculum Page

The following link will take users to a specific curriculum page. The courseid can be found in the Courses report in the admin interface. 

https://yourdomain.myabsorb.com/#/curricula/courseid

Courses List

The following link will take users to their Courses page, listing all of the courses they are currently enrolled in. 

https://yourdomain.myabsorb.com/#/courses

Courses List (Category)

The following link will take users to a specific category in their Courses page. The categoryid can be found in the Manage Categories report in the admin interface (Courses report -> Manage Categories).  

https://yourdomain.myabsorb.com/#/catalog/categoryid

Catalog

The following link will take users to their Catalog page, listing all of the courses available for enrollment or purchase.  

https://yourdomain.myabsorb.com/#/catalog

Catalog (Category)

The following link will take users to a specific category in their Catalog page. The categoryid can be found in the Manage Categories report in the admin interface (Courses report -> Manage Categories). 

https://yourdomain.myabsorb.com/#/catalog/categoryid

Resources

The following link will take users to their Resources page, listing all of the global resources available to them.  

https://yourdomain.myabsorb.com/#/resources

Calendar

The following link will take users to their Calendar page.  

https://yourdomain.myabsorb.com/#/courses?viewType=Calendar

Transcript

The following link will take users to their Transcript page. 

https://yourdomain.myabsorb.com/#/transcript

FAQs

The following link will take users to their FAQs page. 

https://yourdomain.myabsorb.com/#/faq

News

The following link will take users to their News page (Absorb Engage only).   

https://yourdomain.myabsorb.com/#/news

Polls

The following link will take users to their Polls page (Absorb Engage only). 

https://yourdomain.myabsorb.com/#/polls

Search

The following link will take users to the Search page using a specific search term.  

https://yourdomain.myabsorb.com/#/search/all?term=searchterm

 

Display All Online & Instructor-Led Courses

The following link will take users to the Search page using a specific search term and it will allow filtering for more than one type of resource (i.e., OnlineCourseInstructorLedCourse, Curriculum, CourseBundleGlobalResourceNewsArticle, Poll).  

https://yourdomain.myabsorb.com/#/search/all?entityType=OnlineCourse,InstructorLedCourse

Filtering for more than one type of resource, and a search term 

https://yourdomain.myabsorb.com/#/search/all?entityType=entityType&term=searchterm

Filtering by course rating (e.g., OneAndUpTwoAndUpThreeAndUpFourAndUp). 

https://yourdomain.myabsorb.com/#/search/all?courseRating=rating

 

E-Commerce

Purchase

The following link will take new or logged out users to the Purchase page, listing all of the courses available for public purchase prior to sign-in or sign-up. 

https://yourdomain.myabsorb.com/#/catalog

Purchase (Category)

The following link will take new or logged out users to a specific category in the Purchase page. The categoryid can be found in the Manage Categories report in the admin interface (Courses report -> Manage Categories). 

https://yourdomain.myabsorb.com/#/purchase/category/categoryid

Purchase (Department)

The following link will take new or logged out users to a specific category in the Purchase page and it can accommodate additional pages/views not just for the catalog/checkout process. Variable pricing and department-specific course availability can be provided on the Dashboard using the below Deep Link. The categoryid can be found in the Manage Categories report in the admin interface (Courses report -> Manage Categories). 

https://yourdomain.myabsorb.com/?departmentId=departmentId

Variable pricing and department-specific course availability can also be provided in the Catalog using the below Deep Link. 

https://yourdomain.myabsorb.com/?departmentId=departmentId#/catalog

Purchase (Department +Category)

The previous two links can be combined to take new or logged out users to a specific category in the Purchase page while also offering department-specific variable pricing 

https://yourdomain.myabsorb.com/?departmentId=departmentid#/catalog/categoryid

 

Add Course(s) to Cart via Deeplink

An unauthenticated user can add course(s) to their cart via deeplink. We verify the user meets the availability rule requirements before adding the course to the cart. Multiple course types can be added via a single deeplink (e.g. an online course and a specific ILC session). 

Up to 5 courses can be added to the cart via the deeplink; only single seat purchases are allowed for each course. Formatting for the deeplink(s) are as follows: 

Adding a Single Course

https://yourdomain.myabsorb.com/#/AddToCart?CourseIds=GUID

Adding an ILC with a Session

https://yourdomain.myabsorb.com/#/AddToCart?CourseIds=ILCGUID>SessionGUID

Adding Multiple Courses

https://yourdomain.myabsorb.com/#/AddToCart?CourseIds=GUID,GUID,GUID,GUID,GUID

 

SSO Deep Links & RelayState

 

Deep linking in terms of the Absorb LMS is the ability to redirect a user to a particular user content page on the Absorb LMS. This is usually done through a hyperlink that the user would click on. 

Absorb supports deep linking through SAML via using one of SAML’s protocol implementation parameters, the RelayState. Normally, the relay state identifies the relying party trust. But Absorb uses it as an optional parameter to support deep linking.

 

IdP vs. SP Initiated

Deep linking works a bit differently between IdP and SP initiated SSO. For SP initiated the deep link can point directly to your Absorb portal URL, and we'll take care of passing the deep link back to the IdP in the RelayState parameter which can then be returned to us in the final SAML Response  For IdP initiated however the deep link must be built into the IdP's URL, picked up by the IdP, then passed to Absorb in the RelayState parameter in the final SAML Response. The important point here is that if a user lands directly on Absorb in an IdP initiated setup, the deep link is not passed back to the IdP and ultimately the user will end up on the default Absorb dashboard.

 

 **Note the parameters must be URL encoded and the full deep link URLs will need to be formulated by the IdP (client)/ SP initiated SSO configurations can use the Deep Links as listed above. 

 

 

 

 

 

 

 

 

Published on
Have more questions? Submit a request

0 Comments

Article is closed for comments.