Migration Script

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

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

Migration script from v4.3.0 to v4.5.0

To run the migration process successfully, it is necessary to have both versions - v4.3.0 and v4.5.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 v4.3.0) to retrieve data, and the folder ID of the new connector version (v4.5.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.

How to retrieve migration folder IDs in MPO

Installation also requires a valid OAuth URL to trigger the Refresh Token process, a notification process ID, and a notification configuration object - in case the user wants to include the new notification system. The migration script uses some MPO API calls, therefore it requires a valid authentication credentials; apiKey, mpoUrl, and secret.

Please Note

To successfully run the migration script, both the initial and the current version of the connector need to use the same API Key - which is generated during the MPO Setup process.

MPO setup

Initial configuration

In the MPO environment, go to the Migration process folder, within the v4.5.0 connector folder, and 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": "",
    "initial_folder_id": "",
    "mpoUrl": "",
    "new_folder_id": "",
    "notification_config_object": {},
    "notification_process_ID": "",
    "oauthUrl": "",
    "secret": ""
}
ParameterDescription
apiKeyThis is the same connector API key ID generated during MPO setup. Details on where it was generated can be found at MPO Setup.
initial_folder_idThe identification number for the folder ID of the previous connector version (v4.3.0).
mpoUrlMPO environment URL (for example: https://mpo-multitenant.mambuonline.com/) where the API key was generated during the MPO setup process.
new_folder_idThe identification number for the folder ID of the current connector version (v4.5.0).
notification_config_objectObject containing notification connectivity details of the external system. This can be empty if no notification system is used
notification_process_IDThe process ID of the custom notification process. This can be empty if no notification system is used.
oauthUrlThe OAuth URL, which can be different for each environment used (sandbox or production). Details about the oauthUrl can be found in the Installation and configuration section from nCino Setup
secretThe connector’s secret key for the API key that is currently used and was generated during the setup process.

Mandatory post run steps

The following steps are required after successfully running the migration script. Firstly, you need to run the Health Check process to verify that the data was copied. Secondly, you need to open the new Refresh Token process in the /Setup/Salesforce API OAuth/OAuth 2.0 folder of the v4.5.0 connector folder; check that the task exists and that it can be found in the Wait for timeout delay node.

Migration script from v4.5.0 to v4.6.0

Installation and configuration

The migration process requires the folder ID of the previous connector version (v4.5.0), the folder ID of the new connector version (v4.6.), the MPO instance URL, and the same API key and secret used in both connectors. 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.

How to retrieve migration folder IDs in MPO

MPO setup

Initial configuration

In the MPO environment, open the v4.6.0 connector folder. Navigate to the Migration process folder and 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": "",
    "initial_folder_id": "",
    "mpoUrl": "",
    "new_folder_id": "",
    "secret": ""
}
ParameterDescription
apiKeyThis is the same connector API key ID generated during MPO setup. Details on where it was generated can be found at MPO Setup.
initial_folder_idThe identification number for the folder ID of the previous connector version (v4.5.0).
mpoUrlMPO environment URL (for example: mpo-multitenant.mambuonline.com) where the API key was generated during the MPO setup process.
new_folder_idThe identification number for the folder ID of the current connector version (v4.6.0).
secretThe connector’s secret key for the API key that is currently used and was generated during the setup process.

Mandatory post run steps

The following steps are required after successfully running the migration script. Firstly, you need to run the Health Check process to verify that the data was copied. Secondly, you need to open the new Refresh Token process in the /Setup/Salesforce API OAuth/OAuth 2.0 folder of the v4.6.0 connector folder; check that the task exists and that it can be found in the Wait for timeout delay node.