Uploaded image for project: 'PUBLIC - Liferay Portal Community Edition'
  1. PUBLIC - Liferay Portal Community Edition
  2. LPS-115314

As a categories administrator I can flag a vocabulary for internal use only

    Details

      Description

      Motivation

      In order to address the diverse usages of vocabularies in very different use cases, we are adding a new option to the current vocabulary creation process. Along with the existing ones, users will be able to set a vocabulary for internal use only.

      Persona

      Marketer / Vocabularies administration

      Design

      Figma File

      Technical Requirements

      • The previously existing options for vocabularies will remain the same:
        • Name
        • Description
        • Allow multiple categories Y/N
        • Associated asset types
        • Required Y/N
      • Permissions > Viewable by will remain the same, as the internal use check will be a general attribute above those permissions.
      • The new configuration option will be a check for the internal use of the vocabulary: For internal use only
      • It will be:
        •  Available for all vocabularies, regardless of the type of assets they apply to
        • Not checked by default
        • An information icon will display a hover pop up: When checked, the categories in this vocabulary will not be displayed in pages, either through widgets, fragments or content mapping, and can be used for internal searches and categorization only
        • If not selected, categories in the vocabulary will be displayed through pages so no-backend users can see them (in compliance with assigned permissions). See Notes section below.
      • The vocabularies marked as internal will be visually identifiable by an icon in the vocabulary management application. A tooltip will display when hovering on the icon: "For internal use only" (see screenshot below).

      Notes

      The following ways to display categories should be adapted to avoid displaying categories that belong to internal vocabularies:

      • Widgets which display the categories of an asset.
        • For example:
          • Blogs
          • Knowledge Base
          • Wiki
          • Asset Publisher
        • To ensure consistency this change can be done directly in the taglib <liferay-asset:asset-categories-summary> by adding a new attribute called showInternal that should be false by default but could be set to true when invoked from administration portlets.
      • Mapping of category fields:
        • The "All Categories" field should only include assigned categories which belong to vocabularies which are not marked as internal
        • The vocabularies marked as internal should not show up as mappeable fields.

      Acceptance Criteria

      • Given the vocabulary managing application
      • When a user edits an OOTB vocabulary or creates a custom one
      • Then the option "For internal use only" and its tooltip shows

      • Given a vocabulary that is marked as internal
      • When a user adds a widget which displays the asset's categories to a page
      • Then the categories that belongs to the internal vocabulary don't show

      • Given a vocabulary that is marked as internal
      • When a user wants to map a category field
      • Then the categories that belongs to the internal vocabularies don't show in the All categories field, and the vocabularies marked as internal do not show up as mappeable fields.

      • Given the vocabulary management application
      • When the user hovers over the closed eye icon
      • Then a tooltip displays: For internal use only

      Test Scenarios

      AC ID Test Strategy Test Scenarios Is it covered by FrontEnd ? (JS-Unit) Is it covered by BackEnd? (unit or integration) Poshi?
      01 Regression When the user edits an OOTB vocabulary or creates a custom one within the vocabulary managing application, the option "For internal use only" and its tooltip shows No No
      02 Sanity When the user adds a widget which displays the asset's categories to a page and there are vocabularies marked as internal, the categories that belongs to the internal vocabulary don't show No No  
      03 Smoke When the user wants to map a category field and there are vocabularies marked as internal, he categories that belongs to the internal vocabularies don't show in the All categories field, and the vocabularies marked as internal do not show up as mappeable fields No Yes No
      04 Regression When the user hovers over the closed eye icon within the vocabulary managing application, a tooltip displays: For internal use only No No  

        Attachments

          Issue Links

            Activity

              People

              Assignee:
              carlos.brichete Carlos Brichete Báez
              Reporter:
              julia.molano Julia Molano
              Engineering Assignee:
              Ruben Pulido
              Recent user:
              Luiz Queiroz
              Participants of an Issue:
              Votes:
              0 Vote for this issue
              Watchers:
              1 Start watching this issue

                Dates

                Created:
                Updated:
                Resolved:

                  Packages

                  Version Package
                  Master