Renaming/Moving AWM Application Playbook

We encountered some difficulties with renaming and moving AWM apps as described here.

In some cases, an error occurred that caused the app’s homepage to become detached from the code pages. This error can be avoided by fully completing the AWM Wizard first and clearing the fields in the TemplateProvider. Additionally, while the app’s URL was renamed, the app’s page title remained unchanged. Furthermore, some of the application pages were not updated as expected.

After a lot of trial and error, we put together the following playbook, which allows us to move and rename apps without any errors. I hope the playbook is usefull for others as well

Renaming/Moving AWM Application Playbook

Disclaimer:
Make a backup first
Use a testing environment
Use this playbook at your own risk
Some steps are optional, and not every step was required in every case. Following all the steps might be excessive, so feel free to adapt the playbook to suit your specific needs

1. AWM App Reset: In the first step, the app must be reset by fully completing the AWM Wizard.

2. Clear the TemplateProvider: The fields for the template’s creation restrictions and it’s availability in the TemplateProvider must be empty.

3. Rename: It is recommended to perform renaming and moving as separate steps. Start by renaming the app first.

4. Optionally Reset the AppSheet: If the app contains a customized AppSheet, the changes made by the AWM Wizard must be reverted in the AppSheet’s history. (Please note that you may need to manually change the $messageKey to the app’s new name.)

5. Rename the App Homepage, AppClass, and TemplateProvider: The AWM Wizard does not rename all subpages of the “code” page. The app’s Homepage, AppClass, and TemplateProvider must be renamed manually using the WYSIWYG editor.

6. AWM App Reset: The app should be reset again by fully completing the AWM Wizard.

7. Optionally Reset the AppSheet: If the app contains a customized AppSheet, the changes made by the AWM Wizard must again be reverted in the AppSheet’s history.

8. Move: Once renaming is complete, the app can be moved as desired.

9. AWM App Reset: Finally, the app should be reset one more time by fully completing the AWM Wizard.

10. Optionally Fill the TemplateProvider: The fields for the template’s creation restrictions and availability in the TemplateProvider should be refilled as needed.

11. Optionally Reset the AppSheet: If the app contains a customized AppSheet, the changes made by the AWM Wizard must also be reverted in the AppSheet’s history this time.

12. Replace the Class Name in XWiki: Finally, the class name and the 'translationPrefix': '….livetable.', must be replaced everywhere the old class name and the 'translationPrefix' is used (e.g. in every Live Table using the app’s data). This can be done using the “Bulk replace content in pages” snippet.

1 post - 1 participant

Read full topic