LMS Connectors
An external learning platform -- Aspire, or any other -- exchanging courses, enrolments and completions by file (CSV, Excel, text) or over HTTP, with the field mapping and the schedule.
Where to find it
- Module: HRMS
- Group: Learning & Development
- Section: LMS Integration
- Screen: LMS Connectors
Address in the console: /hrms/lms-connectors
List · 10 columns · 18 fields on its form · 2 of them required · 8 actions
What the list shows
These are the columns of the list, in the order they are drawn. Any of them can be sorted on, filtered on, hidden, or exported.
| Column | Kind | Field name |
|---|---|---|
| Code | Code | code |
| Name | Text | name |
| Platform | Status | platform |
| Transport | Status | transport |
| Schedule | Status | schedule |
| Credential | Code | secret_last4 |
| Last run | Date | last_run_at |
| Last status | Status | last_status |
| Open errors | Number | open_errors |
| Active | Yes or no | is_active |
The form
What is asked for when a record is created here. Required fields are marked; a choice drawn from a configuration list is one an administrator can extend without a release.
| Field | Type | Choices | Notes |
|---|---|---|---|
| Code required | Text | ||
| Name required | Text | ||
| Platform | Choice | aspire, generic | Where the field mapping starts: Aspire’s export headings, or our own field names. |
| Transport | Choice | file, rest | |
| Base URL | Text | For HTTP: https://… (or sandbox: to try it with sample data). | |
| Authentication | Choice | none, basic, bearer, api_key | |
| User name (basic) | Text | ||
| API key header | Text | For example X-API-Key. | |
| Endpoints | Text | {"courses":"/courses","enrollments":"/enrollments","completions":"/completions"} | |
| Field mapping | Text | Per kind of record, our field: their column. For example {"completions":{"employee":"EmpID","completed_at":"Date"}}. Only what differs from the platform’s starting map. | |
| Employees matched by | Choice | employee_no, email | |
| A completion enrols if not enrolled | Yes or no | ||
| Create courses not seen before | Yes or no | ||
| File delimiter | Text | ||
| Scheduled import | Text | ["courses","completions"] | |
| Scheduled export | Text | ["enrollments"] | |
| Schedule | Choice | manual, hourly, daily, weekly | |
| Active | Yes or no |
What you can do here
Import file primary
Each row is mapped by the profile, matched to its course and employee, and taken; a row that cannot be is kept in the LMS Error Log with why.
Asks for: What the file holds* File (CSV, Excel or text)*
Pull now
Asks for confirmation: Exchange with the platform now: import and export as the profile says?
Test connection
Set credential
Asks for: Password, token or API key*
Export courses (Excel)
Export enrollments (Excel)
Export completions (Excel)
Export enrollments (CSV)
* required
The rules that apply here
Everything on this screen obeys the platform rules rather than rules of its own. The ones worth knowing before you use it:
- Narrowing a list — search, conditions, sort, totals, export and saved views.
- What may be changed — the five grounds a record may not be edited on.
- Companies and business units — what the switcher above this list is doing to it.
- Creating a record — required fields, where choices come from, and how the number is allocated.
- Importing a spreadsheet — this screen accepts one, and it runs through the same rules as typing.