Addons

HOWTO: Make JSF UI the Default UI

This page is scheduled for review and update. Check back soon for updated content!

JSF UI Deprecation
This requires to have the JSF UI addon installed on your server that is deprecated since Nuxeo Platform LTS 2019.
Please refer to the Web UI documentation.

In case both nuxeo-jsf-ui and nuxeo-web-ui addons are installed, Web UI is set to be the default UI. If you want to make the JSF UI the default UI there are several changes to apply.

Login Page Redirection

To make the login page redirect to the JSF UI instead of the new Web UI you need to add the following XML contribution:

<extension target="org.nuxeo.ecm.platform.ui.web.auth.service.PluggableAuthenticationService" point="loginScreen">
  <loginScreenConfig>
    <startupPages>
      <startupPage id="jsf" priority="1000" />
    </startupPages>
  </loginScreenConfig>
</extension>

Note that the default priority values are:

  • Web UI (id="web"): 100
  • JSF UI ( id="jsf" ): 10

The highest priority wins.

To make the document permalinks generated by the server (and used in email notifications typically) point to the JSF UI instead of the Web UI you need to add the following XML contribution:

<extension target="org.nuxeo.ecm.platform.url.service.DocumentViewCodecService" point="codecs">
  <documentViewCodec name="notificationDocId"
                     enabled="true"
                     prefix="nxdoc"
                     priority="1000"
                     class="org.nuxeo.ui.web.url.codec.JSFNotificationDocumentIdCodec" />
</extension>

Nuxeo Drive Global Configuration

To make Nuxeo Drive handle proper links to the Nuxeo server UI you need to change the ui setting of the Nuxeo Drive global configuration from web to jsf.

15 days ago manonlumeau Final review
3 years ago Solen Guitter 4
3 years ago Solen Guitter 3
3 years ago Solen Guitter 2
3 years ago Antoine Taillefer 1
History: Created by Antoine Taillefer

We'd love to hear your thoughts!

All fields required