renaming.md

Renaming a module

The display name for a module can be safely renamed at any time by updating the name in config.json (as documented later). It is NOT recommended to change the module directory name for modules download from the Repo. For modules that exist solely on a single system, it is possible to change the module directory name. Module specific URLs changing is typically the only side effect, but directory renames should still be tested in a non-production environment first to make sure all module features still work as expected. It is also recommended to sure the module does not contain it's own directory name anywhere in the source code. To rename a module directory, follow these steps:

1. Deploy the module (to all web nodes if there are multiple) under the new directory name (prefix) with a version suffix that matches the version currently enabled on the system.
   • This new deployment can contain code changes as well (e.g. renaming the module in config.json, renaming the module's main class, etc.)
2. Run the following query:

   update redcap_external_modules
   set directory_prefix = 'new_directory_prefix'
   where directory_prefix = 'old_directory_prefix'
   

3. Test to make sure the module still functions as expected.
   • All project enables, settings, logs, crons, etc. should be preserved.
4. Once enough time has passed for any running cron jobs to finish, delete the old directory (on all web nodes if there are multiple)