Using the TopClass - NetForum Bridge

The TopClass–NetForum Bridge provides a seamless two-way integration between your AMS and LMS:

• Real-time profile sync: User and group accounts created or updated in NetForum automatically sync to TopClass.
• Single Sign-On (SSO): Members log in once on your website via NetForum and are automatically logged into TopClass.
• Product and enrollment management: Training product orders in NetForum automatically create enrollments in TopClass.
• Completion writeback: TopClass can write completions and credits back to NetForum, with flexible options available during implementation.

This integration ensures accurate data flow, reduced manual effort, and seamless access to learning activities for members.

Prerequisites

Before implementation, confirm you have the following:

• A NetForum test server with URL and test account credentials.
• NetForum Toolkit access.
• Confirmation of the NetForum version.
• NetForum xWeb credentials for API authentication.
• Customer IT team available to configure services and update queries.

Single Sign On (SSO)

TopClass’ NetForum integration includes a single sign-on mechanism via the eWeb API:

1. User authentication

   • A user logs into NetForum first.
   • Since TopClass’ NetForum integration includes SSO, the user will be seamlessly logged into TopClass if already authenticated via NetForum.
   • NetForum provides SSO through their ewe API (see: NetForum SSO Options).

2. Redirect to NetForum login page

   • NetForum has a built-in .aspx page that can be used for login redirection.
   • When a user attempts to access TopClass, they are redirected to this page.
   • As part of the URL to this page, provide the redirect URL that should be used after a successful login.

   Example URL structure:

   http://ams.company.org/nfcompanyuat/eweb/DynamicPage.aspx?Site=company&WebCode=LoginRequired&URL_success=http://topclassurl/companyname/NetForumSSO.do?userToken={token}

   📘

   Note

   The URL_success section at the end of the URL comes from TopClass Support. The {token} argument is populated by NetForum.

3. Token validation

   • TopClass receives the token from NetForum.
   • TopClass then calls the WEBWebUserValidateToken method in NetForum.
   • If the token is valid, NetForum returns a unique userID.

4. Redirect to TopClass with user ID

   • TopClass uses the returned userID and constructs an endpoint URL to log the user in.
   • The URL includes the uid argument and specifies vendor=NetForum.

   Example endpoint URL:

   http://topclasslms/companyname/login.do?uid=userIdEntity&vendor=NetForum

5. User login to TopClass

   • With the userID, TopClass initiates the userJIT integration.
   • The user is logged into TopClass automatically.

Netforum authentication tokens

NetForum requires a token to be in the header of any API request that is made from clients. To get this token, the integration bridge makes a call to be authenticated using the NetForum xWEB credentials. If our credentials are valid, we will be given a token to make NetForum service calls. See Authenticate for details.

Data flow: NetForum > TopClass

TopClass’ NetForum Bridge allows the transfer of the following information from NetForum to TopClass.

Data synchronization

For each integration scenario (users, groups, activities, enrollments):

• Provide the name of the web method created in NetForum as the query.
• Queries can contain variables. Any placeholders used in the SQL node of the method must be provided for in the TopClass Bridge.
• To execute the scenario, the Bridge requires the following to build a SOAP request:
  • Service name
  • methodName
  • Optional parameters

NetForum provides an API method called ExecuteMethod for complex queries that return data as XML. This is only used for reading data, not writing. Queries must return XML. Use this SQL at the end of queries:

FOR XML PATH ('Individual'), ROOT('Individuals'), ELEMENTS XSINIL

User and group information

TopClass can retrieve user and group information from NetForum using two different mechanisms. These can be used independently or together depending on the requirements:

• ETL batch job: The ETL batch will retrieve all user and group information from NetForum that is required in TopClass. This is split into two distinct steps:

  • Synchronize all groups into TopClass
  • Synchronize all users into TopClass and add the user to their Primary Group

  The ETL process can be scheduled to run via the TopClass user interface on a repeating interval and each

  time it runs it will send a report once the integration has completed. When data is synchronized via the ETL, only data relating to users or groups who have changed since the last

• Just-in-Time (JIT): The Just in Time (JIT) mechanism retrieves and updates user information at the point of authentication. This can be used to allow the creation of users on the fly when they access TopClass for the first time.

📘

Note

JIT does not support groups. It is assumed the group will already exist when synchronizing a user.

📘

Note

It is possible to use both the ETL and JIT processes in parallel, i.e., allow the User ETL integration to run each night to synchronise all users, but also have the JIT process run to pick up users who are created in NetForum during the working day.

Activity information

TopClass can retrieve activity information from NetForum and create and update the associated activities in TopClass, thus reducing the need to re-key in any data. This integration is carried out via a batch process (ETL). The ETL process can be scheduled to run via the TopClass user interface on a repeating interval and each time it runs it will send a report once the integration has completed.

Enrollment/Order information

TopClass can retrieve enrollment/order information from NetForum. This allows a user to purchase an item in the

shopping cart in NetForum and then access TopClass and have the item available to take. This process is a ‘Just in

Time’ process updating the users enrolment information when they login to TopClass.

Data flow: TopClass > NetForum

TopClass’ NetForum Bridge allows the transfer of the following information from TopClass to NetForum.

Completion Writeback

As part of the NetForum integration TopClass can perform a write back of completions and credits to NetForum:

• TopClass can insert or update records in NetForum using:
  • InsertFacadeObject (InsertFacadeObject)
  • UpdateFacadeObject (UpdateFacadeObject)
• A SOAP request provides the following:
  • The object name
  • Attributes of the data
  • The key (for updates)

📘

Note

NetForum provides a wide list of methods and when modifying data in NetForum, it is recommended that you check to see if a method is specifically provided to achieve the task and use that instead of the InsertFacadeObject/UpdateFacadeObject, where feasible. This is due to the fact you may need to do more than just change a single row in a table, and there may be a workflow that needs to be triggered in NetForum.

Responsibilities: TopClass Support & Customer

TopClass Support and the customer are expected to manage the following responsibilities.