Overview

Deep Links direct Learners to a specific page within the LMS, given that the individual is logged into the LMS and has access to the page that they are being directed to. This article explains the deep links that are available to you and how to create them. If you are using SSO, this article will also explain how to encode SSO into the deep link.

Important FYI

  • Learners must be logged in and have permissions to access the page that the deep link is sending them to. If they do not have access, they will be directed to their Learner Dashboard. This is something to keep in mind particularly with Availability Rules when deep linking to a Course.
  • For Portal IDs, Please make sure to change the domain to your specific region. ex: myabsorb.CA/.EU/.COM.AU/.CN. The examples given in this article use .COM

 

Login/Logout 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

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

 

Course Related Links

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

 

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. The lessonid can be found in the Lessons report in the admin interface.

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

 

 

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

 

 

Navigation & Filtering
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., OnlineCourse, InstructorLedCourse, Curriculum, CourseBundle, GlobalResource, NewsArticle, 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

 

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

 

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


 

Encoding SSO Authentication

If a user is authenticated via SSO and then follows a deep link, they should be taken to the LMS page as expected. If a user is not authenticated and then follows a deep link, the behavior will be different based on the Mode selected in your SSO Settings. Those differences are detailed below.

 

Deep Links with Service Provider Initiated SSO

Normal deep links will work as expected if your SSO is properly configured to use Service-Provider Initiated SSO. You can check this by reviewing your SSO Settings within Absorb. The Mode should be set to Service Provider Initiated and the Login URL should be populated with the correct endpoint for SAML requests.

Behavior: User follows deep link > User is authenticated by the IDP > User lands on the specific LMS page contained in the deep link.

 

Deep Links with Identity Provider Initiated SSO

If your SSO is configured as Identity Provider Initiated, normal deep links will not work for unauthenticated users. After the user is authenticated, they will be directed to the Dashboard page.

Behavior: User follows deep link > User is authenticated by the IDP > User lands on the Dashboard.

If you want the SSO process to retain the LMS destination throughout the authentication process, you will need to update the deep link to append a relay state. The recommended process is described below.

Note: This process may not work for all SSO configurations and IDPs.

  1. Find the LMS deep link you want to link users to.

Example deep link: https://company.myabsorb.com/#/online-courses/4d14c306-c7ed-4554-b421-f729fba3a9e3

  1. URL Encode the LMS deep link (you can use this site to do so: https://www.urlencoder.org/).

Example resulting URL-encoded deep link: https%3A%2F%2Fcompany.myabsorb.com%2F%23%2Fonline-courses%2F4d14c306-c7ed-4554-b421-f729fba3a9e3  

  1. Find the Login URL within the Absorb SSO Settings.

For example: https://company.idp.com/home/absorblms/test/1234

  1. Append the URL-encoded Deeplink to the end of the Login URL, inserting “&relaystate=” between them.

Example resulting link to share with users: https://company.idp.com/home/absorblms/test/1234&relaystate= https%3A%2F%2Fcompany.myabsorb.com%2F%23%2Fonline-courses%2F4d14c306-c7ed-4554-b421-f729fba3a9e3

Behavior : User follows deep link > User is authenticated by the IDP > User lands on the specific LMS page contained in the deep link.

 

 

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