Module Migrator
20 min
module migrator is a standalone app designed to address breaking changes and automate the migration of deprecated app modules to their latest versions it eliminates the need for manual updates or skips the pain of identifying what the breaking changes are the module migrator reduces effort, accelerates the migration and adoption of new features migration is not supported for all apps you can view the full list of currently supported apps in the module migrator itself certain complex configurations require manual intervention in these instances, the module provides specific guidelines to help you complete the migration successfully key benefits scalability automatically updates multiple at once provides clarity for risky , the module migrator minimizes user struggle to identify exactly what changed between versions and how to map old configurations to new ones simplifies complexity eliminates human error due to manual migration flexible module migration processes safe recreation the safe recreation method is a "safety first" workflow, allowing users to transition to updated module versions without risking the integrity of their current production environment instead of applying changes directly to the live , this method generates an independent clone of the original scenario during the replication process module migrator intercepts the legacy modules and replaces them with their updated counterparts remaps parameters and adjusts for breaking changes in the background you are prompted to select a designated destination folder for this new version, to separate it from the original how to use it select the create a new scenario option in the module migrator > migrate outdated modules direct update in this method, you can update your instantly without the overhead of managing duplicate files the system scans the existing , identifies the outdated components, and overwrites them with the latest versions directly within the original it automatically maps the old configurations to the new module structure and updates downstream dependencies in real time, ensuring the is ready for immediate use how to use it select the update original scenario option in the module migrator > migrate outdated modules things to remember for with polling triggers if the recreated starts with a polling trigger, you must select the first record to run from (by date, id, from now on, etc ), then activate the new and turn off the original for with instant triggers if the recreated starts with an instant trigger, you must switch the webhook which means, you must unlink it from the original and select it in the new in case of recreating a with instant trigger, the webhook is removed in the copy, so the original remains functional create a connection with the module migrator app provides two ways to connect to the module migrator app oauth2 api key to create the connection using oauth2 , continue to the docid 2udlv6fl ezwevxjdxmnb section to create the connection using an api key , you need to docid 2udlv6fl ezwevxjdxmnb obtain your api key in if you are connecting using an api key, you should first obtain an api key in your account to obtain the api key log in to your account click profile icon > profile click on the api tab if there is no existing api key, create one by clicking add token if there is an existing api key, go to step 5 add the label and scopes for your token and click save use the following scopes organizations\ read , teams\ read , scenarios\ read , scenarios\ write copy the api key value and store it in a safe place you'll use this value in the api key connection field in create the connection in to create the connection log in to your account, add a module migrator module to your , and click create a connection select your connection type oauth2 or api key optional in the connection name field, enter a name for the connection in the environment url field, enter the url address of your instance for example https //eu1 make com if you selected api key as your connection type, enter your api key in the api key field click save if prompted, authenticate your account and confirm access you've successfully created the connection and can now use the app in your if you want to make changes to your connection in the future, follow the steps https //help make com/connect an application#tn2pj module migrator modules search before committing to a migration, you can execute an analysis for migration using the search module field description connection select an account to connect to an existing account or create a new connection organization select the organization where to scan for outdated team select the team where to scan for outdated folder select the folder to scan for outdated output by selecting a specific organization, team, and folder, the module generates a report detailing the impacted deprecated modules whether or not manual steps are required for migration migrate outdated modules use the migrate outdated modules module to migrate a after analysis field description connection select an account to connect to an existing account or create a new connection scenario id map the id of the you want to update migration mode create a new scenario ideal for complex production , this migration method creates a new copy in a designated folder while leaving the original untouched the name of the new will be {original name} \[migrated] this type of migration is best suited for complex production which require manual steps update original scenario ideal for rapid batch processing of low risk , this migration method overwrites the existing with an updated module version organization select the destination organization for your migration team select the destination team for your migration folder select the destination folder for your migration output by selecting a specific organization, team, and folder, the module generates a report detailing the total number of outdated modules total number of migrated modules any warnings or information example scenario before and after migration for direct updates scenario before migration the below contains deprecated modules marked with green arrows the direct update method allows you to update a by overwriting legacy modules with their latest versions instantly scenario during migration when you run this , the search scenarios module scans for that need updates the migrate outdated modules module returns a warning if a module update involves additional manual steps modules eligible for a direct update are replaced immediately scenario after migration you will see that all deprecated modules have been replaced by their updated versions how to use the module migrator updating legacy modules across multiple can be a complex task this procedure guides you through building an automated workflow that identifies deprecated modules and migrates them using either a safe recreation path (for complex ) or a direct update path (for simple, low risk ) step 1 search for the that need migration use the search scenarios module to identify which need migration log in to the platform add a module migrator > search scenarios module to your builder in the connection field, select an account to connect or create a new connection using oauth or api keys from the organization dropdown, select the organization that you would like to search for migration from the team dropdown, select the team to which the belong from the folder dropdown, select the folder in which the are saved click save when run, this module outputs a bundle that shows the old and new module names and whether updates are needed step 2 add a router to route the for migration in this step, you will add a router to route the that need manual updates and those that can be overwritten in your builder, click the + sign after module migrator > search module from the list of modules, add a router step 3 safe recreation set up the module migrator > migrate outdated modules module if manual steps are needed in this method you can create a new copy of the in a designated folder and leave the original untouched set up the module migrator > migrate outdated modules if manual steps are needed for migration to one end of the router, add a module migrator > migrate outdated modules module follow the next steps to configure it as shown in the image below in the connection field, select an account to connect or create a new connection using oauth or api keys in the scenario id field, map the scenario id from the module migrator > search module from the migration mode dropdown, select create a new scenario select a location to store your migrated from the organization dropdown, select the organization from the team dropdown, select the team from the folder dropdown, select the folder click save step 4 direct update set up the module migrator > migrate outdated modules module if manual steps are not needed in this method, the system overwrites the existing with the updated module versions this type of migration is best suited for rapid batch processing of low risk to the second end of the router, add another module migrator > migrate outdated modules module follow the next steps to configure it as shown in the image below in the connection field, select an account to connect or create a new connection using oauth or api keys in the scenario id field, map the scenario id from the module migrator > search module from the migration mode dropdown, select update original scenario click save step 5 set up filters you can set up two filters one filter to catch that require human intervention, the other to to automatically handle updates without manual review to the first route, right click and add a filter in the label field, type create select no in the set the route as a fallback a fallback route is a backup route that is used if the source data didn't go through any other route one router can have only one fallback route field in the condition field, map updates needed = true to the second route, right click and add a filter in the label field, type auto select yes in the set the route as a fallback a fallback route is a backup route that is used if the source data didn't go through any other route one router can have only one fallback route field leave all other attributes to their default values click save step 6 run the scenario click save to save the click run once when you run the , you should see the following results if your requires additional manual steps, it goes through the first filter create once the migrate outdated modules module is executed, a warning bundle is returned together with a list of required updates the output bundle tells exactly which module in your is impacted and instructions to complete the required updates a new duplicate with the suffix \[migrated] is added to your selected folder from step 3 if manual steps were not needed, the go through the second route this path automatically handles all that were simple enough to be updated without manual review