Using Crowd Wisdom LMS with Aptify

This page details down how to use the Crowd Wisdom integration with Aptify.

We need to publish the product on crowd wisdom first and then purchase that product count of registration gets reflected on Crowd Wisdom.

 

This topic covers below sub-topics:

• Creating the Product in Smart Client
• Publishing the Product on Crowd Wisdom Website
• Using Classic e-Business for creating orders
• Using Smart Client or Web for creating orders

• Using Crowd Wisdom with e-Business 6.x/7.x

• Updating the Product

• Registering the Product
• Unregistering the Product
• Attendance

 

Creating the Product in Smart Client

1. Open Smart Client.
2. Check for Integration services added to the applications list.
3. Open an existing or create a new Meeting-class product which you want to integrate with Crowd Wisdom LMS (refer Creating a Meeting Type Class for creating the same).
4. Open the corresponding product record and confirm that the available date from and to dates is set to active dates.
5. Go to Web tab and check on web-enable option.
6. Go to Meeting Logistics tab > Education Unit sub-tab and create Education Units. Refer Configuring a Meeting Product to Track Education Units.
7. Go to Product Details > Integration Mapping > Create a new record.
8. Enter Integration System ID which refers to Crowd Wisdom Integration or click on the search icon, it should display the Crowd Wisdom option.
9. Click Save. If everything is setup correctly, the Integration Record ID populates. It is the same ID as the product ID.
10. Refresh the record.
11. Observe Integration Record ID is auto-populated along with date updated and date created field in Integration Mapping tab.                                                                                                             
12. Under the Integration Logs tab, a new Integration Log record is created with Log type ‘ProductCreate’ , and with more information on the call. If the call fails, error is logged.   
13. Close the record (Record ID is the same given in Crowd Wisdom web course ID).
14. Save the product record.

Publishing the Product on Crowd Wisdom Website

1. Login into Crowd Wisdom website.
2. Search for the product.
3. Publish the product from CrowdWisdom site.
   
   
4. Fill up the address and country, publish the product.
5. Click on Add New Variant, fill up the subscription length. 
6. Click Create.
   Success message gets displayed.
7. Go to Catalog.
8. Verify the product is displayed.
9. Go to Smart Client.
10. Make one Order related to that product (eg: 562) and ship the Order.
11. Go to Crowd Wisdom > Catalog.
12. Check the Order record is created from Smart Client and is displayed in the catalog.

Using Classic e-Business for creating orders

1. Log in to classic e-Business Web application.
2. Go to Education > select Class Schedule option.
   
3. Open the Course record created in the previous step.
4. Select 'Class Schedule' option and register for the same.
5. Further complete the checkout process.
6. The Student status will now be updated to "Currently Registered".
7. Login into Crowd Wisdom Website using valid credentials.
   The login details and URL will be provided by Crowd Wisdom Account Manager.
8. Go to Courses and note that the product which we have integrated in previous step gets displayed in the courses section.
   
9. Click Edit.
10. Check the External Link is same as the product ID in Aptify system.
    
11. Go to Orders, click on the Orders, and search for the orders generated for Crowd Wisdom with product name.
12. Please confirm that the order should have status as “Order Revoked by API” 
13. Click View. In View orders, check Customer Name for whom the order was placed, Order Status as Complete, Order Notes, Education Units & Product Name in Course/Chapter.
14. Once the enrolled users attend the courses, the status of the course attended would be marked as Passed or Failed.
    
15. Go to View Customer option and check the order placed.
16. Click "Assume User" option.
    
17. Avail the course by clicking ''Submit Credit". Click Continue option during re-confirmation.
    Provide ratings as your feedback and click Process Credit option.
    
18. Click Generate Certificate from Crowd Wisdom Site to generate the certificate and view your certificate.
    
    
19. Log out from the Crowd Wisdom application.
20. Login to Aptify Smart Client or Aptify Web application.
21. Select Education management application→ Education Unit Service.
22. Confirm that the Education Units are created for the Aptify product used above.

Enrolled user will receive a subscription email with Crowd Wisdom link.

 Using Smart Client or Web for creating orders

1. Login to Smart Client or Web application.
2. Create an Order related to the product noted in step 3 and ship the Order.
3. Check that the associated order ship to a person receives an email on their primary email ID confirming the "LMS Subscribe“ option.
4. The email would contain the LMS URL using which the person can browse the Crowd Wisdom URL for subscribing the course.
   
5. Please note that similar way, user will receive a Unsubscribe email when the respective order is cancelled and shipped.

Classes/Courses Product Scenario:

• Above steps repeated by creating a new Class with Courses and Product type as class or meeting.

Note: Same above steps to be followed for CMS and Non-CMS and product should be purchased and shipped and that order will get displayed on Crowd Wisdom site.

Using Crowd Wisdom with e-Business 6.x/7.x

In order to connect to the e-Business 6 APIs and obtain a token you will need below prerequisites:

• A set of username and password provided by clients to access the endpoints.
• The user must have the web user group ‘LMS Vendor’ added.
• Tool for calling APIs. You can call the APIs from the Postman or from any other tool.

Follow the steps below to retrieve the token.

Note: The Base URL for e-Business endpoints varies from client to client. Below examples show the usual pattern:

1. [GET] Authenticate: Get a token to be used in subsequent API calls.
   URL:
   [Base URL]/soa/services/Authentication/Login/ebusinesswebuser?Username={username}&Password={password}
   [Base URL]/soa/v1/GetProfile/{PersonID}
   [Base URL]/soa/v1/PostCredit
   [Base URL]/services/Authentication/Login/ebusinesswebuser?Username={ svcCrowdWisdom }&Password={*********}
   Sample Response:
   From this response, we need to use the TokenId property to make further calls to the eBiz6 API.
   {
   "UserId": long,
   "UserName": "string",
   "Email: "string",
   "FirstName": "string",
   "LastName": "string",
   "Title": "string",
   "LinkId": "string",
   "CompanyId": "",
   "TokenId": "4cc7b497-ac18-4924-9872-30e294f81cea",
   "Server": "string",
   "Database": "string",
   "AptifyUserID": long,
   "AptifyUser": "string",
   "AuthenticationTime": "date string",
   "AuthenticatedPersonId": long
   }
   The TokenId needs to be passed for the other endpoints as a header:

   Header Name	Header Value
   AptifyAuthorization	ebusinesswebuser {TokenId}

    
2. [GET] Get Profile Details: To get information about a specific person in Aptify.  The PersonID parameter is the ID of the person that we need info for.
   URL:
   [Base URL]/v1/GetProfile/{PersonID}
   Sample Response:
   {
   "FirstName": "string",
   "LastName": "string",
   "Email": "string",
   "MemberType": "string"
   }
3. [POST] Post Credit: When a user finishes a class in Crowdwisdom, make a call to
   [Base URL]/v1/PostCredit
   Sample Response: No Response
   Sample Request Body:
   The parameters passed in are the same that are passed to the Classic eBiz integration, but now in JSON version.
   {
   "Payload": "{'Score':20,'PersonID':10,'CreditValue':0,'CompletionStatus':'Passed','ProductID':11085,'CreditType':'','CompletionDate':'03/24/2022','TransactionID':'28421'}",
   "LMSSystemID": 1
   }

Postman Calls Information for Reference

[Base URL]/SOA/services/Authentication/Login/ebusinesswebuser?Username=svcCrowdWisdom-NP&Password=^6wutRs2x%22UFn(Fs

{"UserId":393268,"UserName":"svcCrowdWisdom-NP","Email":"","FirstName":"svcCrowdWisdom","LastName":"Service","Title":"","LinkId":"800005","CompanyId":"","TokenId":"04dccbe8-82fe-4b1e-9393-b291bafa6c20","Server":"VzZzOk5GJ2wlyagS8ptKjIzM55mlwlI+08aSO1m9nrI=","Database":"NbsqXB/G6NaSqiIqolUYTw==","AptifyUserID":1371,"AptifyUser":"APEGGA\\svcAptifySOASys-NP","AuthenticationTime":"2023-01-24T12:29:22.8242071-07:00","AuthenticatedPersonId":800005}

Post Credit Information for Reference
[Base URL]/SOA/v1/PostCredit

Updating the Product

When updating some fields of the product record, the integration will create a new Integration Log record with a type ‘ProductUpdate’ with more information on the call. If the call fails, an error will be logged.

Registering the Product

Once the product is created in Aptify and synchronized to Crowd Wisdom, and the Crowd Wisdom product setup is complete and published, the product can start getting purchase from Aptify. When an order holding a Crowd Wisdom product is SHIPPED, a new Integration Log record is created with a type of ‘Subscribe’. This registers the person to the Crowd Wisdom product.

Unregistering the Product

When an order holding a Crowd Wisdom product is CANCELLED and the cancellation order is SHIPPED, a new Integration Log record is created with a type ‘Unsubscribe’. This unregisters the user from the Crowd Wisdom product.

Attendance

When a user completes the Crowd Wisdom product, Crowd Wisdom makes a web service call to Aptify using the callbackUsername and callbackPassword. A new Integration Log record is created with type ‘Credit’. This has more information on completion status of the registration.
When this is processed by the integration, depending on whether the product is of type Meeting or Class, the meeting or class registration is updated, respectively. If the product is of another type (namely General), then only if the ‘createEducationUnit’ attribute is set to true, any action is taken.