iMIS integration: Queries

Queries control the integration sync between iMIS and TopClass.

🚧
Warning
Each query should be reviewed and updated to suit your business requirements. Only review and update the properties that are specifically marked. Do not remove or modify any other properties. If you are unsure about making any changes to these IQAs please speak to your TopClass implementation project manager.

🚧
Warning
Do not change the alias names or the order of the display properties.

To get started, do the following:

Go to RiSE > Intelligent Query Architect.
Open the TopClass folder.
The following queries are defined:

TopClass_Certification_Enrolment_Sync

Syncs purchase details for an online order that relates to a certification. The product must be part of the TopClass Certification category.

📘
Note
You must be licensed in TopClass for Certification for this to work.

TopClass_Certification_Enrolment_Sync
Filters tab properties	Description	Requires updating?
[User] User ID	Ensures the purchaser has a username.
[NetContactData] ID	Fetches the purchaser's ID.
[TopClass_Orders] Entered Date Time	Enter date/time.
[TopClass_Product] Category	Product category is TopClass Certification ("TCCERT") by default.	Yes - Add additional product categories as required.
[TopClass_Product] Status	Ensures the product does not have a status of Out of Production or Marked for Deletion.
Display tab properties	Alias
[NetContactData] Id	WExternalID
[TopClass_Product] ProductCode	WCertProgramExternalID

TopClass_Group_Sync

Syncs details of organizations (ID and name). This creates a group in TopClass, and individuals are then linked to that group.

TopClass_Group_Sync
Filter tab properties	Description	Requires updating?
Is Company	Ensures the record is a company not an individual.
Last Updated	Ensures the contact was last updated date is greater than or equal to the query run date.
Member Type	Ensures only the selected member types are retrieved.	Yes - Add additional member types as required.
Status	Ensures only the selected contact statuses are retrieved.	Yes - Add additional member statuses as required.
Display tab properties	Alias
Id	wExternalId
[vBoNetContactData].[ID]	wShortName
Company	wTitle

TopClass_ILT_Cancelled_Enrolments_Sync

Syncs event registrations that have been cancelled in iMIS to TopClass.

TopClass_ILT_Cancelled_Enrolments_Sync
Filters tab properties	Description	Requires updating?
[TopClass_Orders] St Id	Fetches the registrant's ID.
[TopClass_Orders] Updated Date Time	Enter date/time.
[TopClass_Event] Event Category	Event category (default selections): Online (W), Seminar (SE), Virtual meeting (VIRM), Virtual webinar (VIR), and MS Teams Online Meeting (VIRT).	Yes - Add additional event categories as required.
[TopClass_Event] Event Status	Ensures the event does not have a status of cancelled or closed.
[TopClass_Orders] Status	Ensures the registration status is not cancelled.
Display tab properties	Alias
[TopClass_Orders] St Id	WExternalID
Event product key	WKlassExternalID
Order number	WOrderNo
Line number in order	WOrderLineNo

TopClass_ILT_Sync

Syncs event details from iMIS to TopClass.

TopClass_ILT_Sync
Filters tab properties	Description	Requires updating?
[TopClass_Event] Event Category	Event category (default selections): Online (W), Seminar (SE), Virtual meeting (VIRM), Virtual webinar (VIR), and MS Teams Online Meeting (VIRT).	Yes - Add additional event categories as required.
[TopClass_Event] Event Status	Ensures the event does not have a status of cancelled or closed.
Display tab properties	Alias
Function description	WDescription
Function end date/time	WEndDateTime
Event code	WEventCode
Event description	WEventDescription
Event title	WEventTitle
Product key	WExternalID
Event status	WHidden
Function title	WLongName
Event capacity	WMaxCapacity
Function code	WShortName
Function begin date/time	WStartDateTime
Event category	WSubType
Event time zone	WTimeZone
Staff facilitator	wHost

TopClass_ILT_Enrolments_Sync

Syncs registrant details for events (Instructor-Led Enrolments).

TopClass_ILT_Enrolments_Sync query
Filters tab properties	Description	Requires updating?
[User] User ID	Ensures the purchaser has a username.
[TopClass_Orders] St Id	Fetches the registrant's ID.
[TopClass_Orders] Entered Date Time	Ensures the event begin date is greater than the run date or within the previous 7 days.
[TopClass_Event] Event Category	Event category (default selections): Online (W), Seminar (SE), Virtual meeting (VIRM), Virtual webinar (VIR), and MS Teams Online Meeting (VIRT).	Yes - Add additional event categories as required.
[TopClass_Event] Event Status	Ensures the event does not have a status of cancelled or closed.
[TopClass_Orders] Status	Ensures the registration status is not cancelled.
Display tab properties	Alias
[TopClass_Orders] St Id	Aliased as wIdNum.
Entered datetime of order	Aliased as wEnrollDateTime.
Order line number	Aliased as wOrderLineNo.
Order number	Aliased as WOrderNo.
Product key	Aliased as WExternalClassID.

TopClass_Online_Enrolments_Sync

Syncs purchase details for an online order.

TopClass_Online_Enrolments_Sync query
Filters tab properties	Description	Requires updating?
[User] User ID	Ensures the contact has a username.
[TopClass_Orders] St Id	- Fetches the purchaser's ID.
[TopClass_Orders] Entered Date Time	Enter date/time.
[TopClass_Product] Category	Product category is TopClass by default.	Yes - Add additional product categories as required.
[TopClass_Product] Status	Product does not have a status of Out of Production or Marked for Deletion
Display tab properties	Alias
Ship to ID	wIdNum
Entered datetime of order	WEnrolldatetime
Order line number	wOrderLineNo
Order number	WOrderNo
Product key	WExternalID

TopClass_Online_Sync

Syncs the products for online learning from iMIS to TopClass.

TopClass_Online_Sync query
Filters tab properties	Description	Requires updating?
Category	Product category is TopClass by default.	Yes - Add additional product categories as required.
Status	Ensures the product does not have a status of Out of Production or Marked for Deletion.
Display tab properties	Alias
Product key	WExternalID
Item code (Product code)	WShortname
Name	WLongname
Description	WInfo
Status	WHidden
Product category	WSubtype

TopClass_Users_Sync

Syncs users from iMIS to TopClass.

TopClass_Users_Sync query
Filters tab properties	Description	Requires updating?
[NetContactData] Is Company	Ensures the contact is not a company.
[User] User ID	Ensures the contact has a username.
[NetContactData] Id	Fetches the contact's ID.
[NetContactData] Last Updated	Ensures the contact was last updated date is greater than or equal to the query run date.
[NetContactData] Member Type	Ensures only the selected member types are retrieved.	Yes - Add additional member types as required.
[NetContactData] Status	Ensures only the selected contact statuses are retrieved.	Yes - Add additional member statuses as required.
Display tab properties	Alias
iMIS ID	wIdNum
Username	wUserName
First name	wFirstName
Middle name	wMiddleName
Last name	wLastName
Email	wEmail
Prefix	wPrefix
Suffix	wSuffix
Title	wJobTitle
Work phone	wPhone1
Home phone	wPhone2
Fax	wFaxNumber
Address 1	wAddress1
City	wCity
Zip	wZip
State/Province	wState
Address 2	wAddress2
Contact status code	WStatusCode
User account disabled	wAccountDisabled
User effective date	wValidPeriod_Start
User expiration date	wValidPeriod_End
Country	wCountry
Company ID	WPrimaryGroupID

TopClass_VC_Cancelled_Registrations

Syncs cancelled registrations for virtual conferences. You must be licensed in TopClass for this module.

TopClass_VC_Cancelled_Registrations query
Filters tab properties	Description	Requires updating?
[CsRegistration] Ship To Id	Fetches the registrant's ID.
[CsEvent] Event Code	Fetches the event code.
[CsRegistration] Status	Ensures the registration status is cancelled.
[CsEvent] Event Category	Event category is virtual conference by default.	Yes - Add additional event categories as required.
[User] User ID	Ensures the registrant has a username.
[CsEvent] Begin Date	Ensures the event begin date is beyond the query run date.
Display tab properties	Alias
[CsRegistration] Ship To Id	wIdNum
[CsEvent] Event Code	wEventCode

TopClass_VC_Registrations

Syncs registrations for virtual conferences. You must be licensed in TopClass for this module.

TopClass_VC_Registrations query
Filters tab properties	Description	Requires updating?
[CsRegistration] Ship To Id	Fetches the registrant's ID.
[CsRegistration] Order Date	Fetches registration order date.
[CsEvent] Event Code	Fetches the event code.
[CsRegistration] Status	Ensures the registration status is not cancelled.
[CsEvent] Event Category	Event category is virtual conference by default.	Yes - Add additional event categories as required.
[User] User ID	Ensures the registrant has a username.
Display tab properties	Alias
[CsRegistration] Ship To Id	wIdNum
[CsEvent] Event Code	wEnrollDateTime
Entered datetime of order	wEventCode