Scorecard - Activity Write-back to iMIS

Overview

For a specific eventID, an activity record is sent to iMIS based on a trigger.

Trigger Options

End-user completes a submission OR
End-user completes a task

Field Mapping

Client to provide spreadsheet with the following columns:

Cadmium Field: Select from the list of available fields below
Third-Party Field: Corresponding field name to map to (examples in the chart below are from an integration we do with a specific iMIS reseller)
Required (Yes/No): Indicate all fields that are required by the third-party

Cadmium Field	Third-Party Field Name (Values below are examples)	Required by Third-Party (Yes/No) (Values below are examples)
Field value provided by client	ActivityType	Yes
Field value provided by client	ActivityProductCode	Yes
SubmitterFirstName & SubmitterLastName	ActivityOption1	Yes
SubmitterMemberIDUnique	iMISID	Yes
SubmissionTitle	ActivityDescription	No
SubmissionDateCompleted	ActivityDate	No
SubmissionPresentationNumber	ActivityOtherCode	No
SubmissionType	ActivityCategory	No
SubmissionStatus	ActivityOption2	No
AbstractTopic	ActivityOption3	No
SubmissionID	ActivityOption4	No
PaymentOptionsAmountCharged	ActivityPaymentAmount	No
PaymentOptionsPaidStatus	ActivityPaymentStatus	No
PaymentOptionsDateCharged	ActivityPaymentDate	No
Custom JSON blob (written by Cadmium developers)	ActivitySourceCode	No

Requirements

Technical documentation from third-party vendor
Endpoint
Field mapping spreadsheet noted above
Values for any hardcoded fields
If using a task trigger, TaskID

Acceptance Testing

Note, Cadmium cannot test this type of integration. Testing is the sole responsibility of the client.

Log in as a submitter
Complete a submission/applicable task (depending on trigger) to trigger the activity to be sent
Confirm the activity is created in iMIS and includes all the information you expect to see
If you find any issues, please let your integration project manager know

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 above.

Last modified Jun 18, 2024