Remove companies from Creditsafe monitoring
- Version 1
Business goal​
This action takes the company parties of a dossier out of the Creditsafe Global Monitoring portfolio of the white label, so they are no longer watched and no longer billed.
It is the counterpart of CreditsafeMonitoringRegister and the last step of event-based company monitoring. The complete flow is described on the Creditsafe monitoring rescreening provider page.
:::warning Do not forget this action When only the register action is configured, companies keep accumulating in the portfolio. They keep costing money and keep generating change events that trigger rescreenings on dossiers that are no longer relevant. :::
What the action does​
- It looks up the Creditsafe monitoring provider named by its
MONITORING_PROVIDER_IDENTIFIERsetting, within the organization of the dossier's white label. When no provider with that identifier exists, the action fails. - It collects the company parties of the dossier, limited to the associated party types configured on the monitoring
provider (
associatedPartyTypes). - Each of those companies is only removed when no other active dossier still references it, through the same associated party types registration walked. If one does, the company stays in the portfolio. Only the archived flag counts here: a dossier in a status such as done, closed or rejected still keeps its companies monitored until it is archived.
- The remaining companies are removed from the portfolio. A company that is not (or no longer) in the portfolio is simply reported as removed, so re-archiving a dossier is safe.
- It logs an automation event on the dossier stating how many companies were removed, how many were skipped for having no Connect ID, and how many were kept because another active dossier still references them. A dossier whose companies all stayed monitored is therefore visible in the activity tab as such, instead of looking like a successful removal.
:::note Countries are not filtered here
Unlike the register action, this action ignores SUPPORTED_COUNTRIES. That way a company can always be removed, even
when the country list was narrowed after it had been registered.
:::
Configuration​
- Add the action
CreditsafeMonitoringDeregister. - Link it to the event that marks the end of the dossier's life, typically
DOSSIER_ARCHIVED. - Configure it asynchronously — the action talks to an external service.
{
"className": "eu.myharmoney.app.bll.executors.events.creditsafe.CreditsafeMonitoringDeregister",
"type": "EVENT",
"value": "DOSSIER_ARCHIVED",
"synchronous": false,
"enabled": true,
"settings": {
"MONITORING_PROVIDER_IDENTIFIER": "Creditsafe monitoring"
}
}
Settings​
MONITORING_PROVIDER_IDENTIFIER(required): the identifier of the Creditsafe monitoring provider whose portfolio this action removes companies from. When the configuration is saved, Harmoney checks that a provider with this identifier exists in the organization.
:::danger All three configurations must name the same identifier The register action, the de-register action and the rescreening provider must all point at the same monitoring provider. If the actions write to one portfolio while the rescreening provider reads events from another, both sides succeed and the result is indistinguishable from a window in which nothing changed. Nothing validates this — only the existence of the named provider is checked at save time. :::
The scope of what is monitored (associated party types, countries, the portfolio ID and the metadata key holding the Connect ID) is still configured on the monitoring provider itself, not here.
The general action settings remain available, e.g. dossierFilter, failOnError,
reportFailure and retryFailure.