14.29 Integration and Connector Updates

The Integration and Connector updates cover updates, or new possibilities, where the imc Learning Suite LMS communicates with external software.


Integration Updates

Integration updates are listed below:

Learning Analytics Semantic Model Includes Running Time in Days

Overview: This update adds the Running Time in Days meta tag (ID 10119) to the Learning Analytics dataset. The meta tag appears alongside other available meta tags to include in reports for filtering and results.

Benefits and Use Cases: Report administrators can now add the Running time in days meta tag when generating reports. With the update organisations can report on the time learners invest in training directly within Learning Analytics - without workarounds or manual data exports.

Audience: Report administrators

Setup & Access: The Running Time in Days meta tag (ID: 10119) is automatically available in the dataset. Existing Learning Analytics reports and configurations are unaffected. To utilise the meta tag you need to open Learning Analytics and select the meta tag in desired reports.

Considerations & Limitations: The meta tag is not available for media and level-based learning paths in the Learning Analytics semantic model.

Testing: To test you need to open the Learning Analytics function and edit a course report. The Running time in days meta tag will be available in the dataset to add to course reports.

Risk rating: Low

Preparation of the Tabular Object Model for Future Customer Specific Additions

Overview: The Table Object Model for Learning Analytics has been updated to support future customer specific additions.

Benefits and Use Cases: The update enables Learning Analytics to be operated in a way which allows you to add further custom data to the semantic model. Higher flexibility and faster integration of data which is not yet considered in the semantic model.

Audience: Report administrators

Setup & Access: Custom data needs to be added. This can be done when the Learning Analytics semantic model is in Edit mode. You will be able to add tables, columns and relationships.

Considerations & Limitations: Requires the Learning Analytics integration and licence. It’s important that no new roles are added to the dataset. This is because the existing roles are the only ones mapped in the Analytics Backend. Currently the model contains:

  • 4 roles for UserClearences

  • 1 role for ObjectClearences

Testing: You can test extending the dataset with new tables, columns, or relationships by following this process:

  1. In the Power BI workspace, open the dataset in Edit mode.
    At this step the dataset is converted into a Large Semantic Model type.

  2. After conversion, a download link for the dataset becomes available.

  3. Download the dataset (this can take approximately 10 minutes).

  4. Open the dataset in the Power BI Desktop.

  5. When prompted, click Discard Changes button, so that the queries generated by TOM are not reapplied locally.

  6. After this step, the dataset can be extended by:

    • editing existing queries

    • adding new tables

    • extending existing role rules.

Risk rating: Low

Supporting domain_hint for OpenID Connect SSO

Overview: The OpenID integration has been updated to support the domain_hint concept. This is a parameter that can be included in the authentication request sent by a client application to an OpenID Provider (OP).

  • Directs to the right identity provider: In scenarios where an OP supports multiple identity providers (e.g. social logins like Google, Facebook, or enterprise identity systems like Azure AD), the domain_hint parameter can guide the OP to directly route the user to the appropriate login page.  

  • Skips home realm discovery: Without a domain hint, the OP might present the user with a selection of identity providers. Providing a domain_hint can bypass this step, leading to a smoother and faster login experience.

Benefits and Use Cases: The purpose is to give the OP a hint about the user's domain or identity provider, with the goal of streamlining the authentication process. If a user of an external system clicks on a deeplink to LMS, the OICD of LMS can make use of domain_hint parameter. The user is then directed directly to the specified idp for authentication.

Audience: Technical administrators

Setup & Access: There is no need for setup. The update handles the parameter in case it is available.

Considerations & Limitations: Requires the OIDC integration. The domain hint in OpenID Connect is a valuable tool for enhancing the user experience by making the authentication process more direct and efficient in scenarios involving multiple identity providers.

  • It's just a hint: The OpenID Provider is not obligated to act on the domain_hint.

  • Security: While it improves user experience, the domain_hint itself doesn't provide any security benefits. The standard OpenID Connect security mechanisms still apply.

  • Standardisation: The domain_hint parameter is not strictly defined in the core OpenID Connect specification, but is a common extension supported by many providers, particularly enterprise-focused ones like Azure AD.

Testing: For a basic test you can open the IDM SSO URL for OIDC adding the domain_hint parameter. The redirect authorization call will also contain the same parameter. This is not an end to end test, but it will prove the concept works.

Risk rating: Low

Client ID in Skill and Registration Change Messages (Event Bus)

Overview: This update adds the client_id field to both the Qualification Value Changes ("Skill") event message and the Registration Change event message.

Benefits and Use Cases: Downstream applications and integrations can now process client-specific data directly from event messages. The enhancement also aligns the payload structure across Skill and Registration Change events, providing greater consistency for integrations.

Audience: Technical administrators

Setup & Access: The client_id field is automatically included in Qualification Value Changes ("Skill") and Registration Change event messages. No configuration changes are required.

Considerations & Limitations: The client_id field may contain an empty value when no client identifier is associated with the participant. Consuming systems should handle empty or null values appropriately.

Testing: To verify the update, trigger a Qualification Value Changes ("Skill") event or a Registration Change event and review the generated payload. Confirm that the client_id field is present and populated when a participant has an associated client identifier. Also verify that the field is included with an empty value when no client identifier is available.

Risk Rating: Low


Price, Location, and Planning Status in Course and Registration Change Messages (Event Bus)

Overview: This update enhances Event Bus payloads by adding Price, Location, and Planning Status directly to the Course Change Event. In addition, the Registration Change Event now includes Portfolio ID and Personal Start Date / Personal End Date.

Benefits and Use Cases: Integration consumers can now access Price, Location, and Planning Status at the course level without relying on course registration data or performing additional lookups. The inclusion of Portfolio ID and Personal Start/End Dates in the Registration Change Event provides greater context for registration-related processes and reporting. Overall, the update improves integration reliability, simplifies event consumption, and promotes a more consistent and efficient data exchange with external systems.

Audience: Technical administrators

Setup & Access: The new fields are automatically included in the respective event payloads. No configuration changes are required, and existing integrations remain compatible.

Considerations & Limitations: Consuming applications should be reviewed and updated if they are expected to process the newly available fields. Field values may be empty where corresponding information is not available, and integrations should handle such cases appropriately. Existing event structures remain unchanged except for the addition of the new attributes.

Testing: To validate the enhancement, trigger a Course Change Event and confirm that Price, Location, and Planning Status are included in the event payload. Then trigger a Registration Change Event and verify that Portfolio ID and Personal Start Date / Personal End Date are present and populated where applicable. Also confirm that consuming systems can process these new fields correctly.

Risk Rating: Low



Connector Updates

Connector updates are listed below:

Shopify Admin API Updated to the Latest Version

Overview: The Shopify configuration in the imc Learning Suite is updated to support the latest Admin API version, including modern OAuth-based authentication. Administrators can now configure OAuth credentials (Client ID field & Client Secret field) for Shopify connections and choose between legacy and OAuth authentication. The system automatically handles the 24-hour token lifecycle including fetching, caching, and refreshing access tokens transparently.

Benefits and Use Cases:

  • Ensures continued compatibility with Shopify's latest API version, preventing service disruptions from deprecated endpoints

  • Reduces manual maintenance effort through automated token lifecycle management with concurrency protection

  • Maintains full backward compatibility — existing shop configurations remain unchanged and fully functional

Audience: Shopify administrators

Setup & Access: Not required as the changes are automatically applied. Existing customers do not need to update or change anything as current configurations continue to work as before.

Considerations & Limitations: Official announcement from Shopify: Expiring offline access tokens required for new public apps. This applies only to newly configured public apps after April 1, 2026.

Testing: With any update to a payment gateway, Scheer IMC highly recommends you conduct thorough testing on your Staging environment prior to updating Production.

Risk rating: Medium