...
Please see attachedCRSM Integration Docfor details. As always, please feel free to contact with MOLE team for further help needed.
You are Done!
Enhancements/Updates: During the CRSM integration with Vessel Registry(LOB 001). We found some interesting stuff that would be helpful and avoid the hiccups for other lines of business to consider or implement. The following are the important to consider:
Payment event and expected values from LOB:
When you update or save payment details from your application before or after a service request is completed to generate remissions or invoicing on the CRSM side, WLM expects the following values to be provided to update the payment table in WLM. Once we receive the payment details, then the WLM forward the same to the CRSM side via service bus to generate invoicing.
...
If you are using WLM v2 endpoints, you might need to pass additional information like invoice number and transaction ID
How to add or edit new statuses:
First, find out the list of value types available in LOV by calling the endpoint:
...
| Code Block |
|---|
https://ncdlistofvalueapp01.azurewebsites.net/api/v2/ListOfValues?ListOfValueType=MTOAStatus |
A common list of statuses that MTAPI maintains for MTOAStatus are listed in this excel sheet attached here:
| View file | ||
|---|---|---|
|
In order to find out the MTAPI supported status for MTOAStatus by calling the below endpoint:
https://wwwappstestext.tc.gc.ca/Saf-Sec-Sur/13/MTAPI-INT/api/v1/servicerequests/statuses?serviceId=500
How to evaluate service performance:
Service performance will be automatically calculated when a WorkItem is completed from the application side. To verify whether the service performance has been created from the CRSM side by calling the below SPAPI endpoint, and needs to pass the external request ID as like below:
Important Note: Make sure, the MTAPI status is changed to “Completed“ and “ServiceCategoryCode“ should be marked as “END“ as like in below screenshot:
How to evaluate remissions:
How to evaluate invoicing:
Introduction of MTOAStatus mapping:
Remissions can be evaluated either when a Work Item is completed or they can be completed at a later date provided by payment amount and receipt number from the application. The main important to keep in mind is to verify whether the invoice has been generated for the Work Item. You can verify the status of invoicing from MTAPI by using the below API call in MTAPI:
Implementation of using generic system id:
To get a generic system ID, you need to contact MTAPI by providing the generic user email ID to register with MTAPI, MTAPI will provide you the generic system user ID for the corresponding generic user email.
For example:
The generic system user email id for LOB 001 is: vessel_reg.user@tc.gc.ca
The user ID will be: 22021, keep in mind, that each environment will have a different user ID generated, you need to contact MTAPI to provide different ids for other environments.
To get/update these values, you need to use LOVService swagger by passing the “LineOfBusiness” in one of the GET calls:
Note: If your line of business is integrated with CRSM, the “isEnabled” flag should be turned ON, and if your LOB wants to use a generic system ID, you need to update the values as like shown in the “CustomProperties” below:
How to reach MTAPI platform in case of any issues/failures:Need to update LOV values in ListOfValueService.
MTAPI team is a key resource for us for any permission-related or any secrets to share or add/generate user IDs.
The best way to contact the team is to raise an INTAKE form to someone to handle the ticket and get back to us in a timely manner:
Here is the link to contact and create a MyTCAccount ticket URL.
MOLE Support:
Again, we are here to help out and advise for CRSM integration for new lines of businesses, and at any point, you feel need our assistance, please do not hesitate to reach out to us.