User Interface migration guide

The user interface of the application engine, and the libraries it makes use of, are updated regularly. We strive to do 2 to 4 updates a year. If your application does not have any customized work that depend on user interface resources with a correct version, your application will be upgraded automatically to a new version when it comes available. If not, you will (should) have selected a particular user interface version in the blueprint and you will need to migrate to a newer version when you want to use it. 

Steps to take to migrate to a new UI

Step 1: custom work analysis

Check what custom work your application uses that depend on the user interface version. Use the checklist below:

  1. Custom surrounding page
    This includes ANY page displaying standard engine gui components, for example a website page with a form or a 'backend' page of you application using a customized surrounding page.

  2. Custom css
    Any css rules that work on the css library used but the UI and/or modifies the application engine style (preceded by 'cx_').

  3. Custom javascript 
    Any javascipt that uses the default script libraries and/or uses the javascript hooks of the application engine UI.

  4. Custom snippets
    If you use custom snippets check why you did so. In some cases the custom snippets may not be needed anymore because the functionality is builtin in. If it is still needed, you will need to rewrite it using the current snippets

  5. Custom HTML editor configuration
    Some memo fields in the blueprint might have custom HTML editor configurations.

It's a good idea to document the UI dependencies as part of your application development so you won't need to to do step 1 every time you upgrade to a newer UI.

Step 2: impact analysis

Read the documentation of all user interface version between your current one and the one you intend to migrate to and see if anything will affect your custom work. Depending on your custom work, check if the surrounding pages, javascript/css libraries or snippets have changed.

Step 3: Change user interface

You can preview any user interface by setting this property in your session. If you want to make the change permanent, change the user interface in the Blueprint properties, tab User Interface to the desired version. If you have lots of changes to do, it is wise to create a specific blueprint version to make all the changes in before going into production.

If you are using SASS to generate the CSS it is advised to generate the CSS after changing the user interface.