About updating your integration
Before going ahead with an update, determine if an integration update is required or if this should in fact be a new integration. If your integration is different enough to be considered a new product, or works in a way that can't be used in the same way as your previous integration, you should create a new integration and not perform an update. Updating an integration that should be a new integration would mean replacing the previous integration, which is considered a different product.
A new integration is defined here as a new data provider option being available for users in Maxsight. Users only use this new integration if they add it as a new data provider and configure checks accordingly.
If your integration is significantly different enough to be considered a new product, you should be adding it as a new integration.
In the example below, although all are from GBG ID3global, these are three separate integrations:
An updated integration replaces the old integration. A new data provider option isn't added, and all users using the previous version of your integration, automatically start using the updated integration once the update has been applied. Checks using this integration don't need to be changed.
Any configuration changes are visible to users who then use your updated integration, such as if you changed the integration name, configuration, or credentials options.
Providing no major changes have been deployed, the integration should continue to work as before.
Note
It is worth remembering that integration updates do not affect previous check results. If you want a profile to reflect changes as per an updated integration, you will need to re-run the check so the updated integration is used instead.
Updates that don't require Maxsight intervention
Providing the update is fully tested, updates can be made to your integration and deployed without any intervention from us if the following points are satisfied:
No configuration or credentials are changed as per your integration Configuration endpoint.
Your update includes any of the following:
Adding additional data to optional response fields.
For example, adding dates or addresses that were previously not included in the output.
Changing your integration name.
Adding new configuration options or credentials.
Existing configuration options and credentials can't be changed
Improving data processing time.
Improving data accuracy.
For example, being able to achieve more certain outcomes whereas previously the result was unknown. However, if this materially impacts how a customer would use the integration, this must not be deployed without intervention. Even if this does not materially impact the integration usage, this should still be communicated with implementation engineers and customer success managers.
The output data schema remains the same.
By this we mean the fields and data types of your responses as well as the inclusion of any embedded links or iframes.
The integration update is deployed to the existing integration URL using the existing secret key.
Business logic that impacts the output remains the same.
If this changes, this must be communicated with customer success managers before being deployed, as they will need to assess the impact and inform customers using your integration.
Documentation is updated to reflect any changes.
Even if your integration update is minor, you must always ensure any documentation is up to date. Implementation engineers rely on this documentation to get the most from your integration for customers and so must be fully aware of how it works, and any business logic that impacts the outcome.
It is always advised to inform us that you're making updates no matter how small, even if no intervention is required, to ensure support can be sufficiently prepared and the integration team are aware of the changes. You can let them know by emailing passfort_partners@moodys.com.
When updating your integration is not feasible
If the issues outlined in this topic mean that an update is not feasible, for example if you have a large number of users and the updated configuration isn't compatible with existing configuration settings, you can consider a new integration, followed by a user migration.
This, however, requires significant intervention from Maxsight engineers and would have to be discussed from the outset of any integration development.