Using the TopClass – Protec Bridge
The TopClass–Protec Bridge provides a seamless two-way integration between your AMS and LMS:
- Real-time profile sync: Individual learner accounts created or updated in Protec automatically sync to TopClass.
- Single Sign-On (SSO): Members log in once on your website via Protec and are automatically logged into TopClass.
- Product and enrollment management: Training products entered in Protec are automatically created in TopClass, eliminating duplicate data entry.
- Completion writeback: TopClass can write completions and credits back to Protec, with flexible options available during implementation.
This integration ensures accurate data flow, reduced manual effort, and seamless access to learning activities for members.
Prerequisites
TopClass uses the Protec REST services to integrate, so the following are required to initiate any integration:
- A Protec test server with URL and test account credentials
- URL of REST API endpoint
- Client ID
- API Key
Single Sign On (SSO)
While there are a number of approaches for SSO between TopClass and Protec, the out-of-the-box implementation uses SAML:
- Identity provider and service provider
- Protec acts as the Identity Provider (IdP).
- TopClass acts as the Service Provider (SP).
- SAML assertion
- In the out-of-the-box implementation, Protec provides TopClass with a SAML assertion.
- The assertion is configured to include a user identifier.
- TopClass uses this identifier to match and authenticate the user.
Data flow: Protec > TopClass
The TopClass–Protec Bridge enables seamless data transfer between your AMS and LMS:
- User information: User accounts created or updated in Protec sync to TopClass.
- Group information: Groups created or updated in Protec sync to TopClass.
TopClass connects to Protec via the Protec REST API using fetch XML queries. TopClass Support requires a query for each integration point, and Appendix A provides sample field lists.
User Information
User data can be synchronized using two complementary mechanisms:
- Batch synchronization (ETL)
- Synchronizes all groups into TopClass.
- Synchronizes all users and assigns them to their Primary Group.
- Runs on a scheduled interval from the TopClass UI, with a completion report generated each run.
- Extracts only records that have changed since the last ETL run.
- Just-in-Time (JIT) synchronization
- Retrieves and updates user information at the point of authentication.
- Creates new users on-the-fly when they log into TopClass for the first time.
ETL and JIT can be used in parallel—for example, nightly ETL runs for all users, while JIT handles new users created in Protec during the day.
Group Information
Group data is synchronized from Protec to TopClass via the ETL process:
- Groups are created or updated in TopClass based on Protec records.
- Each sync transfers group attributes needed to manage training assignments or organize users.
- The ETL process can be scheduled from the TopClass UI and generates a report after each run.
Data flow: TopClass > Protec
As part of the Protec integration, TopClass can perform a write back of data to Protec (most commonly this would relate to completion/transcript information). The default fields written back as part of an implementation are the following:
- Course Title - The longname/title of the course in TopClass
- Course Code - The shortname/code of the course in TopClass
- Completion Date - Date the activity was completed in TopClass (Activity Date)
- ID - Registration external ID
- CreditStatus - Hardcoded to 4
- Score - 0
Responsibilities: TopClass Support & Customer
TopClass Support and the customer are expected to manage the following responsibilities:
| Area | TopClass Support | Customer |
|---|---|---|
| SSO | - Configure TopClass for SSO | - Set up domain, connected app and permission sets. - Provide TopClass Support with the following information: - Self Signed Certificate - Details for a test Protec (for testing and validation purposes) |
| Users information (Protec > TopClass) | - Discuss user data requirements during the functional requirements workshop to confirm what data and fields are needed - Configure the Protec Bridge to map the fields from Protec to their respective fields in TopClass | - Provide information on fields needed in TopClass - Confirm if JIT or batch should be used (or both) - Provide Fetch XML for use in the REST API Calls |
Appendix A – Sample Data
Each of the examples below include the fields TopClass requires as a minimum in the Fetch XML queries for the REST API.
NoteAny number of additional profile fields can be included in the User Data Sync and can be agreed during the requirements process.
| Area | Data sources |
|---|---|
| User Data Sync | - User First Name - User Last Name - User Email - User ID – Used as an identifier to link the accounts in Protec and TopClass - User Username – TopClass does not support spaces in username fields |
| Online Activity Data Sync | - ID – This is the code/shortname in TopClass and cannot contain spaces - Name – This is the title/longname in TopClass - Description - IsActive |
| ILT Activity Data Sync | - ID – This is the code/shortname in TopClass and cannot contain spaces - Name – This is the title/longname in TopClass - Description - IsActive - MaxCapacity - StartDate - EndDate |

