Data Push to PARS

Description

Via a Survey Magnet task, users can click a button to send their MOC points from Survey Magnet to PARS.

Supported MOC boards:

  • ABIM MOC
  • ABP MOC

The following fields are pushed to PARS:

  • MagnetUserFirstName
  • MagnetUserLastName
  • MagnetUserDateofBirth
  • UserClaimNumber (MOC ID)
  • TotalCredits (MOC Points)
  • CompletedDate

The following values are provided by the client:

  • reportingOrganization
  • providerOrganization
  • providerDomainAddress
  • activityID
  • activityName
  • creditType

Setup

The following sections are set up by the client.

  • Settings >>> Certificates >>> Credit Type Labels
    • The credit field number used does not matter. The system will identify which field to pull from based on the credit type label.
    • The credit type label MUST be exactly the same as the MOC board name (ABIM MOC or ABP MOC). For example, if the field label is just 'ABIM', the integration will not work. This field is case sensitive. Also, make sure there are no leading or trailing spaces.
  • Task >>> Profile
    • Suggested Task Name: Provide MOC Information
    • In the profile task, the client will collect the MOC number (aka MOC ID) from the end-user. This ID is pushed along with the credits to PARS. This ID is required to link the credits to the user in the PARS system so make sure to set 'Require MOC Number?' to 'Yes'.

The following task is set up by the integration services team.

  • Task >>> Download (old)
    • Suggested Task Name: Submit [ABIM/ABP] MOC Points
  • This task will initially be added and configured by the Cadmium integrations team. The client can change the task name.

Below is an example of how the task will display to the end-user (Fig. 1).

Survey Magnet Task Sample

FIG. 1 - Display of an end user task. 

PARS Requirements

Please provide the following to your integration project manager.

New Integration

The client will provide the following information to the integrations team for the first integration:

  • reportingOrganization
  • providerOrganization
  • providerDomainAddress
  • ParsSandboxUser
  • ParsSandboxPassword
  • ParsProductionUser
  • ParsProductionPassword
  • activityID
  • activityName
  • creditType (ABIM MOC or ABP MOC)
  • Test account that exists in Magnet and in PARS
  • Credit type settings complete
  • Profile task setup complete

Repeat Integration

The client will provide the following information to the integrations team per event:

  • activityID
  • activityName
  • creditType (ABIM MOC or ABP MOC)
  • Test account that exists in Magnet and in PARS
  • Credit type settings complete
  • Profile task setup complete

Client Acceptance Testing

  • Complete the 'Provide MOC Information' task
  • Complete an assessment for ABIM MOC or ABP MOC credit
  • Check the 'PARS Testing' worksheet to ensure all fields values are filled in and that you have the appropriate credits assigned in the corresponding 'MagnetUserCredits' field
  • Go to the task 'Submit [ABIM/ABP] MOC Points'
    1. Make sure you have the same number of credits in the field 'Total credits left to submit'
    2. Click the 'Submit [ABIM/ABP] MOC' button
    3. Make sure you have 0 credits in the field 'Total credits left to submit'
    4. Make sure you have the original number of credits in the field 'Total credits submitted'
    5. Check in PARS to ensure the credits transferred as expected

DISCLAIMER 

 For this integration, Cadmium does the development to connect to the third-party system. It is the Customer's responsibility to verify development needs and associated costs with the third-party to allow Cadmium to connect to their system. The required credentials Cadmium needs from the third-party to develop the integration are noted below. 


Was this article helpful?

That’s Great!

Thank you for your feedback

Sorry! We couldn't be helpful

Thank you for your feedback

Let us know how can we improve this article!

Select at least one of the reasons
CAPTCHA verification is required.

Feedback sent

We appreciate your effort and will try to fix the article