- Not a member of it yet? Learn about its benefits, what's planned and how to get in.
- Already a member? Help us co-creating it by telling us about your experience.
The JSF UI to Web UI migration tool is a safe and automated way to create an equivalent Web UI configuration based on your existing JSF UI configuration.
The migration tool dramatically reduces the effort needed to transition to Web UI, our user interface that makes use of modern web standard technologies to provide an exceptional user experience.
It has been designed to be:
No data is deleted when the migration tool is run. If you are not satisfied with the result, you can:
- go back to the state your project was before triggering it anytime,
- delete the additional configuration that was generated partially or totally.
After a migration run, a detailed report is created so that you can check the results.
A complete run typically finishes in a few minutes.
Steps below assume early access is activated on your project. If it's not yet, you can have a look at how to activate it.
- Checkout the branch you want to migrate in
Source Control -> Branch Managementscreen. If your project does not benefit from branch management, you can skip this step.
- Go to the
Configuration -> Migration Servicesscreen.
- Press the
start migrationbutton and confirm.
Note that if you are using the intermediate or advanced commit modes, you need to discard or commit and push any work in progress before the migration can be launched.
- Target Nuxeo Server version is LTS 2017
- Your dependencies include the JSF UI package and the Web UI package
Otherwise, you may visit the
Settings -> Application Definition page to change your dependencies if needed.
Although it is possible, we recommend not to work while the migration is happening.
Any configuration you would do in that time frame would not be taken into account by the migration tool, and could lead to conflicts if you decide to merge changes afterwards.
See the integrating changes section.
- Document layouts
- Workflow tasks layouts
- Form layouts
- Content views that do not reference a table layout
- User actions
- Content views that contain parameters or that reference a table layout
- Translation files
This scope is subject to change. Feel free to let us know about your migration priorities.
Whenever a migration is run, Nuxeo Studio will create two tags: one before the migration, and one after. If your project benefits from branch management, a dedicated branch is also created for you to easily review, possibly update, and merge changes made.
When the migration is finished, a report will become available in the migration services screen.
You can access the report to get instantly an understanding of the result, browse and search through it easily in order to find a particular information.
Result will be put in a dedicated branch, whose name is indicated in the previous migration list.
From there, you can take a look at the result by going into the
Source Control -> Branch Management menu and switching to the new branch by pressing the
checkout button on it.
No configuration is deleted when the migration is run: we add more, some of it may be slightly updated (typically to put constraints expressed in your layouts only back at schema level as it's a good practice), but we don't remove anything. The configuration produced can be reviewed and changed if needed, at your own pace.
Merging the changes follows the usual feature implementation process. If your project benefits from branch management features, you can also take advantage of the configuration review process to ease the merge.
The JSF UI configuration can be hidden when you are ready to migrate, see the finalizing migration section.
If your project benefits from branch management, you can go to the
Settings -> Branch Management screen to delete the branch created by the migration.
If your project doesn't benefit from branch management, changes can be discarded by reverting to the tag made before the migration was triggered.
If you are happy with the final result and want to finalize the migration to Web UI, in the branch used to create your release that will be used in production go to the
Settings -> Application Definition page, remove the JSF UI dependency and save.
JSF UI related configuration will be hidden in Studio and kept outside from your deployed configuration. If you change your mind, just add it back and your JSF UI configuration will be back.
Migration can be launched as many times as you wish: this can allow you to test configuration changes made on your JSF UI configuration or benefit from new features that have been added to the migration tool for instance.