SAP Knowledge Base Article - Preview

2407011 - LMS Cross Domain Solution (CDS) Knowledge Support and Tips

Symptom

SFTipsNTricks.JPGLMS.png
Click to go back to the main page

 

LMS CROSS DOMAIN SOLUTION (CDS) KNOWLEDGE SESSION FOR CUSTOMERS, PARTNERS AND SAP PRODUCT SUPPORT
 

1. About the SuccessFactors LMS CDS

1.1. Cross Domain Solution Files

1.2. Technical Requirements for the CDS

2. Cross Domain Solution at Run time

2.1. JSlet Tracking vs. Applet Tracking

3. Cross Domain Solution Configuration Overview

3.1. Setting up the Cross Domain Solution on the Content Server

3.2. Configuring LMS-ADMIN for the Cross Domain Solution

3.3. Communication Cross Domain Support Settings

3.4. Enabling the Cross Domain Solution on Content Objects

4. Cross Domain Solution Troubleshooting 

IMPORTANT NOTE:

Cross Domain issues are outside of Customer Support scope.  To obtain the latest CDS war proxlet file, see KBA 2750497
Any requests for help on installing or modifying the Proxlet or setup of reverse proxy has to go through SAP Professional Services.

Please see the User Assistance Documentation for more information. Note that login with a valid S-User account might be required.

 
1. About the SuccessFactors LMS CDS

The Cross Domain Solution (CDS) for content servers applies when you decide to use your own content server instead of iContent.

If Customer has already iContent install, this is already installed for them and you can ignore CDS.

The CDS – Cross Domain Solution (CDS) provides trusted server-to-server communication between an outside content server and SuccessFactors Learning Management System (LMS).  The Trusted communication is necessary when the course content server is different Domain Name Space (DNS) than the SuccessFactors LMS.  This is common.

CDS overview.png

In a cross domain scenario, SuccessFactors recommends the Proxlet WAR CDS.  The Proxlet WAR (Java Web Archive) communicates basic course tracking information back to the LMS such as exam scores and progress through content.

When the Proxlet WAR CDS is NOT working properly, the user can launch content but their completion status is NOT recorded back to the LMS.

 

What is the difference between CDS and OCN?

The Cross Domain Solution (CDS) for content servers applies when you decide to host your contents in your own content server instead of Preferred Content Solutions from SF (used to be iContent).
  • SCORM : The cross-domain content Proxlet WAR (CDS Proxlet) needs to be implemented for SCORM content that is hosted and managed by customer themselves on their own systems that is a different domain to SF Learning. KBA-https://launchpad.support.sap.com/#/notes/2316114
  • AICC : If you have AICC courses and if one or more AICC Courses contains Flash elements, then you need to be upload an XML File at our side (at the instance level) as per the KBA-https://launchpad.support.sap.com/#/notes/2316110 . If none of your AICC courses have any Flash elements in it, no additional setup/update is required on your or our side.

Whereas the OCN Framework is used when vendors host content for the customer and not SF and it needs to be integrated with SF Learning.

How does it work?

SAP SuccessFactors Learning offers an open API that enables content providers to integrate seamlessly with the SAP SuccessFactors Learning.  The open API supports:

  • Automated course imports in bulk
  • Automatic provisioning of user access
  • Single Sign-On (SSO)
  • Automated activity completion recording

This automated solution enables vendor content to be managed in the SF LMS and made available in catalogs as part of Programs or Curricula, and other entities as well as directly assigned to employees by admins or supervisors.  Additionally, all data can be reported on in the same manner as traditional content in one easy to use reporting solution.

Who is in it?

The SAP Open Ecosystem is an easy way to provide content to customers from any content provider, has no cost to join and enables the self-management of content with existing SAP SuccessFactors Customers.

Partners that subscribe to our partner build program can also make their content available through the SAP App store, further simplifying the process and speed to value for our collective customers.  See CrossKnowledge example  - https://www.sapappcenter.com/apps/29033/crossknowledge-for-sap-successfactors#!overview

 

 

1.1. Cross Domain Solution Files

Download the latest CDS files from SAP Software Downloads. as mentioned in KBA 2750417

•The content.zip file contains static files that you copy to the content server. They load the progress tracking code wrap your content.
•The proxlet.war is a small Web ARchive (WAR) application that you deploy on your content server, typically in Tomcat. It is a communication relay between the tracking code and SAP SuccessFactors Learning.
 

1.2. Technical Requirements for the CDS

•  Web Server – Latest Tomcat 7 or 8 versions

•  Java – Latest Oracle JDK 7 or JDK 8 versions
 
 
2. Cross Domain Solution at Run Time

Users are not aware of the Cross Domain Solution (CDS) when they interact with it at run time, but they are working with it to earn credit for their progress. This topic describes how they are interacting with the CDS.

When users click a link in their learning assignments to launch content, they open a new window that is served from the content server. The users see their content in a separate window and do not know about the wrapper.

Inside the wrapper window, users navigate the course, exam, or other content. This content is served from the content server.

While navigating the content, the user's progress is tracked with JSlet (JavaScript "applet") or a Java Applet tracking code.

The proxlet.war application relays the user's progress to the LMS.

 

2.1. JSlet Tracking vs. Applet Tracking

Where possible, we recommend JSlet tracking over applet tracking. This topic describes why and how you can override that recommendation.

If you use an applet, then from time to time, you must patch your server when users update their Java Runtime Environment (JRE). You cannot control when users patch their JRE. When you use the JSlet, you are not affected by JRE updates.

Cloud customers whose users launch tracked content under the proxlet.war Cross Domain Solution (CDS) must use JSlet.

On-premise customers whose users launch tracked content under the proxlet.war Cross Domain Solution (CDS) use JSlet by default. We recommend JSset to avoid JRE update issues.

On-premise customers whose users launch tracked content under the proxlet.war Cross Domain Solution (CDS) can switch to using Java applets. Go to  System Admin -> Configuration->  System Configuration -> LMS_ADMIN  and change the useJsletInsteadApplet setting to false. This setting has no effect on-demand customers.

 

3. Cross Domain Solution Configuration

Before you begin configuring the parts of the Cross Domain Solution (CDS), this topic gives you an overview of the steps.

The proxlet.war implementation of the Cross Domain Solution (CDS) is configured in three parts:

On content server, you extract and deploy the files from crossdomain.zip.

On SuccessFactors, you point the Learning Management System (LMS) to the content server.

On each content object you want to use, you enable the CDS.

 

3.1. Setting up the Cross Domain Solution on the Content Server

You set up the Cross Domain Solution (CDS) on the content server so that users can earn credit for their progression through the learning content served from the content server.

Prerequisites

Identify or create a web accessible directory in your content server to contain the wrapper files. We recommend /content.

Obtain the crossdomain.zip file, which is explained in Cross Domain Solution Files

 

Procedure

Extract content.zip from the crossdomain.zip file to a temporary folder.You see two files in the temporary folder: content.zip and proxlet.war.

Extract content.zip to the web accessible directory.For the web accessible directory, we recommend /content.

Deploy proxlet.war on the content server according to the instructions for your application server or servlet container.

 

3.2. Configuring LMS_ADMIN for the Cross Domain Solution

You configure the LMS_ADMIN file to point the Learning Management System (LMS) to the content server where you deployed the Cross Domain Solution (CDS).

Prerequisites
You have set up the CDS on the content server.

Procedure
Log in to Learning Administration as a system administrator.

Go to  System Admin-> Configuration -> System Configuration ->  LMS_ADMIN .

Edit the communication CDS settings.

 

3.3. Communication Cross Domain Support Settings

Use these settings in LMS_ADMIN to configure Cross Domain Support (CDS) to the proxlet.war.

Configuration Example

communicationCrossDomainSupportEnabled=true
defaultContentServerPath=http://content.xyzcorp.com/content
contentWrapperPageName=main_content_wrapper.html
scorm2004ContentWrapperPageName=scorm_2004_content_wrapper.html
externalURLQuestionWrapperPageName=main_question_wrapper.html
contentOpenerPageName=main_content_opener.html
defaultProxletPath=http://content.xyzcorp.com:8080/proxlet
lmsSessionId=JSESSIONID

properties settings.png

 

3.4. Enabling the Cross Domain Solution on Content Objects

You enable individual content objects for the Cross Domain Solution (CDS) so that the content object can work properly in the CDS context.

Prerequisites
You configured LMS_ADMIN and know the values you set for the properties.
You have imported or created the content objects you want to configure.

Procedure

1.Go to  Learning Admin -> Content -> Content Objects, find your content object, and then open Cross Domain.
2.Select Enable Communication Cross Domain through Proxy and then click Apply Changes.
3.Check the settings in Cross Domain Settings.You see default values based on your Cross Domain Solution (CDS) configuration. In most cases, you do not need to make changes.
  Clear Use Frameset if your content does not run well when launched under a frameset.


4. Cross Domain Solution Troubleshooting

This topic describes how you can troubleshoot issues with your Cross Domain Solution (CDS) configuration.

IMPORTANT NOTE:

Cross Domain issues are outside of Customer Support scope.    
If Customer requests help for installing or modifying the Proxlet or if they want to set up a reverse proxy this has to go through Professional Services.

For more info on Reverse Proxy, see KBA 2154000

Turning on Debugging for All User Sessions

The easiest but broadest way to debug the CDS is to turn debugging on in LMS_ADMIN. When you turn debugging on in this way, all user sessions are put into debugging mode. We recommend this approach if you are debugging a staging server.
Go to  System Admin ->  Configuration ->  System Configuration -> LMS_ADMIN. Find the contentTestPagesEnabled setting and change its value to true.

Please review the additional KBAs in the See Also section below.

ToTop.png

 


Read more...

Environment

SAP SuccessFactors Learning (LMS)

Product

SAP SuccessFactors Learning all versions

Keywords

SAP success factors SF LMS learning Cross Domain Solution CDS Customer Content Server , KBA , LOD-SF-LMS , Learning Management System , LOD-SF-LMS-CNT , Content , How To

About this page

This is a preview of a SAP Knowledge Base Article. Click more to access the full version on SAP ONE Support launchpad (Login required).

Search for additional results

Visit SAP Support Portal's SAP Notes and KBA Search.