Migration Script

Jump to Section

You can use the migration scripts provided to upgrade your connector from older versions. Migration scripts are manually activated processes, which are run once, to upgrade from an older connector version to the newer version. In this way you avoid having to perform a new setup.

Please be Aware:
To avoid any potential loss of data, perform the migration outside of working hours when there are no actions being run in Mambu - such as client or loan account creation.

Prerequisites

To successfully run the migration script, both the initial and the current version of the connector need to use the same API Key. You will need to create a temporary API key and use this with both the previous and the new connector folders.

Mandatory post run steps

After running the migration script you need to run the Health Check process to verify that the data was copied and update webhook URLs in Mambu. You can read more about this process in the next article, Health Check.

Migration script from v2.0.0 to v2.3.0

To run the migration process successfully, it is necessary to have both versions - v2.0.0 and v2.3.0 of the connector uploaded to the same Mambu Process Orchestrator (MPO) tenant.

MPO setup

In the MPO environment: go to the Migration process folder within the v2.3.0 connector folder, open Start migration [main process], switch to View mode, and click New task. Fill in all the required parameters and click Add task. Wait until the task is processed.

Alternatively, you can use the following JSON. Modify it and paste into the Code editor tab.

{
    "apiKey": "146",
    "initial_folder_id": "123",
    "mpoUrl": "https://TENANT_NAME.mpo.mambu.com/",
    "new_folder_id": "17802",
    "secret": "mFcIjjUHHg8a7UqHbsad2dsdam97cWWflJ77kxCM9N0fWM32214XY",
    "sendUnsubscribeReport": true
}

Parameter	Type	Description
`apiKey`	string	This is the temporary API key ID mentioned earlier.
`initial_folder_id`	string	The folder ID of the previous connector version (v2.0.0).
`mpoUrl`	string	The MPO environment URL. For example, for a dedicated environment the URL would be `https://TENANT_NAME.mpo.mambu.com/`.
`new_folder_id`	string	The folder ID of the current connector version (v2.3.0).
`secret`	string	The connector’s secret key for the API key that is currently used.
`sendUnsubscribeReport`	boolean	Option to send Unsubscribe Report when client / group is updated in Mambu and new search is triggered in ComplyAdvantage. Values can be `true` or `false`.

Migration script from v2.0.0 to v2.1.0, v2.1.1, or v2.2.0

To run the migration process successfully, it is necessary to have both versions - v2.0.0 and v2.1.0, v2.1.1, or v2.2.0 of the connector uploaded to the same MPO tenant.

MPO setup

In the MPO environment: go to the Migration process folder within the v2.1.0, v2.1.1, or v2.2.0 connector folder, open Start migration [main process], switch to View mode, and click New task. Fill in all the required parameters and click Add task. Wait until the task is processed.

Alternatively, you can use the following JSON. Modify it and paste into the Code editor tab.

{
    "apiKey": "146",
    "initial_folder_id": "123",
    "mpoUrl": "https://TENANT_NAME.mpo.mambu.com/",
    "new_folder_id": "17802",
    "secret": "mFcIjjUHHg8a7UqHbsad2dsdam97cWWflJ77kxCM9N0fWM32214XY"
}

Parameter	Type	Description
`apiKey`	string	This is the temporary API key ID mentioned earlier.
`initial_folder_id`	string	The identification number for the folder ID of the previous connector version (v2.0.0).
`mpoUrl`	string	The MPO environment URL. For example, for a dedicated environment the URL would be `https://TENANT_NAME.mpo.mambu.com/`.
`new_folder_id`	string	The folder ID of the current connector version (v2.1.0, v2.1.1, or 2.2.0).
`secret`	string	The connector’s secret key for the API key that is currently used.

Migration script from v1.7.0 to v2.0.0

To run the migration process successfully, it is necessary to have both versions - v1.7.0 (and above) and v2.0.0 - of the connector uploaded to the same Mambu Process Orchestrator (MPO) tenant.

MPO setup

In the MPO environment: go to the Migration process folder within the v2.0.0 connector folder, open Start migration [main process], switch to View mode, and click New task. Fill in all the required parameters and click Add task. Wait until the task is processed.

Adding a new task to upgrade the connector

Alternatively, you can use the following JSON. Modify it and paste into the Code editor tab.

{
    "apiKey":  "137",
    "cfMappingData": "cfMappingData": {
        "clientUsedFields": [
            {
                "source": "id",
                "targetPath": "_ComplyAdvantage_AML_Clients.aml_searchId"
            },
            {
                "source": "search_version",
                "targetPath": "_ComplyAdvantage_AML_Clients.aml_clientSearchVersion"
            },
            {
                "source": "share_url",
                "targetPath": "_ComplyAdvantage_AML_Clients.aml_sharedUrl"
            },
            {
                "source": "pep",
                "targetPath": "_CA_AML_Client.isPep"
            },
            {
                "source": "sanctions",
                "targetPath": "_CA_AML_Client.isSanctions"
            },
            {
                "source": "adverseMedia",
                "targetPath": "_CA_AML_Client.isAdverseMedia"
            },            {
                "source": "match_status",
                "targetPath": "_ComplyAdvantage_AML_Clients.aml_matchStatus"
            },
            {
                "source": "risk_level",
                "targetPath": "_ComplyAdvantage_AML_Clients.aml_riskLevel"
            }
        ],
        "groupUsedFields": [
            {
                "source": "id",
                "targetPath": "_ComplyAdvantage_AML_Groups.aml_searchIdGroup"
            },
            {
                "source": "share_url",
                "targetPath": "_ComplyAdvantage_AML_Groups.aml_sharedUrlGroup"
            },
            {
                "source": "pep",
                "targetPath": "_CA_AML_Group.isPep_group"
            },
            {
                "source": "sanctions",
                "targetPath": "_CA_AML_Group.isSanctions_group"
            },
            {
                "source": "adverseMedia",
                "targetPath": "_CA_AML_Group.isAdverseMedia_group"
            },
            {
                "source": "match_status",
                "targetPath": "_ComplyAdvantage_AML_Groups.aml_matchStatusGroup"
            },
            {
                "source": "search_version",
                "targetPath": "_ComplyAdvantage_AML_Groups.aml_groupSearchVersion"
            },
            {
                "source": "risk_level",
                "targetPath": "_ComplyAdvantage_AML_Groups.aml_riskLevelGroup"
            }
        ]
    },
    "customUpdatesClientConfig": {
        "blacklistedStatus": [
            "potential_match",
            "true_positive_approve"
        ],
        "blacklistedSources": [
            "matched_source_PEP",
            "matched_source_AMedia",
            "matched_source_sanctions",
            "matched_source_fitness",
            "matched_source_warnings"
        ],
        "whitelistedStatus": [
            "false_positive",
            "true_positive_reject"
        ],
        "monitoredStatus": [
            "no_match",
            "false_positive",
            "unknown",
            "true_positive",
            "potential_match",
            "true_positive_reject",
            "true_positive_approve"
        ],
        "stopMonitoringOnEvent": [
            "exitedClient",
            "blacklistedClient",
            "rejectedClient"
        ],
        "reportStatus": [
            "no_match",
            "false_positive",
            "unknown",
            "true_positive",
            "potential_match",
            "true_positive_reject",
            "true_positive_approve"
        ],
        "createUpstreamBlacklistedClient": "true"
    },
    "initial_folder_id":  "12345",
    "mpoUrl": "https://TENANT_NAME.mpo.mambu.com/",
    "new_folder_id":  "12346",
    "secret":  "mFcIjjUHHg8a7UqHbsad2dsdam97cWWflJ77kxCM9N0fWM32214XY"
}

Parameter	Type	Description
`apiKey`	string	This is the temporary API key ID mentioned earlier.
`cfMappingData`	object	Represents the Mambu custom fields to Mapping AML data with boolean values for `pep`, `sanctions`, `warnings`, `fitness`, and `adverseMedia`.
`cfMappingData.clientUsedFields[]`	array	An array containing the mapping details for clients in JSON objects with the Mambu `source` and the ComplyAdvantage `targetPath`.
`cfMappingData.groupUsedFields[]`	array	An array containing the mapping details for groups in JSON objects with the Mambu `source` and the ComplyAdvantage `targetPath`.
`customUpdatesClientConfig`	object	Represents the `customUpdatesClientConfig` from Custom Updates Setup.
`initial_folder_id`	string	The folder ID of the previous connector version (v1.7.0 and above).
`mpoUrl`	string	The MPO environment URL. For example, for a dedicated environment the URL would be `https://TENANT_NAME.mpo.mambu.com/`.
`new_folder_id`	string	The folder ID of the current connector version (v2.0.0).
`secret`	string	The connector’s secret key for the API key that is currently used.

Migration script from v1.6.3 to v1.7.0

To run the migration process successfully, it is necessary to have both versions - v1.6.3 and v1.7.0 - of the connector uploaded to the same Mambu Process Orchestrator (MPO) tenant.

Installation and configuration

The migration process requires the folder ID of the previous connector version (v1.6.3) to retrieve data, and the folder ID of the new connector version (v1.7.0) to write the extracted data correctly. To obtain the ID of a folder in MPO, navigate to the list of your MPO connectors, select the one you need, then click the Information icon. The ID appears in a new sidebar on the right-hand side of the MPO workspace.

A screenshot of the items you need to click to retrieve the folder ID

As the migration script uses some MPO API calls, it requires valid authentication credentials; apiKey, mpoUrl, and secret. Installation also requires groupStateValuePath and the optional parameter valueForStopMonitoringGroup.

MPO setup

In the MPO environment: go to the Migration process folder within the v1.7.0 connector folder, open Start migration [main process], switch to View mode, and click New task. Fill in all the required parameters and click Add task. Wait until the task is processed.

Adding a new task to upgrade the connector

Alternatively, you can use the following JSON. Modify it and paste into the Code editor tab.

{
    "apiKey": "111",
    "groupStateValuePath": {
        "targetPath": "_ComplyAdvantage_AML_Groups.aml_stopMonitoring"
    },
    "initial_folder_id": "12345",
    "mpoUrl": "https://TENANT_NAME.mpo.mambu.com/",
    "new_folder_id": "12347",
    "secret": "mFcIjjUHHg8a7UqHbsad2dsdam97cWWflJ77kxCM9N0fWM32214XY",
    "valueForStopMonitoringGroup": "exitedGroup"
}

Parameter	Type	Description
`apiKey`	string	This is the temporary API key ID mentioned at the beginning of the section.
`groupStateValuePath`	object	An object holding the `customSet.customFieldId` created in Mambu environment.
`groupStateValuePath.targetPath`	string	Represents the `customSet.customFieldId` created in Mambu environment.
`initial_folder_id`	string	The folder ID of the previous connector version (v1.6.3).
`mpoUrl`	string	The MPO environment URL. For example, for a dedicated environment the URL would be `https://TENANT_NAME.mpo.mambu.com/`.
`new_folder_id`	string	The folder ID of the current connector version (v1.7.0).
`secret`	string	The connector’s secret key for the API key that is currently used.
`valueForStopMonitoringGroup`	string	Represents the value that marks and allows you to disable monitoring for a group (e.g `exitedGroup`).

Update unmonitored searches SDs