Big Picture: What is Deep Linking

In this article:
What is Deep Linking?
Deep Linking to Alchemy
How to Deep Link to Alchemy
Training Records - Deep Linking with Batch Export

What is Deep Linking?

Deep linking is a method of creating URLs that direct users to a certain landing page or a specific course. We’ve outlined benefits, how each option works, and the best ways to use them:

1. Deep Linking to a specific landing page:
   • Lower maintenance since one URL is used.
   • Use Case:
     • Set up a deep link to the My Learning Plans page in Intertek Alchemy.
     • In your third party LMS, create and link a phrase "Take your Alchemy training here". This will direct Users to the page in eLearning.
   • Details to Consider: 
     • The User will need to be assigned the training in Alchemy.  -or-
     • Find the right course on their own in the Course Catalog.
       
        
2. Deep Linking to a specific course:
   • Reduced navigation for the learner.
   • Use Case:
     • In your third party LMS, create a course shell.
     • This will launch the Alchemy course and it takes them directly to the course.
   • Details to Consider:
     • More setup effort is required from admin to create these deep links.
     • Each Alchemy course will require a course "shell" course in the external LMS. A unique shell/URL is required for each course language.
     • As Alchemy releases new courses, they will need to be added to the external LMS, if they are applicable.
     • Learner is not automatically navigated back to external LMS after course in launched.
     • Courses must be launched in an external browser.

Overall Considerations

While using deep linking in these two ways is convenient and has it's benefits, it is limited when used in isolation.  For full integration, combine deep linking with the Batch Export to both launch courses and maintain accurate training records within your LMS. Refer to our Training Records section for additional information. 

Deep Linking to Alchemy 

Whether linking to the 'My Learning Plans' page or a specific eLearning course, providing a direct hyperlink ensures users are taken to the appropriate Intertek Alchemy content. This setup enables seamless access without hosting the actual content within your LMS. Detailed below is the User Experience to a specific course. Deep linking to a landing page is similar, but directs users to a specific page in Alchemy Manager instead of a specific course. In both cases when Single Sign-On (SSO) is in use, sign in should not be required by the User. 

 

User Experience Using Deep Linking (Specific Course):

1. User clicks on shell course, or a link within the shell course in your external LMS.
2. A new browser or tab opens with the Alchemy course displayed.
   • Without SSO: The course will open within the Alchemy interface and require the User to login with their Alchemy credentials.
   • With SSO: The course will open within the Alchemy interface. 
3. User clicks on Play or starts the course. Learner is not automatically navigated back to external LMS after course in launched.

How to Deep Link to Alchemy

Below are URL templates for Users who would like to deep link using SSO or without using SSO. 

eLearning Courses:

Deep Linking can be done using a URL pattern that changes with an Alchemy Course Code. The portion to change by course code is in blue below. This would be the link to use in the shell course within your LMS. 

Note: The first part of the URL is your Alchemy Manager site address, designated as CompanyName in the examples below.

Example:

• Without SSO:
  https://www.sistemlms.com/CompanyName/course_gw.php?code=AlchemyCourseCode
• With SSO:
  https://www.sistemlms.com/CompanyName/sso/?sso&RelayState=course_gw.php?code=AlchemyCourseCode

This example company wants to link a PPE course, the URL will be:

• Without SSO:
  https://www.sistemlms.com/BunceandBean/course_gw.php?code=UEM4-en-US
• With SSO:
  https://www.sistemlms.com/BunceandBean/sso/?sso&RelayState=course_gw.php?code=UEM4-en-US

Landing Page:

Deep Linking can be done using a URL pattern that does not change. This would be the link to create and link a phrase, such as "Take your Alchemy training here" within your LMS. 

Example:

• Without SSO:
  https://demo.sistemlms.com/CompanyName/user/my_learning_plans
• With SSO:
  https://www.sistemlms.com/CompanyName/sso/?sso&RelayState=/user/my_learning_plans/

This example company wants to link to the 'My Learning Plans' page:

• Without SSO:
  https://demo.sistemlms.com/BunceandBean/user/my_learning_plans
• With SSO:
  https://www.sistemlms.com/BunceandBean/sso/?sso&RelayState=/user/my_learning_plans/

Training Records - Deep Linking with Batch Export

A training records export also known as batch export provides a more complete integration, ensuring all training records are stored in your external LMS. The Users course completion status in the external LMS is not updated until the training records export has processed. For more details on this level of integration refer to Deep Linking with Batch Export.