2318341 - LMS Connectors Knowledge Support and Tips

 

Click to go back to the main page

 

CONNECTORS KNOWLEDGE SESSION FOR CUSTOMERS, PARTNERS AND SAP PRODUCT SUPPORT

1.What are the Connectors in the LMS and for what we use it for?

2.Different connectors types inside LMS

3.Connector Workbooks: Standard Connector, Olsa Connector, Skillsoft Connector and Competency Connector

4.Connectors Configuration LMS

5.SF User Connector – Bizx Integration

5.1 Provisioning

5.2 LMS Configuration

5.3 Adding Custom Columns to Extended Data

6.Connectors: Misc. Settings

7.Connectors Mapping : Mapping / Custom Columns / Transformation Rules

7.1. Connector Mapping

7.2. Connector Custom Colums

7.3 Connector Transformation Rules

8. PGP Configuration

9. Common Known Issues

10. Known Issues: KBA created for connectors LMS

11. Database relations to Connectors

12. A Reminder about Connectors

1. What are the Connectors in the LMS and for what we use it for?

Description

Connectors are used to import data into the LMS. Each connector has it’s own specific data structure, so each input data file must match a predefined format. There are different types of connectors offered. Requires license – All are Free except OLSA Connector that it was substitute by the standard Skillsoft connector in b1508. Competency Connector SF has his own connector workbook and it is not found in the standard connector workbook.

Connector Processing

Processing Methods for Input Fields

The connectors support to modes of processing the input file:

Position Method (DEPRECATED - DO NOT USE):  This method requires that all of the fields in the input file are in a specific order.  This method is deprecated.  Do not use this method it is deprecated.

Header Method:  This method uses the header row to determine the positions of the input data.  This is the only supported method.

Connector will only process the records which presents on the input file. The records that exists in LMS but not presented on the input file won't be touched or wiped out.

Record Rejections

The standard connector and imports will reject a record (not the entire input file) if any of the following conditions occur:

• The input file contains a null value for a field that cannot be null.  Check the ‘Req’ column in the data mapping tables which indicates whether a value for a field is required.
• The input file contains a value that does not comply with the data type for that input file column.
• The field input value is a reference but the value does not match the reference table.

Null Values

Null values in the input file are accepted by a standard connector unless the field is a required field.  The connectors do not update fields when the input file passes a null value.

Input File Format

The input file produced by customers must have the following characteristics in order to be processed correctly by the SuccessFactors Connector:

• Character Set:  SuccessFactors supports only the UTF-8 Character Set in the input file. Do not utilize UTF-8-BOM encoding.
• Column delimiter character:  Will always be a pipe (“|”) character out-of-the-box but is configurable via appropriate connector property.
• Row delimiter character:  !##!
• Column Headers:  Must be included as the first row of the input file. 
• Order of columns:  The connector will be set to “header” method for processing the input file.  This means that the order of the headers can vary since the connector reads this header row and uses it to map data to the connector fields.
• Null values (empty fields):  All columns indicated in the header row must be supplied in the input file data.  You can indicate null values by using two consecutive pipes.

 

 

 

2.Different connectors types inside LMS

Connector :  Description:

• Account Code Connector: This connector adds or removes fully identified Account Code references.  In addition to keeping basic account code references updated, a fully identified account code also enables posting chargebacks to SAP Financials.  A fully identified account code contains an ID, the account code type, and the company code.
• Administrator Connector:  Adds Administrators to the LMS.
• Alternate Job Code Connector: This connector adds or removes additional Job Code reference to users
• Class Connector: Schedules instances of existing item records and is typically used for one-time data migrations.
• Compentency Connector - SF:  Creates competencies and associated rating scales in in the LMS. Records are created in the BizX environment and loaded to the LMS using the connector.
• Curriculum Connector: Similar to Item Connector, this connector adds new curricula and updates to existing curricula.
• Item Connector : Creates new items in SuccessFactors Learning and updates existing records. It is most common for the item connector to be used for one-time data migrations, rather than an ongoing feed.
• Job Code Connector: Formerly known as job position, the job code connector creates new and updates existing job code values, such as domain, if curricula should be automatically assigned, and more
• Learning History Connector: Records item-based completions for existing users’ completion of existing item records. Both the user and the item record must exist within the system for the record to be accepted. The learning history connector is most commonly used for one-time data migrations.
• Organization Connector: creates organization references and updates to existing organization references. This connector has to be populated manually or by a third party solution, there is no standard integration with BizX.
• Organization Owner Connector : This connector ads organization owners to an organization
• Person IDs Connector: This connector syncs the PERSON_GUID from Platform to Learning.
• Position Connector: Do not use.
• Registration Connector: Updates user registrations in existing Classs. Both the user and Class must already exist in the system. This connector is typically used for one-time data migrations.
• Security Domain Connector: Loads new domains, updates existing records, and manages the hierarchical relationship of domains
• Skillsoft Connector: Loads courses from the vendor Skillsoft. Discuss with the vendor for more information.
• User Connector: Loads new users and updates existing records. Capable of creating references, such as domains.
• Federal User Connector: Contains all values as the standard user connector, but adds additional fields required for Federal agencies.
• User Connector - SF: Loads and updates users in an integrated environment from the BizX suite. This connector is used solely for integrated environments.

These are the standard Connectors, then the customers could have their own custom connectors made by Professional Services and there is also the OLSA Connector.

3.Connector Workbooks:

4.Connectors Configuration LMS

Once you’re in the LMS Admin site, navigate to System Admin>Configuration>System Configuration>Connectors

5.SF User Connector – Bizx Integration

5.1 Provisioning

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

5.2 LMS Configuration

• For SF User Connector, LMS will only process files based on Headers.
• Column delimiter character:  Will always be a comma ( , ) character.
• Row delimiter character: End of line
• Null values (empty fields):  Indicate null values (empty fields) by using two consecutive commas.  Do not use blank space to indicate null values; as they will be interpreted by the connector as a non-null data input.
  • Correct indication of a null column:  ,,
  • Incorrect indication of a null column: , ,
  
  

5.3 Adding Custom Columns to Extended Data

Review KBA 2247963 - How to map Bizx custom column in LMS? for more detail information.

IMPORTANT NOTE: the file name to be used is user_extended_data_xxxx.csv or txt.

6 Simple Steps to Add Custom Columns from BizX to LMS

1. BizX - Update the Customer Data Model with the Custom Fields
2. BizX - Add Extended User Information
3. LMS - Update the Connector Property file with the Custom File Mappings
4. LMS - Add the Custom User Columns to the LMS
5. LMS - Export the Extended User Information
6. LMS - Import the Extended User Data

Step 1: Update the Customer Data Model with the Custom Fields
Login to Provisioning and Export the Data Model:

Update the Data Model with the Custom Fields:
Note:   If you want the extra column to be available within the BizX UI, it will need to be added to the form and permissions. This was not tested as part of this solution.

Step 2:  Add Extended User Information
You can see the added column by downloading the Extended Import Template from BizX Admin Tools > Import Employee Data > Download > Extended Import.
Add the user data in the custom field of the new field.

Step 3: Update the Connector Property file with the Custom Field Mapping(s)
Add the following to the CONNECTORS property file:
sfuser.extendeduser.field.customcolumn.160=ADDL_TEST
*The Custom Column from BizX must be entered in uppercase, even though the BizX ID may not be

Step 4: Add the Custom User Column(s) to the LMS
System Admin > Custom Columns > User
The column number must match the value in the property file

Step 5: LMS - Export the Extended User Information
In Provisioning, add a Managed Scheduled Job to export the Live Profile Data from BizX.
This is scheduled to run after the BizX User Export.  Both files are sent to the same location on the SFTP server.  The User Connector-SF will process both files when it runs.

IMPORTANT NOTE : Name of the extended file : user_extended_data

Step 6:  Import the Extended User Data
System Admin > Connectors > User Connector – SF
After the process runs, the data in the custom column displays in the user record:

 

 

6. Connectors: Misc. Settings

Review KBA 2074858 - How to archive connector’s input files - Learning for more detail information.

For enabling the LMS instance to show the archive files of the connectors run please follow next steps bellow:

System Admin>Configuration>Connector Settings

 


7.Connectors Mapping : Mapping / Custom Columns / Transformation Rules

 7.1. Connectors Mapping

All mapping follows this format:
<Connector Prefix>.<Entity Type Prefix (if any)>.field.mapping.data.<LMS DB column>=<name specified in header of input file>

7.2. Connector Custom Columns

Each connector contains at least 5 Standard custom columns.  They follow the same mapping structure:
<Connector Prefix>.field.mapping.data.<LMS DB column>=<customer’s DB value; specified in first row of headers in input file>

sfuser.field.mapping.data.COL_NUM6_VAL=<customer’s DB value>, which would be in the first row of headers in the input file.

To add additional custom columns, you can use this mapping format:
<connector prefix>.field.customcolumn.<field>=<column_number>
where field is the header value that will appear in the input file and column_number is the user custom column where the value will be stored.

A secondary file called “Extended User File” can be ran to specify custom columns to feed.

7.3 Connector Transformation Rules

For more information about this topic please review KBA 2173658 - How to map BizX Locale to LMS Locale via User SF Connector-LMS

There are advanced configurations that are not covered in this guide (ie., Transform rules that allow the data that the customer submits to be transformed to something that the LMS will accept/understand), this is covered on this document:

There are advanced configurations that are not covered in this guide (ie., Transform rules that allow the data that the customer submits to be transformed to something that the LMS will accept/understand), this is covered on this document.  However, below is an example.

The LMS Connector has what we call “transformation properties” that essentially help address mismatches. Locale is one example. The out-of-the-box configuration, transforms incoming “en” and “en_US” (from BizX – Input file) values to English (corresponding locale value in the LMS): sfuser.field.transform.data.LOCALE.English=en,en_US
 
Similarly, if you want to transform a BizX “EST” timezone value to “America/New_York” (corresponding LMS value), you would specify a setting such as: sfuser.field.transform.data.TIMEZONE.America/New_York=EST


8. PGP Configuration

In this example, we see that the issue is pointing to the file ending “unexpectedly” and it gives you a line number.  If we look at the archive file, we see that the input file has long gaps of blank line spaces, starting at line 11930.  This caused the connector to fail.  In this case, a DCOPS JIRA is in order since the Quartz job failed to produce a correct input file.

System Admin>Connectors
Scenario 2:

 

System Admin>Connectors
Scenario 3

We generally see this when:

• Input file has the incorrect name.
• Possible that Staging environment refresh was done and it has same configuration settings as production environment; and it is grabbing the file before production environment (two jobs competing for same input file)
• Incorrect format type (position vs headers)

 


11. Database relations to Connectors

Connectors are jobs that run in the connector node, so the information related to the jobs can be found in the following tables:

PA_SCHEDULED_JOB to check if it is scheduled or not and when it is supposed to run, by JOB_ID
PA_SCHEDULED_JOB_RESULT: you can see connector job results, by JOB_ID
 
PA_SCHEDULED_JOB_LOCK_HOLDER table needs to be checked in case the global lock was enabled and is preventing connector jobs (and other jobs) from running. It has to be reported to Operations.

(If AP Synch is running, connectors won't be able to run. Both connectors and AP Sync may require to update the very same tables and we don't want both of them updating records at the same time.)
PS_CONFIGURATION contains also connector configurations saved in the Admin>System Admin>Configuration>System Configuration>CONNECTORS. You will only see the changes from the original  one, not the full configuration (the same as shown using 'view changes')

Connectors place the information in the tables related to the specific connector. For more detail, check the connector's workbook, as it shows where in the database (field & table) will be saved/modified  each field of the input file, as well as how it will be updated

Other database tables specific for connectors, use the naming convection PA_CONN_...

PA_CONN_ACTIVITY lists the connectors and the last run and it is doing the counting of the entities that need to be inserted, updated and removed. This is the info showed in the connector report> activity summary
PA_CONN_ALT_JOB_POS, related to the alternate job code connector
PA_CONN_CBT_CPNT_MOD, related to the online components of the item connector
PA_CONN_CONFIG has the UPDATE_ON_NULL and NO_UPDATE_ON_NULL configurations, as well as the fields applied to them.
PA_CONN_CONTENT_MOD, related to item connector, content object
PA_CONN_CPNT, related to item connector
PA_CONN_CPNT_CPTY, related to item associated to competency
PA_CONN_CPNT_EVTHST, related to the history of the user
PA_CONN_CPNT_LOCALE_LABEL, item info saved in different locales
PA_CONN_CPNT_SKILL, skills added to the item
PA_CONN_CPNT_USER, contact information associated to an item
PA_CONN_CPTY, competency connector
PA_CONN_CPTY_LOCALE,  competency connector
PA_CONN_CPTY_RATING_CRITERIA, competency connector
PA_CONN_CPTY_RATING_LOCALE, competency connector
PA_CONN_DOMAIN, domain connector
PA_CONN_ENROLL, related to Registration connectorPA_CONN_EXCEPTIONS: For each connector (INTERFACE_ID) shows the exceptions and type found after the execution
PA_CONN_INPUT_DATA: shows the info of the archived connector input file
PA_CONN_JOB_POS, job code connector- info processed
PA_CONN_LOG:  It shows a log of the connector executions
PA_CONN_ORG, organization connector
PA_CONN_ORG_DSHBRD, configuring dashboards for organizations
PA_CONN_ORG_INITIATIVES, Organization connector(organizations can have initiatives set by the org owner)
PA_CONN_ORG_OWNER, Organization connector
PA_CONN_ORG_SUCES_PLNING,  Organization connector, to set up the succession planning
PA_CONN_QUAL, Curriculum connector
PA_CONN_QUAL_CPNT, Curriculum connector- assigning items to the curriculum 
PA_CONN_QUAL_JOB, Curriculum connector- matching the curricula with the job code and assigning the curricula settings on the job code screen of the user
PA_CONN_QUAL_LOCALE_LABEL, curricula locale info
PA_CONN_QUAL_PARENT, parent curricula relations: curricula, subcurriculas...
PA_CONN_QUAL_REQ, Curricula connector, requirements
PA_CONN_SCHED, Class Connector
PA_CONN_SF_CPTY, Competency connector: BizX competencies
PA_CONN_SF_CPTY_RTNG_CRITERIA, Competency connector: BizX  rating criteria (teasers)
PA_CONN_STUD_ALT_SUPER, User connector, alternate supervisors
PA_CONN_STUD_FEDERAL, User connector federal
PA_CONN_STUD_FEDERAL_ALT_SUPER, User Federal connector, alternate supervisors
PA_CONN_STUD_FEDERAL_SUPER, User connector Federal, alternate supervisors
PA_CONN_STUD_PRIVATE, User connector sensitive data
PA_CONN_STUD_SUPER, It contains the user's supervisors
PA_CONN_STUD_USER, User connector, related user for the admin
PA_CONN_STUDENT, User connector
PA_CONN_USER_PRFL, Admin Connector

 

12. A Reminder about Connectors

• Only header-based processing mode is supported for new customers
  connector.input.file.processing.mode=header
• Enhancements are supported only for header-based processing
• Position-based processing will be removed as an option from the UI by 1411
• Connector Template download: System Admin->Tools->Connector Templates
  This new feature provides admin with the ability to download the latest connector template(s) for any connector (“all columns” option). If custom columns beyond the standard 15 have been configured, they will be included in the template as well.

Download connector template(s) for any connector that contains just columns that have been mapped (per the connector.properties file configurations). This option (“only mapped columns”) applies only when header-based processing is enabled

 

 

12.1. A Reminder about Connectors : new features b1411

Jira	Description	Enhancement Type	Config Details
LRN-7147	Support the “force sequential completion” setting for content objects	Admin Opt-in	Use item.field.mapping.data.FORCE_ORDER=FORCE_ORDER –OR– item.itemmodule.field.mapping.data.FORCE_ORDER=FORCE_ORDER
LRN-6321	View connector error logs in UI	Universal	N/A

Connector error logs in UI:

 

 

12.2. A Reminder about Connectors : new features b1502

HR Business Partner (HRBP) – LRN-7912 :
•Add required workflows to HRBP users.
•Setup connectors to import HRBP-User mapping.

SF User Connector for Integrated Customers
•Map HRBP to input HR field: System Admin > Configuration > System Configuration > CONNECTORS > sfuser.field.mapping.data.HRBP=HR
•Supports mapping a single HRBP to a User.
Standard User Connector and Federal User Connector

•New input data file user_manager_data.txt with fields:
STUD_ID
MANAGER
REMOVE_ALT_SUPER - ‘Y’ = Delete; ‘N’ = Add (default)
ALT_SUPER_TYPE - ‘A’ = Alternate Supervisor; ‘H’ = HRBP

•Supports mapping multiple HRBP and Alternate Supervisors to a User.
Note: The limit on the total number of HRBP and Alternate Supervisors has been increased from 10 to now 40.

 

12.3. A Reminder about Connectors : new features b1505

HR Business Partner (HRBP) – LRN-8712 :
In earlier versions of the application Online Content in an Item always opened in a new browser window.  This configuration is available at the content object and can be updated or set via:

Item Connectors (Item Data and Content Module Data) :
New browser window will remain the default configuration behavior.  
 
1.Enable usage of the feature in: System Admin > Configuration > Global Variables > Enable Inline Content Launch Configuration
2.Then, in order to open the content in the same browser window, the value can be set in:
a)Content > Content Objects > Launch Method > Launch in a New Browser Window
b)Content > Tools > Import Content
c)Connector properties:
item.field.mapping.data.LAUNCH_IN_A_NEW_BWSR_WINDOW=LAUNCH_IN_A_NEW_BWSR_WINDOW
-OR-item.contentmodule.field.mapping.data.LAUNCH_IN_A_NEW_BWSR_WINDOW=LAUNCH_IN_A_NEW_BWSR_WINDOW

Jira	Description	Enhancement Type	Config Details
LRN-8920	When the User Connector detects that you are making a user a primary supervisor and that user is already an alternate supervisor, it removes the alternate supervisor assignment and adds the user as a primary supervisor in one action. The enhancement applies to all User Connectors: user, SF user, and Federal.	Universal	N/A
LRN-7086	User connector: Provide option to keep items, curricula, and programs on the user’s learning plan when the user is inactivated	Admin Opt-in	user.connector.inactiveRule.cleanDevPlan=N

LRN-8155	Learning History connector: provide the ability to specify timezone for completion date	Admin Opt-in	1. Populate the new column: COMPL_DTE_TIMEZONE -OR- 2. Set a value for: learninghistory.connector.defaultValue.ComplDteTimezone=
LRN-8154	Item connector: provide the ability to copy substitutes when revising an item	Admin Opt-in	Item.connector.defaultValue.revision.copySubstitutes=Y
LRN-7685	Require explicit revision dates to be passed in order to prevent multiple revisions from getting generated via the item connector. When this is enabled, the connector follows these rules: •New Item ID + Null Rev Date = Throw error: “Revision date cannot be null” •New Item ID + Explicit Rev Date = New item with rev date per the input file •Existing Item + Null Rev Date = Throw error: “Revision date cannot be null” •Existing Item + Explicit Rev Date that is later than item's rev date = Revise the item •Existing Item + Explicit Rev Date that is same as the item's latest rev date = Update the item •Existing Item + Explicit Rev Date that is earlier than item's rev date = Reject the item record	Admin Opt-in	In Enable this restriction via: item.connector.defaultRevDate.currentTimestamp=N. This is the default for new customers. When set to “Y”, the connector follows existing behavior, i.e., the new revision is created with current timestamp
LRN-7305	Support additional fields via the Class connector (shown below)   Note: Values for the 2483 fields can be inherited using: scheduleoffering.connector.defaultValue.inherit2483FieldsFromItemsWhenNull=Y	Admin Opt-in	Mapping configurations in the Connector properties file
LRN-8975	The limit of total Human Resource Business Partners (HRBP) and alternate supervisors has been increased. The User Connector loads up to 200 per employee. The Manage Alternate Supervisor dialog now displays all the associated Alternate supervisors and HRBPs. As long as the total limit is not exceeded, new Alternate Supervisors can be added.	Admin Opt-in	N/A
LRN-8701	Government reporting Age field will be replaced by Birthdate. •A new government reporting field for birthdate is available on the User>Related Government Reporting, SFSF and User connectors, User import, and BizX Extended Import for Employee Data. •Training Manager export of training requests will contain age (computed) and Birthdate.	Universal	N/A

 

 

 

12.4. A Reminder about Connectors : new features b1508

Commerce: Set Cancellation Policy on Pricing tab of Item or Class 
 
Connectors: Item or Class Connector is updated to include Cancellation Policy ID. If blank, when creating an Item the cancelation policy will be set to the system default; when creating a Class, the cancellation policy will be set to the that of the parent Item. When updating an existing Item or Class, if blank any existing cancellation policy will not be deleted.

Jira	Description	Enhancement Type	Config Details
LRN-8972	Competency connector “competency category” field support		competency.connector.sf.enableCategorySync= Default value: “N” for existing customers, “Y” for new. When set to “Y”,the connector uses the BizXcategory column and creates/updates competency records in the LMS with the corresponding category ID NOTE: Competency categories need to have been createdin the LMS first. The connector will not create them on the fly.
LRN-9334	Skillsoft connector productization. See Migration to Skillsoft connector workbook.		Now available under the list of connectors.Migration details for existing customers are being worked out with PS.

 

 

 

12.5. A Reminder about Connectors : new features b1511

Bulk Learning Event Editor (Split costs) 
Split costs cannot be recorded through learning history connector or import.

 

Jira	Description	Enhancement Type	Config Details
LRN-8816	Item Connector: Allow updates to olderinactive revisions	Admin Opt-in	item.connector.update.inactiveRevisions= Defaultvalue: N Accepted values: Y, N
LRN-9012	ScheduledOffering Connector: Control “Allow usersto access online content without registration property” When set to “inherit”, the segment will set the value according to the item setting. If the SO connector tries to create a segment that does not exist in the item, ONLINE_ACCESS_ALLOWED will be set to “N”. When set to blank, the connector will treat this as “inherit”.	Admin Opt-in	scheduleoffering.connector.defaultValue.segmentOnlineAccessAllowed= Defaultvalue: inherit –for new customers; existing customer configurations retained Accepted values: Y, N, Inherit

 

 

 

Read more...

SAP SuccessFactors Learning all versions

• LMS Connectors
• Connectors Implementation
• Connector Support and Tips

, KBA , LOD-SF-LMS-CON , Connectors , LOD-SF-LMS , Learning Management System , How To