Once you've gone through the pages below, you can use this page as a quick cheat sheet to make sure you did everything you're supposed to do to get the integration up and running.
- Installing and Configuring Crowd Wisdom in Aptify
- Using Crowd Wisdom LMS with Aptify
- Configuring Crowd Wisdom Integration on classic e-Business
- Configuring Crowd Wisdom Integration on e-Business 6/7
Changes to Make in Aptify
Integration System Entity
-
Open the Integration System entity.
-
Open the Integration Password field.
-
Go to Security tab, click on Encrypt Data and set security key ID 1:
-
Click OK
-
Open the Callback Password field.
-
Go to Security tab, click on Encrypt Data and set security key ID 3 (the hash one):
-
Click OK
-
Save the entity.
Emails setup (optional)
If emails need to be sent when a person registers/unregisters, then we can enable the event handler that gets installed as part of the unpacking process and we can set up the message templates that also get installed.
This is optional since a client might already have templates that get sent when a person subscribes or unsubscribes.
First, look under Messaging Administration > Message Templates to find the IDs of the message templates that were installed. Because each client might have different templates setup, when the CM tool unpacks the LMS templates, the IDs could be different. For example, these are the IDs from my local machine.
We will use these IDs in the integration system attributes.
Now, under Process Pipeline > Event Handlers, find:
And make sure it’s enabled.
Integration System record
Open the CrowdWisdom Integration System record.
-
Fields:
-
Integration Password: given by Crowdwisdom (usually looks like a GUID).
-
Integration Password Security Key: ID of key used to encrypt the integration PWD (usually ID 1)
-
Callback Password: ONLY used when integrating using classic eBiz. This can be anything and is provided by Aptify to CW. CW will use this PWD to authenticate against the classic eBiz endpoints.
-
Callback Password Security Key: ID of key used to encrypt the callback PWD (usually ID 3 - the hash one)
-
Integration System Attributes:
-
URL: provided by CW. I believe it’s usually: https://www.precrowdwisdom.com/diweb/ws/integration/v1
-
username: provided by CW
-
systemId: provided by CW (i’ve noticed that it’s sometimes the same as the username, but not all the time).
-
callBackUsername: ONLY used when integrating using classic eBiz. This is the username that CW will use in conjunction with the callback PWD to authenticate against the classic eBiz endpoints. Defaults to ‘Test’ but can be changed to anything.
-
subscribeMessageTemplateId: ID of the LMS Subscribe Email template.
-
ubsubscribeMessageTemplateId: ID of the LMS Unsubscribe Email template.
-
-
New attributes:
-
Later versions of the Aptify.LMS assembly can use these three optional attributes.
Name |
Value |
Description |
productMappings |
[ |
Allows sending different fields from different product types to the title, description, start and end date field of CW. If not present, Aptify will just send:
|
productCategoryMappings |
Meetings:Event| Conferences:Publication| Educational Seminars:Publication |
Allows more granular mapping of products in Aptify to types in CW. Instead of using the Type, we use the Category. If not present, Aptify will just use the Type mapping. |
sendDescription |
true |
If set to true, will send the description to CW. Mostly usable if the description field has been modified in CW and we don’t want to override it with the description data from Aptify. If not present, Aptify will default to true. |
Things to Provide to CW:
CW will hit Aptify only when a user finishes a course. Depending on the site the client has (classic eBiz vs eBiz6), the endpoints and authentication changes.
Classic Ebiz:
Deployment Cheat Sheet:
-
2 new DLLs into eBiz bin folder
-
Aptify.LMS
-
Aptify.Integrations
-
-
LMSEndpoints.asmx in Web Services folder.
-
LMSEdnpoints.vb in App_Code folder.
-
Web.config, need to add:
<add name="HttpPost" />
So it looks like: -
More information here: Configuring Crowd Wisdom Integration on classic e-Business
-
LMS System ID: ID of the integration system record. Usually, ID 1.
-
Web Service Base URL: this is the base URL of the classic eBiz where the web service lives.
-
Web Service Password: callback PWD
-
Web Service Username: callback username
eBiz 6/7
Deployment Cheat Sheet:
-
2 new DLLs into SOA bin folder
-
Aptify.LMS
-
Aptify.Integrations
-
-
LMSIntegration folder that contains LMSIntegrationEndpoint.json
More info here: Configuring Crowd Wisdom Integration on e-Business 6/7
Need a new web user group called ‘LMS Vendor’. Only web users with this group will be able to access the eBiz6/7 endpoints as there is security defined.
A web user will need to be created just for use with CW. Based on the documentation linked above, this web user will need to be linked to the ‘LMS Vendor’.
-
LMS System ID: ID of the integration system record. Usually, ID 1.
-
Web Service Base URL: this is the base URL of eBiz 6.
-
Web Service Password: web user’s username
-
Web Service Username: web user PWD
Aptify Web
Deployment Cheat Sheet:
-
2 new DLLs into SOA bin folder
-
Aptify.LMS
-
Aptify.Integrations
-
Comments
Please sign in to leave a comment.