Uploaded image for project: 'Nuxeo Platform'
  1. Nuxeo Platform
  2. NXP-27963

Take into account Commentable facet in Web UI

    XMLWordPrintable

    Details

    • Release Notes Summary:
      The Commentable facet is required to add comments to a document in the WebUI.
    • Epic Link:
    • Tags:
    • Upgrade notes:
      Hide

      Comments will only be available for document with the Commentable facet. Note that on 10.10, this check will only be done when setting the org.nuxeo.web.ui.enforceCommentable conf property to true:

      <require>org.nuxeo.web.ui.properties.contrib</require>
<extension target="org.nuxeo.runtime.ConfigurationService" point="configuration">
  <property name="org.nuxeo.web.ui.enforceCommentable">true</property>
</extension>

      to avoid a breaking change.

      Show
      Comments will only be available for document with the Commentable facet. Note that on 10.10, this check will only be done when setting the org.nuxeo.web.ui.enforceCommentable conf property to true : <require>org.nuxeo.web.ui.properties.contrib</require> <extension target= "org.nuxeo.runtime.ConfigurationService" point= "configuration" > <property name= "org.nuxeo.web.ui.enforceCommentable" > true </property> </extension> to avoid a breaking change.
    • Team:
      GANG
    • Sprint:
      nxGang Sprint 11.1.16

      Description

      Today the comments tab and widget are hardcoded in https://github.com/nuxeo/nuxeo-web-ui/blob/master/elements/document/nuxeo-document-page.js#L217. They are available for all document types and the only way to remove them would be to override this whole element through a slot contribution.

      Some custom projects may want to disable UI application wide comments feature. There is a Commentable facet but it is just ignored on both platform and client-side -> leftover from old implementation.

      We usually stick to a single pattern to enable/disable a feature which is the facet one like for Versionable (NXP-27873). Relying on a doctype facet allows to:

      • control granularity on doc types
      • fully disable it by ignoring its registration at runtime startup

      Unfortunately, If we decide to stick to the Commentable facet pattern for 10.10 it means that comments won't suddenly be available anymore for document types without the Commentable which could be seen as a breaking behavior.

      A possible solution, would be to introduce a Global UI conf on 10.10:

      <property name="org.nuxeo.web.ui.enforceCommentable">false</property>

      and check it to display comments widget and tab.

        Attachments

          Issue Links

          is related to

          New Feature - A new feature of the product, which has yet to be developed. NXP-27873 Allow global disabling of facets, like Versionable

          • Minor - Minor loss of function, or other problem where easy workaround is present.
          • Resolved

          Task - A task that needs to be done. NXP-28790 Retention configuration

          • Major - Major loss of function.
          • Resolved
          is required by

          Bug - A problem which impairs or prevents the functions of the product. NXP-28666 Fix Web UI enforceCommentable boolean property parsing

          • Major - Major loss of function.
          • Resolved
          Is referenced in

          [Captain Hook] PR for master: #966 PR for master: #966

          [Captain Hook] PR for master: #990 PR for master: #990

          [Captain Hook] PR for master: #1241 PR for master: #1241

            Activity

              People

              • Votes:
                0 Vote for this issue
                Watchers:
                3 Start watching this issue

                Dates

                • Created:
                  Updated:
                  Resolved:

                  Time Tracking

                  Estimated:
                  Original Estimate - 0 minutes
                  0m
                  Remaining:
                  Remaining Estimate - 0 minutes
                  0m
                  Logged:
                  Time Spent - 1 day, 30 minutes
                  1d 30m