2326051 - How to configure mapping additional custom columns to connector files in LMS

SAP Knowledge Base Article - Public

2326051 - How to configure mapping additional custom columns to connector files in LMS

Symptom

This is a KBA to demonstrate How To configure the mapping of additonal custom columns to a connector file in the LMS.

Environment

Learning Management System (LMS)

Resolution

When we talk about mapping new custom columns to a connector file we are simply saying that we want to add additional column/header fields to our input file to reflect custom columns that have already been created in the LMS UI and are not already defined in the Connectors Workbook.

Background

Custom columns are created in the LMS to capture data for an entity in the form of Columns or fields that do not already exist in the system by default. Such columns/fields can be added to entities such as Item, User, Curriculum or Scheduled Offering.

Important Information

Whilst most of these custom columns can be updated by their respective connector, only the Item and User Connectors currently allow for the mapping of additional custom columns in their corresponding input files. All the other connectors do not currently allow for more custom columns to be mapped other than those already mapped by default and listed in the Connector Workbook*.

*This includes the user_extended_data input file which is processed by the SF User Connector but whose input file is configured and mapped separately.

Mapping Additional Custom Columns (for User & Item Connectors Only)

Steps

  1. When mapping additional custom columns to the user and item connectors the first step is to manually create them in the system.
  2. This is done in System Admin > Custom Columns > Item/User.
  3. Call these columns whatever you desire but it is important to take note of the column number.
  4. Once you have these column numbers you are ready to map in the Connector Configuration file.
  5. Additional columns are constructed in the following way: user.field.customcolumn.<col_num>=<field mapping from input file>   
  6. The col_num is the custom column number as set up in the LMS.  The field mapping from the input file is the input field that you are mapping to this custom column.
  7. For example, if you want to add custom columns 200, 300, 400, and 500 to the User or Item Connector then you would add the following to the properties file:
  •             User Connector (user_data file)

                  user.field.customcolumn.200=<field mapping from input file>
                  user.field.customcolumn.300=<field mapping from input file>
                  user.field.customcolumn.400=<field mapping from input file>
                  user.field.customcolumn.500=<field mapping from input file> 

  •            SF User Connector (user_data file)

                  sfuser.field.customcolumn.200=<field mapping from input file>
                  sfuser.field.customcolumn.300=<field mapping from input file>
                  sfuser.field.customcolumn.400=<field mapping from input file>
                  sfuser.field.customcolumn.500=<field mapping from input file> 

  •            Item Connector (item_data file)

                  item.field.customcolumn.200=<field mapping from input file>
                  item.field.customcolumn.300=<field mapping from input file>
                  item.field.customcolumn.400=<field mapping from input file>
                  item.field.customcolumn.500=<field mapping from input file> 

         

It is important to remember that mapping additional custom columns is only supported by the three connectors referenced above. Attempting to map additional custom columns (other than those referenced in the Connectors Workbook) to any other connector in the same way as above will result in unexpected errors or erroneous updates. This is because there are currently no validation checks in place in the code base for their associated input files other than for those columns referenced in the Connectors Workbook.  

See Also

2326028 - Validation Errors not being flagged for additional columns in Extended User input file

Keywords

LMS; Custom Columns; Mapping; Connectors; Connector Configuration; Item Connector; User Connector , KBA , LOD-SF-LMS , SuccessFactors Learning , How To

Product

SAP SuccessFactors Learning all versions