Custom Learner Data Fields

<< Click to Display Table of Contents >>

Navigation:  »No topics above this level«

Custom Learner Data Fields

Six additional free text fields, "Custom String 1" through "Custom String 6", are available from the User Detail page to store additional User data. These fields can be custom labeled through Localization settings to provide more descriptive labels. For example, "Custom String 1" can be modified to display "Management Group". The six fields are also included when exporting data and running various reports and can be included with a User import.

Display and Storage

The new custom data fields can be accessed via the User detail page.

1.Navigate to Users > and select a User's Last, First name in the grid to open the User detail page or select a row in the Users grid and click Edit Record edit.

2.Scroll down to view the Custom String fields listed below the address fields.

UserDataCustomFeilds

These free text custom fields are string only fields (NVARCHAR(256)) and support a maximum length per field of 256 characters.

Localization

You can modify the display name of the custom fields through Settings > Localization to match your preferences.

1.Navigate to Settings > 3-dot menu > Localization.

2.Search for the names (labels) of the custom fields, i.e. enter custom string in the Search bar and click the Search button.

Localization_Search

3.Select the pencil beside the custom field.  

Localization_EditRow

4.Enter the revised display name in the Modified Value column and click the checkmark to save the changes. Complete this for both the Label text and Column heading text rows of each Custom String.

Localization_ModifiedValue

After making changes, ensure that any updated labels are correctly reflected in the User detail page.

Localization_renamedFields

User Export

The free text custom fields are included in the User > Export file. The data will appear after the Address columns and be labeled as Custom String 1, Custom String 2, etc., or with the modified name specified through Localization, such as Management Group.

CustomFields_ExportedUserdata

Import Learner Data

Administrators using the Import_Learners spreadsheet to import User data will have the new free text fields included as optional in the Import.  

Additional API Fields

The new free text fields are now available in the API. When calling the 'Users' endpoint with a GET request via the Import Learners API, all six new free text fields are included in the returned JSON object. Each field is assigned a value based on the corresponding database entry, with property names such as `custom_string_1`, `custom_string_2`, etc. If a field has no data, it will be set to `null`.  

For POST requests, these new free text fields are optional and can be included in the JSON data sent to the API, using the same property names: `custom_string_1`, `custom_string_2`, etc.

See API Reference

Reporting

The new free text fields are included in the exported data of the Training Tracking, Course Assignments, Path Progress and Event People reports.

1.Navigate to Run a Report and run the desired Report.

2.Select the Export ExportToExcel option.

The new free text fields and data are always included in the report Export.